# Canonical Authentication Required API

**Canonical:** https://apis.io/apis/canonical/canonical-authenticationrequired-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Base URL:** https://api.snapcraft.io  
**Documentation:** https://api.snapcraft.io/docs/

Canonical Authentication Required API is one of 114 APIs that [Canonical](https://apis.io/providers/canonical/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Authentication Required. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

Access is restricted to the root user.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/changes` | Get all changes |
| GET | `/v2/changes/{id}` | Get the status of a change |
| POST | `/v2/changes/{id}` | Abort a change |
| POST | `/v2/cohorts` | Create cohort keys |
| GET | `/v2/find` | Find snaps in the store |
| POST | `/v2/login` | Authenticate user with snapd and store |
| POST | `/v2/logout` | Log user out of snapd and the store |
| GET | `/v2/logs` | Get log contents |
| POST | `/v2/snapctl` | Run snapctl command |
| GET | `/v2/snaps/{name}/conf` | Get snap configuration |
| GET | `/v2/snapshots/{set-id}/export` | Export a snapshot set |
| GET | `/v2/system/system-recovery-keys` | Get system recovery key |
| POST | `/v2/system/system-recovery-keys` | Manage system recovery keys |
| POST | `/v2/systems` | Perform an action on the current recovery system or create a new one |
| GET | `/v2/systems/{label}` | Get details for a specific recovery system |
| POST | `/v2/systems/{label}` | Perform an action on a specific recovery system |
| GET | `/v2/validation-sets` | Get all enabled validation sets |
| GET | `/v2/validation-sets/{account-id}/{name}` | Get a specific validation set |
| POST | `/v2/validation-sets/{account-id}/{name}` | Manage a specific validation set |
| POST | `/v2/warnings` | Respond to warnings |

## Machine-readable artifacts (25)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-authenticationrequired-api-openapi.yml
- **Documentation** — https://snapcraft.io/docs/reference/development/snapd-rest-api/
- **HowTo** — https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- **Documentation** — https://ubuntu.com/landscape/docs
- **APIReference** — https://documentation.ubuntu.com/landscape/reference/api/
- **ReleaseNotes** — https://documentation.ubuntu.com/landscape/reference/release-notes/
- **Portal** — https://ubuntu.com/landscape
- **Documentation** — https://documentation.ubuntu.com/lxd/latest/rest-api/
- **APIReference** — https://documentation.ubuntu.com/lxd/latest/api-extensions/
- **SourceCode** — https://github.com/canonical/lxd
- **Portal** — https://canonical.com/lxd
- **Documentation** — https://ubuntu.com/security/api/docs
- **APIReference** — https://ubuntu.com/security/api/spec.json
- **Portal** — https://ubuntu.com/security
- **Documentation** — https://documentation.ubuntu.com/pebble/
- **SourceCode** — https://github.com/canonical/pebble
- **Documentation** — https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- **SourceCode** — https://github.com/canonical/testflinger
- **SourceCode** — https://github.com/canonical/hardware-api
- **Portal** — https://ubuntu.com/certified
- **SourceCode** — https://github.com/canonical/identity-platform-api
- **SourceCode** — https://github.com/canonical/test_observer
- **Documentation** — https://documentation.ubuntu.com/anbox-cloud/
- **Portal** — https://canonical.com/anbox-cloud
- **SourceCode** — https://github.com/canonical/cos-registration-server

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [MAAS API](https://apis.io/apis/canonical/maas-api/)
- [Juju Client / Controller API](https://apis.io/apis/canonical/juju-api/)
- [Launchpad Web Services API](https://apis.io/apis/canonical/launchpad-api/)
- [Ubuntu Pro Client API](https://apis.io/apis/canonical/ubuntu-pro-api/)
- [Canonical Assertions API](https://apis.io/apis/canonical/canonical-assertions-api/)
- [Canonical Search API](https://apis.io/apis/canonical/canonical-search-api/)
- [Canonical Snaps API](https://apis.io/apis/canonical/canonical-snaps-api/)
- [MicroCeph REST API](https://apis.io/apis/canonical/microceph-api/)
- [Canonical App Authorization Service API](https://apis.io/apis/canonical/canonical-appauthorizationservice-api/)
- [Canonical Application API](https://apis.io/apis/canonical/canonical-application-api/)

## Tags

Authentication Required

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/canonical/canonical-authenticationrequired-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/canonical/.