How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canonical

LXD REST API

The REST API used by every LXD client. LXD is Canonical's system container and virtual machine manager; the API is available over a local unix+http socket and over remote https, authenticated by TLS client certificate, OIDC identity, or unix group membership for local users. Canonical publishes the full contract as a Swagger 2.0 document with 169 paths, 333 operations and 236 schema definitions — the largest and most complete API contract in the Canonical portfolio. Capability discovery is through the api_extensions[] array on GET /1.0 rather than a path version bump; the path has been /1.0 since 2016.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Containers, Virtualization, and Infrastructure. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 334 operations across 169 paths, organized into 29 resource areas, and defines 236 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://:8443.

334 operations 169 paths 236 schemas 40 DELETE159 GET1 HEAD31 PATCH63 POST40 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://:8443
Contact
LXD upstream
License
AGPL-3.0-only
Resource Areas
29

Paths & Operations 334

Across 169 paths, the API surfaces 334 operations — 40 DELETE, 159 GET, 1 HEAD, 31 PATCH, 63 POST, 40 PUT. They span 29 resource areas, including server, auth_groups, identities, identity_provider_groups, oidc_sessions, permissions, certificates, cluster, and 21 more. Each is listed below with its method, path, parameters, and response codes.

server 7
GET
/
Get the supported API endpoints
api_get → 200
GET
/1.0
Get the server environment and configuration
server_get 2 params → 200500
PATCH
/1.0
Partially update the server configuration
server_patch 2 params → 200400403412500
PUT
/1.0
Update the server configuration
server_put 2 params → 200400403412500
GET
/1.0/events
Get the event stream
events_get 3 params → 200403500
GET
/1.0/resources
Get system resources information
resources_get 1 param → 200403500
GET
/1.0?public
Get the server environment
server_get_untrusted → 200500
auth_groups 8
GET
/1.0/auth/groups
Get the groups
auth_groups_get → 200403500
POST
/1.0/auth/groups
Create a new authorization group
auth_groups_post 1 param → 200400403500
DELETE
/1.0/auth/groups/{groupName}
Delete the authorization group
auth_group_delete → 200400403500
GET
/1.0/auth/groups/{groupName}
Get the authorization group
auth_group_get → 200403500
PATCH
/1.0/auth/groups/{groupName}
Partially update the authorization group
auth_group_patch 1 param → 200400403500
POST
/1.0/auth/groups/{groupName}
Rename the authorization group
auth_group_post 1 param → 200400403500
PUT
/1.0/auth/groups/{groupName}
Update the authorization group
auth_group_put 1 param → 200400403500
GET
/1.0/auth/groups?recursion=1
Get the groups
auth_groups_get_recursion1 → 200403500
identities 26
GET
/1.0/auth/identities
Get the identities
identities_get → 200403500
GET
/1.0/auth/identities/bearer
Get the bearer identities
identities_get_bearer → 200403500
POST
/1.0/auth/identities/bearer
Add a bearer identity.
identities_post_bearer 1 param → 201400403500
DELETE
/1.0/auth/identities/bearer/{nameOrID}/token
Revoke a bearer identity token.
identity_delete_bearer_token → 403404500
POST
/1.0/auth/identities/bearer/{nameOrID}/token
Issue a token for a bearer identity.
identity_post_bearer_token 1 param → 200400403404500
DELETE
/1.0/auth/identities/bearer/{nameOrIdentifier}
Delete the bearer identity
identity_delete_bearer → 200400403500501
GET
/1.0/auth/identities/bearer/{nameOrIdentifier}
Get the bearer identity
identity_get_bearer → 200403500
PATCH
/1.0/auth/identities/bearer/{nameOrIdentifier}
Partially update the bearer identity
identity_patch_bearer 1 param → 200400403412500501
PUT
/1.0/auth/identities/bearer/{nameOrIdentifier}
Update the bearer identity
identity_put_bearer 1 param → 200400403412500501
GET
/1.0/auth/identities/bearer?recursion=1
Get the bearer identities
identities_get_bearer_recursion1 → 200403500
GET
/1.0/auth/identities/current
Get the current identity
identity_get_current → 200403500
GET
/1.0/auth/identities/oidc
Get the OIDC identities
identities_get_oidc → 200403500
DELETE
/1.0/auth/identities/oidc/{nameOrIdentifier}
Delete the OIDC identity
identity_delete_oidc → 200400403500501
GET
/1.0/auth/identities/oidc/{nameOrIdentifier}
Get the OIDC identity
identity_get_oidc → 200403500
PATCH
/1.0/auth/identities/oidc/{nameOrIdentifier}
Partially update the OIDC identity
identity_patch_oidc 1 param → 200400403412500501
PUT
/1.0/auth/identities/oidc/{nameOrIdentifier}
Update the OIDC identity
identity_put_oidc 1 param → 200400403412500501
GET
/1.0/auth/identities/oidc?recursion=1
Get the OIDC identities
identities_get_oidc_recursion1 → 200403500
GET
/1.0/auth/identities/tls
Get the TLS identities
identities_get_tls → 200403500
POST
/1.0/auth/identities/tls
Add a TLS identity.
identities_post_tls 1 param → 201400403500
DELETE
/1.0/auth/identities/tls/{nameOrIdentifier}
Delete the TLS identity
identity_delete_tls → 200400403500501
GET
/1.0/auth/identities/tls/{nameOrIdentifier}
Get the TLS identity
identity_get_tls → 200403500
PATCH
/1.0/auth/identities/tls/{nameOrIdentifier}
Partially update the TLS identity
identity_patch_tls 1 param → 200400403412500501
PUT
/1.0/auth/identities/tls/{nameOrIdentifier}
Update the TLS identity
identity_put_tls 1 param → 200400403412500501
POST
/1.0/auth/identities/tls?public
Add a TLS identity
identities_post_tls_untrusted 1 param → 201400403500
GET
/1.0/auth/identities/tls?recursion=1
Get the TLS identities
identities_get_tls_recursion1 → 200403500
GET
/1.0/auth/identities?recursion=1
Get the identities
identities_get_recursion1 → 200403500
identity_provider_groups 8
GET
/1.0/auth/identity-provider-groups
Get the identity provider groups
identity_provider_groups_get → 200403500
POST
/1.0/auth/identity-provider-groups
Create a new identity provider group
identity_provider_groups_post 1 param → 200400403500
DELETE
/1.0/auth/identity-provider-groups/{idpGroupName}
Delete the identity provider group
identity_provider_group_delete → 200400403500
GET
/1.0/auth/identity-provider-groups/{idpGroupName}
Get the identity provider group
identity_provider_group_get → 200403500
PATCH
/1.0/auth/identity-provider-groups/{idpGroupName}
Partially update the identity provider group
identity_provider_group_patch 1 param → 200400403500
POST
/1.0/auth/identity-provider-groups/{idpGroupName}
Rename the identity provider group
identity_provider_group_post 1 param → 200400403500
PUT
/1.0/auth/identity-provider-groups/{idpGroupName}
Update the identity provider group
identity_provider_group_put 1 param → 200400403500
GET
/1.0/auth/identity-provider-groups?recursion=1
Get the groups
identity_provider_groups_get_recursion1 → 200403500
oidc_sessions 4
GET
/1.0/auth/oidc-sessions
Get OIDC session URLs
oidc_sessions_get 1 param → 200403500
DELETE
/1.0/auth/oidc-sessions/{id}
Delete an OIDC session
oidc_session_delete → 200400403500
GET
/1.0/auth/oidc-sessions/{id}
Get the OIDC session
oidc_session_get → 200403500
GET
/1.0/auth/oidc-sessions?recursion=1
Get the OIDC sessions
oidc_sessions_get_recursion1 1 param → 200403500
permissions 2
GET
/1.0/auth/permissions
Get the permissions
permissions_get 2 params → 200403500
GET
/1.0/auth/permissions?recursion=1
Get the permissions
permissions_get_recursion1 2 params → 200403500
certificates 8
GET
/1.0/certificates
Get the trusted certificates
certificates_get → 200403500
POST
/1.0/certificates
Add a trusted certificate
certificates_post 1 param → 200400403500
DELETE
/1.0/certificates/{fingerprint}
Delete the trusted certificate
certificate_delete → 200400403500
GET
/1.0/certificates/{fingerprint}
Get the trusted certificate
certificate_get → 200403500
PATCH
/1.0/certificates/{fingerprint}
Partially update the trusted certificate
certificate_patch 1 param → 200400403412500
PUT
/1.0/certificates/{fingerprint}
Update the trusted certificate
certificate_put 1 param → 200400403412500
POST
/1.0/certificates?public
Add a trusted certificate
certificates_post_untrusted 1 param → 200400403500
GET
/1.0/certificates?recursion=1
Get the trusted certificates
certificates_get_recursion1 → 200403500
cluster 14
GET
/1.0/cluster
Get the cluster configuration
cluster_get → 200403500
PUT
/1.0/cluster
Update the cluster configuration
cluster_put 1 param → 200400403412500
PUT
/1.0/cluster/certificate
Update the certificate for the cluster
clustering_update_cert 1 param → 200400403500
POST
/1.0/cluster/groups
Create a cluster group.
cluster_groups_post 1 param → 200400403500
GET
/1.0/cluster/members
Get the cluster members
cluster_members_get → 200403500
POST
/1.0/cluster/members
Request a join token
cluster_members_post 1 param → 202400403500
DELETE
/1.0/cluster/members/{name}
Delete the cluster member
cluster_member_delete → 200400403500
GET
/1.0/cluster/members/{name}
Get the cluster member
cluster_member_get → 200403500
PATCH
/1.0/cluster/members/{name}
Partially update the cluster member
cluster_member_patch 1 param → 200400403412500
POST
/1.0/cluster/members/{name}
Rename the cluster member
cluster_member_post 1 param → 200400403500
PUT
/1.0/cluster/members/{name}
Update the cluster member
cluster_member_put 1 param → 200400403412500
GET
/1.0/cluster/members/{name}/state
Get state of the cluster member
cluster_member_state_get → 200403500
POST
/1.0/cluster/members/{name}/state
Evacuate or restore a cluster member
cluster_member_state_post 1 param → 202400403500
GET
/1.0/cluster/members?recursion=1
Get the cluster members
cluster_members_get_recursion1 → 200403500
cluster-groups 7
GET
/1.0/cluster/groups
Get the cluster groups
cluster_groups_get → 200403500
DELETE
/1.0/cluster/groups/{name}
Delete the cluster group.
cluster_group_delete → 200400403500
GET
/1.0/cluster/groups/{name}
Get the cluster group
cluster_group_get → 200403500
PATCH
/1.0/cluster/groups/{name}
Update the cluster group
cluster_group_patch 1 param → 200400403412500
POST
/1.0/cluster/groups/{name}
Rename the cluster group
cluster_group_post 1 param → 200400403500
PUT
/1.0/cluster/groups/{name}
Update the cluster group
cluster_group_put 1 param → 200400403412500
GET
/1.0/cluster/groups?recursion=1
Get the cluster groups
cluster_groups_get_recursion1 → 200403500
cluster-links 9
GET
/1.0/cluster/links
Get the cluster links
cluster_links_get → 200400403500
POST
/1.0/cluster/links
Add a cluster link
cluster_links_post 1 param → 200400403500
DELETE
/1.0/cluster/links/{name}
Delete the cluster link
cluster_link_delete → 200400403500
GET
/1.0/cluster/links/{name}
Get the cluster link
cluster_link_get → 200400403500
PATCH
/1.0/cluster/links/{name}
Update the cluster link
cluster_link_patch 1 param → 200400403412500
POST
/1.0/cluster/links/{name}
Rename the cluster link
cluster_link_post 1 param → 200400403500
PUT
/1.0/cluster/links/{name}
Update the cluster link
cluster_link_put 1 param → 200400403412500
GET
/1.0/cluster/links/{name}/state
Get the cluster link state
cluster_link_state_get 1 param → 200400403500
GET
/1.0/cluster/links?recursion=1
Get the cluster links
cluster_links_get_recursion1 → 200400403500
images 25
GET
/1.0/images
Get the images
images_get 3 params → 200403500
POST
/1.0/images
Add an image
images_post 9 params → 202400403500
DELETE
/1.0/images/{fingerprint}
Delete the image
image_delete 1 param → 202400403500
GET
/1.0/images/{fingerprint}
Get the image
image_get 1 param → 200403500
PATCH
/1.0/images/{fingerprint}
Partially update the image
image_patch 2 params → 200400403412500
PUT
/1.0/images/{fingerprint}
Update the image
image_put 2 params → 200400403412500
GET
/1.0/images/{fingerprint}/export
Get the raw image file(s)
image_export_get 1 param → 200403500
POST
/1.0/images/{fingerprint}/export
Make LXD push the image to a remote server
images_export_post 2 params → 202403500
GET
/1.0/images/{fingerprint}/export?public
Get the raw image file(s)
image_export_get_untrusted 2 params → 200403500
POST
/1.0/images/{fingerprint}/refresh
Refresh an image
images_refresh_post 1 param → 202403500
POST
/1.0/images/{fingerprint}/secret
Generate secret for retrieval of the image by an untrusted client
images_secret_post 1 param → 202403500
GET
/1.0/images/{fingerprint}?public
Get the public image
image_get_untrusted 2 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 1 param → 200400403500
GET
/1.0/images/aliases/{name}
Get the image alias
image_alias_get 1 param → 200403500
PATCH
/1.0/images/aliases/{name}
Partially update the image alias
images_alias_patch 2 params → 200400403412500
POST
/1.0/images/aliases/{name}
Rename the image alias
images_alias_post 2 params → 200400403500
PUT
/1.0/images/aliases/{name}
Update the image alias
images_aliases_put 2 params → 200400403412500
GET
/1.0/images/aliases/{name}?public
Get the public image alias
image_alias_get_untrusted 1 param → 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
instances 51
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 1 param → 200403500
PATCH
/1.0/instances/{name}
Partially update the instance
instance_patch 2 params → 200400403500
POST
/1.0/instances/{name}
Rename or move/migrate an instance
instance_post 2 params → 202400403500
PUT
/1.0/instances/{name}
Update the instance
instance_put 2 params → 202400403500
GET
/1.0/instances/{name}/backups
Get the backups
instance_backups_get 1 param → 200403500
POST
/1.0/instances/{name}/backups
Create a backup
instance_backups_post 2 params → 202400403500
DELETE
/1.0/instances/{name}/backups/{backup}
Delete a backup
instance_backup_delete 1 param → 202400403500
GET
/1.0/instances/{name}/backups/{backup}
Get the backup
instance_backup_get 1 param → 200403500
POST
/1.0/instances/{name}/backups/{backup}
Rename a backup
instance_backup_post 2 params → 202400403500
GET
/1.0/instances/{name}/backups/{backup}/export
Get the raw backup file(s)
instance_backup_export 1 param → 200403500
GET
/1.0/instances/{name}/backups?recursion=1
Get the backups
instance_backups_get_recursion1 1 param → 200403500
DELETE
/1.0/instances/{name}/console
Clear the console log
instance_console_delete 1 param → 200400403404500
GET
/1.0/instances/{name}/console
Get console log
instance_console_get 1 param → 200400403404500
POST
/1.0/instances/{name}/console
Connect to console
instance_console_post 2 params → 202400403500
POST
/1.0/instances/{name}/exec
Run a command
instance_exec_post 2 params → 202400403500
DELETE
/1.0/instances/{name}/files
Delete a file
instance_files_delete 2 params → 200400403404500
GET
/1.0/instances/{name}/files
Get a file
instance_files_get 2 params → 200400403404500
HEAD
/1.0/instances/{name}/files
Get metadata for a file
instance_files_head 2 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 1 param → 200403404500
GET
/1.0/instances/{name}/logs/{filename}
Get the log file
instance_log_get 1 param → 200400403404500
GET
/1.0/instances/{name}/logs/exec-output
Get the exec record-output files
instance_exec-output_get 1 param → 200403404500
DELETE
/1.0/instances/{name}/logs/exec-output/{filename}
Delete the exec record-output file
instance_exec-output_delete 1 param → 200400403404500
GET
/1.0/instances/{name}/logs/exec-output/{filename}
Get the exec-output log file
instance_exec-output_get 1 param → 200400403404500
GET
/1.0/instances/{name}/metadata
Get the instance image metadata
instance_metadata_get 1 param → 200403500
PATCH
/1.0/instances/{name}/metadata
Partially update the image metadata
instance_metadata_patch 2 params → 200400403412500
PUT
/1.0/instances/{name}/metadata
Update the image metadata
instance_metadata_put 2 params → 200400403412500
DELETE
/1.0/instances/{name}/metadata/templates
Delete a template file
instance_metadata_templates_delete 2 params → 200400403404500
GET
/1.0/instances/{name}/metadata/templates
Get the template file names or a specific
instance_metadata_templates_get 2 params → 200400403404500
POST
/1.0/instances/{name}/metadata/templates
Create or replace a template file
instance_metadata_templates_post 3 params → 200400403404500
POST
/1.0/instances/{name}/rebuild
Rebuild an instance
instance_rebuild_post 2 params → 200202400403404500
GET
/1.0/instances/{name}/sftp
Get the instance SFTP connection
instance_sftp → 101400403404500
GET
/1.0/instances/{name}/snapshots
Get the snapshots
instance_snapshots_get 1 param → 200403500
POST
/1.0/instances/{name}/snapshots
Create a snapshot
instance_snapshots_post 2 params → 202400403500
DELETE
/1.0/instances/{name}/snapshots/{snapshot}
Delete a snapshot
instance_snapshot_delete 2 params → 202400403500
GET
/1.0/instances/{name}/snapshots/{snapshot}
Get the snapshot
instance_snapshot_get 1 param → 200403500
PATCH
/1.0/instances/{name}/snapshots/{snapshot}
Partially update snapshot
instance_snapshot_patch 2 params → 202400403500
POST
/1.0/instances/{name}/snapshots/{snapshot}
Rename or move/migrate a snapshot
instance_snapshot_post 2 params → 202400403500
PUT
/1.0/instances/{name}/snapshots/{snapshot}
Update snapshot
instance_snapshot_put 2 params → 202400403500
GET
/1.0/instances/{name}/snapshots?recursion=1
Get the snapshots
instance_snapshots_get_recursion1 1 param → 200403500
GET
/1.0/instances/{name}/state
Get the runtime state
instance_state_get 1 param → 200400403500
PUT
/1.0/instances/{name}/state
Change the state
instance_state_put 2 params → 202400403500
GET
/1.0/instances/{name}/uefi-vars
Get the instance's UEFI variables
instance_uefi_vars_get 1 param → 200403500
PUT
/1.0/instances/{name}/uefi-vars
Set the instance's UEFI variables
instance_uefi_vars_put 2 params → 200400403404500
GET
/1.0/instances/{name}?recursion=1
Get the instance
instance_get_recursion1 2 params → 200400403500
GET
/1.0/instances?recursion=1
Get the instances
instances_get_recursion1 3 params → 200403500
GET
/1.0/instances?recursion=2
Get the instances
instances_get_recursion2 4 params → 200400403500
Operations 1
GET
/1.0/metadata/configuration
Get the metadata configuration
metadata_configuration_get → 200403500
metrics 1
GET
/1.0/metrics
Get metrics
metrics_get 2 params → 200403500
network-acls 9
GET
/1.0/network-acls
Get the network ACLs
network_acls_get 2 params → 200403500
POST
/1.0/network-acls
Add a network ACL
network_acls_post 2 params → 202400403500
DELETE
/1.0/network-acls/{name}
Delete the network ACL
network_acl_delete 1 param → 202400403404500
GET
/1.0/network-acls/{name}
Get the network ACL
network_acl_get 1 param → 200403500
PATCH
/1.0/network-acls/{name}
Partially update the network ACL
network_acl_patch 2 params → 202400403412500
POST
/1.0/network-acls/{name}
Rename the network ACL
network_acl_post 2 params → 202400403500
PUT
/1.0/network-acls/{name}
Update the network ACL
network_acl_put 2 params → 202400403404412500
GET
/1.0/network-acls/{name}/log
Get the network ACL log
network_acl_log_get 1 param → 200403500
GET
/1.0/network-acls?recursion=1
Get the network ACLs
network_acls_get_recursion1 2 params → 200403500
network-allocations 1
GET
/1.0/network-allocations
Get the network allocations in use (network, network-forward, load-balancer, uplink and instance)
network_allocations_get 2 params → 200403500
network-zones 14
GET
/1.0/network-zones
Get the network zones
network_zones_get 2 params → 200403500
POST
/1.0/network-zones
Add a network zone
network_zones_post 2 params → 202400403500
DELETE
/1.0/network-zones/{zone}
Delete the network zone
network_zone_delete 1 param → 202400403404500
GET
/1.0/network-zones/{zone}
Get the network zone
network_zone_get 1 param → 200403500
PATCH
/1.0/network-zones/{zone}
Partially update the network zone
network_zone_patch 2 params → 202400403404412500
PUT
/1.0/network-zones/{zone}
Update the network zone
network_zone_put 2 params → 202400403404412500
GET
/1.0/network-zones/{zone}/records
Get the network zone records
network_zone_records_get 1 param → 200403500
POST
/1.0/network-zones/{zone}/records
Add a network zone record
network_zone_records_post 2 params → 202400403500
DELETE
/1.0/network-zones/{zone}/records/{name}
Delete the network zone record
network_zone_record_delete 1 param → 202400403404500
GET
/1.0/network-zones/{zone}/records/{name}
Get the network zone record
network_zone_record_get 1 param → 200403500
PATCH
/1.0/network-zones/{zone}/records/{name}
Partially update the network zone record
network_zone_record_patch 2 params → 202400403404412500
PUT
/1.0/network-zones/{zone}/records/{name}
Update the network zone record
network_zone_record_put 2 params → 202400403404412500
GET
/1.0/network-zones/{zone}/records?recursion=1
Get the network zone records
network_zone_records_get_recursion1 1 param → 200403500
GET
/1.0/network-zones?recursion=1
Get the network zones
network_zones_get_recursion1 2 params → 200403500
networks 10
GET
/1.0/networks
Get the networks
networks_get 2 params → 200403500
POST
/1.0/networks
Add a network
networks_post 3 params → 202400403500
DELETE
/1.0/networks/{name}
Delete the network
network_delete 1 param → 202400403404500
GET
/1.0/networks/{name}
Get the network
network_get 2 params → 200403500
PATCH
/1.0/networks/{name}
Partially update the network
network_patch 3 params → 202400403412500
POST
/1.0/networks/{name}
Rename the network
network_post 2 params → 202400403500
PUT
/1.0/networks/{name}
Update the network
network_put 3 params → 202400403404412500
GET
/1.0/networks/{name}/leases
Get the DHCP leases
networks_leases_get 2 params → 200403500
GET
/1.0/networks/{name}/state
Get the network state
networks_state_get 2 params → 200403500
GET
/1.0/networks?recursion=1
Get the networks
networks_get_recursion1 3 params → 200403500
network-forwards 7
GET
/1.0/networks/{networkName}/forwards
Get the network address forwards
network_forwards_get 1 param → 200403500
POST
/1.0/networks/{networkName}/forwards
Add a network address forward
network_forwards_post 2 params → 202400403500
DELETE
/1.0/networks/{networkName}/forwards/{listenAddress}
Delete the network address forward
network_forward_delete 1 param → 202400403500
GET
/1.0/networks/{networkName}/forwards/{listenAddress}
Get the network address forward
network_forward_get 1 param → 200403500
PATCH
/1.0/networks/{networkName}/forwards/{listenAddress}
Partially update the network address forward
network_forward_patch 2 params → 202400403412500
PUT
/1.0/networks/{networkName}/forwards/{listenAddress}
Update the network address forward
network_forward_put 2 params → 202400403412500
GET
/1.0/networks/{networkName}/forwards?recursion=1
Get the network address forwards
network_forward_get_recursion1 1 param → 200403500
network-load-balancer-pools 6
GET
/1.0/networks/{networkName}/load-balancer-pools
List network load balancer pools
network_load_balancer_pools_get 1 param → 200400403500
POST
/1.0/networks/{networkName}/load-balancer-pools
Add a network load balancer pool
network_load_balancer_pools_post 2 params → 202400403500
DELETE
/1.0/networks/{networkName}/load-balancer-pools/{poolName}
Delete a network load balancer pool
network_load_balancer_pool_delete 1 param → 202400403500
GET
/1.0/networks/{networkName}/load-balancer-pools/{poolName}
Get a network load balancer pool
network_load_balancer_pool_get 1 param → 200400403500
PUT
/1.0/networks/{networkName}/load-balancer-pools/{poolName}
Update a network load balancer pool
network_load_balancer_pool_put 2 params → 202400403500
GET
/1.0/networks/{networkName}/load-balancer-pools/{poolName}/state
Get the state of a network load balancer pool
network_load_balancer_pool_state_get 1 param → 200400403500
network-load-balancers 7
GET
/1.0/networks/{networkName}/load-balancers
Get the network address of load balancers
network_load_balancers_get 1 param → 200403500
POST
/1.0/networks/{networkName}/load-balancers
Add a network load balancer
network_load_balancers_post 2 params → 202400403500
DELETE
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Delete the network address load balancer
network_load_balancer_delete 1 param → 202400403500
GET
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Get the network address load balancer
network_load_balancer_get 1 param → 200403500
PATCH
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Partially update the network address load balancer
network_load_balancer_patch 2 params → 202400403412500
PUT
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Update the network address load balancer
network_load_balancer_put 2 params → 202400403412500
GET
/1.0/networks/{networkName}/load-balancers?recursion=1
Get the network address load balancers
network_load_balancer_get_recursion1 1 param → 200403500
network-peers 7
GET
/1.0/networks/{networkName}/peers
Get the network peers
network_peers_get 1 param → 200403500
POST
/1.0/networks/{networkName}/peers
Add a network peer
network_peers_post 2 params → 202400403500
DELETE
/1.0/networks/{networkName}/peers/{peerName}
Delete the network peer
network_peer_delete 1 param → 202400403500
GET
/1.0/networks/{networkName}/peers/{peerName}
Get the network peer
network_peer_get 1 param → 200403500
PATCH
/1.0/networks/{networkName}/peers/{peerName}
Partially update the network peer
network_peer_patch 2 params → 202400403412500
PUT
/1.0/networks/{networkName}/peers/{peerName}
Update the network peer
network_peer_put 2 params → 202400403412500
GET
/1.0/networks/{networkName}/peers?recursion=1
Get the network peers
network_peer_get_recursion1 1 param → 200403500
operations 8
GET
/1.0/operations
Get the operations
operations_get 2 params → 200403500
DELETE
/1.0/operations/{id}
Cancel the operation
operation_delete → 200400403500
GET
/1.0/operations/{id}
Get the operation state
operation_get → 200403500
GET
/1.0/operations/{id}/wait
Wait for the operation
operation_wait_get 1 param → 200403500
GET
/1.0/operations/{id}/wait?public
Wait for the operation
operation_wait_get_untrusted 2 params → 200403500
GET
/1.0/operations/{id}/websocket
Get the websocket stream
operation_websocket_get 1 param → 200403500
GET
/1.0/operations/{id}/websocket?public
Get the websocket stream
operation_websocket_get_untrusted 1 param → 200403500
GET
/1.0/operations?recursion=1
Get the operations
operations_get_recursion1 2 params → 200403500
placement-groups 8
GET
/1.0/placement-groups
Get the placement groups
placement_groups_get 2 params → 200403500
POST
/1.0/placement-groups
Add a placement group
placement_groups_post 2 params → 200400403500
DELETE
/1.0/placement-groups/{name}
Delete the placement group
placement_group_delete 1 param → 200400403500
GET
/1.0/placement-groups/{name}
Get the placement group
placement_group_get 1 param → 200403500
PATCH
/1.0/placement-groups/{name}
Partially update the placement group
placement_group_patch 2 params → 200400403412500
POST
/1.0/placement-groups/{name}
Rename a placement group
placement_group_post 1 param → 200400403500
PUT
/1.0/placement-groups/{name}
Update the placement group
placement_group_put 2 params → 200400403412500
GET
/1.0/placement-groups?recursion=1
Get the placement groups
placement_groups_get_recursion1 2 params → 200403500
profiles 8
GET
/1.0/profiles
Get the profiles
profiles_get 2 params → 200403500
POST
/1.0/profiles
Add a profile
profiles_post 2 params → 200400403500
DELETE
/1.0/profiles/{name}
Delete the profile
profile_delete 1 param → 200400403500
GET
/1.0/profiles/{name}
Get the profile
profile_get 1 param → 200403500
PATCH
/1.0/profiles/{name}
Partially update the profile
profile_patch 2 params → 202400403412500
POST
/1.0/profiles/{name}
Rename the profile
profile_post 2 params → 200400403500
PUT
/1.0/profiles/{name}
Update the profile
profile_put 2 params → 202400403412500
GET
/1.0/profiles?recursion=1
Get the profiles
profiles_get_recursion1 2 params → 200403500
projects 10
GET
/1.0/projects
Get the projects
projects_get → 200403500
POST
/1.0/projects
Add a project
projects_post 1 param → 200400403500
DELETE
/1.0/projects/{name}
Delete the project
project_delete 1 param → 202400403500
GET
/1.0/projects/{name}
Get the project
project_get → 200403500
PATCH
/1.0/projects/{name}
Partially update the project
project_patch 1 param → 200400403412500
POST
/1.0/projects/{name}
Rename the project
project_post 1 param → 202400403500
PUT
/1.0/projects/{name}
Update the project
project_put 1 param → 200400403412500
GET
/1.0/projects/{name}/state
Get the project state
project_state_get → 200403500
PUT
/1.0/projects/{name}/state
Update the project replica state
project_state_put 2 params → 202400403404500
GET
/1.0/projects?recursion=1
Get the projects
projects_get_recursion1 → 200403500
replicators 10
GET
/1.0/replicators
Get the replicators
replicators_get 2 params → 200403500
POST
/1.0/replicators
Add a replicator
replicators_post 2 params → 200400403500
DELETE
/1.0/replicators/{name}
Delete the replicator
replicator_delete 1 param → 200400403500
GET
/1.0/replicators/{name}
Get the replicator
replicator_get 1 param → 200400403404500
PATCH
/1.0/replicators/{name}
Partially update the replicator
replicator_patch 2 params → 200400403412500
POST
/1.0/replicators/{name}
Rename the replicator
replicator_post 2 params → 200400403500
PUT
/1.0/replicators/{name}
Update the replicator
replicator_put 2 params → 200400403412500
GET
/1.0/replicators/{name}/state
Get the replicator state
replicator_state_get 1 param → 200403404500
PUT
/1.0/replicators/{name}/state
Update the replicator state
replicator_state_put 2 params → 202400403404500
GET
/1.0/replicators?recursion=1
Get the replicators
replicators_get_recursion1 2 params → 200403500
storage 52
GET
/1.0/storage-pools
Get the storage pools
storage_pools_get 1 param → 200403500
POST
/1.0/storage-pools
Add a storage pool
storage_pools_post 3 params → 202400403500
DELETE
/1.0/storage-pools/{name}/buckets/{bucketName}
Delete the storage bucket
storage_pool_bucket_delete 2 params → 202400403500
PATCH
/1.0/storage-pools/{name}/buckets/{bucketName}
Partially update the storage bucket.
storage_pool_bucket_patch 3 params → 202400403412500
PUT
/1.0/storage-pools/{name}/buckets/{bucketName}
Update the storage bucket
storage_pool_bucket_put 3 params → 202400403412500
DELETE
/1.0/storage-pools/{name}/buckets/{bucketName}/keys/{keyName}
Delete the storage bucket key
storage_pool_bucket_key_delete 2 params → 202400403500
PUT
/1.0/storage-pools/{name}/buckets/{bucketName}/keys/{keyName}
Update the storage bucket key
storage_pool_bucket_key_put 3 params → 202400403412500
GET
/1.0/storage-pools/{name}/resources
Get storage pool resources information
storage_pool_resources 1 param → 200403500
DELETE
/1.0/storage-pools/{poolName}
Delete the storage pool
storage_pools_delete 1 param → 202400403404500
GET
/1.0/storage-pools/{poolName}
Get the storage pool
storage_pool_get 2 params → 200403500
PATCH
/1.0/storage-pools/{poolName}
Partially update the storage pool
storage_pool_patch 3 params → 202400403412500
PUT
/1.0/storage-pools/{poolName}
Update the storage pool
storage_pool_put 3 params → 202400403404412500
GET
/1.0/storage-pools/{poolName}/buckets
Get the storage pool buckets
storage_pool_buckets_get 2 params → 200403500
POST
/1.0/storage-pools/{poolName}/buckets
Add a storage pool bucket.
storage_pool_bucket_post 2 params → 202400403500
GET
/1.0/storage-pools/{poolName}/buckets/{bucketName}
Get the storage pool bucket
storage_pool_bucket_get 1 param → 200403500
GET
/1.0/storage-pools/{poolName}/buckets/{bucketName}/keys
Get the storage pool bucket keys
storage_pool_bucket_keys_get 1 param → 200403500
POST
/1.0/storage-pools/{poolName}/buckets/{bucketName}/keys
Add a storage pool bucket key.
storage_pool_bucket_key_post 2 params → 202400403500
GET
/1.0/storage-pools/{poolName}/buckets/{bucketName}/keys/{keyName}
Get the storage pool bucket key
storage_pool_bucket_key_get 1 param → 200403500
GET
/1.0/storage-pools/{poolName}/buckets/{bucketName}/keys?recursion=1
Get the storage pool bucket keys
storage_pool_bucket_keys_get_recursion1 1 param → 200403500
GET
/1.0/storage-pools/{poolName}/buckets?recursion=1
Get the storage pool buckets
storage_pool_buckets_get_recursion1 2 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes
Get the storage volumes
storage_pool_volumes_get 4 params → 200403500
POST
/1.0/storage-pools/{poolName}/volumes
Add a storage volume
storage_pool_volumes_post 3 params → 202400403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}
Get the storage volumes
storage_pool_volumes_type_get 3 params → 200403500
POST
/1.0/storage-pools/{poolName}/volumes/{type}
Add a storage volume
storage_pool_volumes_type_post 3 params → 202400403500
DELETE
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}
Delete the storage volume
storage_pool_volume_type_delete 2 params → 202400403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}
Get the storage volume
storage_pool_volume_type_get 2 params → 200403500
PATCH
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}
Partially update the storage volume
storage_pool_volume_type_patch 3 params → 202400403412423500
POST
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}
Rename or move/migrate a storage volume
storage_pool_volume_type_post 3 params → 202400403500
PUT
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}
Update the storage volume
storage_pool_volume_type_put 3 params → 202400403412423500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups
Get the storage volume backups
storage_pool_volumes_type_backups_get 2 params → 200403500
POST
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups
Create a storage volume backup
storage_pool_volumes_type_backups_post 3 params → 202400403500
DELETE
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName}
Delete a storage volume backup
storage_pool_volumes_type_backup_delete 2 params → 202400403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName}
Get the storage volume backup
storage_pool_volumes_type_backup_get 2 params → 200403500
POST
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName}
Rename a storage volume backup
storage_pool_volumes_type_backup_post 3 params → 202400403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName}/export
Get the raw backup file
storage_pool_volumes_type_backup_export_get 2 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups?recursion=1
Get the storage volume backups
storage_pool_volumes_type_backups_get_recursion1 2 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots
Get the storage volume snapshots
storage_pool_volumes_type_snapshots_get 2 params → 200403500
POST
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots
Create a storage volume snapshot
storage_pool_volumes_type_snapshots_post 3 params → 202400403500
DELETE
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName}
Delete a storage volume snapshot
storage_pool_volumes_type_snapshot_delete 2 params → 202400403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName}
Get the storage volume snapshot
storage_pool_volumes_type_snapshot_get 2 params → 200403500
PATCH
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName}
Partially update the storage volume snapshot
storage_pool_volumes_type_snapshot_patch 3 params → 202400403412500
POST
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName}
Rename a storage volume snapshot
storage_pool_volumes_type_snapshot_post 3 params → 202400403500
PUT
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName}
Update the storage volume snapshot
storage_pool_volumes_type_snapshot_put 3 params → 202400403412500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots?recursion=1
Get the storage volume snapshots
storage_pool_volumes_type_snapshots_get_recursion1 2 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/state
Get the storage volume state
storage_pool_volume_type_state_get 2 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes/{type}?recursion=1
Get the storage volumes
storage_pool_volumes_type_get_recursion1 3 params → 200403500
GET
/1.0/storage-pools/{poolName}/volumes?recursion=1
Get the storage volumes
storage_pool_volumes_get_recursion1 4 params → 200403500
GET
/1.0/storage-pools?recursion=1
Get the storage pools
storage_pools_get_recursion1 1 param → 200403500
GET
/1.0/storage-volumes
Get the storage volumes
storage_volumes_get 4 params → 200403500
GET
/1.0/storage-volumes/{type}
Get the storage volumes
storage_pool_volumes_type_get 3 params → 200403500
GET
/1.0/storage-volumes/{type}?recursion=1
Get the storage volumes
storage_pool_volumes_type_get_recursion1 3 params → 200403500
GET
/1.0/storage-volumes?recursion=1
Get the storage volumes
storage_pool_volumes_get_recursion1 4 params → 200403500
warnings 6
GET
/1.0/warnings
List the warnings
warnings_get 1 param → 200500
DELETE
/1.0/warnings/{uuid}
Delete the warning
warning_delete → 200500
GET
/1.0/warnings/{uuid}
Get the warning
warning_get → 200404500
PATCH
/1.0/warnings/{uuid}
Partially update the warning
warning_patch 1 param → 200400403500
PUT
/1.0/warnings/{uuid}
Update the warning
warning_put 1 param → 200400403500
GET
/1.0/warnings?recursion=1
Get the warnings
warnings_get_recursion1 1 param → 200500

