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
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.2.0, 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.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 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/
Circuits circuit group assignments list
circuits_circuit_group_assignments_list 68 params → 200
POST
/api/circuits/circuit-group-assignments/
Circuits circuit group assignments create
circuits_circuit_group_assignments_create body → 201
PUT
/api/circuits/circuit-group-assignments/
Circuits circuit group assignments bulk update
circuits_circuit_group_assignments_bulk_update body → 200
PATCH
/api/circuits/circuit-group-assignments/
Circuits circuit group assignments bulk partial update
circuits_circuit_group_assignments_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-group-assignments/
Circuits circuit group assignments bulk destroy
circuits_circuit_group_assignments_bulk_destroy body → 204
GET
/api/circuits/circuit-group-assignments/{id}/
Circuits circuit group assignments retrieve
circuits_circuit_group_assignments_retrieve 4 params → 200
PUT
/api/circuits/circuit-group-assignments/{id}/
Circuits circuit group assignments update
circuits_circuit_group_assignments_update 1 param body → 200
PATCH
/api/circuits/circuit-group-assignments/{id}/
Circuits circuit group assignments partial update
circuits_circuit_group_assignments_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-group-assignments/{id}/
Circuits circuit group assignments destroy
circuits_circuit_group_assignments_destroy 1 param → 204
GET
/api/circuits/circuit-groups/
Circuits circuit groups list
circuits_circuit_groups_list 91 params → 200
POST
/api/circuits/circuit-groups/
Circuits circuit groups create
circuits_circuit_groups_create body → 201
PUT
/api/circuits/circuit-groups/
Circuits circuit groups bulk update
circuits_circuit_groups_bulk_update body → 200
PATCH
/api/circuits/circuit-groups/
Circuits circuit groups bulk partial update
circuits_circuit_groups_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-groups/
Circuits circuit groups bulk destroy
circuits_circuit_groups_bulk_destroy body → 204
GET
/api/circuits/circuit-groups/{id}/
Circuits circuit groups retrieve
circuits_circuit_groups_retrieve 4 params → 200
PUT
/api/circuits/circuit-groups/{id}/
Circuits circuit groups update
circuits_circuit_groups_update 1 param body → 200
PATCH
/api/circuits/circuit-groups/{id}/
Circuits circuit groups partial update
circuits_circuit_groups_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-groups/{id}/
Circuits circuit groups destroy
circuits_circuit_groups_destroy 1 param → 204
GET
/api/circuits/circuit-terminations/
Circuits circuit terminations list
circuits_circuit_terminations_list 160 params → 200
POST
/api/circuits/circuit-terminations/
Circuits circuit terminations create
circuits_circuit_terminations_create body → 201
PUT
/api/circuits/circuit-terminations/
Circuits circuit terminations bulk update
circuits_circuit_terminations_bulk_update body → 200
PATCH
/api/circuits/circuit-terminations/
Circuits circuit terminations bulk partial update
circuits_circuit_terminations_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-terminations/
Circuits circuit terminations bulk destroy
circuits_circuit_terminations_bulk_destroy body → 204
GET
/api/circuits/circuit-terminations/{id}/
Circuits circuit terminations retrieve
circuits_circuit_terminations_retrieve 4 params → 200
PUT
/api/circuits/circuit-terminations/{id}/
Circuits circuit terminations update
circuits_circuit_terminations_update 1 param body → 200
PATCH
/api/circuits/circuit-terminations/{id}/
Circuits circuit terminations partial update
circuits_circuit_terminations_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-terminations/{id}/
Circuits circuit terminations destroy
circuits_circuit_terminations_destroy 1 param → 204
GET
/api/circuits/circuit-terminations/{id}/paths/
Circuits circuit terminations paths retrieve
circuits_circuit_terminations_paths_retrieve 4 params → 200
GET
/api/circuits/circuit-types/
Circuits circuit types list
circuits_circuit_types_list 96 params → 200
POST
/api/circuits/circuit-types/
Circuits circuit types create
circuits_circuit_types_create body → 201
PUT
/api/circuits/circuit-types/
Circuits circuit types bulk update
circuits_circuit_types_bulk_update body → 200
PATCH
/api/circuits/circuit-types/
Circuits circuit types bulk partial update
circuits_circuit_types_bulk_partial_update body → 200
DELETE
/api/circuits/circuit-types/
Circuits circuit types bulk destroy
circuits_circuit_types_bulk_destroy body → 204
GET
/api/circuits/circuit-types/{id}/
Circuits circuit types retrieve
circuits_circuit_types_retrieve 4 params → 200
PUT
/api/circuits/circuit-types/{id}/
Circuits circuit types update
circuits_circuit_types_update 1 param body → 200
PATCH
/api/circuits/circuit-types/{id}/
Circuits circuit types partial update
circuits_circuit_types_partial_update 1 param body → 200
DELETE
/api/circuits/circuit-types/{id}/
Circuits circuit types destroy
circuits_circuit_types_destroy 1 param → 204
GET
/api/circuits/circuits/
Circuits circuits list
circuits_circuits_list 170 params → 200
POST
/api/circuits/circuits/
Circuits circuits create
circuits_circuits_create body → 201
PUT
/api/circuits/circuits/
Circuits circuits bulk update
circuits_circuits_bulk_update body → 200
PATCH
/api/circuits/circuits/
Circuits circuits bulk partial update
circuits_circuits_bulk_partial_update body → 200
DELETE
/api/circuits/circuits/
Circuits circuits bulk destroy
circuits_circuits_bulk_destroy body → 204
GET
/api/circuits/circuits/{id}/
Circuits circuits retrieve
circuits_circuits_retrieve 4 params → 200
PUT
/api/circuits/circuits/{id}/
Circuits circuits update
circuits_circuits_update 1 param body → 200
PATCH
/api/circuits/circuits/{id}/
Circuits circuits partial update
circuits_circuits_partial_update 1 param body → 200
DELETE
/api/circuits/circuits/{id}/
Circuits circuits destroy
circuits_circuits_destroy 1 param → 204
GET
/api/circuits/provider-accounts/
Circuits provider accounts list
circuits_provider_accounts_list 93 params → 200
POST
/api/circuits/provider-accounts/
Circuits provider accounts create
circuits_provider_accounts_create body → 201
PUT
/api/circuits/provider-accounts/
Circuits provider accounts bulk update
circuits_provider_accounts_bulk_update body → 200
PATCH
/api/circuits/provider-accounts/
Circuits provider accounts bulk partial update
circuits_provider_accounts_bulk_partial_update body → 200
DELETE
/api/circuits/provider-accounts/
Circuits provider accounts bulk destroy
circuits_provider_accounts_bulk_destroy body → 204
GET
/api/circuits/provider-accounts/{id}/
Circuits provider accounts retrieve
circuits_provider_accounts_retrieve 4 params → 200
PUT
/api/circuits/provider-accounts/{id}/
Circuits provider accounts update
circuits_provider_accounts_update 1 param body → 200
PATCH
/api/circuits/provider-accounts/{id}/
Circuits provider accounts partial update
circuits_provider_accounts_partial_update 1 param body → 200
DELETE
/api/circuits/provider-accounts/{id}/
Circuits provider accounts destroy
circuits_provider_accounts_destroy 1 param → 204
GET
/api/circuits/provider-networks/
Circuits provider networks list
circuits_provider_networks_list 87 params → 200
POST
/api/circuits/provider-networks/
Circuits provider networks create
circuits_provider_networks_create body → 201
PUT
/api/circuits/provider-networks/
Circuits provider networks bulk update
circuits_provider_networks_bulk_update body → 200
PATCH
/api/circuits/provider-networks/
Circuits provider networks bulk partial update
circuits_provider_networks_bulk_partial_update body → 200
DELETE
/api/circuits/provider-networks/
Circuits provider networks bulk destroy
circuits_provider_networks_bulk_destroy body → 204
GET
/api/circuits/provider-networks/{id}/
Circuits provider networks retrieve
circuits_provider_networks_retrieve 4 params → 200
PUT
/api/circuits/provider-networks/{id}/
Circuits provider networks update
circuits_provider_networks_update 1 param body → 200
PATCH
/api/circuits/provider-networks/{id}/
Circuits provider networks partial update
circuits_provider_networks_partial_update 1 param body → 200
DELETE
/api/circuits/provider-networks/{id}/
Circuits provider networks destroy
circuits_provider_networks_destroy 1 param → 204
GET
/api/circuits/providers/
Circuits providers list
circuits_providers_list 105 params → 200
POST
/api/circuits/providers/
Circuits providers create
circuits_providers_create body → 201
PUT
/api/circuits/providers/
Circuits providers bulk update
circuits_providers_bulk_update body → 200
PATCH
/api/circuits/providers/
Circuits providers bulk partial update
circuits_providers_bulk_partial_update body → 200
DELETE
/api/circuits/providers/
Circuits providers bulk destroy
circuits_providers_bulk_destroy body → 204
GET
/api/circuits/providers/{id}/
Circuits providers retrieve
circuits_providers_retrieve 4 params → 200
PUT
/api/circuits/providers/{id}/
Circuits providers update
circuits_providers_update 1 param body → 200
PATCH
/api/circuits/providers/{id}/
Circuits providers partial update
circuits_providers_partial_update 1 param body → 200
DELETE
/api/circuits/providers/{id}/
Circuits providers destroy
circuits_providers_destroy 1 param → 204
GET
/api/circuits/virtual-circuit-terminations/
Circuits virtual circuit terminations list
circuits_virtual_circuit_terminations_list 76 params → 200
POST
/api/circuits/virtual-circuit-terminations/
Circuits virtual circuit terminations create
circuits_virtual_circuit_terminations_create body → 201
PUT
/api/circuits/virtual-circuit-terminations/
Circuits virtual circuit terminations bulk update
circuits_virtual_circuit_terminations_bulk_update body → 200
PATCH
/api/circuits/virtual-circuit-terminations/
Circuits virtual circuit terminations bulk partial update
circuits_virtual_circuit_terminations_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuit-terminations/
Circuits virtual circuit terminations bulk destroy
circuits_virtual_circuit_terminations_bulk_destroy body → 204
GET
/api/circuits/virtual-circuit-terminations/{id}/
Circuits virtual circuit terminations retrieve
circuits_virtual_circuit_terminations_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuit-terminations/{id}/
Circuits virtual circuit terminations update
circuits_virtual_circuit_terminations_update 1 param body → 200
PATCH
/api/circuits/virtual-circuit-terminations/{id}/
Circuits virtual circuit terminations partial update
circuits_virtual_circuit_terminations_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuit-terminations/{id}/
Circuits virtual circuit terminations destroy
circuits_virtual_circuit_terminations_destroy 1 param → 204
GET
/api/circuits/virtual-circuit-terminations/{id}/paths/
Circuits virtual circuit terminations paths retrieve
circuits_virtual_circuit_terminations_paths_retrieve 4 params → 200
GET
/api/circuits/virtual-circuit-types/
Circuits virtual circuit types list
circuits_virtual_circuit_types_list 96 params → 200
POST
/api/circuits/virtual-circuit-types/
Circuits virtual circuit types create
circuits_virtual_circuit_types_create body → 201
PUT
/api/circuits/virtual-circuit-types/
Circuits virtual circuit types bulk update
circuits_virtual_circuit_types_bulk_update body → 200
PATCH
/api/circuits/virtual-circuit-types/
Circuits virtual circuit types bulk partial update
circuits_virtual_circuit_types_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuit-types/
Circuits virtual circuit types bulk destroy
circuits_virtual_circuit_types_bulk_destroy body → 204
GET
/api/circuits/virtual-circuit-types/{id}/
Circuits virtual circuit types retrieve
circuits_virtual_circuit_types_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuit-types/{id}/
Circuits virtual circuit types update
circuits_virtual_circuit_types_update 1 param body → 200
PATCH
/api/circuits/virtual-circuit-types/{id}/
Circuits virtual circuit types partial update
circuits_virtual_circuit_types_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuit-types/{id}/
Circuits virtual circuit types destroy
circuits_virtual_circuit_types_destroy 1 param → 204
GET
/api/circuits/virtual-circuits/
Circuits virtual circuits list
circuits_virtual_circuits_list 105 params → 200
POST
/api/circuits/virtual-circuits/
Circuits virtual circuits create
circuits_virtual_circuits_create body → 201
PUT
/api/circuits/virtual-circuits/
Circuits virtual circuits bulk update
circuits_virtual_circuits_bulk_update body → 200
PATCH
/api/circuits/virtual-circuits/
Circuits virtual circuits bulk partial update
circuits_virtual_circuits_bulk_partial_update body → 200
DELETE
/api/circuits/virtual-circuits/
Circuits virtual circuits bulk destroy
circuits_virtual_circuits_bulk_destroy body → 204
GET
/api/circuits/virtual-circuits/{id}/
Circuits virtual circuits retrieve
circuits_virtual_circuits_retrieve 4 params → 200
PUT
/api/circuits/virtual-circuits/{id}/
Circuits virtual circuits update
circuits_virtual_circuits_update 1 param body → 200
PATCH
/api/circuits/virtual-circuits/{id}/
Circuits virtual circuits partial update
circuits_virtual_circuits_partial_update 1 param body → 200
DELETE
/api/circuits/virtual-circuits/{id}/
Circuits virtual circuits destroy
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), BulkCircuitRequest (18 properties), ASN (18 properties). Each schema is shown below with its type and property counts.

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

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
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=netbox-labs-circuits-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-labs-circuits-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 NetBox Labs Circuits 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.