How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Clients Service API

The ClientsService API from Canonical — 2 operation(s) for clientsservice.

Canonical Clients Service API is one of 122 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ClientsService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against the base URL https://api.snapcraft.io.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.snapcraft.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Canonical Clients Service API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ClientsService 5
GET
/api/v0/clients
Clients service list clients
ClientsService_ListClients 4 params → 200401403default
POST
/api/v0/clients
Clients service create client
ClientsService_CreateClient body → 201400401403default
DELETE
/api/v0/clients/{id}
Clients service remove client
ClientsService_RemoveClient 1 param → 200401403default
GET
/api/v0/clients/{id}
Clients service get client
ClientsService_GetClient 1 param → 200401403default
PUT
/api/v0/clients/{id}
Clients service update client
ClientsService_UpdateClient 1 param body → 200400401403404default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are clientsClient (47 properties), clientsListClientsResp (4 properties), typesPagination (4 properties), clientsUpdateClientResp (3 properties). Each schema is shown below with its type and property counts.

clientsUpdateClientResp
object
3 properties
clientsCreateClientResp
object
3 properties
clientsGetClientResp
object
3 properties
typesErrorResponse
object
2 properties
clientsClient
object
47 properties
clientsListClientsResp
object
4 properties
clientsRemoveClientResp
object
2 properties
typesPagination
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-clientsservice-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Clients Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.