NetBox

NetBox Circuits API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 101

GET /api/circuits/circuit-group-assignments/ Circuits circuit group assignments list #
POST /api/circuits/circuit-group-assignments/ Circuits circuit group assignments create #
PUT /api/circuits/circuit-group-assignments/ Circuits circuit group assignments bulk update #
PATCH /api/circuits/circuit-group-assignments/ Circuits circuit group assignments bulk partial update #
DELETE /api/circuits/circuit-group-assignments/ Circuits circuit group assignments bulk destroy #
GET /api/circuits/circuit-group-assignments/{id}/ Circuits circuit group assignments retrieve #
PUT /api/circuits/circuit-group-assignments/{id}/ Circuits circuit group assignments update #
PATCH /api/circuits/circuit-group-assignments/{id}/ Circuits circuit group assignments partial update #
DELETE /api/circuits/circuit-group-assignments/{id}/ Circuits circuit group assignments destroy #
GET /api/circuits/circuit-groups/ Circuits circuit groups list #
POST /api/circuits/circuit-groups/ Circuits circuit groups create #
PUT /api/circuits/circuit-groups/ Circuits circuit groups bulk update #
PATCH /api/circuits/circuit-groups/ Circuits circuit groups bulk partial update #
DELETE /api/circuits/circuit-groups/ Circuits circuit groups bulk destroy #
GET /api/circuits/circuit-groups/{id}/ Circuits circuit groups retrieve #
PUT /api/circuits/circuit-groups/{id}/ Circuits circuit groups update #
PATCH /api/circuits/circuit-groups/{id}/ Circuits circuit groups partial update #
DELETE /api/circuits/circuit-groups/{id}/ Circuits circuit groups destroy #
GET /api/circuits/circuit-terminations/ Circuits circuit terminations list #
POST /api/circuits/circuit-terminations/ Circuits circuit terminations create #
PUT /api/circuits/circuit-terminations/ Circuits circuit terminations bulk update #
PATCH /api/circuits/circuit-terminations/ Circuits circuit terminations bulk partial update #
DELETE /api/circuits/circuit-terminations/ Circuits circuit terminations bulk destroy #
GET /api/circuits/circuit-terminations/{id}/ Circuits circuit terminations retrieve #
PUT /api/circuits/circuit-terminations/{id}/ Circuits circuit terminations update #
PATCH /api/circuits/circuit-terminations/{id}/ Circuits circuit terminations partial update #
DELETE /api/circuits/circuit-terminations/{id}/ Circuits circuit terminations destroy #
GET /api/circuits/circuit-terminations/{id}/paths/ Circuits circuit terminations paths retrieve #
GET /api/circuits/circuit-types/ Circuits circuit types list #
POST /api/circuits/circuit-types/ Circuits circuit types create #
PUT /api/circuits/circuit-types/ Circuits circuit types bulk update #
PATCH /api/circuits/circuit-types/ Circuits circuit types bulk partial update #
DELETE /api/circuits/circuit-types/ Circuits circuit types bulk destroy #
GET /api/circuits/circuit-types/{id}/ Circuits circuit types retrieve #
PUT /api/circuits/circuit-types/{id}/ Circuits circuit types update #
PATCH /api/circuits/circuit-types/{id}/ Circuits circuit types partial update #
DELETE /api/circuits/circuit-types/{id}/ Circuits circuit types destroy #
GET /api/circuits/circuits/ Circuits circuits list #
POST /api/circuits/circuits/ Circuits circuits create #
PUT /api/circuits/circuits/ Circuits circuits bulk update #
PATCH /api/circuits/circuits/ Circuits circuits bulk partial update #
DELETE /api/circuits/circuits/ Circuits circuits bulk destroy #
GET /api/circuits/circuits/{id}/ Circuits circuits retrieve #
PUT /api/circuits/circuits/{id}/ Circuits circuits update #
PATCH /api/circuits/circuits/{id}/ Circuits circuits partial update #
DELETE /api/circuits/circuits/{id}/ Circuits circuits destroy #
GET /api/circuits/provider-accounts/ Circuits provider accounts list #
POST /api/circuits/provider-accounts/ Circuits provider accounts create #
PUT /api/circuits/provider-accounts/ Circuits provider accounts bulk update #
PATCH /api/circuits/provider-accounts/ Circuits provider accounts bulk partial update #
DELETE /api/circuits/provider-accounts/ Circuits provider accounts bulk destroy #
GET /api/circuits/provider-accounts/{id}/ Circuits provider accounts retrieve #
PUT /api/circuits/provider-accounts/{id}/ Circuits provider accounts update #
PATCH /api/circuits/provider-accounts/{id}/ Circuits provider accounts partial update #
DELETE /api/circuits/provider-accounts/{id}/ Circuits provider accounts destroy #
GET /api/circuits/provider-networks/ Circuits provider networks list #
POST /api/circuits/provider-networks/ Circuits provider networks create #
PUT /api/circuits/provider-networks/ Circuits provider networks bulk update #
PATCH /api/circuits/provider-networks/ Circuits provider networks bulk partial update #
DELETE /api/circuits/provider-networks/ Circuits provider networks bulk destroy #
GET /api/circuits/provider-networks/{id}/ Circuits provider networks retrieve #
PUT /api/circuits/provider-networks/{id}/ Circuits provider networks update #
PATCH /api/circuits/provider-networks/{id}/ Circuits provider networks partial update #
DELETE /api/circuits/provider-networks/{id}/ Circuits provider networks destroy #
GET /api/circuits/providers/ Circuits providers list #
POST /api/circuits/providers/ Circuits providers create #
PUT /api/circuits/providers/ Circuits providers bulk update #
PATCH /api/circuits/providers/ Circuits providers bulk partial update #
DELETE /api/circuits/providers/ Circuits providers bulk destroy #
GET /api/circuits/providers/{id}/ Circuits providers retrieve #
PUT /api/circuits/providers/{id}/ Circuits providers update #
PATCH /api/circuits/providers/{id}/ Circuits providers partial update #
DELETE /api/circuits/providers/{id}/ Circuits providers destroy #
GET /api/circuits/virtual-circuit-terminations/ Circuits virtual circuit terminations list #
POST /api/circuits/virtual-circuit-terminations/ Circuits virtual circuit terminations create #
PUT /api/circuits/virtual-circuit-terminations/ Circuits virtual circuit terminations bulk update #
PATCH /api/circuits/virtual-circuit-terminations/ Circuits virtual circuit terminations bulk partial update #
DELETE /api/circuits/virtual-circuit-terminations/ Circuits virtual circuit terminations bulk destroy #
GET /api/circuits/virtual-circuit-terminations/{id}/ Circuits virtual circuit terminations retrieve #
PUT /api/circuits/virtual-circuit-terminations/{id}/ Circuits virtual circuit terminations update #
PATCH /api/circuits/virtual-circuit-terminations/{id}/ Circuits virtual circuit terminations partial update #
DELETE /api/circuits/virtual-circuit-terminations/{id}/ Circuits virtual circuit terminations destroy #
GET /api/circuits/virtual-circuit-terminations/{id}/paths/ Circuits virtual circuit terminations paths retrieve #
GET /api/circuits/virtual-circuit-types/ Circuits virtual circuit types list #
POST /api/circuits/virtual-circuit-types/ Circuits virtual circuit types create #
PUT /api/circuits/virtual-circuit-types/ Circuits virtual circuit types bulk update #
PATCH /api/circuits/virtual-circuit-types/ Circuits virtual circuit types bulk partial update #
DELETE /api/circuits/virtual-circuit-types/ Circuits virtual circuit types bulk destroy #
GET /api/circuits/virtual-circuit-types/{id}/ Circuits virtual circuit types retrieve #
PUT /api/circuits/virtual-circuit-types/{id}/ Circuits virtual circuit types update #
PATCH /api/circuits/virtual-circuit-types/{id}/ Circuits virtual circuit types partial update #
DELETE /api/circuits/virtual-circuit-types/{id}/ Circuits virtual circuit types destroy #
GET /api/circuits/virtual-circuits/ Circuits virtual circuits list #
POST /api/circuits/virtual-circuits/ Circuits virtual circuits create #
PUT /api/circuits/virtual-circuits/ Circuits virtual circuits bulk update #
PATCH /api/circuits/virtual-circuits/ Circuits virtual circuits bulk partial update #
DELETE /api/circuits/virtual-circuits/ Circuits virtual circuits bulk destroy #
GET /api/circuits/virtual-circuits/{id}/ Circuits virtual circuits retrieve #
PUT /api/circuits/virtual-circuits/{id}/ Circuits virtual circuits update #
PATCH /api/circuits/virtual-circuits/{id}/ Circuits virtual circuits partial update #
DELETE /api/circuits/virtual-circuits/{id}/ Circuits virtual circuits destroy #

Documentation

📖
Documentation
https://docs.netbox.dev/en/stable/integrations/rest-api/
📖
Authentication
https://docs.netbox.dev/en/stable/integrations/rest-api/#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/openapi/netbox-circuits-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netbox-circuits-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netbox-circuits-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NetBox REST Circuits API
  version: 4.5.9 (4.5)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:


# --- truncated at 32 KB (359 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/openapi/netbox-circuits-api-openapi.yml