# Canonical Job API

**Canonical:** https://apis.io/apis/canonical/canonical-job-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Base URL:** https://api.snapcraft.io  
**Documentation:** https://api.snapcraft.io/docs/

Canonical Job API is one of 122 APIs that [Canonical](https://apis.io/providers/canonical/) publishes on the [APIs.io](https://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.

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

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/job` | Request a job to run from supported queues |
| POST | `/v1/job` | Add a job to the queue |
| GET | `/v1/job/search` | Search for jobs by tags |
| GET | `/v1/job/{job_id}` | Request the json job definition for a specified job, even if it has |
| POST | `/v1/job/{job_id}/action` | Take action on the job status for a specified job ID |
| POST | `/v1/job/{job_id}/events` | Post status updates from the agent to the server to be forwarded |
| GET | `/v1/job/{job_id}/position` | Return the position of the specified jobid in the queue |
| GET | `/v1/job/{job_id}/attachments` | Return the attachments bundle for a specified job_id |
| POST | `/v1/job/{job_id}/attachments` | Post attachment bundle for a specified job_id |

## Machine-readable artifacts (25)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-job-api-openapi.yml
- **Documentation** — https://snapcraft.io/docs/reference/development/snapd-rest-api/
- **HowTo** — https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
- **Documentation** — https://ubuntu.com/landscape/docs
- **APIReference** — https://documentation.ubuntu.com/landscape/reference/api/
- **ReleaseNotes** — https://documentation.ubuntu.com/landscape/reference/release-notes/
- **Portal** — https://ubuntu.com/landscape
- **Documentation** — https://documentation.ubuntu.com/lxd/latest/rest-api/
- **APIReference** — https://documentation.ubuntu.com/lxd/latest/api-extensions/
- **SourceCode** — https://github.com/canonical/lxd
- **Portal** — https://canonical.com/lxd
- **Documentation** — https://ubuntu.com/security/api/docs
- **APIReference** — https://ubuntu.com/security/api/spec.json
- **Portal** — https://ubuntu.com/security
- **Documentation** — https://documentation.ubuntu.com/pebble/
- **SourceCode** — https://github.com/canonical/pebble
- **Documentation** — https://canonical-testflinger.readthedocs-hosted.com/en/latest/
- **SourceCode** — https://github.com/canonical/testflinger
- **SourceCode** — https://github.com/canonical/hardware-api
- **Portal** — https://ubuntu.com/certified
- **SourceCode** — https://github.com/canonical/identity-platform-api
- **SourceCode** — https://github.com/canonical/test_observer
- **Documentation** — https://documentation.ubuntu.com/anbox-cloud/
- **Portal** — https://canonical.com/anbox-cloud
- **SourceCode** — https://github.com/canonical/cos-registration-server

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [MAAS API](https://apis.io/apis/canonical/maas-api/)
- [Juju Client / Controller API](https://apis.io/apis/canonical/juju-api/)
- [Launchpad Web Services API](https://apis.io/apis/canonical/launchpad-api/)
- [Ubuntu Pro Client API](https://apis.io/apis/canonical/ubuntu-pro-api/)
- [Canonical Assertions API](https://apis.io/apis/canonical/canonical-assertions-api/)
- [Canonical Search API](https://apis.io/apis/canonical/canonical-search-api/)
- [Canonical Snaps API](https://apis.io/apis/canonical/canonical-snaps-api/)
- [MicroCeph REST API](https://apis.io/apis/canonical/microceph-api/)
- [Canonical App Authorization Service API](https://apis.io/apis/canonical/canonical-appauthorizationservice-api/)
- [Canonical Application API](https://apis.io/apis/canonical/canonical-application-api/)

## Tags

Job

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/canonical/canonical-job-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/canonical/.