API to access NetBox
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://netboxdemo.com/api
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
API to access NetBox
| method | path | what the vendor says it does |
|---|---|---|
GET | /circuits/circuit-terminations/ | Call to super to allow for caching circuits |
GET | /circuits/circuit-terminations/{id}/ | Call to super to allow for caching circuits |
GET | /circuits/circuit-types/ | Call to super to allow for caching circuits |
GET | /circuits/circuit-types/{id}/ | Call to super to allow for caching circuits |
GET | /circuits/circuits/ | Call to super to allow for caching circuits |
GET | /circuits/circuits/{id}/ | Call to super to allow for caching circuits |
GET | /circuits/providers/ | Call to super to allow for caching circuits |
GET | /circuits/providers/{id}/ | Call to super to allow for caching circuits |
GET | /circuits/providers/{id}/graphs/ | A convenience method for rendering graphs for a particular provider. circuits |
GET | /dcim/cables/ | Call to super to allow for caching dcim |
GET | /dcim/cables/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/connected-device/ | This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer int |
GET | /dcim/console-port-templates/ | Call to super to allow for caching dcim |
GET | /dcim/console-port-templates/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/console-ports/ | Call to super to allow for caching dcim |
GET | /dcim/console-ports/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/console-ports/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/console-server-port-templates/ | Call to super to allow for caching dcim |
GET | /dcim/console-server-port-templates/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/console-server-ports/ | Call to super to allow for caching dcim |
GET | /dcim/console-server-ports/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/console-server-ports/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/device-bay-templates/ | Call to super to allow for caching dcim |
GET | /dcim/device-bay-templates/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/device-bays/ | Call to super to allow for caching dcim |
GET | /dcim/device-bays/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/device-roles/ | Call to super to allow for caching dcim |
GET | /dcim/device-roles/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/device-types/ | Call to super to allow for caching dcim |
GET | /dcim/device-types/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/devices/ | Call to super to allow for caching dcim |
GET | /dcim/devices/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/devices/{id}/graphs/ | A convenience method for rendering graphs for a particular Device. dcim |
GET | /dcim/devices/{id}/napalm/ | Execute a NAPALM method on a Device dcim |
GET | /dcim/front-port-templates/ | Call to super to allow for caching dcim |
GET | /dcim/front-port-templates/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/front-ports/ | Call to super to allow for caching dcim |
GET | /dcim/front-ports/{id}/ | Call to super to allow for caching dcim |
GET | /dcim/front-ports/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/interface-templates/ | Call to super to allow for caching dcim |
and 101 more operation(s) in this specification, all searchable.
specification origin: https://netboxdemo.com/api/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.