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

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Incus

Incus images API

The images API from Incus — 14 operation(s) for images.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 25 operations across 14 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version 1.0.

25 operations 14 paths 13 schemas 2 DELETE12 GET2 PATCH7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Contact
Incus upstream
License
Apache-2.0
Resource Areas
1

Paths & Operations 25

Across 14 paths, the API surfaces 25 operations — 2 DELETE, 12 GET, 2 PATCH, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

images 25
GET
/1.0/images
Get the images
images_get 3 params → 200403500
POST
/1.0/images
Add an image
images_post 10 params → 202400403500
DELETE
/1.0/images/{fingerprint}
Delete the image
image_delete 2 params → 202400403500
GET
/1.0/images/{fingerprint}
Get the image
image_get 2 params → 200403500
PATCH
/1.0/images/{fingerprint}
Partially update the image
image_patch 3 params → 200400403412500
PUT
/1.0/images/{fingerprint}
Update the image
image_put 3 params → 200400403412500
GET
/1.0/images/{fingerprint}/export
Get the raw image file(s)
image_export_get 2 params → 200403500
POST
/1.0/images/{fingerprint}/export
Make the server push the image to a remote server
images_export_post 3 params → 202403500
GET
/1.0/images/{fingerprint}/export?public
Get the raw image file(s)
image_export_get_untrusted 3 params → 200403500
POST
/1.0/images/{fingerprint}/refresh
Refresh an image
images_refresh_post 2 params → 202403500
POST
/1.0/images/{fingerprint}/secret
Generate secret for retrieval of the image by an untrusted client
images_secret_post 2 params → 202403500
GET
/1.0/images/{fingerprint}?public
Get the public image
image_get_untrusted 3 params → 200403500
GET
/1.0/images/aliases
Get the image aliases
images_aliases_get 1 param → 200403500
POST
/1.0/images/aliases
Add an image alias
images_aliases_post 2 params → 200400403500
DELETE
/1.0/images/aliases/{name}
Delete the image alias
image_alias_delete 2 params → 200400403500
GET
/1.0/images/aliases/{name}
Get the image alias
image_alias_get 2 params → 200403500
PATCH
/1.0/images/aliases/{name}
Partially update the image alias
images_alias_patch 3 params → 200400403412500
POST
/1.0/images/aliases/{name}
Rename the image alias
images_alias_post 3 params → 200400403500
PUT
/1.0/images/aliases/{name}
Update the image alias
images_aliases_put 3 params → 200400403412500
GET
/1.0/images/aliases/{name}?public
Get the public image alias
image_alias_get_untrusted 2 params → 200403500
GET
/1.0/images/aliases?recursion=1
Get the image aliases
images_aliases_get_recursion1 1 param → 200403500
GET
/1.0/images?public
Get the public images
images_get_untrusted 3 params → 200403500
POST
/1.0/images?public
Add an image
images_post_untrusted 2 params → 200400403500
GET
/1.0/images?public&recursion=1
Get the public images
images_get_recursion1_untrusted 3 params → 200403500
GET
/1.0/images?recursion=1
Get the images
images_get_recursion1 3 params → 200403500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Image (17 properties), ImagesPostSource (12 properties), Operation (12 properties), ImagesPost (10 properties). Each schema is shown below with its type and property counts.

StatusCode
integer
ImageAliasesEntry
object
ImageAliasesEntry represents an image alias
4 properties
ImageAliasesEntryPut
object
ImageAliasesEntryPut represents the modifiable fields of an image alias
2 properties
ImageSource
object
ImageSource represents the source of an image
5 properties
ImageAliasesPost
object
ImageAliasesPost represents a new image alias
4 properties
Image
object
Image represents an image
17 properties
ImagePut
object
ImagePut represents the modifiable fields of an image
5 properties
ImageAlias
object
ImageAlias represents an alias from the alias list of an image
2 properties
ImageAliasesEntryPost
object
ImageAliasesEntryPost represents the required fields to rename an image alias
1 property
Operation
object
Operation represents a background operation
12 properties
ImagesPost
object
ImagesPost represents the fields available for a new image
10 properties
ImageExportPost
object
ImageExportPost represents the fields required to export an image
6 properties
ImagesPostSource
object
ImagesPostSource represents the source of a new image
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-images-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
AE Profile APIs.io
Incus cluster API
AE Profile APIs.io
Incus cluster-groups API
AE Profile APIs.io
Incus instances API
AE Profile APIs.io
Incus Metadata API
AE Profile APIs.io
Incus metrics API
AE Profile APIs.io
Incus network-acls API
AE Profile APIs.io
Incus network-address-sets API
AE Profile APIs.io
Incus network-allocations API
AE Profile APIs.io
Incus network-forwards API
AE Profile APIs.io
Incus network-integrations API
AE Profile APIs.io
Incus network-load-balancers API
AE Profile APIs.io
#images
← Back to I APIs
API Details
ID
incus:incus-images-api
Docs
https://linuxcontainers.org/incus/docs/main/rest-api/
Provider
Incus
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network