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

NetBox Labs Virtualization API

The virtualization API from NetBox Labs — 15 operation(s) for virtualization.

NetBox Labs Virtualization API is one of 13 APIs that NetBox Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtualization. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 64 operations across 15 paths, and defines 94 schemas. It is described by OpenAPI 3.2.0, at version 4.6.5 (4.6).

Requests are made against the base URL https://demo.netbox.dev/api/.

64 operations 15 paths 94 schemas 14 DELETE14 GET14 PATCH8 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.6.5 (4.6)
Base URL
https://demo.netbox.dev/api/
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox Labs Virtualization API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 64

Across 15 paths, the API surfaces 64 operations — 14 DELETE, 14 GET, 14 PATCH, 8 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

virtualization 64
GET
/api/virtualization/cluster-groups/
Virtualization cluster groups list
virtualization_cluster_groups_list 89 params → 200
POST
/api/virtualization/cluster-groups/
Virtualization cluster groups create
virtualization_cluster_groups_create body → 201
PUT
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk update
virtualization_cluster_groups_bulk_update body → 200
PATCH
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk partial update
virtualization_cluster_groups_bulk_partial_update body → 200
DELETE
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk destroy
virtualization_cluster_groups_bulk_destroy body → 204
GET
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups retrieve
virtualization_cluster_groups_retrieve 4 params → 200
PUT
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups update
virtualization_cluster_groups_update 1 param body → 200
PATCH
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups partial update
virtualization_cluster_groups_partial_update 1 param body → 200
DELETE
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups destroy
virtualization_cluster_groups_destroy 1 param → 204
GET
/api/virtualization/cluster-types/
Virtualization cluster types list
virtualization_cluster_types_list 83 params → 200
POST
/api/virtualization/cluster-types/
Virtualization cluster types create
virtualization_cluster_types_create body → 201
PUT
/api/virtualization/cluster-types/
Virtualization cluster types bulk update
virtualization_cluster_types_bulk_update body → 200
PATCH
/api/virtualization/cluster-types/
Virtualization cluster types bulk partial update
virtualization_cluster_types_bulk_partial_update body → 200
DELETE
/api/virtualization/cluster-types/
Virtualization cluster types bulk destroy
virtualization_cluster_types_bulk_destroy body → 204
GET
/api/virtualization/cluster-types/{id}/
Virtualization cluster types retrieve
virtualization_cluster_types_retrieve 4 params → 200
PUT
/api/virtualization/cluster-types/{id}/
Virtualization cluster types update
virtualization_cluster_types_update 1 param body → 200
PATCH
/api/virtualization/cluster-types/{id}/
Virtualization cluster types partial update
virtualization_cluster_types_partial_update 1 param body → 200
DELETE
/api/virtualization/cluster-types/{id}/
Virtualization cluster types destroy
virtualization_cluster_types_destroy 1 param → 204
GET
/api/virtualization/clusters/
Virtualization clusters list
virtualization_clusters_list 130 params → 200
POST
/api/virtualization/clusters/
Virtualization clusters create
virtualization_clusters_create body → 201
PUT
/api/virtualization/clusters/
Virtualization clusters bulk update
virtualization_clusters_bulk_update body → 200
PATCH
/api/virtualization/clusters/
Virtualization clusters bulk partial update
virtualization_clusters_bulk_partial_update body → 200
DELETE
/api/virtualization/clusters/
Virtualization clusters bulk destroy
virtualization_clusters_bulk_destroy body → 204
GET
/api/virtualization/clusters/{id}/
Virtualization clusters retrieve
virtualization_clusters_retrieve 4 params → 200
PUT
/api/virtualization/clusters/{id}/
Virtualization clusters update
virtualization_clusters_update 1 param body → 200
PATCH
/api/virtualization/clusters/{id}/
Virtualization clusters partial update
virtualization_clusters_partial_update 1 param body → 200
DELETE
/api/virtualization/clusters/{id}/
Virtualization clusters destroy
virtualization_clusters_destroy 1 param → 204
GET
/api/virtualization/interfaces/
Virtualization interfaces list
virtualization_interfaces_list 133 params → 200
POST
/api/virtualization/interfaces/
Virtualization interfaces create
virtualization_interfaces_create body → 201
PUT
/api/virtualization/interfaces/
Virtualization interfaces bulk update
virtualization_interfaces_bulk_update body → 200
PATCH
/api/virtualization/interfaces/
Virtualization interfaces bulk partial update
virtualization_interfaces_bulk_partial_update body → 200
DELETE
/api/virtualization/interfaces/
Virtualization interfaces bulk destroy
virtualization_interfaces_bulk_destroy body → 204
GET
/api/virtualization/interfaces/{id}/
Virtualization interfaces retrieve
virtualization_interfaces_retrieve 4 params → 200
PUT
/api/virtualization/interfaces/{id}/
Virtualization interfaces update
virtualization_interfaces_update 1 param body → 200
PATCH
/api/virtualization/interfaces/{id}/
Virtualization interfaces partial update
virtualization_interfaces_partial_update 1 param body → 200
DELETE
/api/virtualization/interfaces/{id}/
Virtualization interfaces destroy
virtualization_interfaces_destroy 1 param → 204
GET
/api/virtualization/virtual-disks/
Virtualization virtual disks list
virtualization_virtual_disks_list 81 params → 200
POST
/api/virtualization/virtual-disks/
Virtualization virtual disks create
virtualization_virtual_disks_create body → 201
PUT
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk update
virtualization_virtual_disks_bulk_update body → 200
PATCH
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk partial update
virtualization_virtual_disks_bulk_partial_update body → 200
DELETE
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk destroy
virtualization_virtual_disks_bulk_destroy body → 204
GET
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks retrieve
virtualization_virtual_disks_retrieve 4 params → 200
PUT
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks update
virtualization_virtual_disks_update 1 param body → 200
PATCH
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks partial update
virtualization_virtual_disks_partial_update 1 param body → 200
DELETE
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks destroy
virtualization_virtual_disks_destroy 1 param → 204
GET
/api/virtualization/virtual-machine-types/
Virtualization virtual machine types list
virtualization_virtual_machine_types_list 108 params → 200
POST
/api/virtualization/virtual-machine-types/
Virtualization virtual machine types create
virtualization_virtual_machine_types_create body → 201
PUT
/api/virtualization/virtual-machine-types/
Virtualization virtual machine types bulk update
virtualization_virtual_machine_types_bulk_update body → 200
PATCH
/api/virtualization/virtual-machine-types/
Virtualization virtual machine types bulk partial update
virtualization_virtual_machine_types_bulk_partial_update body → 200
DELETE
/api/virtualization/virtual-machine-types/
Virtualization virtual machine types bulk destroy
virtualization_virtual_machine_types_bulk_destroy body → 204
GET
/api/virtualization/virtual-machine-types/{id}/
Virtualization virtual machine types retrieve
virtualization_virtual_machine_types_retrieve 4 params → 200
PUT
/api/virtualization/virtual-machine-types/{id}/
Virtualization virtual machine types update
virtualization_virtual_machine_types_update 1 param body → 200
PATCH
/api/virtualization/virtual-machine-types/{id}/
Virtualization virtual machine types partial update
virtualization_virtual_machine_types_partial_update 1 param body → 200
DELETE
/api/virtualization/virtual-machine-types/{id}/
Virtualization virtual machine types destroy
virtualization_virtual_machine_types_destroy 1 param → 204
GET
/api/virtualization/virtual-machines/
Virtualization virtual machines list
virtualization_virtual_machines_list 222 params → 200
POST
/api/virtualization/virtual-machines/
Virtualization virtual machines create
virtualization_virtual_machines_create body → 201
PUT
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk update
virtualization_virtual_machines_bulk_update body → 200
PATCH
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk partial update
virtualization_virtual_machines_bulk_partial_update body → 200
DELETE
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk destroy
virtualization_virtual_machines_bulk_destroy body → 204
GET
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines retrieve
virtualization_virtual_machines_retrieve 4 params → 200
PUT
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines update
virtualization_virtual_machines_update 1 param body → 200
PATCH
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines partial update
virtualization_virtual_machines_partial_update 1 param body → 200
DELETE
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines destroy
virtualization_virtual_machines_destroy 1 param → 204
POST
/api/virtualization/virtual-machines/{id}/render-config/
Virtualization virtual machines render config create
virtualization_virtual_machines_render_config_create 2 params body → 200400500

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are VirtualMachineWithConfigContext (33 properties), VMInterface (28 properties), PatchedBulkVirtualMachineWithConfigContextRequest (24 properties), Cluster (24 properties). Each schema is shown below with its type and property counts.

NestedIPAddressRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
BulkClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 3 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
PaginatedVirtualMachineTypeList
object
4 properties 2 required
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
ClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
RenderConfigInputRequest
object
Describes the request body for the device/VM /render-config/ endpoints. Any additional keys supplied are passed through as context variables to the rendered te…
1 property
BriefClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
VirtualDisk
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 9 required
PatchedBulkVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 1 required
PatchedBulkClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 1 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 4 required
BriefVirtualMachineRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
VirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
23 properties 1 required
BulkVirtualMachineTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 10 required
PatchedBulkVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
18 properties 1 required
BriefPlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
BriefClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
BriefVirtualMachine
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 6 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
WritableVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties 2 required
PatchedWritableVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
23 properties
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
RenderedConfig
object
Describes the JSON response returned by the /render-config/ and /render/ endpoints.
2 properties 2 required
VMInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
28 properties 13 required
PaginatedClusterTypeList
object
4 properties 2 required
Cluster
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 14 required
BriefClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
VirtualMachineTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
BulkClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 3 required
WritableVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
23 properties 1 required
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
NestedVLAN
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 5 required
BriefVirtualMachineType
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PaginatedClusterList
object
4 properties 2 required
BriefVirtualMachineTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedVirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PaginatedVMInterfaceList
object
4 properties 2 required
ClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
WritableClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
BriefConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties 1 required
BulkVirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 4 required
NestedTag
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 6 required
PatchedWritableVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
VirtualMachineWithConfigContext
object
Base serializer class for models inheriting from PrimaryModel.
33 properties 11 required
VirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties 3 required
BulkClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 3 required
BriefVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
ClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
BriefCluster
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
ClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
PatchedBulkClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 1 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BulkVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 2 required
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties 4 required
NestedVMInterface
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 6 required
PatchedBulkVirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 1 required
BriefMACAddress
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties 4 required
PaginatedClusterGroupList
object
4 properties 2 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 1 required
PatchedBulkClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 1 required
PaginatedVirtualDiskList
object
4 properties 2 required
BriefVLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PatchedWritableClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
BriefClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
NestedVMInterfaceRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedBulkVirtualMachineTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
VMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties 2 required
NestedIPAddress
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 6 required
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BulkVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
18 properties 3 required
BriefClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
ClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
PaginatedVirtualMachineWithConfigContextList
object
4 properties 2 required
NestedVirtualMachine
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
BriefMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefDeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
PatchedVirtualMachineTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
VirtualMachineType
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-virtualization-api-openapi.yml Raw ↑

Other APIs NetBox Labs publishes across the network.

NetBox Labs Authentication Check API
NetBox Labs Circuits API
NetBox Labs Core API
NetBox Labs Dcim API
NetBox Labs Extras API
NetBox Labs Ipam API
NetBox Labs Schema API
NetBox Labs Status API
NetBox Labs Tenancy API
NetBox Labs Users API
NetBox Labs Vpn API
NetBox Labs Wireless API
Where this information came from

This is an independent, third-party profile of NetBox Labs Virtualization 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.