# Ubuntu Security API

**Canonical:** https://apis.io/apis/canonical/ubuntu-security-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Base URL:** https://ubuntu.com  
**Documentation:** https://ubuntu.com/security/api/docs

Ubuntu Security API is one of 22 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 Security, CVE, and Vulnerability. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

An open, unauthenticated API over Canonical's vulnerability data — Ubuntu Security Notices (USNs), CVE records with CVSS3 scoring, and per-release support status. Canonical publishes a Swagger 2.0 contract for it at https://ubuntu.com/security/api/spec.json and a Swagger UI at /security/api/docs. It is the most agent-friendly surface Canonical operates: read-only, needs no credential, and answers the question "is my Ubuntu package affected by this CVE?" directly.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/security/compat/notices.json` | — |
| GET | `/security/compat/notices/{notice_id}.json` | — |
| GET | `/security/cves.json` | — |
| GET | `/security/cves/{cve_id}.json` | — |
| GET | `/security/notices.json` | — |
| GET | `/security/notices/{notice_id}.json` | — |
| GET | `/security/page/notices.json` | — |
| GET | `/security/releases.json` | — |
| GET | `/security/releases/{release_codename}.json` | — |
| PUT | `/security/updates/cves.json` | — |
| DELETE | `/security/updates/cves/{cve_id}.json` | — |
| POST | `/security/updates/notices.json` | — |
| DELETE | `/security/updates/notices/{notice_id}.json` | — |
| PUT | `/security/updates/notices/{notice_id}.json` | — |
| POST | `/security/updates/releases.json` | — |
| DELETE | `/security/updates/releases/{release_codename}.json` | — |
| PUT | `/security/updates/releases/{release_codename}.json` | — |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-ubuntu-security-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/overlays/canonical-ubuntu-security-api-overlay.yaml
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/skills/canonical-ubuntu-security-cve-lookup.md
- **Documentation** — https://ubuntu.com/security/api/docs
- **APIReference** — https://ubuntu.com/security/api/spec.json
- **Portal** — https://ubuntu.com/security

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [snapd REST API](https://apis.io/apis/canonical/snapd-rest-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/)
- [Landscape API](https://apis.io/apis/canonical/landscape-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/)
- [LXD REST API](https://apis.io/apis/canonical/lxd-rest-api/)

## Tags

Security, CVE, Vulnerability

---

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