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

Landscape API

Canonical Landscape is the systems-management platform for Ubuntu at scale. Its API lets operators manage and automate inventories, upgrades, patch compliance, reboots, scripts, monitoring, and alerts across fleets of Ubuntu machines (on-prem, hybrid, or hosted Landscape SaaS).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 30 operations across 18 paths, organized into 5 resource areas, and defines 28 schemas. It is described by OpenAPI 3.0.3, at version 0.1.0.

30 operations 18 paths 28 schemas 4 DELETE11 GET4 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.1.0
Resource Areas
5

Paths & Operations 30

Across 18 paths, the API surfaces 30 operations — 4 DELETE, 11 GET, 4 PATCH, 11 POST. They span 5 resource areas: LocalService, MirrorService, OperationService, PublicationTargetService, PublicationService. Each is listed below with its method, path, parameters, and response codes.

LocalService 8

Manages local repositories.

GET
/v1/locals
Returns a list of local repositories.
LocalService_ListLocals 3 params → 200default
POST
/v1/locals
Creates a new local repository.
LocalService_CreateLocal 1 param body → 200default
GET
/v1/locals/{local}
Retrieves a local repository by its resource name.
LocalService_GetLocal 1 param → 200default
DELETE
/v1/locals/{local}
Deletes a local repository.
LocalService_DeleteLocal 1 param → 200default
PATCH
/v1/locals/{local}
Updates a local repository.
LocalService_UpdateLocal 2 params body → 200default
GET
/v1/locals/{local}/packages
Retrieves a list of packages available in a local repository.
LocalService_ListLocalPackages 3 params → 200default
POST
/v1/locals/{local}:importPackages
Imports packages from a URL pointing to a package list or index into the local repository. This is an async operation; poll the returned operation for status.
LocalService_ImportLocalPackages 1 param body → 200default
POST
/v1/locals:batchGet
Retrieves a list of local repositories based on their names.
LocalService_BatchGetLocals body → 200default
MirrorService 8

Methods for managing repository mirrors.

GET
/v1/mirrors
Returns a list of mirrors.
MirrorService_ListMirrors 3 params → 200default
POST
/v1/mirrors
Creates a new mirror. It validates the upstream but does not initiate synchronization.
MirrorService_CreateMirror 1 param body → 200default
GET
/v1/mirrors/{mirror}
Retrieves a mirror by its resource name.
MirrorService_GetMirror 1 param → 200default
DELETE
/v1/mirrors/{mirror}
Deletes a mirror.
MirrorService_DeleteMirror 2 params → 200default
PATCH
/v1/mirrors/{mirror}
Updates the details of a mirror.
MirrorService_UpdateMirror 2 params body → 200default
GET
/v1/mirrors/{mirror}/packages
Retrieves the list of packages available in a mirror.
MirrorService_ListMirrorPackages 3 params → 200default
POST
/v1/mirrors/{mirror}:sync
Synchronizes a mirror.
MirrorService_SyncMirror 1 param body → 200default
POST
/v1/mirrors:batchGet
Retrieves a batch of mirrors based on their name.
MirrorService_BatchGetMirrors body → 200default
OperationService 2

Manages long-running operations.

GET
/v1/operations/{operation}
Retrieves the latest state of a long-running operation. Use this to poll the operation result.
OperationService_GetOperation 1 param → 200default
POST
/v1/operations:batchGet
Retrieves a batch of long-running operations based on their names.
OperationService_BatchGetOperations body → 200default
PublicationTargetService 6

Manages the storage destinations for publishing Debian archives.

GET
/v1/publicationTargets
Lists publication targets.
PublicationTargetService_ListPublicationTargets 3 params → 200default
POST
/v1/publicationTargets
Creates a new publication target.
PublicationTargetService_CreatePublicationTarget 1 param body → 200default
GET
/v1/publicationTargets/{publicationTarget}
Retrieves details of a single publication target.
PublicationTargetService_GetPublicationTarget 1 param → 200default
DELETE
/v1/publicationTargets/{publicationTarget}
Deletes a PublicationTarget. This does not necessarily clean up published artifacts.
PublicationTargetService_DeletePublicationTarget 1 param → 200default
PATCH
/v1/publicationTargets/{publicationTarget}
Updates an existing publication target.
PublicationTargetService_UpdatePublicationTarget 2 params body → 200default
POST
/v1/publicationTargets:batchGet
Retrieves a list of publication targets based on their names.
PublicationTargetService_BatchGetPublicationTargets body → 200default
PublicationService 6

