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 Projects API

The projects API from Canonical — 4 operation(s) for projects.

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

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

This API exposes 10 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

10 operations 4 paths 10 schemas 1 DELETE4 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.snapcraft.io
Resource Areas
1

Paths & Operations 10

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

Projects 10
GET
/1.0/projects
Get the projects
projects_get → 200403500
POST
/1.0/projects
Add a project
projects_post body → 200400403500
DELETE
/1.0/projects/{name}
Delete the project
project_delete 1 param → 202400403500
GET
/1.0/projects/{name}
Get the project
project_get → 200403500
PATCH
/1.0/projects/{name}
Partially update the project
project_patch body → 200400403412500
POST
/1.0/projects/{name}
Rename the project
project_post body → 202400403500
PUT
/1.0/projects/{name}
Update the project
project_put body → 200400403412500
GET
/1.0/projects/{name}/state
Get the project state
project_state_get → 200403500
PUT
/1.0/projects/{name}/state
Update the project replica state
project_state_put 1 param body → 202400403404500
GET
/1.0/projects?recursion=1
Get the projects
projects_get_recursion1 → 200403500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Operation (15 properties), Project (6 properties), ProjectsPost (5 properties), OperationRequestor (3 properties). Each schema is shown below with its type and property counts.

StatusCode
integer
Operation
object
Operation represents a LXD background operation
15 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
ProjectPut
object
ProjectPut represents the modifiable fields of a LXD project
2 properties
ProjectStateResource
object
ProjectStateResource represents the state of a particular resource in a LXD project
2 properties
ProjectPost
object
ProjectPost represents the fields required to rename a LXD project
1 property
Project
object
Project represents a LXD project
6 properties
ProjectStatePut
object
ProjectStatePut represents the fields for updating project replica state
1 property
ProjectsPost
object
ProjectsPost represents the fields of a new LXD project
5 properties
ProjectState
object
ProjectState represents the current running state of a LXD project
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-projects-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 Projects 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.