Incus instances API

The instances API from Incus — 28 operation(s) for instances.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 54 operations across 28 paths, and defines 37 schemas. It is described by OpenAPI 2.0, at version 1.0.

54 operations 28 paths 37 schemas 8 DELETE25 GET1 HEAD3 PATCH12 POST5 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

Paths & Operations 54

Across 28 paths, the API surfaces 54 operations — 8 DELETE, 25 GET, 1 HEAD, 3 PATCH, 12 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

instances 54

GET

/1.0/instances

Get the instances

instances_get 3 params → 200403500

POST

/1.0/instances

Create a new instance

instances_post 4 params → 202400403500

PUT

/1.0/instances

Bulk instance state update

instances_put 2 params → 202400403500

DELETE

/1.0/instances/{name}

Delete an instance

instance_delete 2 params → 202400403500

GET

/1.0/instances/{name}

Get the instance

instance_get 2 params → 200403500

PATCH

/1.0/instances/{name}

Partially update the instance

instance_patch 3 params → 200400403500

POST

/1.0/instances/{name}

Rename or move/migrate an instance

instance_post 3 params → 202400403500

PUT

/1.0/instances/{name}

Update the instance

instance_put 3 params → 202400403500

GET

/1.0/instances/{name}/access

Get who has access to an instance

instance_access 2 params → 200400403500

GET

/1.0/instances/{name}/backups

Get the backups

instance_backups_get 2 params → 200403500

POST

/1.0/instances/{name}/backups

Create a backup

instance_backups_post 3 params → 202400403500

DELETE

/1.0/instances/{name}/backups/{backup}

Delete a backup

instance_backup_delete 3 params → 202400403500

GET

/1.0/instances/{name}/backups/{backup}

Get the backup

instance_backup_get 3 params → 200403500

POST

/1.0/instances/{name}/backups/{backup}

Rename a backup

instance_backup_post 4 params → 202400403500

GET

/1.0/instances/{name}/backups/{backup}/export

Get the raw backup file(s)

instance_backup_export 3 params → 200403500

GET

/1.0/instances/{name}/backups?recursion=1

Get the backups

instance_backups_get_recursion1 2 params → 200403500

POST

/1.0/instances/{name}/bitmaps

Create a bitmap

instance_bitmaps_post 3 params → 202400403500

DELETE

/1.0/instances/{name}/console

Clear the console log

instance_console_delete 2 params → 200400403404500

GET

/1.0/instances/{name}/console

Get console output

instance_console_get 3 params → 200400403404500

POST

/1.0/instances/{name}/console

Connect to console

instance_console_post 3 params → 202400403500

GET

/1.0/instances/{name}/debug/memory

Get memory debug information of an instance

instance_debug_memory_get 3 params → 200400403404500

GET

/1.0/instances/{name}/debug/repair

Trigger a repair action on the instance.

instance_debug_repair_post 3 params → 200400403404500

POST

/1.0/instances/{name}/exec

Run a command

instance_exec_post 3 params → 202400403500

DELETE

/1.0/instances/{name}/files

Delete a file

instance_files_delete 4 params → 200400403404500

GET

/1.0/instances/{name}/files

Get a file

instance_files_get 3 params → 200400403404500

HEAD

/1.0/instances/{name}/files

Get metadata for a file

instance_files_head 3 params → 200400403404500

POST

/1.0/instances/{name}/files

Create or replace a file

instance_files_post 9 params → 200400403404500

GET

/1.0/instances/{name}/logs

Get the log files

instance_logs_get 2 params → 200403404500

DELETE

/1.0/instances/{name}/logs/{filename}

Delete the log file

instance_log_delete 3 params → 200400403404500

GET

/1.0/instances/{name}/logs/{filename}

Get the log file

instance_log_get 3 params → 200400403404500

GET

/1.0/instances/{name}/logs/exec-output

Get the exec record-output files

instance_exec-outputs_get 2 params → 200403404500

DELETE

/1.0/instances/{name}/logs/exec-output/{filename}

Delete the exec record-output file

instance_exec-output_delete 3 params → 200400403404500

GET

/1.0/instances/{name}/logs/exec-output/{filename}

Get the exec-output log file

instance_exec-output_get 3 params → 200400403404500

GET

/1.0/instances/{name}/metadata

Get the instance image metadata

instance_metadata_get 2 params → 200403500

PATCH

/1.0/instances/{name}/metadata

Partially update the image metadata

instance_metadata_patch 3 params → 200400403412500

PUT

/1.0/instances/{name}/metadata

Update the image metadata

instance_metadata_put 3 params → 200400403412500

DELETE

/1.0/instances/{name}/metadata/templates

Delete a template file

instance_metadata_templates_delete 3 params → 200400403404500

GET

/1.0/instances/{name}/metadata/templates

Get the template file names or a specific

instance_metadata_templates_get 3 params → 200400403404500

POST

/1.0/instances/{name}/metadata/templates

Create or replace a template file

instance_metadata_templates_post 4 params → 200400403404500

POST

/1.0/instances/{name}/rebuild

Rebuild an instance

instance_rebuild_post 3 params → 200202400403404500

GET

/1.0/instances/{name}/sftp

Get the instance SFTP connection

instance_sftp 1 param → 101400403404500

GET

/1.0/instances/{name}/snapshots

Get the snapshots

instance_snapshots_get 2 params → 200403500

POST

/1.0/instances/{name}/snapshots

Create a snapshot

instance_snapshots_post 3 params → 202400403500

DELETE