Incus

Incus Instances API

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

GitHub OpenAPI

Operations 54

GET /1.0/instances Get the instances #
POST /1.0/instances Create a new instance #
PUT /1.0/instances Bulk instance state update #
DELETE /1.0/instances/{name} Delete an instance #
GET /1.0/instances/{name} Get the instance #
PATCH /1.0/instances/{name} Partially update the instance #
POST /1.0/instances/{name} Rename or move/migrate an instance #
PUT /1.0/instances/{name} Update the instance #
GET /1.0/instances/{name}/access Get who has access to an instance #
GET /1.0/instances/{name}/backups Get the backups #
POST /1.0/instances/{name}/backups Create a backup #
DELETE /1.0/instances/{name}/backups/{backup} Delete a backup #
GET /1.0/instances/{name}/backups/{backup} Get the backup #
POST /1.0/instances/{name}/backups/{backup} Rename a backup #
GET /1.0/instances/{name}/backups/{backup}/export Get the raw backup file(s) #
GET /1.0/instances/{name}/backups?recursion=1 Get the backups #
POST /1.0/instances/{name}/bitmaps Create a bitmap #
DELETE /1.0/instances/{name}/console Clear the console log #
GET /1.0/instances/{name}/console Get console output #
POST /1.0/instances/{name}/console Connect to console #
GET /1.0/instances/{name}/debug/memory Get memory debug information of an instance #
GET /1.0/instances/{name}/debug/repair Trigger a repair action on the instance #
POST /1.0/instances/{name}/exec Run a command #
DELETE /1.0/instances/{name}/files Delete a file #
GET /1.0/instances/{name}/files Get a file #
HEAD /1.0/instances/{name}/files Get metadata for a file #
POST /1.0/instances/{name}/files Create or replace a file #
GET /1.0/instances/{name}/logs Get the log files #
DELETE /1.0/instances/{name}/logs/{filename} Delete the log file #
GET /1.0/instances/{name}/logs/{filename} Get the log file #
GET /1.0/instances/{name}/logs/exec-output Get the exec record-output files #
DELETE /1.0/instances/{name}/logs/exec-output/{filename} Delete the exec record-output file #
GET /1.0/instances/{name}/logs/exec-output/{filename} Get the exec-output log file #
GET /1.0/instances/{name}/metadata Get the instance image metadata #
PATCH /1.0/instances/{name}/metadata Partially update the image metadata #
PUT /1.0/instances/{name}/metadata Update the image metadata #
DELETE /1.0/instances/{name}/metadata/templates Delete a template file #
GET /1.0/instances/{name}/metadata/templates Get the template file names or a specific #
POST /1.0/instances/{name}/metadata/templates Create or replace a template file #
POST /1.0/instances/{name}/rebuild Rebuild an instance #
GET /1.0/instances/{name}/sftp Get the instance SFTP connection #
GET /1.0/instances/{name}/snapshots Get the snapshots #
POST /1.0/instances/{name}/snapshots Create a snapshot #
DELETE /1.0/instances/{name}/snapshots/{snapshot} Delete a snapshot #
GET /1.0/instances/{name}/snapshots/{snapshot} Get the snapshot #
PATCH /1.0/instances/{name}/snapshots/{snapshot} Partially update snapshot #
POST /1.0/instances/{name}/snapshots/{snapshot} Rename or move/migrate a snapshot #
PUT /1.0/instances/{name}/snapshots/{snapshot} Update snapshot #
GET /1.0/instances/{name}/snapshots?recursion=1 Get the snapshots #
GET /1.0/instances/{name}/state Get the runtime state #
PUT /1.0/instances/{name}/state Change the state #
GET /1.0/instances/{name}?recursion=1 Get the instance #
GET /1.0/instances?recursion=1 Get the instances #
GET /1.0/instances?recursion=2 Get the instances #

Documentation

📖
Documentation
https://linuxcontainers.org/incus/docs/main/rest-api/
📖
Authentication
https://linuxcontainers.org/incus/docs/main/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/incus/refs/heads/main/openapi/incus-instances-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/lxc/incus

Other Resources

🔗
Rules
https://raw.githubusercontent.com/api-evangelist/incus/refs/heads/main/rules/incus-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/incus-instances-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

incus-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: lxc-devel@lists.linuxcontainers.org
    name: Incus upstream
    url: https://github.com/lxc/incus
  description: 'This is the REST API used by all Incus clients.

    Internal endpoints aren''t included in this documentation.


    The Incus API is available over both a local unix+http and remote https API.

    Authentication for local users relies on group membership and access to the unix socket.

    For remote users, the default authentication method is TLS client

    certificates.'
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Incus external REST Instances API
  version: '1.0'
tags:


# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/incus/refs/heads/main/openapi/incus-instances-api-openapi.yml