V2 API Reference

This is the documentation for version 33 of Snapcraft Dashboard v2 API.

• Registries
• Snaps
• Brand Stores
• Developer Tokens
• Validation Sets

Changelog

Version 32:

• api-tokens-revoke: New API endpoint for revoking Developer Tokens.

Version 31:

• api-store-info: Added extra field to store info dict: “brand-id”.

• api-store-invites: Added extra field to store info dict: “brand-id”.

• api-store-settings: Added extra field to store info dict: “brand-id”.

• api-store-snaps: Added extra field to store info dict: “brand-id”.

• api-store-users: Added extra field to store info dict: “brand-id”.

• api-tokens-list: New API endpoint for Developer Tokens listing.

Version 30:

• api-tokens-exchange: New API endpoint for Developer Tokens exchange.

Version 29:

• api-store-metrics-models: Added extra field to store metrics: “device-ids”.

Version 28:

• api-store-info: Added extra field to store info dict: parent.

• api-store-invites: Added extra field to store info dict: parent.

• api-store-settings: Added extra field to store info dict: parent.

• api-store-snaps: Added extra field to store info dict: parent.

• api-store-users: Added extra field to store info dict: parent.

Version 27:

• api-tokens-whoami: New API endpoints for obtaining user information.

Version 26:

• api-tokens-request-macaroon: New API endpoints for Developer Tokens management.

Version 25:

• api-store-snaps: Add searching of snaps for inclusion in brand store using query params: q and allowed-for-inclusion

Version 24:

• api-store-snaps: Remove fields from store snaps endpoint: user id, user email

Version 23:

• api-store-snaps: Add searching of snaps to store snaps endpoint using query param: q

Version 22:

• api-store-snaps: Added extra field to store snaps GET response: latest-release

Version 21:

• api-store-snaps: Added extra field to store snaps response: users (publisher and collaborators).

Version 20:

• api-store-users: Add GET support to store users endpoint.

Version 19:

• api-store-invites: Update store invites endpoint to allow modifications to existing invites.

Version 18:

• api-store-settings: New API endpoint to edit store settings.

Version 17:

• api-store-info: Added extra fields to store info dict: private, manual-review-policy

• api-store-invites: Added extra fields to store info dict: private, manual-review-policy

• api-store-snaps: Added extra fields to store info dict: private, manual-review-policy

• api-store-users: Added extra fields to store info dict: private, manual-review-policy

Version 16:

• api-validation-sets: New API endpoints for Validation Sets management.

• api-validation-sets-build-assertion: New API endpoints for Validation Sets management.

Version 15:

• api-store-metrics-models: New API endpoint to fetch store metrics.

Version 14:

• api-snap-channel-map: Added current-percentage to the progressive dict.

• api-snap-releases: Added current-percentage to the progressive dict.

Version 13:

• api-snap-channel-map: Added status to the tracks metadata dict.

• api-snap-releases: Added status to the tracks metadata dict.

Version 12:

• api-snap-channel-map: Added title and publisher to the snap metadata dict.

• api-snap-releases: Added title and publisher to the snap metadata dict.

Version 11:

• api-snap-channel-map: Removed the field key in the progressive dictionary.

• api-snap-releases: Removed the field key in the progressive dictionary.

Version 9:

• api-snap-releases: Added two new top-level fields to the response: tracks, listing the most relevant tracks for this snap, with proper metadata and ordering; and channels, listing the most relevant channels, including the channel breakdown with track, risk and branch and their fallback channel. Branches are only included in the channels list if there is a release available in that branch.

Version 8:

• api-snap-releases: Added two new fields to the releases dictionaries: channel, providing the channel name for the release; and expiration-date that, if not null, indicates when the release will expire, in ISO 8601 format.

Version 7:

• api-store-invites: New API endpoint to create store invites.

Version 6:

• api-snap-releases: Added new field snap to the response including metadata from the snap itself.

Version 5:

• api-store-info: Added extra field to store info dict: invites.

Version 4:

• api-snap-releases: Added new field progressive for each release item, providing details about whether that release is a progressive release or not.

Version 3:

• api-store-info: Added extra field to store info dict: snap-name-prefixes.

• api-store-snaps: Added extra field to store info dict: snap-name-prefixes.

• api-store-users: Added extra field to store info dict: snap-name-prefixes.

Version 2:

• api-store-info: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores.

• api-store-snaps: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores.

• api-store-users: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores.