NetBox Virtualization API
The virtualization API from NetBox — 13 operation(s) for virtualization.
NetBox Virtualization API is one of 14 APIs that NetBox 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, API documentation, and authentication docs.
This API exposes 55 operations across 13 paths, and defines 70 schemas. It is described by OpenAPI 3.2.0, at version 4.5.9 (4.5).
Requests are made against the base URL https://demo.netbox.dev/api.
55 operations
13 paths
70 schemas
12 DELETE12 GET12 PATCH7 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox 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 55
Across 13 paths, the API surfaces 55 operations — 12 DELETE, 12 GET, 12 PATCH, 7 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
virtualization 55
GET
/api/virtualization/cluster-groups/
Virtualization cluster groups list
POST
/api/virtualization/cluster-groups/
Virtualization cluster groups create
PUT
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk update
PATCH
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk partial update
DELETE
/api/virtualization/cluster-groups/
Virtualization cluster groups bulk destroy
GET
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups retrieve
PUT
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups update
PATCH
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups partial update
DELETE
/api/virtualization/cluster-groups/{id}/
Virtualization cluster groups destroy
GET
/api/virtualization/cluster-types/
Virtualization cluster types list
POST
/api/virtualization/cluster-types/
Virtualization cluster types create
PUT
/api/virtualization/cluster-types/
Virtualization cluster types bulk update
PATCH
/api/virtualization/cluster-types/
Virtualization cluster types bulk partial update
DELETE
/api/virtualization/cluster-types/
Virtualization cluster types bulk destroy
GET
/api/virtualization/cluster-types/{id}/
Virtualization cluster types retrieve
PUT
/api/virtualization/cluster-types/{id}/
Virtualization cluster types update
PATCH
/api/virtualization/cluster-types/{id}/
Virtualization cluster types partial update
DELETE
/api/virtualization/cluster-types/{id}/
Virtualization cluster types destroy
GET
/api/virtualization/clusters/
Virtualization clusters list
POST
/api/virtualization/clusters/
Virtualization clusters create
PUT
/api/virtualization/clusters/
Virtualization clusters bulk update
PATCH
/api/virtualization/clusters/
Virtualization clusters bulk partial update
DELETE
/api/virtualization/clusters/
Virtualization clusters bulk destroy
GET
/api/virtualization/clusters/{id}/
Virtualization clusters retrieve
PUT
/api/virtualization/clusters/{id}/
Virtualization clusters update
PATCH
/api/virtualization/clusters/{id}/
Virtualization clusters partial update
DELETE
/api/virtualization/clusters/{id}/
Virtualization clusters destroy
GET
/api/virtualization/interfaces/
Virtualization interfaces list
POST
/api/virtualization/interfaces/
Virtualization interfaces create
PUT
/api/virtualization/interfaces/
Virtualization interfaces bulk update
PATCH
/api/virtualization/interfaces/
Virtualization interfaces bulk partial update
DELETE
/api/virtualization/interfaces/
Virtualization interfaces bulk destroy
GET
/api/virtualization/interfaces/{id}/
Virtualization interfaces retrieve
PUT
/api/virtualization/interfaces/{id}/
Virtualization interfaces update
PATCH
/api/virtualization/interfaces/{id}/
Virtualization interfaces partial update
DELETE
/api/virtualization/interfaces/{id}/
Virtualization interfaces destroy
GET
/api/virtualization/virtual-disks/
Virtualization virtual disks list
POST
/api/virtualization/virtual-disks/
Virtualization virtual disks create
PUT
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk update
PATCH
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk partial update
DELETE
/api/virtualization/virtual-disks/
Virtualization virtual disks bulk destroy
GET
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks retrieve
PUT
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks update
PATCH
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks partial update
DELETE
/api/virtualization/virtual-disks/{id}/
Virtualization virtual disks destroy
GET
/api/virtualization/virtual-machines/
Virtualization virtual machines list
POST
/api/virtualization/virtual-machines/
Virtualization virtual machines create
PUT
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk update
PATCH
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk partial update
DELETE
/api/virtualization/virtual-machines/
Virtualization virtual machines bulk destroy
GET
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines retrieve
PUT
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines update
PATCH
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines partial update
DELETE
/api/virtualization/virtual-machines/{id}/
Virtualization virtual machines destroy
POST
/api/virtualization/virtual-machines/{id}/render-config/
Virtualization virtual machines render config create
Schemas 70
The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are VirtualMachineWithConfigContext (32 properties), VMInterface (28 properties), Cluster (24 properties), VLAN (22 properties). Each schema is shown below with its type and property counts.
PaginatedClusterTypeList
object
4 properties
2 required
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
7 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
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
BriefConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties
1 required
BriefVirtualMachineRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
5 required
VMInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
28 properties
13 required
BriefCluster
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
WritableClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
2 required
Cluster
object
Base serializer class for models inheriting from PrimaryModel.
24 properties
14 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties
4 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
WritableVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
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
BriefClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
PatchedClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
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
BriefClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PatchedWritableVMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
ClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
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
PatchedWritableVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
VMInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 required
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
BriefVLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
10 required
VirtualMachineWithConfigContext
object
Base serializer class for models inheriting from PrimaryModel.
32 properties
11 required
VirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties
3 required
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 required
BriefPlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
BriefMACAddress
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 required
BriefClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
ClusterType
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties
9 required
ClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
2 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
BriefVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
WritableVirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
1 required
BriefVirtualMachine
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
VirtualMachineWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
1 required
VirtualDisk
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
9 required
PatchedWritableClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
PaginatedClusterGroupList
object
4 properties
2 required
PaginatedClusterList
object
4 properties
2 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
5 required
BriefMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PaginatedVirtualDiskList
object
4 properties
2 required
BriefClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
BriefDeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 required
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
ClusterGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties
9 required
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties
4 required
PaginatedVMInterfaceList
object
4 properties
2 required
PatchedVirtualDiskRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
7 properties
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
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
PaginatedVirtualMachineWithConfigContextList
object
4 properties
2 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PatchedClusterTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
ClusterGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.
NetBox GraphQL API
NetBox Authentication Check API
NetBox Circuits API
NetBox Core API
NetBox Dcim API
NetBox Extras API
NetBox Ipam API
NetBox Schema API
NetBox Status API
NetBox Tenancy API
NetBox Users API
NetBox Vpn API
#Virtualization
Where this information came from
This is an independent, third-party profile of NetBox 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.