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

The files API from Canonical — 1 operation(s) for files.

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

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

This API exposes 2 operations across 1 path, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

2 operations 1 paths 11 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 2

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

Files 2
GET
/v1/files
Read or list files
getV1Files 4 params → 200
POST
/v1/files
Create, write, remove files/directories
postV1Files body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are FileInfo (10 properties), makeDirsItem (7 properties), errorResult (3 properties), BaseResponse (3 properties). Each schema is shown below with its type and property counts.

makeDirsItem
object
7 properties 1 required
ListFilesResponse
errorResult
object
3 properties 1 required
ReadFilesResponse
object
2 properties
FileInfo
object
10 properties 5 required
removePathsItem
object
2 properties 1 required
PostFilesResponse
PostFilesRemovePathsRequest
object
2 properties 2 required
PostFilesMakeDirsRequest
object
2 properties 2 required
fileResult
object
2 properties
BaseResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-files-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 Files 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.