just/mocks_
mockzilla.org →
Catalog /devtools /NetBox Demo Dev API

NetBox Demo Dev API

PROVIDER · Netbox SPEC v3.4 · OpenAPI 3.0.0 MOCK · LIVE
▸ TRY IT
https://api.justmocks.com/netbox-demo
Open mock →

Simulate the NetBox Demo Dev API in seconds. API to access NetBox

[01]

About

overview

Mock the NetBox Demo Dev API as a turnkey Mockzilla sim with 844 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. API to access NetBox Methods: 208x GET, 180x DELETE, 180x PATCH, 180x PUT, 96x POST. Top resource groups: dcim, ipam, extras, tenancy. Hit https://api.justmocks.com/netbox-demo for the Mockzilla API Explorer landing and per-endpoint sample requests.

Endpoints
422 across 8 resource groups
Methods
GET 104 · POST 51 · PUT 89 · PATCH 89 · DEL 89 none deprecated
OpenAPI
3.0.0 spec version 3.4
Source spec
1365 KB · YAML view raw →
[02]

Endpoints

422 operations · 8 resource groups
DEL /circuits/circuit-terminations/
circuits
PATCH /circuits/circuit-terminations/
circuits
PUT /circuits/circuit-terminations/
circuits
GET /circuits/circuit-terminations/{id}/
circuits
PUT /circuits/circuit-terminations/{id}/
circuits
DEL /circuits/circuit-types/
circuits
PATCH /circuits/circuit-types/
circuits
PUT /circuits/circuit-types/
circuits
GET /circuits/circuit-types/{id}/
circuits
PUT /circuits/circuit-types/{id}/
circuits
GET /circuits/circuits/
circuits
POST /circuits/circuits/
circuits
DEL /circuits/circuits/{id}/
circuits
PATCH /circuits/circuits/{id}/
circuits
DEL /circuits/provider-networks/
circuits
PATCH /circuits/provider-networks/
circuits
PUT /circuits/provider-networks/
circuits
GET /circuits/provider-networks/{id}/
circuits
PUT /circuits/provider-networks/{id}/
circuits
GET /circuits/providers/
circuits
POST /circuits/providers/
circuits
DEL /circuits/providers/{id}/
circuits
PATCH /circuits/providers/{id}/
circuits
DEL /dcim/cable-terminations/
dcim
PATCH /dcim/cable-terminations/
dcim
PUT /dcim/cable-terminations/
dcim
GET /dcim/cable-terminations/{id}/
dcim
PUT /dcim/cable-terminations/{id}/
dcim
GET /dcim/cables/
dcim
POST /dcim/cables/
dcim
DEL /dcim/cables/{id}/
dcim
PATCH /dcim/cables/{id}/
dcim
GET /dcim/connected-device/
dcim
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-port-templates/
dcim
POST /dcim/console-port-templates/
dcim
DEL /dcim/console-port-templates/{id}/
dcim
PATCH /dcim/console-port-templates/{id}/
dcim
DEL /dcim/console-ports/
dcim
PATCH /dcim/console-ports/
dcim
PUT /dcim/console-ports/
dcim
GET /dcim/console-ports/{id}/
dcim
PUT /dcim/console-ports/{id}/
dcim
DEL /dcim/console-server-port-templates/
dcim
PATCH /dcim/console-server-port-templates/
dcim
PUT /dcim/console-server-port-templates/
dcim
GET /dcim/console-server-port-templates/{id}/
dcim
PUT /dcim/console-server-port-templates/{id}/
dcim
GET /dcim/console-server-ports/
dcim
POST /dcim/console-server-ports/
dcim
DEL /dcim/console-server-ports/{id}/
dcim
PATCH /dcim/console-server-ports/{id}/
dcim
GET /dcim/console-server-ports/{id}/trace/
dcim
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET /dcim/device-bay-templates/
dcim
POST /dcim/device-bay-templates/
dcim
DEL /dcim/device-bay-templates/{id}/
dcim
PATCH /dcim/device-bay-templates/{id}/
dcim
DEL /dcim/device-bays/
dcim
PATCH /dcim/device-bays/
dcim
PUT /dcim/device-bays/
dcim
GET /dcim/device-bays/{id}/
dcim
PUT /dcim/device-bays/{id}/
dcim
GET /dcim/device-roles/
dcim
POST /dcim/device-roles/
dcim
DEL /dcim/device-roles/{id}/
dcim
PATCH /dcim/device-roles/{id}/
dcim
DEL /dcim/device-types/
dcim
PATCH /dcim/device-types/
dcim
PUT /dcim/device-types/
dcim
GET /dcim/device-types/{id}/
dcim
PUT /dcim/device-types/{id}/
dcim
GET /dcim/devices/
dcim
POST /dcim/devices/
dcim
DEL /dcim/devices/{id}/
dcim
PATCH /dcim/devices/{id}/
dcim
GET /dcim/devices/{id}/napalm/
dcim
Execute a NAPALM method on a Device
GET /dcim/front-port-templates/
dcim
POST /dcim/front-port-templates/
dcim
DEL /dcim/front-port-templates/{id}/
dcim
PATCH /dcim/front-port-templates/{id}/
dcim
DEL /dcim/front-ports/
dcim
PATCH /dcim/front-ports/
dcim
PUT /dcim/front-ports/
dcim
GET /dcim/front-ports/{id}/
dcim
PUT /dcim/front-ports/{id}/
dcim
DEL /dcim/interface-templates/
dcim
PATCH /dcim/interface-templates/
dcim
PUT /dcim/interface-templates/
dcim
GET /dcim/interface-templates/{id}/
dcim
PUT /dcim/interface-templates/{id}/
dcim
GET /dcim/interfaces/
dcim
POST /dcim/interfaces/
dcim
DEL /dcim/interfaces/{id}/
dcim
PATCH /dcim/interfaces/{id}/
dcim
GET /dcim/interfaces/{id}/trace/
dcim
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET /dcim/inventory-item-roles/
dcim
POST /dcim/inventory-item-roles/
dcim
DEL /dcim/inventory-item-roles/{id}/
dcim
PATCH /dcim/inventory-item-roles/{id}/
dcim
DEL /dcim/inventory-item-templates/
dcim
PATCH /dcim/inventory-item-templates/
dcim
PUT /dcim/inventory-item-templates/
dcim
GET /dcim/inventory-item-templates/{id}/
dcim
PUT /dcim/inventory-item-templates/{id}/
dcim
GET /dcim/inventory-items/
dcim
POST /dcim/inventory-items/
dcim
DEL /dcim/inventory-items/{id}/
dcim
PATCH /dcim/inventory-items/{id}/
dcim
DEL /dcim/locations/
dcim
PATCH /dcim/locations/
dcim
PUT /dcim/locations/
dcim
GET /dcim/locations/{id}/
dcim
PUT /dcim/locations/{id}/
dcim
GET /dcim/manufacturers/
dcim
POST /dcim/manufacturers/
dcim
DEL /dcim/manufacturers/{id}/
dcim
PATCH /dcim/manufacturers/{id}/
dcim
DEL /dcim/module-bay-templates/
dcim
PATCH /dcim/module-bay-templates/
dcim
PUT /dcim/module-bay-templates/
dcim
GET /dcim/module-bay-templates/{id}/
dcim
PUT /dcim/module-bay-templates/{id}/
dcim
GET /dcim/module-bays/
dcim
POST /dcim/module-bays/
dcim
DEL /dcim/module-bays/{id}/
dcim
PATCH /dcim/module-bays/{id}/
dcim
DEL /dcim/module-types/
dcim
PATCH /dcim/module-types/
dcim
PUT /dcim/module-types/
dcim
GET /dcim/module-types/{id}/
dcim
PUT /dcim/module-types/{id}/
dcim
GET /dcim/modules/
dcim
POST /dcim/modules/
dcim
DEL /dcim/modules/{id}/
dcim
PATCH /dcim/modules/{id}/
dcim
DEL /dcim/platforms/
dcim
PATCH /dcim/platforms/
dcim
PUT /dcim/platforms/
dcim
GET /dcim/platforms/{id}/
dcim
PUT /dcim/platforms/{id}/
dcim
GET /dcim/power-feeds/
dcim
POST /dcim/power-feeds/
dcim
DEL /dcim/power-feeds/{id}/
dcim
PATCH /dcim/power-feeds/{id}/
dcim
GET /dcim/power-feeds/{id}/trace/
dcim
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET /dcim/power-outlet-templates/
dcim
POST /dcim/power-outlet-templates/
dcim
DEL /dcim/power-outlet-templates/{id}/
dcim
PATCH /dcim/power-outlet-templates/{id}/
dcim
DEL /dcim/power-outlets/
dcim
PATCH /dcim/power-outlets/
dcim
PUT /dcim/power-outlets/
dcim
GET /dcim/power-outlets/{id}/
dcim
PUT /dcim/power-outlets/{id}/
dcim
DEL /dcim/power-panels/
dcim
PATCH /dcim/power-panels/
dcim
PUT /dcim/power-panels/
dcim
GET /dcim/power-panels/{id}/
dcim
PUT /dcim/power-panels/{id}/
dcim
GET /dcim/power-port-templates/
dcim
POST /dcim/power-port-templates/
dcim
DEL /dcim/power-port-templates/{id}/
dcim
PATCH /dcim/power-port-templates/{id}/
dcim
DEL /dcim/power-ports/
dcim
PATCH /dcim/power-ports/
dcim
PUT /dcim/power-ports/
dcim
GET /dcim/power-ports/{id}/
dcim
PUT /dcim/power-ports/{id}/
dcim
DEL /dcim/rack-reservations/
dcim
PATCH /dcim/rack-reservations/
dcim
PUT /dcim/rack-reservations/
dcim
GET /dcim/rack-reservations/{id}/
dcim
PUT /dcim/rack-reservations/{id}/
dcim
GET /dcim/rack-roles/
dcim
POST /dcim/rack-roles/
dcim
DEL /dcim/rack-roles/{id}/
dcim
PATCH /dcim/rack-roles/{id}/
dcim
DEL /dcim/racks/
dcim
PATCH /dcim/racks/
dcim
PUT /dcim/racks/
dcim
GET /dcim/racks/{id}/
dcim
PUT /dcim/racks/{id}/
dcim
DEL /dcim/rear-port-templates/
dcim
PATCH /dcim/rear-port-templates/
dcim
PUT /dcim/rear-port-templates/
dcim
GET /dcim/rear-port-templates/{id}/
dcim
PUT /dcim/rear-port-templates/{id}/
dcim
GET /dcim/rear-ports/
dcim
POST /dcim/rear-ports/
dcim
DEL /dcim/rear-ports/{id}/
dcim
PATCH /dcim/rear-ports/{id}/
dcim
GET /dcim/rear-ports/{id}/paths/
dcim
Return all CablePaths which traverse a given pass-through port.
GET /dcim/regions/
dcim
POST /dcim/regions/
dcim
DEL /dcim/regions/{id}/
dcim
PATCH /dcim/regions/{id}/
dcim
DEL /dcim/site-groups/
dcim
PATCH /dcim/site-groups/
dcim
PUT /dcim/site-groups/
dcim
GET /dcim/site-groups/{id}/
dcim
PUT /dcim/site-groups/{id}/
dcim
GET /dcim/sites/
dcim
POST /dcim/sites/
dcim
DEL /dcim/sites/{id}/
dcim
PATCH /dcim/sites/{id}/
dcim
DEL /dcim/virtual-chassis/
dcim
PATCH /dcim/virtual-chassis/
dcim
PUT /dcim/virtual-chassis/
dcim
GET /dcim/virtual-chassis/{id}/
dcim
PUT /dcim/virtual-chassis/{id}/
dcim
GET /dcim/virtual-device-contexts/
dcim
POST /dcim/virtual-device-contexts/
dcim
DEL /dcim/virtual-device-contexts/{id}/
dcim
PATCH /dcim/virtual-device-contexts/{id}/
dcim
DEL /extras/config-contexts/
extras
PATCH /extras/config-contexts/
extras
PUT /extras/config-contexts/
extras
GET /extras/config-contexts/{id}/
extras
PUT /extras/config-contexts/{id}/
extras
GET /extras/content-types/{id}/
extras
Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.
GET /extras/custom-fields/
extras
POST /extras/custom-fields/
extras
DEL /extras/custom-fields/{id}/
extras
PATCH /extras/custom-fields/{id}/
extras
DEL /extras/custom-links/
extras
PATCH /extras/custom-links/
extras
PUT /extras/custom-links/
extras
GET /extras/custom-links/{id}/
extras
PUT /extras/custom-links/{id}/
extras
GET /extras/export-templates/
extras
POST /extras/export-templates/
extras
DEL /extras/export-templates/{id}/
extras
PATCH /extras/export-templates/{id}/
extras
DEL /extras/image-attachments/
extras
PATCH /extras/image-attachments/
extras
PUT /extras/image-attachments/
extras
GET /extras/image-attachments/{id}/
extras
PUT /extras/image-attachments/{id}/
extras
GET /extras/job-results/{id}/
extras
Retrieve a list of job results. Served by the Mockzilla mock runtime.
GET /extras/journal-entries/
extras
POST /extras/journal-entries/
extras
DEL /extras/journal-entries/{id}/
extras
PATCH /extras/journal-entries/{id}/
extras
GET /extras/object-changes/
extras
Retrieve a list of recent changes.
GET /extras/reports/
extras
Compile all reports and their related results (if any). Result data is deferred in the list view.
POST /extras/reports/{id}/run/
extras
Run a Report identified as "." and return the pending JobResult as the result. Mocked via Mockzilla.
GET /extras/saved-filters/
extras
POST /extras/saved-filters/
extras
DEL /extras/saved-filters/{id}/
extras
PATCH /extras/saved-filters/{id}/
extras
GET /extras/scripts/
extras
DEL /extras/tags/
extras
PATCH /extras/tags/
extras
PUT /extras/tags/
extras
GET /extras/tags/{id}/
extras
PUT /extras/tags/{id}/
extras
GET /extras/webhooks/
extras
POST /extras/webhooks/
extras
DEL /extras/webhooks/{id}/
extras
PATCH /extras/webhooks/{id}/
extras
DEL /ipam/aggregates/
ipam
PATCH /ipam/aggregates/
ipam
PUT /ipam/aggregates/
ipam
GET /ipam/aggregates/{id}/
ipam
PUT /ipam/aggregates/{id}/
ipam
GET /ipam/asns/
ipam
POST /ipam/asns/
ipam
DEL /ipam/asns/{id}/
ipam
PATCH /ipam/asns/{id}/
ipam
DEL /ipam/fhrp-group-assignments/
ipam
PATCH /ipam/fhrp-group-assignments/
ipam
PUT /ipam/fhrp-group-assignments/
ipam
GET /ipam/fhrp-group-assignments/{id}/
ipam
PUT /ipam/fhrp-group-assignments/{id}/
ipam
GET /ipam/fhrp-groups/
ipam
POST /ipam/fhrp-groups/
ipam
DEL /ipam/fhrp-groups/{id}/
ipam
PATCH /ipam/fhrp-groups/{id}/
ipam
DEL /ipam/ip-addresses/
ipam
PATCH /ipam/ip-addresses/
ipam
PUT /ipam/ip-addresses/
ipam
GET /ipam/ip-addresses/{id}/
ipam
PUT /ipam/ip-addresses/{id}/
ipam
GET /ipam/ip-ranges/
ipam
POST /ipam/ip-ranges/
ipam
DEL /ipam/ip-ranges/{id}/
ipam
PATCH /ipam/ip-ranges/{id}/
ipam
GET /ipam/ip-ranges/{id}/available-ips/
ipam
DEL /ipam/l2vpn-terminations/
ipam
PATCH /ipam/l2vpn-terminations/
ipam
PUT /ipam/l2vpn-terminations/
ipam
GET /ipam/l2vpn-terminations/{id}/
ipam
PUT /ipam/l2vpn-terminations/{id}/
ipam
GET /ipam/l2vpns/
ipam
POST /ipam/l2vpns/
ipam
DEL /ipam/l2vpns/{id}/
ipam
PATCH /ipam/l2vpns/{id}/
ipam
DEL /ipam/prefixes/
ipam
PATCH /ipam/prefixes/
ipam
PUT /ipam/prefixes/
ipam
GET /ipam/prefixes/{id}/
ipam
PUT /ipam/prefixes/{id}/
ipam
POST /ipam/prefixes/{id}/available-ips/
ipam
POST /ipam/prefixes/{id}/available-prefixes/
ipam
GET /ipam/rirs/
ipam
POST /ipam/rirs/
ipam
DEL /ipam/rirs/{id}/
ipam
PATCH /ipam/rirs/{id}/
ipam
DEL /ipam/roles/
ipam
PATCH /ipam/roles/
ipam
PUT /ipam/roles/
ipam
GET /ipam/roles/{id}/
ipam
PUT /ipam/roles/{id}/
ipam
GET /ipam/route-targets/
ipam
POST /ipam/route-targets/
ipam
DEL /ipam/route-targets/{id}/
ipam
PATCH /ipam/route-targets/{id}/
ipam
DEL /ipam/service-templates/
ipam
PATCH /ipam/service-templates/
ipam
PUT /ipam/service-templates/
ipam
GET /ipam/service-templates/{id}/
ipam
PUT /ipam/service-templates/{id}/
ipam
GET /ipam/services/
ipam
POST /ipam/services/
ipam
DEL /ipam/services/{id}/
ipam
PATCH /ipam/services/{id}/
ipam
DEL /ipam/vlan-groups/
ipam
PATCH /ipam/vlan-groups/
ipam
PUT /ipam/vlan-groups/
ipam
GET /ipam/vlan-groups/{id}/
ipam
PUT /ipam/vlan-groups/{id}/
ipam
POST /ipam/vlan-groups/{id}/available-vlans/
ipam
GET /ipam/vlans/
ipam
POST /ipam/vlans/
ipam
DEL /ipam/vlans/{id}/
ipam
PATCH /ipam/vlans/{id}/
ipam
DEL /ipam/vrfs/
ipam
PATCH /ipam/vrfs/
ipam
PUT /ipam/vrfs/
ipam
GET /ipam/vrfs/{id}/
ipam
PUT /ipam/vrfs/{id}/
ipam
DEL /tenancy/contact-assignments/
tenancy
PATCH /tenancy/contact-assignments/
tenancy
PUT /tenancy/contact-assignments/
tenancy
GET /tenancy/contact-assignments/{id}/
tenancy
PUT /tenancy/contact-assignments/{id}/
tenancy
GET /tenancy/contact-groups/
tenancy
POST /tenancy/contact-groups/
tenancy
DEL /tenancy/contact-groups/{id}/
tenancy
PATCH /tenancy/contact-groups/{id}/
tenancy
DEL /tenancy/contact-roles/
tenancy
PATCH /tenancy/contact-roles/
tenancy
PUT /tenancy/contact-roles/
tenancy
GET /tenancy/contact-roles/{id}/
tenancy
PUT /tenancy/contact-roles/{id}/
tenancy
GET /tenancy/contacts/
tenancy
POST /tenancy/contacts/
tenancy
DEL /tenancy/contacts/{id}/
tenancy
PATCH /tenancy/contacts/{id}/
tenancy
DEL /tenancy/tenant-groups/
tenancy
PATCH /tenancy/tenant-groups/
tenancy
PUT /tenancy/tenant-groups/
tenancy
GET /tenancy/tenant-groups/{id}/
tenancy
PUT /tenancy/tenant-groups/{id}/
tenancy
GET /tenancy/tenants/
tenancy
POST /tenancy/tenants/
tenancy
DEL /tenancy/tenants/{id}/
tenancy
PATCH /tenancy/tenants/{id}/
tenancy
GET /users/config/
users
Return the UserConfig for the currently authenticated User.
GET /users/groups/
users
POST /users/groups/
users
DEL /users/groups/{id}/
users
PATCH /users/groups/{id}/
users
DEL /users/permissions/
users
PATCH /users/permissions/
users
PUT /users/permissions/
users
GET /users/permissions/{id}/
users
PUT /users/permissions/{id}/
users
GET /users/tokens/
users
POST /users/tokens/
users
POST /users/tokens/provision/
users
Non-authenticated REST API endpoint via which a user may create a Token.
GET /users/tokens/{id}/
users
PUT /users/tokens/{id}/
users
GET /users/users/
users
POST /users/users/
users
DEL /users/users/{id}/
users
PATCH /users/users/{id}/
users
DEL /virtualization/cluster-groups/
virtualization
PATCH /virtualization/cluster-groups/
virtualization
PUT /virtualization/cluster-groups/
virtualization
GET /virtualization/cluster-groups/{id}/
virtualization
PUT /virtualization/cluster-groups/{id}/
virtualization
GET /virtualization/cluster-types/
virtualization
POST /virtualization/cluster-types/
virtualization
DEL /virtualization/cluster-types/{id}/
virtualization
PATCH /virtualization/cluster-types/{id}/
virtualization
DEL /virtualization/clusters/
virtualization
PATCH /virtualization/clusters/
virtualization
PUT /virtualization/clusters/
virtualization
GET /virtualization/clusters/{id}/
virtualization
PUT /virtualization/clusters/{id}/
virtualization
GET /virtualization/interfaces/
virtualization
POST /virtualization/interfaces/
virtualization
DEL /virtualization/interfaces/{id}/
virtualization
PATCH /virtualization/interfaces/{id}/
virtualization
DEL /virtualization/virtual-machines/
virtualization
PATCH /virtualization/virtual-machines/
virtualization
PUT /virtualization/virtual-machines/
virtualization
GET /virtualization/virtual-machines/{id}/
virtualization
PUT /virtualization/virtual-machines/{id}/
virtualization
GET /wireless/wireless-lan-groups/
wireless
POST /wireless/wireless-lan-groups/
wireless
DEL /wireless/wireless-lan-groups/{id}/
wireless
PATCH /wireless/wireless-lan-groups/{id}/
wireless
DEL /wireless/wireless-lans/
wireless
PATCH /wireless/wireless-lans/
wireless
PUT /wireless/wireless-lans/
wireless
GET /wireless/wireless-lans/{id}/
wireless
PUT /wireless/wireless-lans/{id}/
wireless
GET /wireless/wireless-links/
wireless
POST /wireless/wireless-links/
wireless
DEL /wireless/wireless-links/{id}/
wireless
PATCH /wireless/wireless-links/{id}/
wireless