NetBox core API
The core API from NetBox — 21 operation(s) for core.
NetBox core API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include core. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 28 operations across 21 paths, and defines 19 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox core 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 28
Across 21 paths, the API surfaces 28 operations — 2 DELETE, 16 GET, 2 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 19
The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BackgroundTask (27 properties), BackgroundTaskRequest (22 properties), DataSource (20 properties), Job (20 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.