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

The Agents API from Canonical — 6 operation(s) for agents.

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

Tagged areas include Agents. 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 6 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://testflinger.ps7.canonical.com/.

8 operations 6 paths 8 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 8
GET
/v1/agents/data
Get all agent data
getV1AgentsData → 200
GET
/v1/agents/queues
Get all advertised queues from this server
getV1AgentsQueues → 200
POST
/v1/agents/queues
Tell testflinger the queue names that are being serviced
postV1AgentsQueues body → 200422
POST
/v1/agents/images
Tell testflinger about known images for a specified queue
postV1AgentsImages body → 200422
GET
/v1/agents/images/{queue}
Get a dict of known images for a given queue
getV1AgentsImagesByQueue 1 param → 404200
GET
/v1/agents/data/{agent_name}
Get the information from a specified agent
getV1AgentsDataByAgentName 1 param → 200404
POST
/v1/agents/data/{agent_name}
Post information about the agent to the server
postV1AgentsDataByAgentName 1 param body → 200422404
POST
/v1/agents/provision_logs/{agent_name}
Post provision logs for the agent to the server
postV1AgentsProvisionLogsByAgentName 1 param body → 200422404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AgentOut (9 properties), AgentIn (8 properties), AgentJob (8 properties), ProvisionLogsIn (3 properties). Each schema is shown below with its type and property counts.

ImagesIn
object
AgentJob
object
8 properties 1 required
QueuesIn
object
ProvisionLogsIn
object
3 properties 2 required
AgentOut
object
9 properties 1 required
HTTPError
object
2 properties
AgentIn
object
8 properties
ValidationError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-agents-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 Agents 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.