Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox Labs

NetBox Labs circuits API

The circuits API from NetBox Labs — 24 operation(s) for circuits.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Labs circuits 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 circuits. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 101 operations across 24 paths, and defines 105 schemas. It is described by OpenAPI 3.0.3, at version 4.6.5 (4.6).

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

101 operations 24 paths 105 schemas 22 DELETE24 GET22 PATCH11 POST22 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
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 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.
circuits_circuit_group_assignments_list 68 params → 200
POST
/api/circuits/circuit-group-assignments/
Post a list of Circuit group assignment objects.
circuits_circuit_group_assignments_create body → 201
PUT
/api/circuits/circuit-group-assignments/
Put a list of Circuit group assignment objects.
circuits_circuit_group_assignments_bulk_update body → 200
PATCH
/api/circuits/circuit-group-assignments/
Patch a list of Circuit group assignment objects.
circuits_circuit_group_assignments_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-group-assignments/
Delete a list of Circuit group assignment objects.
circuits_circuit_group_assignments_bulk_destroy body → 204
GET
/api/circuits/circuit-group-assignments/{id}/
Get a Circuit group assignment object.
circuits_circuit_group_assignments_retrieve 4 params → 200
PUT
/api/circuits/circuit-group-assignments/{id}/
Put a Circuit group assignment object.
circuits_circuit_group_assignments_update 1 param body → 200
PATCH
/api/circuits/circuit-group-assignments/{id}/
Patch a Circuit group assignment object.
circuits_circuit_group_assignments_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-group-assignments/{id}/
Delete a Circuit group assignment object.
circuits_circuit_group_assignments_destroy 1 param → 204
GET
/api/circuits/circuit-groups/
Get a list of circuit group objects.
circuits_circuit_groups_list 91 params → 200
POST
/api/circuits/circuit-groups/
Post a list of circuit group objects.
circuits_circuit_groups_create body → 201
PUT
/api/circuits/circuit-groups/
Put a list of circuit group objects.
circuits_circuit_groups_bulk_update body → 200
PATCH
/api/circuits/circuit-groups/
Patch a list of circuit group objects.
circuits_circuit_groups_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-groups/
Delete a list of circuit group objects.
circuits_circuit_groups_bulk_destroy body → 204
GET
/api/circuits/circuit-groups/{id}/
Get a circuit group object.
circuits_circuit_groups_retrieve 4 params → 200
PUT
/api/circuits/circuit-groups/{id}/
Put a circuit group object.
circuits_circuit_groups_update 1 param body → 200
PATCH
/api/circuits/circuit-groups/{id}/
Patch a circuit group object.
circuits_circuit_groups_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-groups/{id}/
Delete a circuit group object.
circuits_circuit_groups_destroy 1 param → 204
GET
/api/circuits/circuit-terminations/
Get a list of circuit termination objects.
circuits_circuit_terminations_list 160 params → 200
POST
/api/circuits/circuit-terminations/
Post a list of circuit termination objects.
circuits_circuit_terminations_create body → 201
PUT
/api/circuits/circuit-terminations/
Put a list of circuit termination objects.
circuits_circuit_terminations_bulk_update body → 200
PATCH
/api/circuits/circuit-terminations/
Patch a list of circuit termination objects.
circuits_circuit_terminations_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-terminations/
Delete a list of circuit termination objects.
circuits_circuit_terminations_bulk_destroy body → 204
GET
/api/circuits/circuit-terminations/{id}/
Get a circuit termination object.
circuits_circuit_terminations_retrieve 4 params → 200
PUT
/api/circuits/circuit-terminations/{id}/
Put a circuit termination object.
circuits_circuit_terminations_update 1 param body → 200
PATCH
/api/circuits/circuit-terminations/{id}/
Patch a circuit termination object.
circuits_circuit_terminations_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-terminations/{id}/
Delete a circuit termination object.
circuits_circuit_terminations_destroy 1 param → 204
GET
/api/circuits/circuit-terminations/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
circuits_circuit_terminations_paths_retrieve 4 params → 200
GET
/api/circuits/circuit-types/
Get a list of circuit type objects.
circuits_circuit_types_list 96 params → 200
POST
/api/circuits/circuit-types/
Post a list of circuit type objects.
circuits_circuit_types_create body → 201
PUT
/api/circuits/circuit-types/
Put a list of circuit type objects.
circuits_circuit_types_bulk_update body → 200
PATCH
/api/circuits/circuit-types/
Patch a list of circuit type objects.
circuits_circuit_types_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-types/
Delete a list of circuit type objects.
circuits_circuit_types_bulk_destroy body → 204
GET
/api/circuits/circuit-types/{id}/
Get a circuit type object.
circuits_circuit_types_retrieve 4 params → 200
PUT
/api/circuits/circuit-types/{id}/
Put a circuit type object.
circuits_circuit_types_update 1 param body → 200
PATCH
/api/circuits/circuit-types/{id}/
Patch a circuit type object.
circuits_circuit_types_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-types/{id}/
Delete a circuit type object.
circuits_circuit_types_destroy 1 param → 204
GET
/api/circuits/circuits/
Get a list of circuit objects.
circuits_circuits_list 170 params → 200
POST
/api/circuits/circuits/
Post a list of circuit objects.
circuits_circuits_create body → 201
PUT
/api/circuits/circuits/
Put a list of circuit objects.
circuits_circuits_bulk_update body → 200
PATCH
/api/circuits/circuits/
Patch a list of circuit objects.
circuits_circuits_bulk_partial_update body → 200
DELETE
/api/circuits/circuits/
Delete a list of circuit objects.
circuits_circuits_bulk_destroy body → 204
GET
/api/circuits/circuits/{id}/
Get a circuit object.
circuits_circuits_retrieve 4 params → 200
PUT
/api/circuits/circuits/{id}/
Put a circuit object.
circuits_circuits_update 1 param body → 200
PATCH
/api/circuits/circuits/{id}/
Patch a circuit object.
circuits_circuits_partial_update 1 param body → 200
DELETE
/api/circuits/circuits/{id}/
Delete a circuit object.
circuits_circuits_destroy 1 param → 204
GET
/api/circuits/provider-accounts/
Get a list of provider account objects.
circuits_provider_accounts_list 93 params → 200
POST
/api/circuits/provider-accounts/
Post a list of provider account objects.
circuits_provider_accounts_create body → 201
PUT
/api/circuits/provider-accounts/
Put a list of provider account objects.
circuits_provider_accounts_bulk_update body → 200
PATCH
/api/circuits/provider-accounts/
Patch a list of provider account objects.
circuits_provider_accounts_bulk_partial_update body → 200
DELETE
/api/circuits/provider-accounts/
Delete a list of provider account objects.
circuits_provider_accounts_bulk_destroy body → 204
GET
/api/circuits/provider-accounts/{id}/
Get a provider account object.
circuits_provider_accounts_retrieve 4 params → 200
PUT
/api/circuits/provider-accounts/{id}/
Put a provider account object.
circuits_provider_accounts_update 1 param body → 200
PATCH
/api/circuits/provider-accounts/{id}/
Patch a provider account object.
circuits_provider_accounts_partial_update 1 param body → 200
DELETE
/api/circuits/provider-accounts/{id}/
Delete a provider account object.
circuits_provider_accounts_destroy 1 param → 204
GET
/api/circuits/provider-networks/
Get a list of provider network objects.
circuits_provider_networks_list 87 params → 200
POST
/api/circuits/provider-networks/
Post a list of provider network objects.
circuits_provider_networks_create body → 201
PUT
/api/circuits/provider-networks/
Put a list of provider network objects.
circuits_provider_networks_bulk_update body → 200
PATCH
/api/circuits/provider-networks/
Patch a list of provider network objects.
circuits_provider_networks_bulk_partial_update body → 200
DELETE
/api/circuits/provider-networks/
Delete a list of provider network objects.
circuits_provider_networks_bulk_destroy body → 204
GET
/api/circuits/provider-networks/{id}/
Get a provider network object.
circuits_provider_networks_retrieve 4 params → 200
PUT
/api/circuits/provider-networks/{id}/
Put a provider network object.
circuits_provider_networks_update 1 param body → 200
PATCH
/api/circuits/provider-networks/{id}/
Patch a provider network object.
circuits_provider_networks_partial_update 1 param body → 200
DELETE
/api/circuits/provider-networks/{id}/
Delete a provider network object.
circuits_provider_networks_destroy 1 param → 204
GET
/api/circuits/providers/
Get a list of provider objects.
circuits_providers_list 105 params → 200
POST
/api/circuits/providers/
Post a list of provider objects.
circuits_providers_create body → 201
PUT
/api/circuits/providers/
Put a list of provider objects.
circuits_providers_bulk_update body → 200
PATCH
/api/circuits/providers/
Patch a list of provider objects.
circuits_providers_bulk_partial_update body → 200
DELETE
/api/circuits/providers/
Delete a list of provider objects.
circuits_providers_bulk_destroy body → 204
GET
/api/circuits/providers/{id}/
Get a provider object.
circuits_providers_retrieve 4 params → 200
PUT
/api/circuits/providers/{id}/
Put a provider object.
circuits_providers_update 1 param body → 200
PATCH
/api/circuits/providers/{id}/
Patch a provider object.
circuits_providers_partial_update 1 param body → 200
DELETE
/api/circuits/providers/{id}/
Delete a provider object.
circuits_providers_destroy 1 param → 204
GET
/api/circuits/virtual-circuit-terminations/
Get a list of virtual circuit termination objects.
circuits_virtual_circuit_terminations_list 76 params → 200
POST
/api/circuits/virtual-circuit-terminations/
Post a list of virtual circuit termination objects.
circuits_virtual_circuit_terminations_create body → 201
PUT
/api/circuits/virtual-circuit-terminations/
Put a list of virtual circuit termination objects.
circuits_virtual_circuit_terminations_bulk_update body → 200
PATCH
/api/circuits/virtual-circuit-terminations/
Patch a list of virtual circuit termination objects.
circuits_virtual_circuit_terminations_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuit-terminations/
Delete a list of virtual circuit termination objects.
circuits_virtual_circuit_terminations_bulk_destroy body → 204
GET
/api/circuits/virtual-circuit-terminations/{id}/
Get a virtual circuit termination object.
circuits_virtual_circuit_terminations_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuit-terminations/{id}/
Put a virtual circuit termination object.
circuits_virtual_circuit_terminations_update 1 param body → 200
PATCH
/api/circuits/virtual-circuit-terminations/{id}/
Patch a virtual circuit termination object.
circuits_virtual_circuit_terminations_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuit-terminations/{id}/
Delete a virtual circuit termination object.
circuits_virtual_circuit_terminations_destroy 1 param → 204
GET
/api/circuits/virtual-circuit-terminations/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
circuits_virtual_circuit_terminations_paths_retrieve 4 params → 200
GET
/api/circuits/virtual-circuit-types/
Get a list of virtual circuit type objects.
circuits_virtual_circuit_types_list 96 params → 200
POST
/api/circuits/virtual-circuit-types/
Post a list of virtual circuit type objects.
circuits_virtual_circuit_types_create body → 201
PUT
/api/circuits/virtual-circuit-types/
Put a list of virtual circuit type objects.
circuits_virtual_circuit_types_bulk_update body → 200
PATCH
/api/circuits/virtual-circuit-types/
Patch a list of virtual circuit type objects.
circuits_virtual_circuit_types_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuit-types/
Delete a list of virtual circuit type objects.
circuits_virtual_circuit_types_bulk_destroy body → 204
GET
/api/circuits/virtual-circuit-types/{id}/
Get a virtual circuit type object.
circuits_virtual_circuit_types_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuit-types/{id}/
Put a virtual circuit type object.
circuits_virtual_circuit_types_update 1 param body → 200
PATCH
/api/circuits/virtual-circuit-types/{id}/
Patch a virtual circuit type object.
circuits_virtual_circuit_types_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuit-types/{id}/
Delete a virtual circuit type object.
circuits_virtual_circuit_types_destroy 1 param → 204
GET
/api/circuits/virtual-circuits/
Get a list of virtual circuit objects.
circuits_virtual_circuits_list 105 params → 200
POST
/api/circuits/virtual-circuits/
Post a list of virtual circuit objects.
circuits_virtual_circuits_create body → 201
PUT
/api/circuits/virtual-circuits/
Put a list of virtual circuit objects.
circuits_virtual_circuits_bulk_update body → 200
PATCH
/api/circuits/virtual-circuits/
Patch a list of virtual circuit objects.
circuits_virtual_circuits_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuits/
Delete a list of virtual circuit objects.
circuits_virtual_circuits_bulk_destroy body → 204
GET
/api/circuits/virtual-circuits/{id}/
Get a virtual circuit object.
circuits_virtual_circuits_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuits/{id}/
Put a virtual circuit object.
circuits_virtual_circuits_update 1 param body → 200
PATCH
/api/circuits/virtual-circuits/{id}/
Patch a virtual circuit object.
circuits_virtual_circuits_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuits/{id}/
Delete a virtual circuit object.
circuits_virtual_circuits_destroy 1 param → 204