Manages the publication of Debian artifacts.

GET
/v1/publications
Returns a list of publications.
PublicationService_ListPublications 3 params → 200default
POST
/v1/publications
Creates a new publication.
PublicationService_CreatePublication 1 param body → 200default
GET
/v1/publications/{publication}
Retrieves a publication by its resource name.
PublicationService_GetPublication 1 param → 200default
DELETE
/v1/publications/{publication}
Deletes a Publication.
PublicationService_DeletePublication 1 param → 200default
PATCH
/v1/publications/{publication}
Updates the details of a publication.
PublicationService_UpdatePublication 2 params body → 200default
POST
/v1/publications/{publication}:publish
Publishes a publication to its publication target.
PublicationService_PublishPublication 1 param body → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Mirror (20 properties), Publication (18 properties), S3Target (13 properties), SwiftTarget (11 properties). Each schema is shown below with its type and property counts.

BatchGetLocalsRequest
object
The request message for retrieving a batch of local repositories.
2 properties 1 required
BatchGetLocalsResponse
object
The response message for retrieving a batch of local repositories.
2 properties
BatchGetMirrorsRequest
object
The request message for retrieving a batch of mirrors.
2 properties 1 required
BatchGetMirrorsResponse
object
The response message for retrieving a batch of mirrors.
2 properties
BatchGetOperationsRequest
object
The request message for retrieving a batch of long-running operations.
2 properties 1 required
BatchGetOperationsResponse
object
The response message for retrieving a batch of long-running operations.
2 properties
BatchGetPublicationTargetsRequest
object
The request message for retrieving a batch of publication targets.
2 properties 1 required
BatchGetPublicationTargetsResponse
object
The response message for retrieving a batch of publication targets.
2 properties
FilesystemTarget
object
A local filesystem storage destination.
2 properties 1 required
GoogleProtobufAny
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
GpgKey
object
A GPG key resource.
3 properties 1 required
ImportLocalPackagesRequest
object
The request message for importing packages into a local repository.
3 properties 2 required
ListLocalPackagesResponse
object
The response message for listing local repository packages.
2 properties
ListLocalsResponse
object
The response message for listing local repositories.
2 properties
ListMirrorPackagesResponse
object
The response message for listing packages in a mirror.
2 properties
ListMirrorsResponse
object
The response message for listing mirrors.
2 properties
ListPublicationTargetsResponse
object
The response message for listing publication targets.
2 properties
ListPublicationsResponse
object
The response message for listing publications.
2 properties
Local
object
Represents a local repository.
8 properties 3 required
Mirror
object
A repository mirror configuration and status.
20 properties 5 required
Operation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
Publication
object
The configuration for publishing Debian artifacts from a Source (mirror or local repository) to a publication target.
18 properties 3 required
PublicationTarget
object
Represents a publication storage destination (S3, Swift, or filesystem).
6 properties 1 required
PublishPublicationRequest
object
The request message for publishing a publication.
3 properties 1 required
S3Target
object
An S3 publication target destination.
13 properties 4 required
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
SwiftTarget
object
A Swift (OpenStack) storage destination.
11 properties 4 required
SyncMirrorRequest
object
The request message for syncing a mirror.
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-landscape-debarchive-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
AE Profile APIs.io
Charmhub API
AE Profile APIs.io
snapd REST 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
LXD REST API
AE Profile APIs.io
Ubuntu Security API
AE Profile APIs.io
#Systems Management#Patch Management#Fleet
← Back to L APIs
API Details
ID
canonical:landscape-api
Docs
https://ubuntu.com/landscape/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=landscape-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/landscape-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 Landscape 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.