NetBox Demo API
Mock the NetBox Demo API in seconds. API to access NetBox
[01]
About
Mock the NetBox Demo API as a turnkey Mockzilla sim with 357 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. API to access NetBox Methods: 138x GET, 57x POST, 54x DELETE, 54x PATCH, 54x PUT. Top resource groups: dcim, ipam, extras, virtualization. Hit https://api.justmocks.com/netboxdemo for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
357 across 7 resource groups
Methods
GET 138 · POST 57 · PUT 54 · PATCH 54 · DEL 54 none deprecated
OpenAPI
3.0.0 spec version 2.4
Source spec
354 KB · YAML
[02]
Endpoints
| GET |
/circuits/_choices/
|
|
| GET |
/circuits/_choices/{id}/
|
|
| GET |
/circuits/circuit-terminations/
|
|
| POST |
/circuits/circuit-terminations/
|
|
| DEL |
/circuits/circuit-terminations/{id}/
|
|
| GET |
/circuits/circuit-terminations/{id}/
|
|
| PATCH |
/circuits/circuit-terminations/{id}/
|
|
| PUT |
/circuits/circuit-terminations/{id}/
|
|
| GET |
/circuits/circuit-types/
|
|
| POST |
/circuits/circuit-types/
|
|
| DEL |
/circuits/circuit-types/{id}/
|
|
| GET |
/circuits/circuit-types/{id}/
|
|
| PATCH |
/circuits/circuit-types/{id}/
|
|
| PUT |
/circuits/circuit-types/{id}/
|
|
| GET |
/circuits/circuits/
|
|
| POST |
/circuits/circuits/
|
|
| DEL |
/circuits/circuits/{id}/
|
|
| GET |
/circuits/circuits/{id}/
|
|
| PATCH |
/circuits/circuits/{id}/
|
|
| PUT |
/circuits/circuits/{id}/
|
|
| GET |
/circuits/providers/
|
|
| POST |
/circuits/providers/
|
|
| DEL |
/circuits/providers/{id}/
|
|
| GET |
/circuits/providers/{id}/
|
|
| PATCH |
/circuits/providers/{id}/
|
|
| PUT |
/circuits/providers/{id}/
|
|
| GET |
/circuits/providers/{id}/graphs/
|
A convenience method for rendering graphs for a particular provider. Mocked via Mockzilla.
|
| GET |
/dcim/_choices/
|
|
| GET |
/dcim/_choices/{id}/
|
|
| GET |
/dcim/connected-device/
|
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors via a protocol such as LLDP. Two query parameters must be included in the request: peer_device: The name of the peer device peer_interface: The name of the peer interface
|
| GET |
/dcim/console-connections/
|
|
| GET |
/dcim/console-port-templates/
|
|
| POST |
/dcim/console-port-templates/
|
|
| DEL |
/dcim/console-port-templates/{id}/
|
|
| GET |
/dcim/console-port-templates/{id}/
|
|
| PATCH |
/dcim/console-port-templates/{id}/
|
|
| PUT |
/dcim/console-port-templates/{id}/
|
|
| GET |
/dcim/console-ports/
|
|
| POST |
/dcim/console-ports/
|
|
| DEL |
/dcim/console-ports/{id}/
|
|
| GET |
/dcim/console-ports/{id}/
|
|
| PATCH |
/dcim/console-ports/{id}/
|
|
| PUT |
/dcim/console-ports/{id}/
|
|
| GET |
/dcim/console-server-port-templates/
|
|
| POST |
/dcim/console-server-port-templates/
|
|
| DEL |
/dcim/console-server-port-templates/{id}/
|
|
| GET |
/dcim/console-server-port-templates/{id}/
|
|
| PATCH |
/dcim/console-server-port-templates/{id}/
|
|
| PUT |
/dcim/console-server-port-templates/{id}/
|
|
| GET |
/dcim/console-server-ports/
|
|
| POST |
/dcim/console-server-ports/
|
|
| DEL |
/dcim/console-server-ports/{id}/
|
|
| GET |
/dcim/console-server-ports/{id}/
|
|
| PATCH |
/dcim/console-server-ports/{id}/
|
|
| PUT |
/dcim/console-server-ports/{id}/
|
|
| GET |
/dcim/device-bay-templates/
|
|
| POST |
/dcim/device-bay-templates/
|
|
| DEL |
/dcim/device-bay-templates/{id}/
|
|
| GET |
/dcim/device-bay-templates/{id}/
|
|
| PATCH |
/dcim/device-bay-templates/{id}/
|
|
| PUT |
/dcim/device-bay-templates/{id}/
|
|
| GET |
/dcim/device-bays/
|
|
| POST |
/dcim/device-bays/
|
|
| DEL |
/dcim/device-bays/{id}/
|
|
| GET |
/dcim/device-bays/{id}/
|
|
| PATCH |
/dcim/device-bays/{id}/
|
|
| PUT |
/dcim/device-bays/{id}/
|
|
| GET |
/dcim/device-roles/
|
|
| POST |
/dcim/device-roles/
|
|
| DEL |
/dcim/device-roles/{id}/
|
|
| GET |
/dcim/device-roles/{id}/
|
|
| PATCH |
/dcim/device-roles/{id}/
|
|
| PUT |
/dcim/device-roles/{id}/
|
|
| GET |
/dcim/device-types/
|
|
| POST |
/dcim/device-types/
|
|
| DEL |
/dcim/device-types/{id}/
|
|
| GET |
/dcim/device-types/{id}/
|
|
| PATCH |
/dcim/device-types/{id}/
|
|
| PUT |
/dcim/device-types/{id}/
|
|
| GET |
/dcim/devices/
|
|
| POST |
/dcim/devices/
|
|
| DEL |
/dcim/devices/{id}/
|
|
| GET |
/dcim/devices/{id}/
|
|
| PATCH |
/dcim/devices/{id}/
|
|
| PUT |
/dcim/devices/{id}/
|
|
| GET |
/dcim/devices/{id}/napalm/
|
Execute a NAPALM method on a Device
|
| GET |
/dcim/interface-connections/
|
|
| POST |
/dcim/interface-connections/
|
|
| DEL |
/dcim/interface-connections/{id}/
|
|
| GET |
/dcim/interface-connections/{id}/
|
|
| PATCH |
/dcim/interface-connections/{id}/
|
|
| PUT |
/dcim/interface-connections/{id}/
|
|
| GET |
/dcim/interface-templates/
|
|
| POST |
/dcim/interface-templates/
|
|
| DEL |
/dcim/interface-templates/{id}/
|
|
| GET |
/dcim/interface-templates/{id}/
|
|
| PATCH |
/dcim/interface-templates/{id}/
|
|
| PUT |
/dcim/interface-templates/{id}/
|
|
| GET |
/dcim/interfaces/
|
|
| POST |
/dcim/interfaces/
|
|
| DEL |
/dcim/interfaces/{id}/
|
|
| GET |
/dcim/interfaces/{id}/
|
|
| PATCH |
/dcim/interfaces/{id}/
|
|
| PUT |
/dcim/interfaces/{id}/
|
|
| GET |
/dcim/interfaces/{id}/graphs/
|
A convenience method for rendering graphs for a particular interface.
|
| GET |
/dcim/inventory-items/
|
|
| POST |
/dcim/inventory-items/
|
|
| DEL |
/dcim/inventory-items/{id}/
|
|
| GET |
/dcim/inventory-items/{id}/
|
|
| PATCH |
/dcim/inventory-items/{id}/
|
|
| PUT |
/dcim/inventory-items/{id}/
|
|
| GET |
/dcim/manufacturers/
|
|
| POST |
/dcim/manufacturers/
|
|
| DEL |
/dcim/manufacturers/{id}/
|
|
| GET |
/dcim/manufacturers/{id}/
|
|
| PATCH |
/dcim/manufacturers/{id}/
|
|
| PUT |
/dcim/manufacturers/{id}/
|
|
| GET |
/dcim/platforms/
|
|
| POST |
/dcim/platforms/
|
|
| DEL |
/dcim/platforms/{id}/
|
|
| GET |
/dcim/platforms/{id}/
|
|
| PATCH |
/dcim/platforms/{id}/
|
|
| PUT |
/dcim/platforms/{id}/
|
|
| GET |
/dcim/power-connections/
|
|
| GET |
/dcim/power-outlet-templates/
|
|
| POST |
/dcim/power-outlet-templates/
|
|
| DEL |
/dcim/power-outlet-templates/{id}/
|
|
| GET |
/dcim/power-outlet-templates/{id}/
|
|
| PATCH |
/dcim/power-outlet-templates/{id}/
|
|
| PUT |
/dcim/power-outlet-templates/{id}/
|
|
| GET |
/dcim/power-outlets/
|
|
| POST |
/dcim/power-outlets/
|
|
| DEL |
/dcim/power-outlets/{id}/
|
|
| GET |
/dcim/power-outlets/{id}/
|
|
| PATCH |
/dcim/power-outlets/{id}/
|
|
| PUT |
/dcim/power-outlets/{id}/
|
|
| GET |
/dcim/power-port-templates/
|
|
| POST |
/dcim/power-port-templates/
|
|
| DEL |
/dcim/power-port-templates/{id}/
|
|
| GET |
/dcim/power-port-templates/{id}/
|
|
| PATCH |
/dcim/power-port-templates/{id}/
|
|
| PUT |
/dcim/power-port-templates/{id}/
|
|
| GET |
/dcim/power-ports/
|
|
| POST |
/dcim/power-ports/
|
|
| DEL |
/dcim/power-ports/{id}/
|
|
| GET |
/dcim/power-ports/{id}/
|
|
| PATCH |
/dcim/power-ports/{id}/
|
|
| PUT |
/dcim/power-ports/{id}/
|
|
| GET |
/dcim/rack-groups/
|
|
| POST |
/dcim/rack-groups/
|
|
| DEL |
/dcim/rack-groups/{id}/
|
|
| GET |
/dcim/rack-groups/{id}/
|
|
| PATCH |
/dcim/rack-groups/{id}/
|
|
| PUT |
/dcim/rack-groups/{id}/
|
|
| GET |
/dcim/rack-reservations/
|
|
| POST |
/dcim/rack-reservations/
|
|
| DEL |
/dcim/rack-reservations/{id}/
|
|
| GET |
/dcim/rack-reservations/{id}/
|
|
| PATCH |
/dcim/rack-reservations/{id}/
|
|
| PUT |
/dcim/rack-reservations/{id}/
|
|
| GET |
/dcim/rack-roles/
|
|
| POST |
/dcim/rack-roles/
|
|
| DEL |
/dcim/rack-roles/{id}/
|
|
| GET |
/dcim/rack-roles/{id}/
|
|
| PATCH |
/dcim/rack-roles/{id}/
|
|
| PUT |
/dcim/rack-roles/{id}/
|
|
| GET |
/dcim/racks/
|
|
| POST |
/dcim/racks/
|
|
| DEL |
/dcim/racks/{id}/
|
|
| GET |
/dcim/racks/{id}/
|
|
| PATCH |
/dcim/racks/{id}/
|
|
| PUT |
/dcim/racks/{id}/
|
|
| GET |
/dcim/racks/{id}/units/
|
List rack units (by rack)
|
| GET |
/dcim/regions/
|
|
| POST |
/dcim/regions/
|
|
| DEL |
/dcim/regions/{id}/
|
|
| GET |
/dcim/regions/{id}/
|
|
| PATCH |
/dcim/regions/{id}/
|
|
| PUT |
/dcim/regions/{id}/
|
|
| GET |
/dcim/sites/
|
|
| POST |
/dcim/sites/
|
|
| DEL |
/dcim/sites/{id}/
|
|
| GET |
/dcim/sites/{id}/
|
|
| PATCH |
/dcim/sites/{id}/
|
|
| PUT |
/dcim/sites/{id}/
|
|
| GET |
/dcim/sites/{id}/graphs/
|
A convenience method for rendering graphs for a particular site. Available as a Mockzilla mock endpoint.
|
| GET |
/dcim/virtual-chassis/
|
|
| POST |
/dcim/virtual-chassis/
|
|
| DEL |
/dcim/virtual-chassis/{id}/
|
|
| GET |
/dcim/virtual-chassis/{id}/
|
|
| PATCH |
/dcim/virtual-chassis/{id}/
|
|
| PUT |
/dcim/virtual-chassis/{id}/
|
|
| GET |
/extras/_choices/
|
|
| GET |
/extras/_choices/{id}/
|
|
| GET |
/extras/config-contexts/
|
|
| POST |
/extras/config-contexts/
|
|
| DEL |
/extras/config-contexts/{id}/
|
|
| GET |
/extras/config-contexts/{id}/
|
|
| PATCH |
/extras/config-contexts/{id}/
|
|
| PUT |
/extras/config-contexts/{id}/
|
|
| GET |
/extras/export-templates/
|
|
| POST |
/extras/export-templates/
|
|
| DEL |
/extras/export-templates/{id}/
|
|
| GET |
/extras/export-templates/{id}/
|
|
| PATCH |
/extras/export-templates/{id}/
|
|
| PUT |
/extras/export-templates/{id}/
|
|
| GET |
/extras/graphs/
|
|
| POST |
/extras/graphs/
|
|
| DEL |
/extras/graphs/{id}/
|
|
| GET |
/extras/graphs/{id}/
|
|
| PATCH |
/extras/graphs/{id}/
|
|
| PUT |
/extras/graphs/{id}/
|
|
| GET |
/extras/image-attachments/
|
|
| POST |
/extras/image-attachments/
|
|
| DEL |
/extras/image-attachments/{id}/
|
|
| GET |
/extras/image-attachments/{id}/
|
|
| PATCH |
/extras/image-attachments/{id}/
|
|
| PUT |
/extras/image-attachments/{id}/
|
|
| GET |
/extras/object-changes/
|
Retrieve a list of recent changes.
|
| GET |
/extras/object-changes/{id}/
|
Retrieve a list of recent changes.
|
| GET |
/extras/recent-activity/
|
|
| GET |
/extras/recent-activity/{id}/
|
|
| GET |
/extras/tags/
|
|
| POST |
/extras/tags/
|
|
| DEL |
/extras/tags/{id}/
|
|
| GET |
/extras/tags/{id}/
|
|
| PATCH |
/extras/tags/{id}/
|
|
| PUT |
/extras/tags/{id}/
|
|
| GET |
/extras/topology-maps/
|
|
| POST |
/extras/topology-maps/
|
|
| DEL |
/extras/topology-maps/{id}/
|
|
| GET |
/extras/topology-maps/{id}/
|
|
| PATCH |
/extras/topology-maps/{id}/
|
|
| PUT |
/extras/topology-maps/{id}/
|
|
| GET |
/extras/topology-maps/{id}/render/
|
|
| GET |
/ipam/_choices/
|
|
| GET |
/ipam/_choices/{id}/
|
|
| GET |
/ipam/aggregates/
|
|
| POST |
/ipam/aggregates/
|
|
| DEL |
/ipam/aggregates/{id}/
|
|
| GET |
/ipam/aggregates/{id}/
|
|
| PATCH |
/ipam/aggregates/{id}/
|
|
| PUT |
/ipam/aggregates/{id}/
|
|
| GET |
/ipam/ip-addresses/
|
|
| POST |
/ipam/ip-addresses/
|
|
| DEL |
/ipam/ip-addresses/{id}/
|
|
| GET |
/ipam/ip-addresses/{id}/
|
|
| PATCH |
/ipam/ip-addresses/{id}/
|
|
| PUT |
/ipam/ip-addresses/{id}/
|
|
| GET |
/ipam/prefixes/
|
|
| POST |
/ipam/prefixes/
|
|
| DEL |
/ipam/prefixes/{id}/
|
|
| GET |
/ipam/prefixes/{id}/
|
|
| PATCH |
/ipam/prefixes/{id}/
|
|
| PUT |
/ipam/prefixes/{id}/
|
|
| GET |
/ipam/prefixes/{id}/available-ips/
|
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
|
| POST |
/ipam/prefixes/{id}/available-ips/
|
A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
|
| GET |
/ipam/prefixes/{id}/available-prefixes/
|
A convenience method for returning available child prefixes within a parent. Mockzilla mock: no signup, no API key.
|
| POST |
/ipam/prefixes/{id}/available-prefixes/
|
A convenience method for returning available child prefixes within a parent.
|
| GET |
/ipam/rirs/
|
|
| POST |
/ipam/rirs/
|
|
| DEL |
/ipam/rirs/{id}/
|
|
| GET |
/ipam/rirs/{id}/
|
|
| PATCH |
/ipam/rirs/{id}/
|
|
| PUT |
/ipam/rirs/{id}/
|
|
| GET |
/ipam/roles/
|
|
| POST |
/ipam/roles/
|
|
| DEL |
/ipam/roles/{id}/
|
|
| GET |
/ipam/roles/{id}/
|
|
| PATCH |
/ipam/roles/{id}/
|
|
| PUT |
/ipam/roles/{id}/
|
|
| GET |
/ipam/services/
|
|
| POST |
/ipam/services/
|
|
| DEL |
/ipam/services/{id}/
|
|
| GET |
/ipam/services/{id}/
|
|
| PATCH |
/ipam/services/{id}/
|
|
| PUT |
/ipam/services/{id}/
|
|
| GET |
/ipam/vlan-groups/
|
|
| POST |
/ipam/vlan-groups/
|
|
| DEL |
/ipam/vlan-groups/{id}/
|
|
| GET |
/ipam/vlan-groups/{id}/
|
|
| PATCH |
/ipam/vlan-groups/{id}/
|
|
| PUT |
/ipam/vlan-groups/{id}/
|
|
| GET |
/ipam/vlans/
|
|
| POST |
/ipam/vlans/
|
|
| DEL |
/ipam/vlans/{id}/
|
|
| GET |
/ipam/vlans/{id}/
|
|
| PATCH |
/ipam/vlans/{id}/
|
|
| PUT |
/ipam/vlans/{id}/
|
|
| GET |
/ipam/vrfs/
|
|
| POST |
/ipam/vrfs/
|
|
| DEL |
/ipam/vrfs/{id}/
|
|
| GET |
/ipam/vrfs/{id}/
|
|
| PATCH |
/ipam/vrfs/{id}/
|
|
| PUT |
/ipam/vrfs/{id}/
|
|
| GET |
/secrets/_choices/
|
|
| GET |
/secrets/_choices/{id}/
|
|
| GET |
/secrets/generate-rsa-key-pair/
|
This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format. { "public_key": "", "private_key": "" }
|
| POST |
/secrets/get-session-key/
|
Retrieve a temporary session key to use for encrypting and decrypting secrets via the API. The user's private RSA key is POSTed with the name private_key. An example: curl -v -X POST -H "Authorization: Token " -H "Accept: application/json; indent=4" \ --data-urlencode "private_key@" https://netbox/api/secrets/get-session-key/ This request will yield a base64-encoded session key to be included in an X-Session-Key header in future requests: { "session_key": "+8t4SI6XikgVmB5+/urhozx9O5qCQANyOk1MNe6taRf=" } This endpoint accepts one optional parameter: preserve_key. If True and a session key exists, the existing session key will be returned instead of a new one.
|
| GET |
/secrets/secret-roles/
|
|
| POST |
/secrets/secret-roles/
|
|
| DEL |
/secrets/secret-roles/{id}/
|
|
| GET |
/secrets/secret-roles/{id}/
|
|
| PATCH |
/secrets/secret-roles/{id}/
|
|
| PUT |
/secrets/secret-roles/{id}/
|
|
| GET |
/secrets/secrets/
|
|
| POST |
/secrets/secrets/
|
|
| DEL |
/secrets/secrets/{id}/
|
|
| GET |
/secrets/secrets/{id}/
|
|
| PATCH |
/secrets/secrets/{id}/
|
|
| PUT |
/secrets/secrets/{id}/
|
|
| GET |
/tenancy/_choices/
|
|
| GET |
/tenancy/_choices/{id}/
|
|
| GET |
/tenancy/tenant-groups/
|
|
| POST |
/tenancy/tenant-groups/
|
|
| DEL |
/tenancy/tenant-groups/{id}/
|
|
| GET |
/tenancy/tenant-groups/{id}/
|
|
| PATCH |
/tenancy/tenant-groups/{id}/
|
|
| PUT |
/tenancy/tenant-groups/{id}/
|
|
| GET |
/tenancy/tenants/
|
|
| POST |
/tenancy/tenants/
|
|
| DEL |
/tenancy/tenants/{id}/
|
|
| GET |
/tenancy/tenants/{id}/
|
|
| PATCH |
/tenancy/tenants/{id}/
|
|
| PUT |
/tenancy/tenants/{id}/
|
|
| GET |
/virtualization/_choices/
|
|
| GET |
/virtualization/_choices/{id}/
|
|
| GET |
/virtualization/cluster-groups/
|
|
| POST |
/virtualization/cluster-groups/
|
|
| DEL |
/virtualization/cluster-groups/{id}/
|
|
| GET |
/virtualization/cluster-groups/{id}/
|
|
| PATCH |
/virtualization/cluster-groups/{id}/
|
|
| PUT |
/virtualization/cluster-groups/{id}/
|
|
| GET |
/virtualization/cluster-types/
|
|
| POST |
/virtualization/cluster-types/
|
|
| DEL |
/virtualization/cluster-types/{id}/
|
|
| GET |
/virtualization/cluster-types/{id}/
|
|
| PATCH |
/virtualization/cluster-types/{id}/
|
|
| PUT |
/virtualization/cluster-types/{id}/
|
|
| GET |
/virtualization/clusters/
|
|
| POST |
/virtualization/clusters/
|
|
| DEL |
/virtualization/clusters/{id}/
|
|
| GET |
/virtualization/clusters/{id}/
|
|
| PATCH |
/virtualization/clusters/{id}/
|
|
| PUT |
/virtualization/clusters/{id}/
|
|
| GET |
/virtualization/interfaces/
|
|
| POST |
/virtualization/interfaces/
|
|
| DEL |
/virtualization/interfaces/{id}/
|
|
| GET |
/virtualization/interfaces/{id}/
|
|
| PATCH |
/virtualization/interfaces/{id}/
|
|
| PUT |
/virtualization/interfaces/{id}/
|
|
| GET |
/virtualization/virtual-machines/
|
|
| POST |
/virtualization/virtual-machines/
|
|
| DEL |
/virtualization/virtual-machines/{id}/
|
|
| GET |
/virtualization/virtual-machines/{id}/
|
|
| PATCH |
/virtualization/virtual-machines/{id}/
|
|
| PUT |
/virtualization/virtual-machines/{id}/
|
[03]
Related mocks
NetBox Demo Dev API
Simulate the NetBox Demo Dev API in seconds. API to access NetBox
422 endpoints
·
devtools, infrastructure
Apache Airflow REST API
Mock the Apache Airflow REST API in seconds. Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects.
73 endpoints
·
ai, data, devtools
Appwrite Client API
Emulate the Appwrite Client API in seconds. Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application.
95 endpoints
·
backend, devtools