Schemas 105

The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are Circuit (25 properties), CircuitTermination (24 properties), ASN (18 properties), BulkCircuitRequest (18 properties). Each schema is shown below with its type and property counts.

BulkCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 4 required
PatchedProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
CircuitTermination
object
Adds support for custom fields and tags.
24 properties 14 required
BriefProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
WritableVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
ASN
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 9 required
PaginatedVirtualCircuitTerminationList
object
4 properties 2 required
PaginatedCircuitGroupAssignmentList
object
4 properties 2 required
BriefInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 7 required
BulkProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 3 required
PatchedBulkProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
PaginatedCircuitTerminationList
object
4 properties 2 required
BriefProviderNetwork
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
VirtualCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
CircuitGroup
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
BriefCircuit
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefVirtualCircuit
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritableCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties
BulkCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 3 required
BriefCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedWritableVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
PatchedVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
CircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
BriefCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
1 property 1 required
PatchedCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
PatchedBulkCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 1 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
VirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
BulkCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 3 required
WritableCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties 3 required
BriefProvider
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
CircuitGroupAssignment
object
Base serializer for group assignments under CircuitSerializer.
12 properties 10 required
PatchedProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
BriefInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties 2 required
CircuitTerminationRequest
object
Adds support for custom fields and tags.
12 properties 2 required
PatchedBulkProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
CircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
PatchedBulkCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 1 required
PaginatedProviderList
object
4 properties 2 required
VirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties 2 required
VirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
BriefCircuitGroup
object
Base serializer class for models inheriting from OrganizationalModel.
4 properties 4 required
PaginatedCircuitGroupList
object
4 properties 2 required
BriefCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
VirtualCircuit
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 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
ProviderNetwork
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 8 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
PatchedCircuitTerminationRequest
object
Adds support for custom fields and tags.
12 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
BriefVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
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
BulkVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 3 required
BriefCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
PaginatedProviderNetworkList
object
4 properties 2 required
CircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
5 properties 3 required
BulkProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 3 required
ProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
PatchedBulkCircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 1 required
PatchedWritableVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties
BulkProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 3 required
BriefVirtualCircuitType
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedBulkCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
6 properties 1 required
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
WritableVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
6 properties 2 required
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedWritableCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 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
BriefProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
BriefCircuitGroupAssignmentSerializer_Request
object
Base serializer for group assignments under CircuitSerializer.
2 properties 1 required
ProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
BulkCircuitTerminationRequest
object
Adds support for custom fields and tags.
13 properties 3 required
CircuitGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
PatchedCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
BriefCircuitGroupAssignmentSerializer_
object
Base serializer for group assignments under CircuitSerializer.
5 properties 4 required
PaginatedVirtualCircuitTypeList
object
4 properties 2 required
PatchedBulkVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 1 required
BriefVirtualCircuitTypeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
BulkVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
7 properties 3 required
PatchedBulkCircuitTerminationRequest
object
Adds support for custom fields and tags.
13 properties 1 required
WritableCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 3 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
PatchedBulkVirtualCircuitTerminationRequest
object
Adds support for custom fields and tags.
7 properties 1 required
PatchedBulkProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedBulkVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
ProviderRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
BriefProviderAccountRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
ProviderAccount
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 8 required
PaginatedProviderAccountList
object
4 properties 2 required
BulkCircuitGroupAssignmentRequest
object
Base serializer for group assignments under CircuitSerializer.
6 properties 4 required
PaginatedCircuitTypeList
object
4 properties 2 required
Provider
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
BriefProviderAccount
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 4 required
PaginatedVirtualCircuitList
object
4 properties 2 required
VirtualCircuitTermination
object
Adds support for custom fields and tags.
12 properties 8 required
BulkVirtualCircuitRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 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
PaginatedCircuitList
object
4 properties 2 required
PatchedProviderNetworkRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs NetBox Labs publishes across the network.

NetBox Labs authentication-check API
AE Profile APIs.io
NetBox Labs core API
AE Profile APIs.io
NetBox Labs dcim API
AE Profile APIs.io
NetBox Labs extras API
AE Profile APIs.io
NetBox Labs ipam API
AE Profile APIs.io
NetBox Labs schema API
AE Profile APIs.io
NetBox Labs status API
AE Profile APIs.io
NetBox Labs tenancy API
AE Profile APIs.io
NetBox Labs users API
AE Profile APIs.io
NetBox Labs virtualization API
AE Profile APIs.io
NetBox Labs vpn API
AE Profile APIs.io
NetBox Labs wireless API
AE Profile APIs.io
#circuits
← Back to N APIs
API Details
ID
netbox-labs:netbox-labs-circuits-api
Base URL
https://demo.netbox.dev/api/
Docs
https://netboxlabs.com/docs/netbox/integrations/rest-api/
Provider
NetBox Labs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network