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

NetBox status API

The status API from NetBox — 1 operation(s) for status.

NetBox status API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include status. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path. 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.

1 operations 1 paths 0 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.5.9 (4.5)
Base URL
https://demo.netbox.dev/api
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox status 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

status 1
GET
/api/status/
A lightweight read-only endpoint for conveying NetBox's current operational status.
status_retrieve → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-status-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
NetBox authentication-check API
NetBox circuits API
NetBox core API
NetBox dcim API
NetBox extras API
NetBox ipam API
NetBox schema API
NetBox tenancy API
NetBox users API
NetBox virtualization API
NetBox vpn API