Incus server API
The server API from Incus — 5 operation(s) for server.
Incus server API is one of 22 APIs that Incus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include server. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.
This API exposes 7 operations across 5 paths, and defines 43 schemas. It is described by OpenAPI 2.0, at version 1.0.
7 operations
5 paths
43 schemas
5 GET1 PATCH1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 5 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
server 7
GET
/
Get the supported API endpoints
GET
/1.0
Get the server environment and configuration
PATCH
/1.0
Partially update the server configuration
PUT
/1.0
Update the server configuration
GET
/1.0/events
Get the event stream
GET
/1.0/resources
Get system resources information
GET
/1.0?public
Get the server environment
Schemas 43
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are ServerEnvironment (24 properties), ResourcesStorageDisk (18 properties), ResourcesNetworkCardPort (13 properties), ResourcesNetworkCard (13 properties). Each schema is shown below with its type and property counts.
ResourcesPCI
object
ResourcesPCI represents the PCI devices available on the system
2 properties
ResourcesNetwork
object
ResourcesNetwork represents the network cards available on the system
2 properties
ResourcesGPUCardSRIOV
object
ResourcesGPUCardSRIOV represents the SRIOV configuration of the GPU
3 properties
ResourcesCPUSocket
object
ResourcesCPUSocket represents a CPU socket on the system
9 properties
ServerStorageDriverInfo
object
ServerStorageDriverInfo represents the read-only info about a storage driver
3 properties
ResourcesCPUAddressSizes
object
2 properties
ResourcesGPUCard
object
ResourcesGPUCard represents a GPU card on the system
13 properties
ResourcesUSB
object
ResourcesUSB represents the USB devices available on the system
2 properties
ResourcesNetworkCardSRIOV
object
ResourcesNetworkCardSRIOV represents the SRIOV configuration of the network card
3 properties
ResourcesNetworkCardVDPA
object
ResourcesNetworkCardVDPA represents the VDPA configuration of the network card
2 properties
ResourcesStorageDiskPartition
object
ResourcesStorageDiskPartition represents a partition on a disk
5 properties
ResourcesMemory
object
ResourcesMemory represents the memory resources available on the system
6 properties
ResourcesPCIDevice
object
ResourcesPCIDevice represents a PCI device
10 properties
ResourcesPCIVPD
object
ResourcesPCIVPD represents VPD entries for a device
2 properties
ResourcesSystemChassis
object
ResourcesSystemChassis represents the system chassis
4 properties
ServerUntrusted
object
ServerUntrusted represents a server configuration for an untrusted client
7 properties
Server
object
Server represents a server configuration
10 properties
Resources
object
Resources represents the system hardware resources
10 properties
ResourcesSystem
object
ResourcesSystem represents the system
11 properties
ResourcesCPUCore
object
ResourcesCPUCore represents a CPU core on the system
5 properties
ResourcesGPU
object
ResourcesGPU represents the GPU resources available on the system
2 properties
ResourcesMemoryNode
object
ResourcesMemoryNode represents the node-specific memory resources available on the system
5 properties
ResourcesCPUCache
object
ResourcesCPUCache represents a CPU cache
3 properties
ResourcesSerial
object
ResourcesSerial represents the serial devices available on the system
2 properties
ResourcesNetworkCardPort
object
ResourcesNetworkCardPort represents a network port on the system
13 properties
ServerPut
object
ServerPut represents the modifiable fields of a server configuration
1 property
ResourcesStorage
object
ResourcesStorage represents the local storage
2 properties
ResourcesNetworkCard
object
ResourcesNetworkCard represents a network card on the system
13 properties
ResourcesCPU
object
ResourcesCPU represents the cpu resources available on the system
3 properties
ServerEnvironment
object
24 properties
ResourcesCPUThread
object
ResourcesCPUThread represents a CPU thread on the system
5 properties
Event
object
Event represents an event entry (over websocket)
5 properties
ResourcesGPUCardDRM
object
ResourcesGPUCardDRM represents the Linux DRM configuration of the GPU
7 properties
ResourcesGPUCardMdev
object
ResourcesGPUCardMdev represents the mediated devices configuration of the GPU
5 properties
ResourcesUSBDevice
object
ResourcesUSBDevice represents a USB device
9 properties
ResourcesSystemMotherboard
object
ResourcesSystemMotherboard represents the motherboard
4 properties
ResourcesSerialDevice
object
ResourcesSerialDevice represents a serial device
9 properties
ResourcesLoad
object
ResourcesLoad represents system load information
4 properties
ResourcesGPUCardNvidia
object
ResourcesGPUCardNvidia represents additional information for NVIDIA GPUs
8 properties
ResourcesNetworkCardPortInfiniband
object
ResourcesNetworkCardPortInfiniband represents the Linux Infiniband configuration for the port
6 properties
ResourcesUSBDeviceInterface
object
ResourcesUSBDeviceInterface represents a USB device interface
7 properties
ResourcesSystemFirmware
object
ResourcesSystemFirmware represents the system firmware
3 properties
ResourcesStorageDisk
object
ResourcesStorageDisk represents a disk
18 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Incus 12
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
#server