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://demo.netbox.dev/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/{id}/paths/ | Return all CablePaths which traverse a given pass-through port. circuits |
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-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-ports/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/devices/{id}/napalm/ | Execute a NAPALM method on a Device dcim |
GET | /dcim/front-ports/{id}/paths/ | Return all CablePaths which traverse a given pass-through port. dcim |
GET | /dcim/interfaces/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/power-feeds/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/power-outlets/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/power-ports/{id}/trace/ | Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). dci |
GET | /dcim/racks/{id}/elevation/ | Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG. dcim |
GET | /dcim/rear-ports/{id}/paths/ | Return all CablePaths which traverse a given pass-through port. dcim |
GET | /extras/content-types/ | Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. extras |
GET | /extras/content-types/{id}/ | Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. extras |
GET | /extras/job-results/ | Retrieve a list of job results extras |
GET | /extras/job-results/{id}/ | Retrieve a list of job results extras |
GET | /extras/object-changes/ | Retrieve a list of recent changes. extras |
GET | /extras/object-changes/{id}/ | Retrieve a list of recent changes. extras |
GET | /extras/reports/ | Compile all reports and their related results (if any). Result data is deferred in the list view. extras |
GET | /extras/reports/{id}/ | Retrieve a single Report identified as ".". extras |
POST | /extras/reports/{id}/run/ | Run a Report identified as "." and return the pending JobResult as the result extras |
GET | /status/ | A lightweight read-only endpoint for conveying NetBox's current operational status. status |
GET | /users/config/ | Return the UserConfig for the currently authenticated User. users |
POST | /users/tokens/provision/ | Non-authenticated REST API endpoint via which a user may create a Token. users |
specification origin: https://demo.netbox.dev/api/docs/?format=openapi
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.