Netbox

NetBox API

API to access NetBox

Other#openapi#enterprise

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API to access NetBox

Endpoints 400

circuits

  • GETcircuits_circuit-terminations_list/circuits/circuit-terminations/?id=string&term_side=string&port_speed=string&upstream_speed=string&xconnect_id=string&description=string&cable_end=string&created=string&last_updated=string&q=string&tag=string&cabled=string&occupied=string&circuit_id=string&site_id=string&site=string&provider_network_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&term_side__n=string&port_speed__n=string&port_speed__lte=string&port_speed__lt=string&port_speed__gte=string&port_speed__gt=string&upstream_speed__n=string&upstream_speed__lte=string&upstream_speed__lt=string&upstream_speed__gte=string&upstream_speed__gt=string&xconnect_id__n=string&xconnect_id__ic=string&xconnect_id__nic=string&xconnect_id__iew=string&xconnect_id__niew=string&xconnect_id__isw=string&xconnect_id__nisw=string&xconnect_id__ie=string&xconnect_id__nie=string&xconnect_id__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&circuit_id__n=string&site_id__n=string&site__n=string&provider_network_id__n=string&ordering=string&limit=0&offset=0
  • PUTcircuits_circuit-terminations_bulk_update/circuits/circuit-terminations/
  • POSTcircuits_circuit-terminations_create/circuits/circuit-terminations/
  • DELETEcircuits_circuit-terminations_bulk_delete/circuits/circuit-terminations/
  • PATCHcircuits_circuit-terminations_bulk_partial_update/circuits/circuit-terminations/
  • GETcircuits_circuit-terminations_read/circuits/circuit-terminations/:id/
  • PUTcircuits_circuit-terminations_update/circuits/circuit-terminations/:id/
  • DELETEcircuits_circuit-terminations_delete/circuits/circuit-terminations/:id/
  • PATCHcircuits_circuit-terminations_partial_update/circuits/circuit-terminations/:id/
  • GETcircuits_circuit-terminations_paths/circuits/circuit-terminations/:id/paths/Return all CablePaths which traverse a given pass-through port.
  • GETcircuits_circuit-types_list/circuits/circuit-types/?id=string&name=string&slug=string&description=string&created=string&last_updated=string&q=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTcircuits_circuit-types_bulk_update/circuits/circuit-types/
  • POSTcircuits_circuit-types_create/circuits/circuit-types/
  • DELETEcircuits_circuit-types_bulk_delete/circuits/circuit-types/
  • PATCHcircuits_circuit-types_bulk_partial_update/circuits/circuit-types/
  • GETcircuits_circuit-types_read/circuits/circuit-types/:id/
  • PUTcircuits_circuit-types_update/circuits/circuit-types/:id/
  • DELETEcircuits_circuit-types_delete/circuits/circuit-types/:id/
  • PATCHcircuits_circuit-types_partial_update/circuits/circuit-types/:id/
  • GETcircuits_circuits_list/circuits/circuits/?id=string&cid=string&description=string&install_date=string&termination_date=string&commit_rate=string&created=string&last_updated=string&q=string&tag=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&contact=string&contact_role=string&contact_group=string&provider_id=string&provider=string&provider_network_id=string&type_id=string&type=string&status=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&cid__n=string&cid__ic=string&cid__nic=string&cid__iew=string&cid__niew=string&cid__isw=string&cid__nisw=string&cid__ie=string&cid__nie=string&cid__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&install_date__n=string&install_date__lte=string&install_date__lt=string&install_date__gte=string&install_date__gt=string&termination_date__n=string&termination_date__lte=string&termination_date__lt=string&termination_date__gte=string&termination_date__gt=string&commit_rate__n=string&commit_rate__lte=string&commit_rate__lt=string&commit_rate__gte=string&commit_rate__gt=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&contact__n=string&contact_role__n=string&contact_group__n=string&provider_id__n=string&provider__n=string&provider_network_id__n=string&type_id__n=string&type__n=string&status__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&ordering=string&limit=0&offset=0
  • PUTcircuits_circuits_bulk_update/circuits/circuits/
  • POSTcircuits_circuits_create/circuits/circuits/
  • DELETEcircuits_circuits_bulk_delete/circuits/circuits/
  • PATCHcircuits_circuits_bulk_partial_update/circuits/circuits/
  • GETcircuits_circuits_read/circuits/circuits/:id/
  • PUTcircuits_circuits_update/circuits/circuits/:id/
  • DELETEcircuits_circuits_delete/circuits/circuits/:id/
  • PATCHcircuits_circuits_partial_update/circuits/circuits/:id/
  • GETcircuits_provider-networks_list/circuits/provider-networks/?id=string&name=string&service_id=string&description=string&created=string&last_updated=string&q=string&tag=string&provider_id=string&provider=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&service_id__n=string&service_id__ic=string&service_id__nic=string&service_id__iew=string&service_id__niew=string&service_id__isw=string&service_id__nisw=string&service_id__ie=string&service_id__nie=string&service_id__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&provider_id__n=string&provider__n=string&ordering=string&limit=0&offset=0
  • PUTcircuits_provider-networks_bulk_update/circuits/provider-networks/
  • POSTcircuits_provider-networks_create/circuits/provider-networks/
  • DELETEcircuits_provider-networks_bulk_delete/circuits/provider-networks/
  • PATCHcircuits_provider-networks_bulk_partial_update/circuits/provider-networks/
  • GETcircuits_provider-networks_read/circuits/provider-networks/:id/
  • PUTcircuits_provider-networks_update/circuits/provider-networks/:id/
  • DELETEcircuits_provider-networks_delete/circuits/provider-networks/:id/
  • PATCHcircuits_provider-networks_partial_update/circuits/provider-networks/:id/
  • GETcircuits_providers_list/circuits/providers/?id=string&name=string&slug=string&account=string&created=string&last_updated=string&q=string&tag=string&contact=string&contact_role=string&contact_group=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&asn_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&account__n=string&account__ic=string&account__nic=string&account__iew=string&account__niew=string&account__isw=string&account__nisw=string&account__ie=string&account__nie=string&account__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&contact__n=string&contact_role__n=string&contact_group__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&asn_id__n=string&ordering=string&limit=0&offset=0
  • PUTcircuits_providers_bulk_update/circuits/providers/
  • POSTcircuits_providers_create/circuits/providers/
  • DELETEcircuits_providers_bulk_delete/circuits/providers/
  • PATCHcircuits_providers_bulk_partial_update/circuits/providers/
  • GETcircuits_providers_read/circuits/providers/:id/
  • PUTcircuits_providers_update/circuits/providers/:id/
  • DELETEcircuits_providers_delete/circuits/providers/:id/
  • PATCHcircuits_providers_partial_update/circuits/providers/:id/

