NetBox circuits API
The circuits API from NetBox — 24 operation(s) for circuits.
NetBox circuits API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include circuits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 101 operations across 24 paths, and defines 82 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).
Requests are made against the base URL https://demo.netbox.dev/api.
101 operations
24 paths
82 schemas
22 DELETE24 GET22 PATCH11 POST22 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox circuits 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 101
Across 24 paths, the API surfaces 101 operations — 22 DELETE, 24 GET, 22 PATCH, 11 POST, 22 PUT. Each is listed below with its method, path, parameters, and response codes.
circuits 101
GET
/api/circuits/circuit-group-assignments/
Get a list of Circuit group assignment objects.
POST
/api/circuits/circuit-group-assignments/
Post a list of Circuit group assignment objects.
PUT
/api/circuits/circuit-group-assignments/
Put a list of Circuit group assignment objects.
PATCH
/api/circuits/circuit-group-assignments/
Patch a list of Circuit group assignment objects.
DELETE
/api/circuits/circuit-group-assignments/
Delete a list of Circuit group assignment objects.
GET
/api/circuits/circuit-group-assignments/{id}/
Get a Circuit group assignment object.
PUT
/api/circuits/circuit-group-assignments/{id}/
Put a Circuit group assignment object.
PATCH
/api/circuits/circuit-group-assignments/{id}/
Patch a Circuit group assignment object.
DELETE
/api/circuits/circuit-group-assignments/{id}/
Delete a Circuit group assignment object.
GET
/api/circuits/circuit-groups/
Get a list of circuit group objects.
POST
/api/circuits/circuit-groups/
Post a list of circuit group objects.
PUT
/api/circuits/circuit-groups/
Put a list of circuit group objects.
PATCH
/api/circuits/circuit-groups/
Patch a list of circuit group objects.
DELETE
/api/circuits/circuit-groups/
Delete a list of circuit group objects.
GET
/api/circuits/circuit-groups/{id}/
Get a circuit group object.
PUT
/api/circuits/circuit-groups/{id}/
Put a circuit group object.
PATCH
/api/circuits/circuit-groups/{id}/
Patch a circuit group object.
DELETE
/api/circuits/circuit-groups/{id}/
Delete a circuit group object.
GET
/api/circuits/circuit-terminations/
Get a list of circuit termination objects.
POST
/api/circuits/circuit-terminations/
Post a list of circuit termination objects.
PUT
/api/circuits/circuit-terminations/
Put a list of circuit termination objects.
PATCH
/api/circuits/circuit-terminations/
Patch a list of circuit termination objects.
DELETE
/api/circuits/circuit-terminations/
Delete a list of circuit termination objects.
GET
/api/circuits/circuit-terminations/{id}/
Get a circuit termination object.
PUT
/api/circuits/circuit-terminations/{id}/
Put a circuit termination object.
PATCH
/api/circuits/circuit-terminations/{id}/
Patch a circuit termination object.
DELETE
/api/circuits/circuit-terminations/{id}/
Delete a circuit termination object.
GET
/api/circuits/circuit-terminations/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
GET
/api/circuits/circuit-types/
Get a list of circuit type objects.
POST
/api/circuits/circuit-types/
Post a list of circuit type objects.
PUT
/api/circuits/circuit-types/
Put a list of circuit type objects.
PATCH
/api/circuits/circuit-types/
Patch a list of circuit type objects.
DELETE
/api/circuits/circuit-types/
Delete a list of circuit type objects.
GET
/api/circuits/circuit-types/{id}/
Get a circuit type object.
PUT
/api/circuits/circuit-types/{id}/
Put a circuit type object.
PATCH
/api/circuits/circuit-types/{id}/
Patch a circuit type object.
DELETE
/api/circuits/circuit-types/{id}/
Delete a circuit type object.
GET
/api/circuits/circuits/
Get a list of circuit objects.
POST
/api/circuits/circuits/
Post a list of circuit objects.
PUT
/api/circuits/circuits/
Put a list of circuit objects.
PATCH
/api/circuits/circuits/
Patch a list of circuit objects.
DELETE
/api/circuits/circuits/
Delete a list of circuit objects.
GET
/api/circuits/circuits/{id}/
Get a circuit object.
PUT
/api/circuits/circuits/{id}/
Put a circuit object.
PATCH
/api/circuits/circuits/{id}/
Patch a circuit object.
DELETE
/api/circuits/circuits/{id}/
Delete a circuit object.
GET
/api/circuits/provider-accounts/
Get a list of provider account objects.
POST
/api/circuits/provider-accounts/
Post a list of provider account objects.
PUT
/api/circuits/provider-accounts/
Put a list of provider account objects.
PATCH
/api/circuits/provider-accounts/
Patch a list of provider account objects.
DELETE
/api/circuits/provider-accounts/
Delete a list of provider account objects.
GET
/api/circuits/provider-accounts/{id}/
Get a provider account object.
PUT
/api/circuits/provider-accounts/{id}/
Put a provider account object.
PATCH
/api/circuits/provider-accounts/{id}/
Patch a provider account object.
DELETE
/api/circuits/provider-accounts/{id}/
Delete a provider account object.
GET
/api/circuits/provider-networks/
Get a list of provider network objects.
POST
/api/circuits/provider-networks/
Post a list of provider network objects.
PUT
/api/circuits/provider-networks/
Put a list of provider network objects.
PATCH
/api/circuits/provider-networks/
Patch a list of provider network objects.
DELETE
/api/circuits/provider-networks/
Delete a list of provider network objects.
GET
/api/circuits/provider-networks/{id}/
Get a provider network object.
PUT
/api/circuits/provider-networks/{id}/
Put a provider network object.
PATCH
/api/circuits/provider-networks/{id}/
Patch a provider network object.
DELETE
/api/circuits/provider-networks/{id}/
Delete a provider network object.
GET
/api/circuits/providers/
Get a list of provider objects.
POST
/api/circuits/providers/
Post a list of provider objects.
PUT
/api/circuits/providers/
Put a list of provider objects.
PATCH
/api/circuits/providers/
Patch a list of provider objects.
DELETE
/api/circuits/providers/
Delete a list of provider objects.
GET
/api/circuits/providers/{id}/
Get a provider object.
PUT
/api/circuits/providers/{id}/
Put a provider object.
PATCH
/api/circuits/providers/{id}/
Patch a provider object.
DELETE
/api/circuits/providers/{id}/
Delete a provider object.
GET
/api/circuits/virtual-circuit-terminations/
Get a list of virtual circuit termination objects.
POST
/api/circuits/virtual-circuit-terminations/
Post a list of virtual circuit termination objects.
PUT
/api/circuits/virtual-circuit-terminations/
Put a list of virtual circuit termination objects.
PATCH
/api/circuits/virtual-circuit-terminations/
Patch a list of virtual circuit termination objects.
DELETE
/api/circuits/virtual-circuit-terminations/
Delete a list of virtual circuit termination objects.
GET
/api/circuits/virtual-circuit-terminations/{id}/
Get a virtual circuit termination object.
PUT
/api/circuits/virtual-circuit-terminations/{id}/
Put a virtual circuit termination object.
PATCH
/api/circuits/virtual-circuit-terminations/{id}/
Patch a virtual circuit termination object.
DELETE
/api/circuits/virtual-circuit-terminations/{id}/
Delete a virtual circuit termination object.
GET
/api/circuits/virtual-circuit-terminations/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
GET
/api/circuits/virtual-circuit-types/
Get a list of virtual circuit type objects.
POST
/api/circuits/virtual-circuit-types/
Post a list of virtual circuit type objects.
PUT
/api/circuits/virtual-circuit-types/
Put a list of virtual circuit type objects.
PATCH
/api/circuits/virtual-circuit-types/
Patch a list of virtual circuit type objects.
DELETE
/api/circuits/virtual-circuit-types/
Delete a list of virtual circuit type objects.
GET
/api/circuits/virtual-circuit-types/{id}/
Get a virtual circuit type object.
PUT
/api/circuits/virtual-circuit-types/{id}/
Put a virtual circuit type object.
PATCH
/api/circuits/virtual-circuit-types/{id}/
Patch a virtual circuit type object.
DELETE
/api/circuits/virtual-circuit-types/{id}/
Delete a virtual circuit type object.
GET
/api/circuits/virtual-circuits/
Get a list of virtual circuit objects.
POST
/api/circuits/virtual-circuits/
Post a list of virtual circuit objects.
PUT
/api/circuits/virtual-circuits/
Put a list of virtual circuit objects.
PATCH
/api/circuits/virtual-circuits/
Patch a list of virtual circuit objects.
DELETE
/api/circuits/virtual-circuits/
Delete a list of virtual circuit objects.
GET
/api/circuits/virtual-circuits/{id}/
Get a virtual circuit object.
PUT
/api/circuits/virtual-circuits/{id}/
Put a virtual circuit object.
PATCH
/api/circuits/virtual-circuits/{id}/
Patch a virtual circuit object.
DELETE
/api/circuits/virtual-circuits/{id}/
Delete a virtual circuit object.
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are Circuit (25 properties), CircuitTermination (24 properties), CircuitRequest (17 properties), ASN (17 properties). Each schema is shown below with its type and property counts.
BriefProviderNetwork
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
PatchedVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
BriefProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefCircuitGroupAssignmentSerializer_Request
object
Base serializer for group assignments under CircuitSerializer.
2 properties
1 required
Provider
object
Base serializer class for models inheriting from PrimaryModel.
16 properties
9 required
PaginatedProviderList
object
4 properties
2 required
PaginatedProviderAccountList
object
4 properties
2 required
PaginatedCircuitTerminationList
object
4 properties
2 required
PatchedProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
CircuitCircuitTermination
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…
11 properties
5 required
PaginatedCircuitList
object
4 properties
2 required
BriefVirtualCircuit
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefCircuit
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
WritableVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties
2 required
BriefProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 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
BriefProviderAccount
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
4 required
VirtualCircuitTermination
object
Adds support for custom fields and tags.
12 properties
8 required
ProviderAccount
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
8 required
WritableCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties
3 required
ProviderNetwork
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
8 required
VirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
BriefCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
BriefVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PatchedProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PaginatedVirtualCircuitTypeList
object
4 properties
2 required
CircuitTerminationRequest
object
Adds support for custom fields and tags.
12 properties
2 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
PaginatedProviderNetworkList
object
4 properties
2 required
BriefCircuitGroup
object
Base serializer class for models inheriting from OrganizationalModel.
4 properties
4 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
BriefCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
1 property
1 required
BriefCircuitGroupAssignmentSerializer_
object
Base serializer for group assignments under CircuitSerializer.
5 properties
4 required
PaginatedVirtualCircuitTerminationList
object
4 properties
2 required
VirtualCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
BriefProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PatchedWritableVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties
Circuit
object
Base serializer class for models inheriting from PrimaryModel.
25 properties
11 required
CircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
3 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
PaginatedVirtualCircuitList
object
4 properties
2 required
ProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
2 required
PatchedWritableCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
CircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties
3 required
CircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
PaginatedCircuitTypeList
object
4 properties
2 required
PaginatedCircuitGroupAssignmentList
object
4 properties
2 required
BriefVirtualCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
PatchedCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
PatchedCircuitTerminationRequest
object
Adds support for custom fields and tags.
12 properties
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
CircuitTermination
object
Adds support for custom fields and tags.
24 properties
14 required
BriefInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties
2 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
ProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
2 required
PatchedWritableCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties
PaginatedCircuitGroupList
object
4 properties
2 required
CircuitGroup
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
ASNSite
object
This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.
6 properties
5 required
PatchedCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
CircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
WritableCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
3 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
BriefCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
CircuitGroupAssignment
object
Base serializer for group assignments under CircuitSerializer.
12 properties
10 required
WritableVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
VirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties
2 required
CircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
BriefInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
7 required
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 required
PatchedWritableVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
BriefVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
VirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
NestedProviderAccount
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
BriefProvider
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
6 required
VirtualCircuit
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 required
PatchedProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
ProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
2 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 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 core API
NetBox dcim API
NetBox extras API
NetBox ipam API
NetBox schema API
NetBox status API
NetBox tenancy API
NetBox users API
NetBox virtualization API
NetBox vpn API
#circuits