Schemas 236

The contract defines 236 schemas that model the data the API accepts and returns. The most detailed are ServerEnvironment (27 properties), InstanceSource (23 properties), InstanceFull (21 properties), ResourcesStorageDisk (21 properties). Each schema is shown below with its type and property counts.

AuthGroup
object
6 properties
AuthGroupPost
object
1 property
AuthGroupPut
object
2 properties
AuthGroupsPost
object
3 properties
Certificate
object
Certificate represents a LXD certificate
7 properties
CertificateAddToken
object
6 properties
CertificatePut
object
CertificatePut represents the modifiable fields of a LXD certificate
5 properties
CertificatesPost
object
CertificatesPost represents the fields of a new LXD certificate
8 properties
Cluster
object
3 properties
ClusterCertificatePut
object
ClusterCertificatePut represents the certificate and key pair for all members in a LXD Cluster
2 properties
ClusterGroup
object
4 properties
ClusterGroupPost
object
1 property
ClusterGroupPut
object
2 properties
ClusterGroupsPost
object
3 properties
ClusterLink
object
6 properties
ClusterLinkCertificate
object
It is returned when creating a pending public cluster link, and its fingerprint must be submitted back as ClusterLinksPost.Fingerprint to confirm and pin the c…
1 property
ClusterLinkMemberState
object
3 properties
ClusterLinkPost
object
1 property
ClusterLinkPut
object
2 properties
ClusterLinkState
object
1 property
ClusterLinksPost
object
9 properties
ClusterMember
object
11 properties
ClusterMemberConfigKey
object
The Value field is empty when getting clustering information with GET 1.0/cluster, and should be filled by the joining node when performing a PUT 1.0/cluster j…
5 properties
ClusterMemberJoinToken
object
5 properties
ClusterMemberPost
object
1 property
ClusterMemberPut
object
ClusterMemberPut represents the modifiable fields of a LXD cluster member
5 properties
ClusterMemberState
object
2 properties
ClusterMemberStatePost
object
3 properties
ClusterMemberSysInfo
object
10 properties
ClusterMembersPost
object
1 property
ClusterPut
object
ClusterPut represents the fields required to bootstrap or join a LXD cluster.
7 properties
Event
object
Event represents an event entry (over websocket)
5 properties
IdentitiesBearerPost
object
3 properties
IdentitiesTLSPost
object
5 properties
Identity
object
8 properties
IdentityBearerToken
object
IdentityBearerToken contains a token issued for an identity whose authentication method is api.AuthenticationMethodBearer.
1 property
IdentityBearerTokenPost
object
1 property
IdentityInfo
object
These fields can only be evaluated for the currently authenticated identity.
11 properties
IdentityProviderGroup
object
3 properties
IdentityProviderGroupPost
object
1 property
IdentityProviderGroupPut
object
1 property
IdentityProviderGroupsPost
object
2 properties
IdentityPut
object
2 properties
Image
object
Image represents a LXD image
20 properties
ImageAlias
object
ImageAlias represents an alias from the alias list of a LXD image
2 properties
ImageAliasesEntry
object
ImageAliasesEntry represents a LXD image alias
5 properties
ImageAliasesEntryPost
object
ImageAliasesEntryPost represents the required fields to rename a LXD image alias
1 property
ImageAliasesEntryPut
object
ImageAliasesEntryPut represents the modifiable fields of a LXD image alias
2 properties
ImageAliasesPost
object
ImageAliasesPost represents a new LXD image alias
5 properties
ImageExportPost
object
ImageExportPost represents the fields required to export a LXD image
6 properties
ImageMetadata
object
ImageMetadata represents LXD image metadata (used in image tarball)
5 properties
ImageMetadataTemplate
object
ImageMetadataTemplate represents a template entry in image metadata (used in image tarball)
4 properties
ImagePut
object
ImagePut represents the modifiable fields of a LXD image
5 properties
ImageRegistriesPost
object
4 properties
ImageRegistry
object
7 properties
ImageRegistryPost
object
1 property
ImageRegistryPut
object
2 properties
ImageSource
object
ImageSource represents the source of a LXD image
6 properties
ImagesPost
object
ImagesPost represents the fields available for a new LXD image
9 properties
ImagesPostSource
object
ImagesPostSource represents the source of a new LXD image
14 properties
InitClusterPreseed
object
8 properties
InitLocalPreseed
object
6 properties
InitNetworksProjectPost
object
5 properties
InitPreseed
object
2 properties
InitStorageVolumesProjectPost
object
9 properties
Instance
object
18 properties
InstanceBackup
object
6 properties
InstanceBackupPost
object
1 property
InstanceBackupsPost
object
7 properties
InstanceConsolePost
object
3 properties
InstanceExecPost
object
10 properties
InstanceFull
object
21 properties
InstancePost
object
13 properties
InstancePostTarget
object
3 properties
InstancePut
object
9 properties
InstanceRebuildPost
object
1 property
InstanceSnapshot
object
13 properties
InstanceSnapshotPost
object
4 properties
InstanceSnapshotPut
object
1 property
InstanceSnapshotsPost
object
4 properties
InstanceSource
object
23 properties
InstanceState
object
8 properties
InstanceStateCPU
object
1 property
InstanceStateDisk
object
2 properties
InstanceStateMemory
object
5 properties
InstanceStateNetwork
object
7 properties
InstanceStateNetworkAddress
object
InstanceStateNetworkAddress represents a network address as part of the network section of a LXD instance's state.
4 properties
InstanceStateNetworkCounters
object
InstanceStateNetworkCounters represents packet counters as part of the network section of a LXD instance's state.
8 properties
InstanceStatePut
object
4 properties
InstanceType
string
InstanceUEFIVariable
object
InstanceUEFIVariable represents an EFI variable entry
4 properties
InstanceUEFIVars
object
1 property
InstancesPost
object
14 properties
InstancesPut
object
1 property
MetadataConfiguration
object
2 properties
MetadataConfigurationConfigKey
object
8 properties
MetadataConfigurationConfigKeys
object
1 property
MetadataConfigurationEntity
object
2 properties
MetadataConfigurationEntityEntitlement
object
2 properties
Network
object
Network represents a LXD network
10 properties
NetworkACL
object
8 properties
NetworkACLPost
object
1 property
NetworkACLPut
object
4 properties
NetworkACLRule
object
Refer to doc/network-acls.md for details.
10 properties
NetworkACLsPost
object
5 properties
NetworkAllocations
object
NetworkAllocations used for displaying network addresses used by a consuming entity e.g, instance, network forward, load-balancer, network...
6 properties
NetworkForward
object
5 properties
NetworkForwardPort
object
NetworkForwardPort represents a port specification in a network address forward
5 properties
NetworkForwardPut
object
NetworkForwardPut represents the modifiable fields of a LXD network address forward
3 properties
NetworkForwardsPost
object
NetworkForwardsPost represents the fields of a new LXD network address forward
4 properties
NetworkLease
object
NetworkLease represents a DHCP lease
6 properties
NetworkLoadBalancer
object
NetworkLoadBalancer used for displaying a network load balancer
6 properties
NetworkLoadBalancerBackend
object
NetworkLoadBalancerBackend represents a target backend specification in a network load balancer
4 properties
NetworkLoadBalancerPool
object
5 properties
NetworkLoadBalancerPoolInstance
object
An instance can have multiple targets depending on how many addresses it has in the pool's network.
2 properties
NetworkLoadBalancerPoolPut
object
3 properties
NetworkLoadBalancerPoolState
object
1 property
NetworkLoadBalancerPoolTarget
object
If an instance has both IPv4 and IPv6 addresses on the same network interface, those are represented as two targets inside the pool. Each target has its own he…
7 properties
NetworkLoadBalancerPoolsPost
object
4 properties
NetworkLoadBalancerPort
object
NetworkLoadBalancerPort represents a port specification in a network load balancer
5 properties
NetworkLoadBalancerPut
object
NetworkLoadBalancerPut represents the modifiable fields of a LXD network load balancer
4 properties
NetworkLoadBalancersPost
object
NetworkLoadBalancersPost represents the fields of a new LXD network load balancer
5 properties
NetworkPeer
object
7 properties
NetworkPeerPut
object
NetworkPeerPut represents the modifiable fields of a LXD network peering
2 properties
NetworkPeersPost
object
NetworkPeersPost represents the fields of a new LXD network peering
5 properties
NetworkPost
object
NetworkPost represents the fields required to rename a LXD network
1 property
NetworkPut
object
NetworkPut represents the modifiable fields of a LXD network
2 properties
NetworkState
object
NetworkState represents the network state
10 properties
NetworkStateAddress
object
NetworkStateAddress represents a network address
4 properties
NetworkStateBond
object
NetworkStateBond represents bond specific state
7 properties
NetworkStateBridge
object
NetworkStateBridge represents bridge specific state
6 properties
NetworkStateCounters
object
NetworkStateCounters represents packet counters
4 properties
NetworkStateOVN
object
NetworkStateOVN represents OVN specific state
1 property
NetworkStateVLAN
object
NetworkStateVLAN represents VLAN specific state
2 properties
NetworkZone
object
6 properties
NetworkZonePut
object
NetworkZonePut represents the modifiable fields of a LXD network zone
2 properties
NetworkZoneRecord
object
4 properties
NetworkZoneRecordEntry
object
NetworkZoneRecordEntry represents the fields in a record entry
3 properties
NetworkZoneRecordPut
object
NetworkZoneRecordPut represents the modifiable fields of a LXD network zone record
3 properties
NetworkZoneRecordsPost
object
NetworkZoneRecordsPost represents the fields of a new LXD network zone record
4 properties
NetworkZonesPost
object
NetworkZonesPost represents the fields of a new LXD network zone
3 properties
NetworksPost
object
NetworksPost represents the fields of a new LXD network
4 properties
OIDCSession
object
7 properties
Operation
object
Operation represents a LXD background operation
15 properties
OperationFull
object
16 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
Permission
object
3 properties
PermissionInfo
object
4 properties
Profile
object
Profile represents a LXD profile
7 properties
ProfilePost
object
ProfilePost represents the fields required to rename a LXD profile
1 property
ProfilePut
object
ProfilePut represents the modifiable fields of a LXD profile
3 properties
ProfilesPost
object
ProfilesPost represents the fields of a new LXD profile
4 properties
Project
object
Project represents a LXD project
6 properties
ProjectPost
object
ProjectPost represents the fields required to rename a LXD project
1 property
ProjectPut
object
ProjectPut represents the modifiable fields of a LXD project
2 properties
ProjectState
object
ProjectState represents the current running state of a LXD project
1 property
ProjectStatePut
object
ProjectStatePut represents the fields for updating project replica state
1 property
ProjectStateResource
object
ProjectStateResource represents the state of a particular resource in a LXD project
2 properties
ProjectsPost
object
ProjectsPost represents the fields of a new LXD project
5 properties
Replicator
object
7 properties
ReplicatorPost
object
1 property
ReplicatorPut
object
2 properties
ReplicatorState
object
1 property
ReplicatorStatePut
object
1 property
ReplicatorsPost
object
3 properties
Resources
object
Resources represents the system resources available for LXD
8 properties
ResourcesCPU
object
ResourcesCPU represents the cpu resources available on the system
3 properties
ResourcesCPUCache
object
ResourcesCPUCache represents a CPU cache
3 properties
ResourcesCPUCore
object
ResourcesCPUCore represents a CPU core on the system
4 properties
ResourcesCPUSocket
object
ResourcesCPUSocket represents a CPU socket on the system
8 properties
ResourcesCPUThread
object
ResourcesCPUThread represents a CPU thread on the system
5 properties
ResourcesGPU
object
ResourcesGPU represents the GPU resources available on the system
2 properties
ResourcesGPUCard
object
ResourcesGPUCard represents a GPU card on the system
13 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
ResourcesGPUCardNvidia
object
ResourcesGPUCardNvidia represents additional information for NVIDIA GPUs
8 properties
ResourcesGPUCardSRIOV
object
ResourcesGPUCardSRIOV represents the SRIOV configuration of the GPU
3 properties
ResourcesMemory
object
ResourcesMemory represents the memory resources available on the system
6 properties
ResourcesMemoryNode
object
ResourcesMemoryNode represents the node-specific memory resources available on the system
5 properties
ResourcesNetwork
object
ResourcesNetwork represents the network cards available on the system
2 properties
ResourcesNetworkCard
object
ResourcesNetworkCard represents a network card on the system
13 properties
ResourcesNetworkCardPort
object
ResourcesNetworkCardPort represents a network port on the system
13 properties
ResourcesNetworkCardPortInfiniband
object
ResourcesNetworkCardPortInfiniband represents the Linux Infiniband configuration for the port
6 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
ResourcesPCI
object
ResourcesPCI represents the PCI devices available on the system
2 properties
ResourcesPCIDevice
object
ResourcesPCIDevice represents a PCI device
10 properties
ResourcesPCIVPD
object
ResourcesPCIVPD represents VPD entries for a device
2 properties
ResourcesStorage
object
ResourcesStorage represents the local storage
2 properties
ResourcesStorageDisk
object
ResourcesStorageDisk represents a disk
21 properties
ResourcesStorageDiskPartition
object
ResourcesStorageDiskPartition represents a partition on a disk
7 properties
ResourcesStoragePool
object
ResourcesStoragePool represents the resources available to a given storage pool
2 properties
ResourcesStoragePoolInodes
object
ResourcesStoragePoolInodes represents the inodes available to a given storage pool
2 properties
ResourcesStoragePoolSpace
object
ResourcesStoragePoolSpace represents the space available to a given storage pool
2 properties
ResourcesSystem
object
ResourcesSystem represents the system
11 properties
ResourcesSystemChassis
object
ResourcesSystemChassis represents the system chassis
4 properties
ResourcesSystemFirmware
object
ResourcesSystemFirmware represents the system firmware
3 properties
ResourcesSystemMotherboard
object
ResourcesSystemMotherboard represents the motherboard
4 properties
ResourcesUSB
object
ResourcesUSB represents the USB devices available on the system
2 properties
ResourcesUSBDevice
object
ResourcesUSBDevice represents a USB device
9 properties
ResourcesUSBDeviceInterface
object
ResourcesUSBDeviceInterface represents a USB device interface
7 properties
Server
object
Server represents a LXD server
12 properties
ServerEnvironment
object
27 properties
ServerPut
object
ServerPut represents the modifiable fields of a LXD server configuration
1 property
ServerStorageDriverInfo
object
ServerStorageDriverInfo represents the read-only info about a storage driver
3 properties
ServerUntrusted
object
ServerUntrusted represents a LXD server for an untrusted client
8 properties
SourceType
string
StatusCode
integer
StorageBucket
object
StorageBucket represents the fields of a LXD storage pool bucket
7 properties
StorageBucketKey
object
StorageBucketKey represents the fields of a LXD storage pool bucket key
5 properties
StorageBucketKeyPut
object
StorageBucketKeyPut represents the modifiable fields of a LXD storage pool bucket key
4 properties
StorageBucketKeysPost
object
StorageBucketKeysPost represents the fields of a new LXD storage pool bucket key
5 properties
StorageBucketPut
object
StorageBucketPut represents the modifiable fields of a LXD storage pool bucket
2 properties
StorageBucketsPost
object
StorageBucketsPost represents the fields of a new LXD storage pool bucket
3 properties
StoragePool
object
8 properties
StoragePoolPut
object
2 properties
StoragePoolState
object
2 properties
StoragePoolVolumeBackup
object
StoragePoolVolumeBackup represents a LXD volume backup
5 properties
StoragePoolVolumeBackupPost
object
StoragePoolVolumeBackupPost represents the fields available for the renaming of a volume backup
1 property
StoragePoolVolumeBackupsPost
object
StoragePoolVolumeBackupsPost represents the fields available for a new LXD volume backup
6 properties
StoragePoolsPost
object
StoragePoolsPost represents the fields of a new LXD storage pool
4 properties
StorageVolume
object
11 properties
StorageVolumePost
object
StorageVolumePost represents the fields required to rename a LXD storage pool volume
7 properties
StorageVolumePostTarget
object
StorageVolumePostTarget represents the migration target host and operation
3 properties
StorageVolumePut
object
StorageVolumePut represents the modifiable fields of a LXD storage volume
3 properties
StorageVolumeSnapshot
object
StorageVolumeSnapshot represents a LXD storage volume snapshot
6 properties
StorageVolumeSnapshotPost
object
StorageVolumeSnapshotPost represents the fields required to rename/move a LXD storage volume snapshot
3 properties
StorageVolumeSnapshotPut
object
StorageVolumeSnapshotPut represents the modifiable fields of a LXD storage volume
2 properties
StorageVolumeSnapshotsPost
object
StorageVolumeSnapshotsPost represents the fields available for a new LXD storage volume snapshot
3 properties
StorageVolumeSource
object
StorageVolumeSource represents the creation source for a new storage volume
11 properties
StorageVolumeState
object
StorageVolumeState represents the live state of the volume
1 property
StorageVolumeStateUsage
object
StorageVolumeStateUsage represents the disk usage of a volume
2 properties
StorageVolumesPost
object
StorageVolumesPost represents the fields of a new LXD storage pool volume
7 properties
Warning
object
11 properties
WarningPut
object
1 property
WithEntitlements
object
that is, entities that can have access entitlements granted to the requesting user.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-lxd-rest-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
AE Profile APIs.io
Charmhub API
AE Profile APIs.io
snapd REST API
AE Profile APIs.io
MAAS API
AE Profile APIs.io
Juju Client / Controller API
AE Profile APIs.io
Launchpad Web Services API
AE Profile APIs.io
Ubuntu Pro Client API
AE Profile APIs.io
Landscape API
AE Profile APIs.io
Canonical Assertions API
AE Profile APIs.io
Canonical Search API
AE Profile APIs.io
Canonical Snaps API
AE Profile APIs.io
Ubuntu Security API
AE Profile APIs.io
#Containers#Virtualization#Infrastructure
← Back to L APIs
API Details
ID
canonical:lxd-rest-api
Base URL
https://:8443
Docs
https://documentation.ubuntu.com/lxd/latest/rest-api/
Provider
Canonical
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lxd-rest-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lxd-rest-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of LXD REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.