dcim

  • GETdcim_cable-terminations_list/dcim/cable-terminations/?id=string&cable=string&cable_end=string&termination_type=string&termination_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&cable__n=string&cable_end__n=string&termination_type__n=string&termination_id__n=string&termination_id__lte=string&termination_id__lt=string&termination_id__gte=string&termination_id__gt=string&ordering=string&limit=0&offset=0
  • PUTdcim_cable-terminations_bulk_update/dcim/cable-terminations/
  • POSTdcim_cable-terminations_create/dcim/cable-terminations/
  • DELETEdcim_cable-terminations_bulk_delete/dcim/cable-terminations/
  • PATCHdcim_cable-terminations_bulk_partial_update/dcim/cable-terminations/
  • GETdcim_cable-terminations_read/dcim/cable-terminations/:id/
  • PUTdcim_cable-terminations_update/dcim/cable-terminations/:id/
  • DELETEdcim_cable-terminations_delete/dcim/cable-terminations/:id/
  • PATCHdcim_cable-terminations_partial_update/dcim/cable-terminations/:id/
  • GETdcim_cables_list/dcim/cables/?id=string&label=string&length=string&length_unit=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&last_updated=string&q=string&tag=string&termination_a_type=string&termination_a_id=string&termination_b_type=string&termination_b_id=string&type=string&status=string&color=string&device_id=string&device=string&rack_id=string&rack=string&location_id=string&location=string&site_id=string&site=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&length__n=string&length__lte=string&length__lt=string&length__gte=string&length__gt=string&length_unit__n=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&termination_a_type__n=string&termination_a_id__n=string&termination_a_id__lte=string&termination_a_id__lt=string&termination_a_id__gte=string&termination_a_id__gt=string&termination_b_type__n=string&termination_b_id__n=string&termination_b_id__lte=string&termination_b_id__lt=string&termination_b_id__gte=string&termination_b_id__gt=string&type__n=string&status__n=string&color__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_cables_bulk_update/dcim/cables/
  • POSTdcim_cables_create/dcim/cables/
  • DELETEdcim_cables_bulk_delete/dcim/cables/
  • PATCHdcim_cables_bulk_partial_update/dcim/cables/
  • GETdcim_cables_read/dcim/cables/:id/
  • PUTdcim_cables_update/dcim/cables/:id/
  • DELETEdcim_cables_delete/dcim/cables/:id/
  • PATCHdcim_cables_partial_update/dcim/cables/:id/
  • GETdcim_connected-device_list/dcim/connected-device/?peer_device=string&peer_interface=stringThis 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…
  • GETdcim_console-port-templates_list/dcim/console-port-templates/?id=string&name=string&type=string&created=string&last_updated=string&q=string&devicetype_id=string&moduletype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&type__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&moduletype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_console-port-templates_bulk_update/dcim/console-port-templates/
  • POSTdcim_console-port-templates_create/dcim/console-port-templates/
  • DELETEdcim_console-port-templates_bulk_delete/dcim/console-port-templates/
  • PATCHdcim_console-port-templates_bulk_partial_update/dcim/console-port-templates/
  • GETdcim_console-port-templates_read/dcim/console-port-templates/:id/
  • PUTdcim_console-port-templates_update/dcim/console-port-templates/:id/
  • DELETEdcim_console-port-templates_delete/dcim/console-port-templates/:id/
  • PATCHdcim_console-port-templates_partial_update/dcim/console-port-templates/:id/
  • GETdcim_console-ports_list/dcim/console-ports/?id=string&name=string&label=string&description=string&cable_end=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&module_id=string&created=string&last_updated=string&tag=string&cabled=string&occupied=string&connected=string&type=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&module_id__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&type__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_console-ports_bulk_update/dcim/console-ports/
  • POSTdcim_console-ports_create/dcim/console-ports/
  • DELETEdcim_console-ports_bulk_delete/dcim/console-ports/
  • PATCHdcim_console-ports_bulk_partial_update/dcim/console-ports/
  • GETdcim_console-ports_read/dcim/console-ports/:id/
  • PUTdcim_console-ports_update/dcim/console-ports/:id/
  • DELETEdcim_console-ports_delete/dcim/console-ports/:id/
  • PATCHdcim_console-ports_partial_update/dcim/console-ports/:id/
  • GETdcim_console-ports_trace/dcim/console-ports/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_console-server-port-templates_list/dcim/console-server-port-templates/?id=string&name=string&type=string&created=string&last_updated=string&q=string&devicetype_id=string&moduletype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&type__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&moduletype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_console-server-port-templates_bulk_update/dcim/console-server-port-templates/
  • POSTdcim_console-server-port-templates_create/dcim/console-server-port-templates/
  • DELETEdcim_console-server-port-templates_bulk_delete/dcim/console-server-port-templates/
  • PATCHdcim_console-server-port-templates_bulk_partial_update/dcim/console-server-port-templates/
  • GETdcim_console-server-port-templates_read/dcim/console-server-port-templates/:id/
  • PUTdcim_console-server-port-templates_update/dcim/console-server-port-templates/:id/
  • DELETEdcim_console-server-port-templates_delete/dcim/console-server-port-templates/:id/
  • PATCHdcim_console-server-port-templates_partial_update/dcim/console-server-port-templates/:id/
  • GETdcim_console-server-ports_list/dcim/console-server-ports/?id=string&name=string&label=string&description=string&cable_end=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&module_id=string&created=string&last_updated=string&tag=string&cabled=string&occupied=string&connected=string&type=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&module_id__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&type__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_console-server-ports_bulk_update/dcim/console-server-ports/
  • POSTdcim_console-server-ports_create/dcim/console-server-ports/
  • DELETEdcim_console-server-ports_bulk_delete/dcim/console-server-ports/
  • PATCHdcim_console-server-ports_bulk_partial_update/dcim/console-server-ports/
  • GETdcim_console-server-ports_read/dcim/console-server-ports/:id/
  • PUTdcim_console-server-ports_update/dcim/console-server-ports/:id/
  • DELETEdcim_console-server-ports_delete/dcim/console-server-ports/:id/
  • PATCHdcim_console-server-ports_partial_update/dcim/console-server-ports/:id/
  • GETdcim_console-server-ports_trace/dcim/console-server-ports/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_device-bay-templates_list/dcim/device-bay-templates/?id=string&name=string&created=string&last_updated=string&q=string&devicetype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_device-bay-templates_bulk_update/dcim/device-bay-templates/
  • POSTdcim_device-bay-templates_create/dcim/device-bay-templates/
  • DELETEdcim_device-bay-templates_bulk_delete/dcim/device-bay-templates/
  • PATCHdcim_device-bay-templates_bulk_partial_update/dcim/device-bay-templates/
  • GETdcim_device-bay-templates_read/dcim/device-bay-templates/:id/
  • PUTdcim_device-bay-templates_update/dcim/device-bay-templates/:id/
  • DELETEdcim_device-bay-templates_delete/dcim/device-bay-templates/:id/
  • PATCHdcim_device-bay-templates_partial_update/dcim/device-bay-templates/:id/
  • GETdcim_device-bays_list/dcim/device-bays/?id=string&name=string&label=string&description=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&created=string&last_updated=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_device-bays_bulk_update/dcim/device-bays/
  • POSTdcim_device-bays_create/dcim/device-bays/
  • DELETEdcim_device-bays_bulk_delete/dcim/device-bays/
  • PATCHdcim_device-bays_bulk_partial_update/dcim/device-bays/
  • GETdcim_device-bays_read/dcim/device-bays/:id/
  • PUTdcim_device-bays_update/dcim/device-bays/:id/
  • DELETEdcim_device-bays_delete/dcim/device-bays/:id/
  • PATCHdcim_device-bays_partial_update/dcim/device-bays/:id/
  • GETdcim_device-roles_list/dcim/device-roles/?id=string&name=string&slug=string&color=string&vm_role=string&description=string&created=string&last_updated=string&q=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&color__n=string&color__ic=string&color__nic=string&color__iew=string&color__niew=string&color__isw=string&color__nisw=string&color__ie=string&color__nie=string&color__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_device-roles_bulk_update/dcim/device-roles/
  • POSTdcim_device-roles_create/dcim/device-roles/
  • DELETEdcim_device-roles_bulk_delete/dcim/device-roles/
  • PATCHdcim_device-roles_bulk_partial_update/dcim/device-roles/
  • GETdcim_device-roles_read/dcim/device-roles/:id/
  • PUTdcim_device-roles_update/dcim/device-roles/:id/
  • DELETEdcim_device-roles_delete/dcim/device-roles/:id/
  • PATCHdcim_device-roles_partial_update/dcim/device-roles/:id/
  • GETdcim_device-types_list/dcim/device-types/?id=string&model=string&slug=string&part_number=string&u_height=string&is_full_depth=string&subdevice_role=string&airflow=string&weight=string&weight_unit=string&created=string&last_updated=string&q=string&tag=string&manufacturer_id=string&manufacturer=string&has_front_image=string&has_rear_image=string&console_ports=string&console_server_ports=string&power_ports=string&power_outlets=string&interfaces=string&pass_through_ports=string&module_bays=string&device_bays=string&inventory_items=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&model__n=string&model__ic=string&model__nic=string&model__iew=string&model__niew=string&model__isw=string&model__nisw=string&model__ie=string&model__nie=string&model__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&part_number__n=string&part_number__ic=string&part_number__nic=string&part_number__iew=string&part_number__niew=string&part_number__isw=string&part_number__nisw=string&part_number__ie=string&part_number__nie=string&part_number__empty=string&u_height__n=string&u_height__lte=string&u_height__lt=string&u_height__gte=string&u_height__gt=string&subdevice_role__n=string&airflow__n=string&weight__n=string&weight__lte=string&weight__lt=string&weight__gte=string&weight__gt=string&weight_unit__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&manufacturer_id__n=string&manufacturer__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_device-types_bulk_update/dcim/device-types/
  • POSTdcim_device-types_create/dcim/device-types/
  • DELETEdcim_device-types_bulk_delete/dcim/device-types/
  • PATCHdcim_device-types_bulk_partial_update/dcim/device-types/
  • GETdcim_device-types_read/dcim/device-types/:id/
  • PUTdcim_device-types_update/dcim/device-types/:id/
  • DELETEdcim_device-types_delete/dcim/device-types/:id/
  • PATCHdcim_device-types_partial_update/dcim/device-types/:id/
  • GETdcim_devices_list/dcim/devices/?id=string&asset_tag=string&face=string&position=string&airflow=string&vc_position=string&vc_priority=string&created=string&last_updated=string&q=string&tag=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&contact=string&contact_role=string&contact_group=string&local_context_data=string&manufacturer_id=string&manufacturer=string&device_type=string&device_type_id=string&role_id=string&role=string&parent_device_id=string&platform_id=string&platform=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&rack_id=string&cluster_id=string&model=string&name=string&status=string&is_full_depth=string&mac_address=string&serial=string&has_primary_ip=string&virtual_chassis_id=string&virtual_chassis_member=string&console_ports=string&console_server_ports=string&power_ports=string&power_outlets=string&interfaces=string&pass_through_ports=string&module_bays=string&device_bays=string&primary_ip4_id=string&primary_ip6_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&asset_tag__n=string&asset_tag__ic=string&asset_tag__nic=string&asset_tag__iew=string&asset_tag__niew=string&asset_tag__isw=string&asset_tag__nisw=string&asset_tag__ie=string&asset_tag__nie=string&asset_tag__empty=string&face__n=string&position__n=string&position__lte=string&position__lt=string&position__gte=string&position__gt=string&airflow__n=string&vc_position__n=string&vc_position__lte=string&vc_position__lt=string&vc_position__gte=string&vc_position__gt=string&vc_priority__n=string&vc_priority__lte=string&vc_priority__lt=string&vc_priority__gte=string&vc_priority__gt=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&contact__n=string&contact_role__n=string&contact_group__n=string&manufacturer_id__n=string&manufacturer__n=string&device_type__n=string&device_type_id__n=string&role_id__n=string&role__n=string&parent_device_id__n=string&platform_id__n=string&platform__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&rack_id__n=string&cluster_id__n=string&model__n=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&status__n=string&mac_address__n=string&mac_address__ic=string&mac_address__nic=string&mac_address__iew=string&mac_address__niew=string&mac_address__isw=string&mac_address__nisw=string&mac_address__ie=string&mac_address__nie=string&serial__n=string&serial__ic=string&serial__nic=string&serial__iew=string&serial__niew=string&serial__isw=string&serial__nisw=string&serial__ie=string&serial__nie=string&serial__empty=string&virtual_chassis_id__n=string&primary_ip4_id__n=string&primary_ip6_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_devices_bulk_update/dcim/devices/
  • POSTdcim_devices_create/dcim/devices/
  • DELETEdcim_devices_bulk_delete/dcim/devices/
  • PATCHdcim_devices_bulk_partial_update/dcim/devices/
  • GETdcim_devices_read/dcim/devices/:id/
  • PUTdcim_devices_update/dcim/devices/:id/
  • DELETEdcim_devices_delete/dcim/devices/:id/
  • PATCHdcim_devices_partial_update/dcim/devices/:id/
  • GETdcim_devices_napalm/dcim/devices/:id/napalm/?method=stringExecute a NAPALM method on a Device
  • GETdcim_front-port-templates_list/dcim/front-port-templates/?id=string&name=string&type=string&color=string&created=string&last_updated=string&q=string&devicetype_id=string&moduletype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&type__n=string&color__n=string&color__ic=string&color__nic=string&color__iew=string&color__niew=string&color__isw=string&color__nisw=string&color__ie=string&color__nie=string&color__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&moduletype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_front-port-templates_bulk_update/dcim/front-port-templates/
  • POSTdcim_front-port-templates_create/dcim/front-port-templates/
  • DELETEdcim_front-port-templates_bulk_delete/dcim/front-port-templates/
  • PATCHdcim_front-port-templates_bulk_partial_update/dcim/front-port-templates/
  • GETdcim_front-port-templates_read/dcim/front-port-templates/:id/
  • PUTdcim_front-port-templates_update/dcim/front-port-templates/:id/
  • DELETEdcim_front-port-templates_delete/dcim/front-port-templates/:id/
  • PATCHdcim_front-port-templates_partial_update/dcim/front-port-templates/:id/
  • GETdcim_front-ports_list/dcim/front-ports/?id=string&name=string&label=string&type=string&color=string&description=string&cable_end=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&module_id=string&created=string&last_updated=string&tag=string&cabled=string&occupied=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&type__n=string&color__n=string&color__ic=string&color__nic=string&color__iew=string&color__niew=string&color__isw=string&color__nisw=string&color__ie=string&color__nie=string&color__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&module_id__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_front-ports_bulk_update/dcim/front-ports/
  • POSTdcim_front-ports_create/dcim/front-ports/
  • DELETEdcim_front-ports_bulk_delete/dcim/front-ports/
  • PATCHdcim_front-ports_bulk_partial_update/dcim/front-ports/
  • GETdcim_front-ports_read/dcim/front-ports/:id/
  • PUTdcim_front-ports_update/dcim/front-ports/:id/
  • DELETEdcim_front-ports_delete/dcim/front-ports/:id/
  • PATCHdcim_front-ports_partial_update/dcim/front-ports/:id/
  • GETdcim_front-ports_paths/dcim/front-ports/:id/paths/Return all CablePaths which traverse a given pass-through port.
  • GETdcim_interface-templates_list/dcim/interface-templates/?id=string&name=string&type=string&mgmt_only=string&created=string&last_updated=string&q=string&devicetype_id=string&moduletype_id=string&poe_mode=string&poe_type=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&type__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&moduletype_id__n=string&poe_mode__n=string&poe_type__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_interface-templates_bulk_update/dcim/interface-templates/
  • POSTdcim_interface-templates_create/dcim/interface-templates/
  • DELETEdcim_interface-templates_bulk_delete/dcim/interface-templates/
  • PATCHdcim_interface-templates_bulk_partial_update/dcim/interface-templates/
  • GETdcim_interface-templates_read/dcim/interface-templates/:id/
  • PUTdcim_interface-templates_update/dcim/interface-templates/:id/
  • DELETEdcim_interface-templates_delete/dcim/interface-templates/:id/
  • PATCHdcim_interface-templates_partial_update/dcim/interface-templates/:id/
  • GETdcim_interfaces_list/dcim/interfaces/?id=string&name=string&label=string&type=string&enabled=string&mtu=string&mgmt_only=string&poe_mode=string&poe_type=string&mode=string&rf_role=string&rf_channel=string&rf_channel_frequency=string&rf_channel_width=string&tx_power=string&description=string&cable_end=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&module_id=string&created=string&last_updated=string&tag=string&cabled=string&occupied=string&connected=string&kind=string&parent_id=string&bridge_id=string&lag_id=string&speed=string&duplex=string&mac_address=string&wwn=string&vlan_id=string&vlan=string&vrf_id=string&vrf=string&vdc_id=string&vdc_identifier=string&vdc=string&l2vpn_id=string&l2vpn=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&type__n=string&mtu__n=string&mtu__lte=string&mtu__lt=string&mtu__gte=string&mtu__gt=string&poe_mode__n=string&poe_type__n=string&mode__n=string&rf_role__n=string&rf_channel__n=string&rf_channel_frequency__n=string&rf_channel_frequency__lte=string&rf_channel_frequency__lt=string&rf_channel_frequency__gte=string&rf_channel_frequency__gt=string&rf_channel_width__n=string&rf_channel_width__lte=string&rf_channel_width__lt=string&rf_channel_width__gte=string&rf_channel_width__gt=string&tx_power__n=string&tx_power__lte=string&tx_power__lt=string&tx_power__gte=string&tx_power__gt=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&module_id__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&parent_id__n=string&bridge_id__n=string&lag_id__n=string&speed__n=string&speed__lte=string&speed__lt=string&speed__gte=string&speed__gt=string&duplex__n=string&mac_address__n=string&mac_address__ic=string&mac_address__nic=string&mac_address__iew=string&mac_address__niew=string&mac_address__isw=string&mac_address__nisw=string&mac_address__ie=string&mac_address__nie=string&wwn__n=string&wwn__ic=string&wwn__nic=string&wwn__iew=string&wwn__niew=string&wwn__isw=string&wwn__nisw=string&wwn__ie=string&wwn__nie=string&vrf_id__n=string&vrf__n=string&vdc_id__n=string&vdc_identifier__n=string&vdc__n=string&l2vpn_id__n=string&l2vpn__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_interfaces_bulk_update/dcim/interfaces/
  • POSTdcim_interfaces_create/dcim/interfaces/
  • DELETEdcim_interfaces_bulk_delete/dcim/interfaces/
  • PATCHdcim_interfaces_bulk_partial_update/dcim/interfaces/
  • GETdcim_interfaces_read/dcim/interfaces/:id/
  • PUTdcim_interfaces_update/dcim/interfaces/:id/
  • DELETEdcim_interfaces_delete/dcim/interfaces/:id/
  • PATCHdcim_interfaces_partial_update/dcim/interfaces/:id/
  • GETdcim_interfaces_trace/dcim/interfaces/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_inventory-item-roles_list/dcim/inventory-item-roles/?id=string&name=string&slug=string&color=string&created=string&last_updated=string&q=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&color__n=string&color__ic=string&color__nic=string&color__iew=string&color__niew=string&color__isw=string&color__nisw=string&color__ie=string&color__nie=string&color__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_inventory-item-roles_bulk_update/dcim/inventory-item-roles/
  • POSTdcim_inventory-item-roles_create/dcim/inventory-item-roles/
  • DELETEdcim_inventory-item-roles_bulk_delete/dcim/inventory-item-roles/
  • PATCHdcim_inventory-item-roles_bulk_partial_update/dcim/inventory-item-roles/
  • GETdcim_inventory-item-roles_read/dcim/inventory-item-roles/:id/
  • PUTdcim_inventory-item-roles_update/dcim/inventory-item-roles/:id/
  • DELETEdcim_inventory-item-roles_delete/dcim/inventory-item-roles/:id/
  • PATCHdcim_inventory-item-roles_partial_update/dcim/inventory-item-roles/:id/
  • GETdcim_inventory-item-templates_list/dcim/inventory-item-templates/?id=string&name=string&label=string&part_id=string&created=string&last_updated=string&q=string&devicetype_id=string&parent_id=string&manufacturer_id=string&manufacturer=string&role_id=string&role=string&component_type=string&component_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&part_id__n=string&part_id__ic=string&part_id__nic=string&part_id__iew=string&part_id__niew=string&part_id__isw=string&part_id__nisw=string&part_id__ie=string&part_id__nie=string&part_id__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&parent_id__n=string&manufacturer_id__n=string&manufacturer__n=string&role_id__n=string&role__n=string&component_type__n=string&component_id__n=string&component_id__lte=string&component_id__lt=string&component_id__gte=string&component_id__gt=string&ordering=string&limit=0&offset=0
  • PUTdcim_inventory-item-templates_bulk_update/dcim/inventory-item-templates/
  • POSTdcim_inventory-item-templates_create/dcim/inventory-item-templates/
  • DELETEdcim_inventory-item-templates_bulk_delete/dcim/inventory-item-templates/
  • PATCHdcim_inventory-item-templates_bulk_partial_update/dcim/inventory-item-templates/
  • GETdcim_inventory-item-templates_read/dcim/inventory-item-templates/:id/
  • PUTdcim_inventory-item-templates_update/dcim/inventory-item-templates/:id/
  • DELETEdcim_inventory-item-templates_delete/dcim/inventory-item-templates/:id/
  • PATCHdcim_inventory-item-templates_partial_update/dcim/inventory-item-templates/:id/
  • GETdcim_inventory-items_list/dcim/inventory-items/?id=string&name=string&label=string&part_id=string&asset_tag=string&discovered=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&created=string&last_updated=string&tag=string&parent_id=string&manufacturer_id=string&manufacturer=string&role_id=string&role=string&component_type=string&component_id=string&serial=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&part_id__n=string&part_id__ic=string&part_id__nic=string&part_id__iew=string&part_id__niew=string&part_id__isw=string&part_id__nisw=string&part_id__ie=string&part_id__nie=string&part_id__empty=string&asset_tag__n=string&asset_tag__ic=string&asset_tag__nic=string&asset_tag__iew=string&asset_tag__niew=string&asset_tag__isw=string&asset_tag__nisw=string&asset_tag__ie=string&asset_tag__nie=string&asset_tag__empty=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&parent_id__n=string&manufacturer_id__n=string&manufacturer__n=string&role_id__n=string&role__n=string&component_type__n=string&component_id__n=string&component_id__lte=string&component_id__lt=string&component_id__gte=string&component_id__gt=string&serial__n=string&serial__ic=string&serial__nic=string&serial__iew=string&serial__niew=string&serial__isw=string&serial__nisw=string&serial__ie=string&serial__nie=string&serial__empty=string&ordering=string&limit=0&offset=0
  • PUTdcim_inventory-items_bulk_update/dcim/inventory-items/
  • POSTdcim_inventory-items_create/dcim/inventory-items/
  • DELETEdcim_inventory-items_bulk_delete/dcim/inventory-items/
  • PATCHdcim_inventory-items_bulk_partial_update/dcim/inventory-items/
  • GETdcim_inventory-items_read/dcim/inventory-items/:id/
  • PUTdcim_inventory-items_update/dcim/inventory-items/:id/
  • DELETEdcim_inventory-items_delete/dcim/inventory-items/:id/
  • PATCHdcim_inventory-items_partial_update/dcim/inventory-items/:id/
  • GETdcim_locations_list/dcim/locations/?id=string&name=string&slug=string&status=string&description=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&contact=string&contact_role=string&contact_group=string&created=string&last_updated=string&q=string&tag=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&parent_id=string&parent=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&status__n=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&contact__n=string&contact_role__n=string&contact_group__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&parent_id__n=string&parent__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_locations_bulk_update/dcim/locations/
  • POSTdcim_locations_create/dcim/locations/
  • DELETEdcim_locations_bulk_delete/dcim/locations/
  • PATCHdcim_locations_bulk_partial_update/dcim/locations/
  • GETdcim_locations_read/dcim/locations/:id/
  • PUTdcim_locations_update/dcim/locations/:id/
  • DELETEdcim_locations_delete/dcim/locations/:id/
  • PATCHdcim_locations_partial_update/dcim/locations/:id/
  • GETdcim_manufacturers_list/dcim/manufacturers/?id=string&name=string&slug=string&description=string&created=string&last_updated=string&q=string&tag=string&contact=string&contact_role=string&contact_group=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&contact__n=string&contact_role__n=string&contact_group__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_manufacturers_bulk_update/dcim/manufacturers/
  • POSTdcim_manufacturers_create/dcim/manufacturers/
  • DELETEdcim_manufacturers_bulk_delete/dcim/manufacturers/
  • PATCHdcim_manufacturers_bulk_partial_update/dcim/manufacturers/
  • GETdcim_manufacturers_read/dcim/manufacturers/:id/
  • PUTdcim_manufacturers_update/dcim/manufacturers/:id/
  • DELETEdcim_manufacturers_delete/dcim/manufacturers/:id/
  • PATCHdcim_manufacturers_partial_update/dcim/manufacturers/:id/
  • GETdcim_module-bay-templates_list/dcim/module-bay-templates/?id=string&name=string&created=string&last_updated=string&q=string&devicetype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_module-bay-templates_bulk_update/dcim/module-bay-templates/
  • POSTdcim_module-bay-templates_create/dcim/module-bay-templates/
  • DELETEdcim_module-bay-templates_bulk_delete/dcim/module-bay-templates/
  • PATCHdcim_module-bay-templates_bulk_partial_update/dcim/module-bay-templates/
  • GETdcim_module-bay-templates_read/dcim/module-bay-templates/:id/
  • PUTdcim_module-bay-templates_update/dcim/module-bay-templates/:id/
  • DELETEdcim_module-bay-templates_delete/dcim/module-bay-templates/:id/
  • PATCHdcim_module-bay-templates_partial_update/dcim/module-bay-templates/:id/
  • GETdcim_module-bays_list/dcim/module-bays/?id=string&name=string&label=string&description=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&created=string&last_updated=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_module-bays_bulk_update/dcim/module-bays/
  • POSTdcim_module-bays_create/dcim/module-bays/
  • DELETEdcim_module-bays_bulk_delete/dcim/module-bays/
  • PATCHdcim_module-bays_bulk_partial_update/dcim/module-bays/
  • GETdcim_module-bays_read/dcim/module-bays/:id/
  • PUTdcim_module-bays_update/dcim/module-bays/:id/
  • DELETEdcim_module-bays_delete/dcim/module-bays/:id/
  • PATCHdcim_module-bays_partial_update/dcim/module-bays/:id/
  • GETdcim_module-types_list/dcim/module-types/?id=string&model=string&part_number=string&weight=string&weight_unit=string&created=string&last_updated=string&q=string&tag=string&manufacturer_id=string&manufacturer=string&console_ports=string&console_server_ports=string&power_ports=string&power_outlets=string&interfaces=string&pass_through_ports=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&model__n=string&model__ic=string&model__nic=string&model__iew=string&model__niew=string&model__isw=string&model__nisw=string&model__ie=string&model__nie=string&model__empty=string&part_number__n=string&part_number__ic=string&part_number__nic=string&part_number__iew=string&part_number__niew=string&part_number__isw=string&part_number__nisw=string&part_number__ie=string&part_number__nie=string&part_number__empty=string&weight__n=string&weight__lte=string&weight__lt=string&weight__gte=string&weight__gt=string&weight_unit__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&manufacturer_id__n=string&manufacturer__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_module-types_bulk_update/dcim/module-types/
  • POSTdcim_module-types_create/dcim/module-types/
  • DELETEdcim_module-types_bulk_delete/dcim/module-types/
  • PATCHdcim_module-types_bulk_partial_update/dcim/module-types/
  • GETdcim_module-types_read/dcim/module-types/:id/
  • PUTdcim_module-types_update/dcim/module-types/:id/
  • DELETEdcim_module-types_delete/dcim/module-types/:id/
  • PATCHdcim_module-types_partial_update/dcim/module-types/:id/
  • GETdcim_modules_list/dcim/modules/?id=string&status=string&asset_tag=string&created=string&last_updated=string&q=string&tag=string&manufacturer_id=string&manufacturer=string&module_type_id=string&module_type=string&module_bay_id=string&device_id=string&serial=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&status__n=string&asset_tag__n=string&asset_tag__ic=string&asset_tag__nic=string&asset_tag__iew=string&asset_tag__niew=string&asset_tag__isw=string&asset_tag__nisw=string&asset_tag__ie=string&asset_tag__nie=string&asset_tag__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&manufacturer_id__n=string&manufacturer__n=string&module_type_id__n=string&module_type__n=string&module_bay_id__n=string&device_id__n=string&serial__n=string&serial__ic=string&serial__nic=string&serial__iew=string&serial__niew=string&serial__isw=string&serial__nisw=string&serial__ie=string&serial__nie=string&serial__empty=string&ordering=string&limit=0&offset=0
  • PUTdcim_modules_bulk_update/dcim/modules/
  • POSTdcim_modules_create/dcim/modules/
  • DELETEdcim_modules_bulk_delete/dcim/modules/
  • PATCHdcim_modules_bulk_partial_update/dcim/modules/
  • GETdcim_modules_read/dcim/modules/:id/
  • PUTdcim_modules_update/dcim/modules/:id/
  • DELETEdcim_modules_delete/dcim/modules/:id/
  • PATCHdcim_modules_partial_update/dcim/modules/:id/
  • GETdcim_platforms_list/dcim/platforms/?id=string&name=string&slug=string&napalm_driver=string&description=string&created=string&last_updated=string&q=string&tag=string&manufacturer_id=string&manufacturer=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&slug__n=string&slug__ic=string&slug__nic=string&slug__iew=string&slug__niew=string&slug__isw=string&slug__nisw=string&slug__ie=string&slug__nie=string&slug__empty=string&napalm_driver__n=string&napalm_driver__ic=string&napalm_driver__nic=string&napalm_driver__iew=string&napalm_driver__niew=string&napalm_driver__isw=string&napalm_driver__nisw=string&napalm_driver__ie=string&napalm_driver__nie=string&napalm_driver__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&manufacturer_id__n=string&manufacturer__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_platforms_bulk_update/dcim/platforms/
  • POSTdcim_platforms_create/dcim/platforms/
  • DELETEdcim_platforms_bulk_delete/dcim/platforms/
  • PATCHdcim_platforms_bulk_partial_update/dcim/platforms/
  • GETdcim_platforms_read/dcim/platforms/:id/
  • PUTdcim_platforms_update/dcim/platforms/:id/
  • DELETEdcim_platforms_delete/dcim/platforms/:id/
  • PATCHdcim_platforms_partial_update/dcim/platforms/:id/
  • GETdcim_power-feeds_list/dcim/power-feeds/?id=string&name=string&status=string&type=string&supply=string&phase=string&voltage=string&amperage=string&max_utilization=string&cable_end=string&created=string&last_updated=string&q=string&tag=string&cabled=string&occupied=string&connected=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&power_panel_id=string&rack_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&status__n=string&type__n=string&supply__n=string&phase__n=string&voltage__n=string&voltage__lte=string&voltage__lt=string&voltage__gte=string&voltage__gt=string&amperage__n=string&amperage__lte=string&amperage__lt=string&amperage__gte=string&amperage__gt=string&max_utilization__n=string&max_utilization__lte=string&max_utilization__lt=string&max_utilization__gte=string&max_utilization__gt=string&cable_end__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&power_panel_id__n=string&rack_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_power-feeds_bulk_update/dcim/power-feeds/
  • POSTdcim_power-feeds_create/dcim/power-feeds/
  • DELETEdcim_power-feeds_bulk_delete/dcim/power-feeds/
  • PATCHdcim_power-feeds_bulk_partial_update/dcim/power-feeds/
  • GETdcim_power-feeds_read/dcim/power-feeds/:id/
  • PUTdcim_power-feeds_update/dcim/power-feeds/:id/
  • DELETEdcim_power-feeds_delete/dcim/power-feeds/:id/
  • PATCHdcim_power-feeds_partial_update/dcim/power-feeds/:id/
  • GETdcim_power-feeds_trace/dcim/power-feeds/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_power-outlet-templates_list/dcim/power-outlet-templates/?id=string&name=string&type=string&feed_leg=string&created=string&last_updated=string&q=string&devicetype_id=string&moduletype_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&type__n=string&feed_leg__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&devicetype_id__n=string&moduletype_id__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_power-outlet-templates_bulk_update/dcim/power-outlet-templates/
  • POSTdcim_power-outlet-templates_create/dcim/power-outlet-templates/
  • DELETEdcim_power-outlet-templates_bulk_delete/dcim/power-outlet-templates/
  • PATCHdcim_power-outlet-templates_bulk_partial_update/dcim/power-outlet-templates/
  • GETdcim_power-outlet-templates_read/dcim/power-outlet-templates/:id/
  • PUTdcim_power-outlet-templates_update/dcim/power-outlet-templates/:id/
  • DELETEdcim_power-outlet-templates_delete/dcim/power-outlet-templates/:id/
  • PATCHdcim_power-outlet-templates_partial_update/dcim/power-outlet-templates/:id/
  • GETdcim_power-outlets_list/dcim/power-outlets/?id=string&name=string&label=string&feed_leg=string&description=string&cable_end=string&q=string&region_id=string&region=string&site_group_id=string&site_group=string&site_id=string&site=string&location_id=string&location=string&rack_id=string&rack=string&device_id=string&device=string&virtual_chassis_id=string&virtual_chassis=string&module_id=string&created=string&last_updated=string&tag=string&cabled=string&occupied=string&connected=string&type=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&name__n=string&name__ic=string&name__nic=string&name__iew=string&name__niew=string&name__isw=string&name__nisw=string&name__ie=string&name__nie=string&name__empty=string&label__n=string&label__ic=string&label__nic=string&label__iew=string&label__niew=string&label__isw=string&label__nisw=string&label__ie=string&label__nie=string&label__empty=string&feed_leg__n=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&region_id__n=string&region__n=string&site_group_id__n=string&site_group__n=string&site_id__n=string&site__n=string&location_id__n=string&location__n=string&rack_id__n=string&rack__n=string&device_id__n=string&device__n=string&virtual_chassis_id__n=string&virtual_chassis__n=string&module_id__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&type__n=string&ordering=string&limit=0&offset=0
  • PUTdcim_power-outlets_bulk_update/dcim/power-outlets/
  • POSTdcim_power-outlets_create/dcim/power-outlets/
  • DELETEdcim_power-outlets_bulk_delete/dcim/power-outlets/

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://demo.netbox.dev/api
Authentication
An API key in the Authorization header
Operations
844 operations on 210 pathsGET 208PUT 180PATCH 180DELETE 180POST 96
Main resources
dcim 380ipam 161extras 92tenancy 54circuits 46virtualization 45users 38wireless 27status 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 3.4
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the NetBox API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the NetBox API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “circuits_circuit-terminations_list” (GET /circuits/circuit-terminations/?id=string&term_side=string&port_speed=string&upstream_speed=string&xconnect_id=string&description=string&cable_end=string&created=string&last_updated=string&q=string&tag=string&cabled=string&occupied=string&circuit_id=string&site_id=string&site=string&provider_network_id=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&term_side__n=string&port_speed__n=string&port_speed__lte=string&port_speed__lt=string&port_speed__gte=string&port_speed__gt=string&upstream_speed__n=string&upstream_speed__lte=string&upstream_speed__lt=string&upstream_speed__gte=string&upstream_speed__gt=string&xconnect_id__n=string&xconnect_id__ic=string&xconnect_id__nic=string&xconnect_id__iew=string&xconnect_id__niew=string&xconnect_id__isw=string&xconnect_id__nisw=string&xconnect_id__ie=string&xconnect_id__nie=string&xconnect_id__empty=string&description__n=string&description__ic=string&description__nic=string&description__iew=string&description__niew=string&description__isw=string&description__nisw=string&description__ie=string&description__nie=string&description__empty=string&cable_end__n=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&last_updated__n=string&last_updated__lte=string&last_updated__lt=string&last_updated__gte=string&last_updated__gt=string&tag__n=string&circuit_id__n=string&site_id__n=string&site__n=string&provider_network_id__n=string&ordering=string&limit=0&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the NetBox API?

API to access NetBox It is listed under Other and has 844 endpoints.

Who publishes the NetBox API?

It is listed from Netbox's public API description (an OpenAPI document), not published by Netbox on Swastik Codes. Anyone who controls netbox.dev can claim the profile by adding a DNS TXT record.

What is the base URL of the NetBox API?

Requests go to https://demo.netbox.dev/api. Endpoint paths are added to this base URL.

How do I authenticate with the NetBox API?

With an API key in the Authorization header.

How many endpoints does the NetBox API have?

844 operations on 210 paths (208 GET, 180 PUT, 180 PATCH, 180 DELETE, 96 POST). The largest groups are dcim, ipam, extras, tenancy. This listing's collection holds the first 400.

Is forking the NetBox API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.