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 Labs status API

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

NetBox Labs status 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 status. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.3, at version 4.6.5 (4.6).

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.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 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 3 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-status-api-openapi.yml Raw ↑

Other APIs NetBox Labs publishes across the network.

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