Skip to content
OpenParablePublic APIs

NetBox API API

by netbox.dev

API keyHTTPSBusiness
Open documentation ↗

Overview

API to access NetBox

NetBox API is a business API from netbox.dev. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 844 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Business
Base URL
https://demo.netbox.dev/api
Version
3.4
Endpoints
844
OpenAPI
Specification ↗
Spec updated
2023-03-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://demo.netbox.dev/api/circuits/circuit-terminations/" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://demo.netbox.dev/api/circuits/circuit-terminations/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://demo.netbox.dev/api/circuits/circuit-terminations/",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/circuits/circuit-terminations/circuits_circuit-terminations_list
POST/circuits/circuit-terminations/circuits_circuit-terminations_create
PUT/circuits/circuit-terminations/circuits_circuit-terminations_bulk_update
PATCH/circuits/circuit-terminations/circuits_circuit-terminations_bulk_partial_update
DELETE/circuits/circuit-terminations/circuits_circuit-terminations_bulk_delete
GET/circuits/circuit-terminations/{id}/circuits_circuit-terminations_read
PUT/circuits/circuit-terminations/{id}/circuits_circuit-terminations_update
PATCH/circuits/circuit-terminations/{id}/circuits_circuit-terminations_partial_update
DELETE/circuits/circuit-terminations/{id}/circuits_circuit-terminations_delete
GET/circuits/circuit-terminations/{id}/paths/Return all CablePaths which traverse a given pass-through port.
GET/circuits/circuit-types/circuits_circuit-types_list
POST/circuits/circuit-types/circuits_circuit-types_create
PUT/circuits/circuit-types/circuits_circuit-types_bulk_update
PATCH/circuits/circuit-types/circuits_circuit-types_bulk_partial_update
DELETE/circuits/circuit-types/circuits_circuit-types_bulk_delete
GET/circuits/circuit-types/{id}/circuits_circuit-types_read
PUT/circuits/circuit-types/{id}/circuits_circuit-types_update
PATCH/circuits/circuit-types/{id}/circuits_circuit-types_partial_update
DELETE/circuits/circuit-types/{id}/circuits_circuit-types_delete
GET/circuits/circuits/circuits_circuits_list
POST/circuits/circuits/circuits_circuits_create
PUT/circuits/circuits/circuits_circuits_bulk_update
PATCH/circuits/circuits/circuits_circuits_bulk_partial_update
DELETE/circuits/circuits/circuits_circuits_bulk_delete
GET/circuits/circuits/{id}/circuits_circuits_read
PUT/circuits/circuits/{id}/circuits_circuits_update
PATCH/circuits/circuits/{id}/circuits_circuits_partial_update
DELETE/circuits/circuits/{id}/circuits_circuits_delete
GET/circuits/provider-networks/circuits_provider-networks_list
POST/circuits/provider-networks/circuits_provider-networks_create
PUT/circuits/provider-networks/circuits_provider-networks_bulk_update
PATCH/circuits/provider-networks/circuits_provider-networks_bulk_partial_update
DELETE/circuits/provider-networks/circuits_provider-networks_bulk_delete
GET/circuits/provider-networks/{id}/circuits_provider-networks_read
PUT/circuits/provider-networks/{id}/circuits_provider-networks_update
PATCH/circuits/provider-networks/{id}/circuits_provider-networks_partial_update
DELETE/circuits/provider-networks/{id}/circuits_provider-networks_delete
GET/circuits/providers/circuits_providers_list
POST/circuits/providers/circuits_providers_create
PUT/circuits/providers/circuits_providers_bulk_update
PATCH/circuits/providers/circuits_providers_bulk_partial_update
DELETE/circuits/providers/circuits_providers_bulk_delete
GET/circuits/providers/{id}/circuits_providers_read
PUT/circuits/providers/{id}/circuits_providers_update
PATCH/circuits/providers/{id}/circuits_providers_partial_update
DELETE/circuits/providers/{id}/circuits_providers_delete
GET/dcim/cable-terminations/dcim_cable-terminations_list
POST/dcim/cable-terminations/dcim_cable-terminations_create
PUT/dcim/cable-terminations/dcim_cable-terminations_bulk_update
PATCH/dcim/cable-terminations/dcim_cable-terminations_bulk_partial_update
DELETE/dcim/cable-terminations/dcim_cable-terminations_bulk_delete
GET/dcim/cable-terminations/{id}/dcim_cable-terminations_read
PUT/dcim/cable-terminations/{id}/dcim_cable-terminations_update
PATCH/dcim/cable-terminations/{id}/dcim_cable-terminations_partial_update
DELETE/dcim/cable-terminations/{id}/dcim_cable-terminations_delete
GET/dcim/cables/dcim_cables_list
POST/dcim/cables/dcim_cables_create
PUT/dcim/cables/dcim_cables_bulk_update
PATCH/dcim/cables/dcim_cables_bulk_partial_update
DELETE/dcim/cables/dcim_cables_bulk_delete
GET/dcim/cables/{id}/dcim_cables_read
PUT/dcim/cables/{id}/dcim_cables_update
PATCH/dcim/cables/{id}/dcim_cables_partial_update
DELETE/dcim/cables/{id}/dcim_cables_delete
GET/dcim/connected-device/This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer
GET/dcim/console-port-templates/dcim_console-port-templates_list
POST/dcim/console-port-templates/dcim_console-port-templates_create
PUT/dcim/console-port-templates/dcim_console-port-templates_bulk_update
PATCH/dcim/console-port-templates/dcim_console-port-templates_bulk_partial_update
DELETE/dcim/console-port-templates/dcim_console-port-templates_bulk_delete
GET/dcim/console-port-templates/{id}/dcim_console-port-templates_read
PUT/dcim/console-port-templates/{id}/dcim_console-port-templates_update
PATCH/dcim/console-port-templates/{id}/dcim_console-port-templates_partial_update
DELETE/dcim/console-port-templates/{id}/dcim_console-port-templates_delete
GET/dcim/console-ports/dcim_console-ports_list
POST/dcim/console-ports/dcim_console-ports_create
PUT/dcim/console-ports/dcim_console-ports_bulk_update
PATCH/dcim/console-ports/dcim_console-ports_bulk_partial_update
DELETE/dcim/console-ports/dcim_console-ports_bulk_delete
GET/dcim/console-ports/{id}/dcim_console-ports_read
PUT/dcim/console-ports/{id}/dcim_console-ports_update
PATCH/dcim/console-ports/{id}/dcim_console-ports_partial_update
DELETE/dcim/console-ports/{id}/dcim_console-ports_delete
GET/dcim/console-ports/{id}/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET/dcim/console-server-port-templates/dcim_console-server-port-templates_list
POST/dcim/console-server-port-templates/dcim_console-server-port-templates_create
PUT/dcim/console-server-port-templates/dcim_console-server-port-templates_bulk_update
PATCH/dcim/console-server-port-templates/dcim_console-server-port-templates_bulk_partial_update
DELETE/dcim/console-server-port-templates/dcim_console-server-port-templates_bulk_delete
GET/dcim/console-server-port-templates/{id}/dcim_console-server-port-templates_read
PUT/dcim/console-server-port-templates/{id}/dcim_console-server-port-templates_update
PATCH/dcim/console-server-port-templates/{id}/dcim_console-server-port-templates_partial_update
DELETE/dcim/console-server-port-templates/{id}/dcim_console-server-port-templates_delete
GET/dcim/console-server-ports/dcim_console-server-ports_list
POST/dcim/console-server-ports/dcim_console-server-ports_create
PUT/dcim/console-server-ports/dcim_console-server-ports_bulk_update
PATCH/dcim/console-server-ports/dcim_console-server-ports_bulk_partial_update
DELETE/dcim/console-server-ports/dcim_console-server-ports_bulk_delete
GET/dcim/console-server-ports/{id}/dcim_console-server-ports_read
PUT/dcim/console-server-ports/{id}/dcim_console-server-ports_update

Showing the first 100 of 844 endpoints; the full list is in the documentation.

Questions

Does the NetBox API API need an API key?

Yes. The NetBox API API uses API key authentication; the documentation explains how to get credentials.

Does the NetBox API API support HTTPS?

Yes, the NetBox API API is served over HTTPS.

How many endpoints does the NetBox API API have?

Its OpenAPI description lists 844 endpoints in version 3.4. The first 100 are shown on this page.

What are alternatives to the NetBox API API?

Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.

Compare alternatives →

Gmail

Business

Flexible, RESTful access to the user's inbox

OAuth

Google Analytics

Business

Collect, configure and analyze your data to reach the right audience

OAuth

Apache Superset

Business

API to manage your BI dashboards and data sources on Superset

API keyCORS

Trello

Business

Boards, lists and cards to help you organize and prioritize your projects

OAuth324 endpoints

Square

Business

Easy way to take payments, manage refunds, and help customers checkout online

OAuth200 endpoints

Mailchimp

Business

Send marketing campaigns and transactional mails

API key

Listed from APIs.guru (CC0).