Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Incus operations API

The operations API from Incus — 7 operation(s) for operations.

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

Tagged areas include operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

This API exposes 8 operations across 7 paths, and defines 2 schemas. It is described by OpenAPI 2.0, at version 1.0.

8 operations 7 paths 2 schemas 1 DELETE7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
License
Resource Areas
1

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 7 GET. Each is listed below with its method, path, parameters, and response codes.

operations 8
GET
/1.0/operations
Get the operations
operations_get 2 params → 200403500
DELETE
/1.0/operations/{id}
Cancel the operation
operation_delete 1 param → 200400403500
GET
/1.0/operations/{id}
Get the operation state
operation_get 1 param → 200403500
GET
/1.0/operations/{id}/wait
Wait for the operation
operation_wait_get 2 params → 200403500
GET
/1.0/operations/{id}/wait?public
Wait for the operation
operation_wait_get_untrusted 3 params → 200403500
GET
/1.0/operations/{id}/websocket
Get the websocket stream
operation_websocket_get 2 params → 200403500
GET
/1.0/operations/{id}/websocket?public
Get the websocket stream
operation_websocket_get_untrusted 2 params → 200403500
GET
/1.0/operations?recursion=1
Get the operations
operations_get_recursion1 2 params → 200403500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is Operation (12 properties). Each schema is shown below with its type and property counts.

Operation
object
Operation represents a background operation
12 properties
StatusCode
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-operations-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
Incus cluster API
Incus cluster-groups API
Incus images API
Incus instances API
Incus Metadata API
Incus metrics API
Incus network-acls API
Incus network-address-sets API
Incus network-allocations API
Incus network-forwards API
Incus network-integrations API