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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canonical

Canonical Job API

The Job API from Canonical — 7 operation(s) for job.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 7 paths, and defines 13 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/.

9 operations 7 paths 13 schemas 5 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 9

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

Job 9
GET
/v1/job
Request a job to run from supported queues
getV1Job → 200204
POST
/v1/job
Add a job to the queue
postV1Job body → 200422
GET
/v1/job/search
Search for jobs by tags
getV1JobSearch 3 params → 200422
GET
/v1/job/{job_id}
Request the json job definition for a specified job, even if it has
getV1JobByJobId 1 param → 200404
POST
/v1/job/{job_id}/action
Take action on the job status for a specified job ID
postV1JobByJobIdAction 1 param body → 200422404
POST
/v1/job/{job_id}/events
Post status updates from the agent to the server to be forwarded
postV1JobByJobIdEvents 1 param body → 200422404
GET
/v1/job/{job_id}/position
Return the position of the specified jobid in the queue
getV1JobByJobIdPosition 1 param → 200404
GET
/v1/job/{job_id}/attachments
Return the attachments bundle for a specified jobid
getV1JobByJobIdAttachments 1 param → 200404
POST
/v1/job/{job_id}/attachments
Post attachment bundle for a specified jobid
postV1JobByJobIdAttachments 1 param → 200404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are JobOut (18 properties), Job (17 properties), TestData (5 properties), StatusUpdate (4 properties). Each schema is shown below with its type and property counts.

Attachment
object
2 properties 1 required
ActionIn
object
1 property 1 required
JobSearchResponse
object
1 property 1 required
JobEvent
object
3 properties 2 required
TestData
object
5 properties
JobId
object
1 property 1 required
ValidationError
object
2 properties
ProvisionData
object
StatusUpdate
object
4 properties 1 required
ReserveData
object
2 properties
Job
object
17 properties 1 required
HTTPError
object
2 properties
JobOut
object
18 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-job-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
AE Profile APIs.io
Charmhub API
AE Profile APIs.io
MAAS API
AE Profile APIs.io
Juju Client / Controller API
AE Profile APIs.io
Launchpad Web Services API
AE Profile APIs.io
Ubuntu Pro Client API
AE Profile APIs.io
Canonical Assertions API
AE Profile APIs.io
Canonical Search API
AE Profile APIs.io
Canonical Snaps API
AE Profile APIs.io
MicroCeph REST API
AE Profile APIs.io
Canonical App Authorization Service API
AE Profile APIs.io
Canonical Application API
AE Profile APIs.io
#Job
← Back to C APIs
API Details
ID
canonical:canonical-job-api
Base URL
https://api.snapcraft.io
Docs
https://api.snapcraft.io/docs/
Provider
Canonical
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=canonical-job-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canonical-job-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Canonical Job 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.