The server API from Incus — 5 operation(s) for server.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/incus-server-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
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 certificates Server API
version: '1.0'
tags:
- name: server
paths:
/:
get:
description: 'Returns a list of supported API versions (URLs).
Internal API endpoints are not reported as those aren''t versioned
and should only be used by the daemon itself.'
operationId: api_get
responses:
'200':
description: API endpoints
content:
application/json:
schema:
description: Sync response
properties:
metadata:
description: List of endpoints
example:
- /1.0
items:
type: string
type: array
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
summary: Get the supported API endpoints
tags:
- server
/1.0:
get:
description: Shows the full server environment and configuration.
operationId: server_get
parameters:
- description: Cluster member name
example: server01
in: query
name: target
schema:
type: string
- description: Project name
example: default
in: query
name: project
schema:
type: string
responses:
'200':
description: Server environment and configuration
content:
application/json:
schema:
description: Sync response
properties:
metadata:
$ref: '#/components/schemas/Server'
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'500':
$ref: '#/components/responses/InternalServerError'
summary: Get the server environment and configuration
tags:
- server
patch:
description: Updates a subset of the server configuration.
operationId: server_patch
parameters:
- description: Cluster member name
example: server01
in: query
name: target
schema:
type: string
responses:
'200':
$ref: '#/components/responses/EmptySyncResponse'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'412':
$ref: '#/components/responses/PreconditionFailed'
'500':
$ref: '#/components/responses/InternalServerError'
summary: Partially update the server configuration
tags:
- server
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPut'
description: Server configuration
required: true
put:
description: Updates the entire server configuration.
operationId: server_put
parameters:
- description: Cluster member name
example: server01
in: query
name: target
schema:
type: string
responses:
'200':
$ref: '#/components/responses/EmptySyncResponse'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'412':
$ref: '#/components/responses/PreconditionFailed'
'500':
$ref: '#/components/responses/InternalServerError'
summary: Update the server configuration
tags:
- server
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPut'
description: Server configuration
required: true
/1.0/events:
get:
description: Connects to the event API using websocket.
operationId: events_get
parameters:
- description: Project name
example: default
in: query
name: project
schema:
type: string
- description: Event type(s), comma separated (valid types are logging, operation or lifecycle)
example: logging,lifecycle
in: query
name: type
schema:
type: string
- description: Retrieve instances from all projects
in: query
name: all-projects
schema:
type: boolean
responses:
'200':
description: Websocket message (JSON)
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
summary: Get the event stream
tags:
- server
/1.0/resources:
get:
description: Gets the hardware information profile of the server.
operationId: resources_get
parameters:
- description: Cluster member name
example: server01
in: query
name: target
schema:
type: string
responses:
'200':
description: Hardware resources
content:
application/json:
schema:
description: Sync response
properties:
metadata:
$ref: '#/components/schemas/Resources'
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
summary: Get system resources information
tags:
- server
/1.0?public:
get:
description: 'Shows a small subset of the server environment and configuration
which is required by untrusted clients to reach a server.
The `?public` part of the URL isn''t required, it''s simply used to
separate the two behaviors of this endpoint.'
operationId: server_get_untrusted
responses:
'200':
description: Server environment and configuration
content:
application/json:
schema:
description: Sync response
properties:
metadata:
$ref: '#/components/schemas/ServerUntrusted'
status:
description: Status description
example: Success
type: string
status_code:
description: Status code
example: 200
type: integer
type:
description: Response type
example: sync
type: string
type: object
'500':
$ref: '#/components/responses/InternalServerError'
summary: Get the server environment
tags:
- server
components:
schemas:
ServerEnvironment:
properties:
addresses:
description: List of addresses the server is listening on
example:
- :8443
items:
type: string
type: array
x-go-name: Addresses
architectures:
description: List of architectures supported by the server
example:
- x86_64
- i686
items:
type: string
type: array
x-go-name: Architectures
certificate:
description: Server certificate as PEM encoded X509
example: X509 PEM certificate
type: string
x-go-name: Certificate
certificate_fingerprint:
description: Server certificate fingerprint as SHA256
example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69
type: string
x-go-name: CertificateFingerprint
driver:
description: List of supported instance drivers (separate by " | ")
example: lxc | qemu
type: string
x-go-name: Driver
driver_version:
description: List of supported instance driver versions (separate by " | ")
example: 4.0.7 | 5.2.0
type: string
x-go-name: DriverVersion
firewall:
description: Current firewall driver
example: nftables
type: string
x-go-name: Firewall
kernel:
description: OS kernel name
example: Linux
type: string
x-go-name: Kernel
kernel_architecture:
description: OS kernel architecture
example: x86_64
type: string
x-go-name: KernelArchitecture
kernel_features:
additionalProperties:
type: string
description: Map of kernel features that were tested on startup
example:
netnsid_getifaddrs: 'true'
seccomp_listener: 'true'
type: object
x-go-name: KernelFeatures
kernel_version:
description: Kernel version
example: 5.4.0-36-generic
type: string
x-go-name: KernelVersion
lxc_features:
additionalProperties:
type: string
description: Map of LXC features that were tested on startup
example:
cgroup2: 'true'
devpts_fd: 'true'
pidfd: 'true'
type: object
x-go-name: LXCFeatures
os_name:
description: Name of the operating system (Linux distribution)
example: Ubuntu
type: string
x-go-name: OSName
os_version:
description: Version of the operating system (Linux distribution)
example: '22.04'
type: string
x-go-name: OSVersion
project:
description: Current project name
example: default
type: string
x-go-name: Project
server:
description: Server implementation name
example: incus
type: string
x-go-name: Server
server_clustered:
description: Whether the server is part of a cluster
example: false
type: boolean
x-go-name: ServerClustered
server_event_mode:
description: 'Mode that the event distribution subsystem is operating in on this server.
Either "full-mesh", "hub-server" or "hub-client".'
example: full-mesh
type: string
x-go-name: ServerEventMode
server_name:
description: Server hostname
example: castiana
type: string
x-go-name: ServerName
server_pid:
description: PID of the daemon
example: 1453969
format: int64
type: integer
x-go-name: ServerPid
server_version:
description: Server version
example: '4.11'
type: string
x-go-name: ServerVersion
storage:
description: List of active storage drivers (separate by " | ")
example: dir | zfs
type: string
x-go-name: Storage
storage_supported_drivers:
description: List of supported storage drivers
items:
$ref: '#/components/schemas/ServerStorageDriverInfo'
type: array
x-go-name: StorageSupportedDrivers
storage_version:
description: List of active storage driver versions (separate by " | ")
example: 1 | 0.8.4-1ubuntu11
type: string
x-go-name: StorageVersion
title: ServerEnvironment represents the read-only environment fields of a server configuration.
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesUSBDeviceInterface:
description: ResourcesUSBDeviceInterface represents a USB device interface
properties:
class:
description: Class of USB interface
example: Human Interface Device
type: string
x-go-name: Class
class_id:
description: ID of the USB interface class
example: 3
format: uint64
type: integer
x-go-name: ClassID
driver:
description: Kernel driver currently associated with the device
example: usbhid
type: string
x-go-name: Driver
driver_version:
description: Version of the kernel driver
example: 5.8.0-36-generic
type: string
x-go-name: DriverVersion
number:
description: Interface number
example: 0
format: uint64
type: integer
x-go-name: Number
subclass:
description: Sub class of the interface
example: Boot Interface Subclass
type: string
x-go-name: SubClass
subclass_id:
description: ID of the USB interface sub class
example: 1
format: uint64
type: integer
x-go-name: SubClassID
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesGPUCard:
description: ResourcesGPUCard represents a GPU card on the system
properties:
driver:
description: Kernel driver currently associated with the GPU
example: i915
type: string
x-go-name: Driver
driver_version:
description: Version of the kernel driver
example: 5.8.0-36-generic
type: string
x-go-name: DriverVersion
drm:
$ref: '#/components/schemas/ResourcesGPUCardDRM'
mdev:
additionalProperties:
$ref: '#/components/schemas/ResourcesGPUCardMdev'
description: Map of available mediated device profiles
example: null
type: object
x-go-name: Mdev
numa_node:
description: NUMA node the GPU is a part of
example: 0
format: uint64
type: integer
x-go-name: NUMANode
nvidia:
$ref: '#/components/schemas/ResourcesGPUCardNvidia'
pci_address:
description: PCI address
example: '0000:00:02.0'
type: string
x-go-name: PCIAddress
product:
description: Name of the product
example: HD Graphics 620
type: string
x-go-name: Product
product_id:
description: PCI ID of the product
example: '5916'
type: string
x-go-name: ProductID
sriov:
$ref: '#/components/schemas/ResourcesGPUCardSRIOV'
usb_address:
description: USB address (for USB cards)
example: '2:7'
type: string
x-go-name: USBAddress
vendor:
description: Name of the vendor
example: Intel Corporation
type: string
x-go-name: Vendor
vendor_id:
description: PCI ID of the vendor
example: '8086'
type: string
x-go-name: VendorID
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
Server:
description: Server represents a server configuration
properties:
api_extensions:
description: List of supported API extensions
example:
- etag
- patch
- network
- storage
items:
type: string
readOnly: true
type: array
x-go-name: APIExtensions
api_status:
description: Support status of the current API (one of "devel", "stable" or "deprecated")
example: stable
readOnly: true
type: string
x-go-name: APIStatus
api_version:
description: API version number
example: '1.0'
readOnly: true
type: string
x-go-name: APIVersion
auth:
description: Whether the client is trusted (one of "trusted" or "untrusted")
example: untrusted
readOnly: true
type: string
x-go-name: Auth
auth_methods:
description: List of supported authentication methods
example:
- tls
items:
type: string
readOnly: true
type: array
x-go-name: AuthMethods
auth_user_method:
description: The current API user login method
example: unix
readOnly: true
type: string
x-go-name: AuthUserMethod
auth_user_name:
description: The current API user identifier
example: uid=201105
readOnly: true
type: string
x-go-name: AuthUserName
config:
description: Server configuration map (refer to doc/server.md)
example:
core.https_address: :8443
type: object
x-go-name: Config
environment:
$ref: '#/components/schemas/ServerEnvironment'
public:
description: Whether the server is public-only (only public endpoints are implemented)
example: false
readOnly: true
type: boolean
x-go-name: Public
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesUSB:
description: ResourcesUSB represents the USB devices available on the system
properties:
devices:
description: List of USB devices
items:
$ref: '#/components/schemas/ResourcesUSBDevice'
type: array
x-go-name: Devices
total:
description: Total number of USB devices
example: 1
format: uint64
type: integer
x-go-name: Total
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesGPUCardMdev:
description: ResourcesGPUCardMdev represents the mediated devices configuration of the GPU
properties:
api:
description: The mechanism used by this device
example: vfio-pci
type: string
x-go-name: API
available:
description: Number of available devices of this profile
example: 2
format: uint64
type: integer
x-go-name: Available
description:
description: Profile description
example: 'low_gm_size: 128MB\nhigh_gm_size: 512MB\nfence: 4\nresolution: 1920x1200\nweight: 4'
type: string
x-go-name: Description
devices:
description: List of active devices (UUIDs)
example:
- 42200aac-0977-495c-8c9e-6c51b9092a01
- b4950c00-1437-41d9-88f6-28d61cf9b9ef
items:
type: string
type: array
x-go-name: Devices
name:
description: Profile name
example: i915-GVTg_V5_8
type: string
x-go-name: Name
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesCPUSocket:
description: ResourcesCPUSocket represents a CPU socket on the system
properties:
address_sizes:
$ref: '#/components/schemas/ResourcesCPUAddressSizes'
cache:
description: List of CPU caches
items:
$ref: '#/components/schemas/ResourcesCPUCache'
type: array
x-go-name: Cache
cores:
description: List of CPU cores
items:
$ref: '#/components/schemas/ResourcesCPUCore'
type: array
x-go-name: Cores
frequency:
description: Current CPU frequency (Mhz)
example: 3499
format: uint64
type: integer
x-go-name: Frequency
frequency_minimum:
description: Minimum CPU frequency (Mhz)
example: 400
format: uint64
type: integer
x-go-name: FrequencyMinimum
frequency_turbo:
description: Maximum CPU frequency (Mhz)
example: 3500
format: uint64
type: integer
x-go-name: FrequencyTurbo
name:
description: Product name
example: Intel(R) Core(TM) i5-7300U CPU @ 2.60GHz
type: string
x-go-name: Name
socket:
description: Socket number
example: 0
format: uint64
type: integer
x-go-name: Socket
vendor:
description: Vendor name
example: GenuineIntel
type: string
x-go-name: Vendor
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesPCI:
description: ResourcesPCI represents the PCI devices available on the system
properties:
devices:
description: List of PCI devices
items:
$ref: '#/components/schemas/ResourcesPCIDevice'
type: array
x-go-name: Devices
total:
description: Total number of PCI devices
example: 1
format: uint64
type: integer
x-go-name: Total
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesCPUThread:
description: ResourcesCPUThread represents a CPU thread on the system
properties:
id:
description: Thread ID (used for CPU pinning)
example: 0
format: int64
type: integer
x-go-name: ID
isolated:
description: Whether the thread has been isolated (outside of normal scheduling)
example: false
type: boolean
x-go-name: Isolated
numa_node:
description: NUMA node the thread is a part of
example: 0
format: uint64
type: integer
x-go-name: NUMANode
online:
description: Whether the thread is online (enabled)
example: true
type: boolean
x-go-name: Online
thread:
description: Thread identifier within the core
example: 0
format: uint64
type: integer
x-go-name: Thread
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesNetworkCardPort:
description: ResourcesNetworkCardPort represents a network port on the system
properties:
address:
description: MAC address
example: 00:23:a4:01:01:6f
type: string
x-go-name: Address
auto_negotiation:
description: Whether auto negotiation is used
example: true
type: boolean
x-go-name: AutoNegotiation
id:
description: Port identifier (interface name)
example: eth0
type: string
x-go-name: ID
infiniband:
$ref: '#/components/schemas/ResourcesNetworkCardPortInfiniband'
link_detected:
description: Whether a link was detected
example: true
type: boolean
x-go-name: LinkDetected
link_duplex:
description: Duplex type
example: full
type: string
x-go-name: LinkDuplex
link_speed:
description: Current speed (Mbit/s)
example: 10000
format: uint64
type: integer
x-go-name: LinkSpeed
port:
description: Port number
example: 0
format: uint64
type: integer
x-go-name: Port
port_type:
description: Current port type
example: twisted pair
type: string
x-go-name: PortType
protocol:
description: Transport protocol
example: ethernet
type: string
x-go-name: Protocol
supported_modes:
description: List of supported modes
example:
- 100baseT/Full
- 1000baseT/Full
- 2500baseT/Full
- 5000baseT/Full
- 10000baseT/Full
items:
type: string
type: array
x-go-name: SupportedModes
supported_ports:
description: List of supported port types
example:
- twisted pair
items:
type: string
type: array
x-go-name: SupportedPorts
transceiver_type:
description: Type of transceiver used
example: internal
type: string
x-go-name: TransceiverType
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesCPUAddressSizes:
properties:
physical_bits:
format: uint64
type: integer
x-go-name: PhysicalBits
virtual_bits:
format: uint64
type: integer
x-go-name: VirtualBits
title: ResourcesCPUAddressSizes resprents address size information for a CPU socket.
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesSystemMotherboard:
description: ResourcesSystemMotherboard represents the motherboard
properties:
product:
description: Motherboard model
example: 20HRCTO1WW
type: string
x-go-name: Product
serial:
description: Motherboard serial number
example: L3CF4FX003A
type: string
x-go-name: Serial
vendor:
description: Motherboard vendor
example: Lenovo
type: string
x-go-name: Vendor
version:
description: Motherboard version/revision
example: None
type: string
x-go-name: Version
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesCPUCache:
description: ResourcesCPUCache represents a CPU cache
properties:
level:
description: Cache level (usually a number from 1 to 3)
example: 1
format: uint64
type: integer
x-go-name: Level
size:
description: Size of the cache (in bytes)
example: 32768
format: uint64
type: integer
x-go-name: Size
type:
description: Type of cache (Data, Instruction, Unified, ...)
example: Data
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesUSBDevice:
description: ResourcesUSBDevice represents a USB device
properties:
bus_address:
description: USB address (bus)
example: 1
format: uint64
type: integer
x-go-name: BusAddress
device_address:
description: USB address (device)
example: 3
format: uint64
type: integer
x-go-name: DeviceAddress
interfaces:
description: List of USB interfaces
items:
$ref: '#/components/schemas/ResourcesUSBDeviceInterface'
type: array
x-go-name: Interfaces
product:
description: Name of the product
example: Hermon USB hidmouse Device
type: string
x-go-name: Product
product_id:
description: USB ID of the product
example: '2221'
type: string
x-go-name: ProductID
serial:
description: USB serial number
example: DAE005fp
type: string
x-go-name: Serial
speed:
description: Transfer speed (Mbit/s)
example: 12
format: double
type: number
x-go-name: Speed
vendor:
description: Name of the vendor
example: ATEN International Co., Ltd
type: string
x-go-name: Vendor
vendor_id:
description: USB ID of the vendor
example: '0557'
type: string
x-go-name: VendorID
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesStorage:
description: ResourcesStorage represents the local storage
properties:
disks:
description: List of disks
items:
$ref: '#/components/schemas/ResourcesStorageDisk'
type: array
x-go-name: Disks
total:
description: Total number of partitions
example: 1
format: uint64
type: integer
x-go-name: Total
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesCPU:
description: ResourcesCPU represents the cpu resources available on the system
properties:
architecture:
description: Architecture name
example: x86_64
type: string
x-go-name: Architecture
sockets:
description: List of CPU sockets
items:
$ref: '#/components/schemas/ResourcesCPUSocket'
type: array
x-go-name: Sockets
total:
description: Total number of CPU threads (from all sockets and cores)
example: 1
format: uint64
type: integer
x-go-name: Total
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesLoad:
description: ResourcesLoad represents system load information
properties:
Average1Min:
description: Load average in the past minute
example: 0.69
format: double
type: number
Average5Min:
description: Load average in the past 5 minutes
example: 1.1
format: double
type: number
Average10Min:
description: Load average in the past 10 minutes
example: 1.29
format: double
type: number
Processes:
description: The number of active processes
example: 1234
format: int64
type: integer
type: object
x-go-package: github.com/lxc/incus/v7/shared/api
ResourcesGPUCardDRM:
description: ResourcesGPUCardDRM represents the Linux DRM configuration of the GPU
properties:
card_device:
description: Card device number
example: '226:0'
type: string
x-go-name: CardDevice
card_name:
description: Card device name
example: card0
type: string
x-go-name: CardName
control_device:
description: Control device number
example: '226:0'
type: string
x-go-name: ControlDevice
control_name:
description: Control device name
example: controlD64
type: string
x-go-name: ControlName
id:
description: DRM card ID
example: 0
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/incus/refs/heads/main/openapi/incus-server-api-openapi.yml