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 Mirror Service API

Methods for managing repository mirrors.

Canonical Mirror 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 MirrorService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

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

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

8 operations 5 paths 10 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 8

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

MirrorService 8

Methods for managing repository mirrors.

GET
/v1/mirrors
Mirror service list mirrors
MirrorService_ListMirrors 3 params → 200default
POST
/v1/mirrors
Mirror service create mirror
MirrorService_CreateMirror 1 param body → 200default
GET
/v1/mirrors/{mirror}
Mirror service get mirror
MirrorService_GetMirror 1 param → 200default
DELETE
/v1/mirrors/{mirror}
Mirror service delete mirror
MirrorService_DeleteMirror 2 params → 200default
PATCH
/v1/mirrors/{mirror}
Mirror service update mirror
MirrorService_UpdateMirror 2 params body → 200default
GET
/v1/mirrors/{mirror}/packages
Mirror service list mirror packages
MirrorService_ListMirrorPackages 3 params → 200default
POST
/v1/mirrors/{mirror}:sync
Mirror service sync mirror
MirrorService_SyncMirror 1 param body → 200default
POST
/v1/mirrors:batchGet
Mirror service batch get mirrors
MirrorService_BatchGetMirrors body → 200default

Schemas 10

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

SyncMirrorRequest
object
The request message for syncing a mirror.
6 properties 1 required
Operation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
GoogleProtobufAny
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
ListMirrorPackagesResponse
object
The response message for listing packages in a mirror.
2 properties
Mirror
object
A repository mirror configuration and status.
20 properties 5 required
BatchGetMirrorsResponse
object
The response message for retrieving a batch of mirrors.
2 properties
GpgKey
object
A GPG key resource.
3 properties 1 required
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
ListMirrorsResponse
object
The response message for listing mirrors.
2 properties
BatchGetMirrorsRequest
object
The request message for retrieving a batch of mirrors.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-mirrorservice-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 Mirror 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.