Netboxdemo

NetBox API

API to access NetBox

Developer tools#openapi#cloud

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 386

circuits

  • GETcircuits_circuit-terminations_list/circuits/circuit-terminations/?term_side=string&port_speed=string&upstream_speed=string&xconnect_id=string&q=string&circuit_id=string&site_id=string&site=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&circuit_id__n=string&site_id__n=string&site__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTcircuits_circuit-terminations_create/circuits/circuit-terminations/
  • GETcircuits_circuit-terminations_read/circuits/circuit-terminations/:id/Call to super to allow for caching
  • 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-types_list/circuits/circuit-types/?id=string&name=string&slug=string&q=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&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&limit=0&offset=0Call to super to allow for caching
  • POSTcircuits_circuit-types_create/circuits/circuit-types/
  • GETcircuits_circuit-types_read/circuits/circuit-types/:id/Call to super to allow for caching
  • 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&install_date=string&commit_rate=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&provider_id=string&provider=string&type_id=string&type=string&status=string&site_id=string&site=string&region_id=string&region=string&tag=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&install_date__n=string&install_date__lte=string&install_date__lt=string&install_date__gte=string&install_date__gt=string&commit_rate__n=string&commit_rate__lte=string&commit_rate__lt=string&commit_rate__gte=string&commit_rate__gt=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&provider_id__n=string&provider__n=string&type_id__n=string&type__n=string&status__n=string&site_id__n=string&site__n=string&region_id__n=string&region__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTcircuits_circuits_create/circuits/circuits/
  • GETcircuits_circuits_read/circuits/circuits/:id/Call to super to allow for caching
  • PUTcircuits_circuits_update/circuits/circuits/:id/
  • DELETEcircuits_circuits_delete/circuits/circuits/:id/
  • PATCHcircuits_circuits_partial_update/circuits/circuits/:id/
  • GETcircuits_providers_list/circuits/providers/?id=string&name=string&slug=string&asn=string&account=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&region_id=string&region=string&site_id=string&site=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&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&asn__n=string&asn__lte=string&asn__lt=string&asn__gte=string&asn__gt=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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTcircuits_providers_create/circuits/providers/
  • GETcircuits_providers_read/circuits/providers/:id/Call to super to allow for caching
  • PUTcircuits_providers_update/circuits/providers/:id/
  • DELETEcircuits_providers_delete/circuits/providers/:id/
  • PATCHcircuits_providers_partial_update/circuits/providers/:id/
  • GETcircuits_providers_graphs/circuits/providers/:id/graphs/A convenience method for rendering graphs for a particular provider.

dcim

  • GETdcim_cables_list/dcim/cables/?id=string&label=string&length=string&length_unit=string&q=string&type=string&status=string&color=string&device_id=string&device=string&rack_id=string&rack=string&site_id=string&site=string&tenant_id=string&tenant=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&length__n=string&length__lte=string&length__lt=string&length__gte=string&length__gt=string&length_unit__n=string&type__n=string&status__n=string&color__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_cables_create/dcim/cables/
  • GETdcim_cables_read/dcim/cables/:id/Call to super to allow for caching
  • 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-connections_list/dcim/console-connections/?name=string&connection_status=string&site=string&device_id=string&device=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&connection_status__n=string&limit=0&offset=0
  • GETdcim_console-port-templates_list/dcim/console-port-templates/?id=string&name=string&type=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&type__n=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_console-port-templates_create/dcim/console-port-templates/
  • GETdcim_console-port-templates_read/dcim/console-port-templates/:id/Call to super to allow for caching
  • 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&description=string&connection_status=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&type=string&cabled=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&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&connection_status__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&type__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_console-ports_create/dcim/console-ports/
  • GETdcim_console-ports_read/dcim/console-ports/:id/Call to super to allow for caching
  • 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&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&type__n=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_console-server-port-templates_create/dcim/console-server-port-templates/
  • GETdcim_console-server-port-templates_read/dcim/console-server-port-templates/:id/Call to super to allow for caching
  • 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&description=string&connection_status=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&type=string&cabled=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&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&connection_status__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&type__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_console-server-ports_create/dcim/console-server-ports/
  • GETdcim_console-server-ports_read/dcim/console-server-ports/:id/Call to super to allow for caching
  • 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&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&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_device-bay-templates_create/dcim/device-bay-templates/
  • GETdcim_device-bay-templates_read/dcim/device-bay-templates/:id/Call to super to allow for caching
  • 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&description=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=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&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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_device-bays_create/dcim/device-bays/
  • GETdcim_device-bays_read/dcim/device-bays/:id/Call to super to allow for caching
  • 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&q=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&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&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&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_device-roles_create/dcim/device-roles/
  • GETdcim_device-roles_read/dcim/device-roles/:id/Call to super to allow for caching
  • 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&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=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&device_bays=string&tag=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&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&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&u_height__n=string&u_height__lte=string&u_height__lt=string&u_height__gte=string&u_height__gt=string&subdevice_role__n=string&manufacturer_id__n=string&manufacturer__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_device-types_create/dcim/device-types/
  • GETdcim_device-types_read/dcim/device-types/:id/Call to super to allow for caching
  • 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&name=string&asset_tag=string&face=string&position=string&vc_position=string&vc_priority=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&local_context_data=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&manufacturer_id=string&manufacturer=string&device_type_id=string&role_id=string&role=string&platform_id=string&platform=string&region_id=string&region=string&site_id=string&site=string&rack_group_id=string&rack_id=string&cluster_id=string&model=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&device_bays=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&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&face__n=string&position__n=string&position__lte=string&position__lt=string&position__gte=string&position__gt=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&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&manufacturer_id__n=string&manufacturer__n=string&device_type_id__n=string&role_id__n=string&role__n=string&platform_id__n=string&platform__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&rack_group_id__n=string&rack_id__n=string&cluster_id__n=string&model__n=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&virtual_chassis_id__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_devices_create/dcim/devices/
  • GETdcim_devices_read/dcim/devices/:id/Call to super to allow for caching
  • PUTdcim_devices_update/dcim/devices/:id/
  • DELETEdcim_devices_delete/dcim/devices/:id/
  • PATCHdcim_devices_partial_update/dcim/devices/:id/
  • GETdcim_devices_graphs/dcim/devices/:id/graphs/A convenience method for rendering graphs for a particular Device.
  • 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&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&type__n=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_front-port-templates_create/dcim/front-port-templates/
  • GETdcim_front-port-templates_read/dcim/front-port-templates/:id/Call to super to allow for caching
  • 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&type=string&description=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&cabled=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&type__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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_front-ports_create/dcim/front-ports/
  • GETdcim_front-ports_read/dcim/front-ports/:id/Call to super to allow for caching
  • 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_trace/dcim/front-ports/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_interface-connections_list/dcim/interface-connections/?connection_status=string&site=string&device_id=string&device=string&connection_status__n=string&limit=0&offset=0
  • GETdcim_interface-templates_list/dcim/interface-templates/?id=string&name=string&type=string&mgmt_only=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&type__n=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_interface-templates_create/dcim/interface-templates/
  • GETdcim_interface-templates_read/dcim/interface-templates/:id/Call to super to allow for caching
  • 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&connection_status=string&type=string&enabled=string&mtu=string&mgmt_only=string&mode=string&description=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&cabled=string&kind=string&lag_id=string&mac_address=string&vlan_id=string&vlan=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&connection_status__n=string&type__n=string&mtu__n=string&mtu__lte=string&mtu__lt=string&mtu__gte=string&mtu__gt=string&mode__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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&tag__n=string&lag_id__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&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_interfaces_create/dcim/interfaces/
  • GETdcim_interfaces_read/dcim/interfaces/:id/Call to super to allow for caching
  • PUTdcim_interfaces_update/dcim/interfaces/:id/
  • DELETEdcim_interfaces_delete/dcim/interfaces/:id/
  • PATCHdcim_interfaces_partial_update/dcim/interfaces/:id/
  • GETdcim_interfaces_graphs/dcim/interfaces/:id/graphs/A convenience method for rendering graphs for a particular interface.
  • 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-items_list/dcim/inventory-items/?id=string&name=string&part_id=string&asset_tag=string&discovered=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&parent_id=string&manufacturer_id=string&manufacturer=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&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&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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&parent_id__n=string&manufacturer_id__n=string&manufacturer__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_inventory-items_create/dcim/inventory-items/
  • GETdcim_inventory-items_read/dcim/inventory-items/:id/Call to super to allow for caching
  • 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_manufacturers_list/dcim/manufacturers/?id=string&name=string&slug=string&description=string&q=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&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&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&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_manufacturers_create/dcim/manufacturers/
  • GETdcim_manufacturers_read/dcim/manufacturers/:id/Call to super to allow for caching
  • PUTdcim_manufacturers_update/dcim/manufacturers/:id/
  • DELETEdcim_manufacturers_delete/dcim/manufacturers/:id/
  • PATCHdcim_manufacturers_partial_update/dcim/manufacturers/:id/
  • GETdcim_platforms_list/dcim/platforms/?id=string&name=string&slug=string&napalm_driver=string&description=string&q=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&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&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&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&manufacturer_id__n=string&manufacturer__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_platforms_create/dcim/platforms/
  • GETdcim_platforms_read/dcim/platforms/:id/Call to super to allow for caching
  • PUTdcim_platforms_update/dcim/platforms/:id/
  • DELETEdcim_platforms_delete/dcim/platforms/:id/
  • PATCHdcim_platforms_partial_update/dcim/platforms/:id/
  • GETdcim_power-connections_list/dcim/power-connections/?name=string&connection_status=string&site=string&device_id=string&device=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&connection_status__n=string&limit=0&offset=0
  • 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&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&region_id=string&region=string&site_id=string&site=string&power_panel_id=string&rack_id=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&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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&power_panel_id__n=string&rack_id__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-feeds_create/dcim/power-feeds/
  • GETdcim_power-feeds_read/dcim/power-feeds/:id/Call to super to allow for caching
  • 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-outlet-templates_list/dcim/power-outlet-templates/?id=string&name=string&type=string&feed_leg=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&type__n=string&feed_leg__n=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-outlet-templates_create/dcim/power-outlet-templates/
  • GETdcim_power-outlet-templates_read/dcim/power-outlet-templates/:id/Call to super to allow for caching
  • 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&feed_leg=string&description=string&connection_status=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&type=string&cabled=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&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&connection_status__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&type__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-outlets_create/dcim/power-outlets/
  • GETdcim_power-outlets_read/dcim/power-outlets/:id/Call to super to allow for caching
  • PUTdcim_power-outlets_update/dcim/power-outlets/:id/
  • DELETEdcim_power-outlets_delete/dcim/power-outlets/:id/
  • PATCHdcim_power-outlets_partial_update/dcim/power-outlets/:id/
  • GETdcim_power-outlets_trace/dcim/power-outlets/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_power-panels_list/dcim/power-panels/?id=string&name=string&q=string&region_id=string&region=string&site_id=string&site=string&rack_group_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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&rack_group_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-panels_create/dcim/power-panels/
  • GETdcim_power-panels_read/dcim/power-panels/:id/Call to super to allow for caching
  • PUTdcim_power-panels_update/dcim/power-panels/:id/
  • DELETEdcim_power-panels_delete/dcim/power-panels/:id/
  • PATCHdcim_power-panels_partial_update/dcim/power-panels/:id/
  • GETdcim_power-port-templates_list/dcim/power-port-templates/?id=string&name=string&type=string&maximum_draw=string&allocated_draw=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&type__n=string&maximum_draw__n=string&maximum_draw__lte=string&maximum_draw__lt=string&maximum_draw__gte=string&maximum_draw__gt=string&allocated_draw__n=string&allocated_draw__lte=string&allocated_draw__lt=string&allocated_draw__gte=string&allocated_draw__gt=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-port-templates_create/dcim/power-port-templates/
  • GETdcim_power-port-templates_read/dcim/power-port-templates/:id/Call to super to allow for caching
  • PUTdcim_power-port-templates_update/dcim/power-port-templates/:id/
  • DELETEdcim_power-port-templates_delete/dcim/power-port-templates/:id/
  • PATCHdcim_power-port-templates_partial_update/dcim/power-port-templates/:id/
  • GETdcim_power-ports_list/dcim/power-ports/?id=string&name=string&maximum_draw=string&allocated_draw=string&description=string&connection_status=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&type=string&cabled=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&maximum_draw__n=string&maximum_draw__lte=string&maximum_draw__lt=string&maximum_draw__gte=string&maximum_draw__gt=string&allocated_draw__n=string&allocated_draw__lte=string&allocated_draw__lt=string&allocated_draw__gte=string&allocated_draw__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&connection_status__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&type__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_power-ports_create/dcim/power-ports/
  • GETdcim_power-ports_read/dcim/power-ports/:id/Call to super to allow for caching
  • PUTdcim_power-ports_update/dcim/power-ports/:id/
  • DELETEdcim_power-ports_delete/dcim/power-ports/:id/
  • PATCHdcim_power-ports_partial_update/dcim/power-ports/:id/
  • GETdcim_power-ports_trace/dcim/power-ports/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_rack-groups_list/dcim/rack-groups/?id=string&name=string&slug=string&description=string&q=string&region_id=string&region=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&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&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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&parent_id__n=string&parent__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_rack-groups_create/dcim/rack-groups/
  • GETdcim_rack-groups_read/dcim/rack-groups/:id/Call to super to allow for caching
  • PUTdcim_rack-groups_update/dcim/rack-groups/:id/
  • DELETEdcim_rack-groups_delete/dcim/rack-groups/:id/
  • PATCHdcim_rack-groups_partial_update/dcim/rack-groups/:id/
  • GETdcim_rack-reservations_list/dcim/rack-reservations/?id=string&created=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&q=string&rack_id=string&site_id=string&site=string&group_id=string&group=string&user_id=string&user=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&created__n=string&created__lte=string&created__lt=string&created__gte=string&created__gt=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&rack_id__n=string&site_id__n=string&site__n=string&group_id__n=string&group__n=string&user_id__n=string&user__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_rack-reservations_create/dcim/rack-reservations/
  • GETdcim_rack-reservations_read/dcim/rack-reservations/:id/Call to super to allow for caching
  • PUTdcim_rack-reservations_update/dcim/rack-reservations/:id/
  • DELETEdcim_rack-reservations_delete/dcim/rack-reservations/:id/
  • PATCHdcim_rack-reservations_partial_update/dcim/rack-reservations/:id/
  • GETdcim_rack-roles_list/dcim/rack-roles/?id=string&name=string&slug=string&color=string&q=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&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&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&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_rack-roles_create/dcim/rack-roles/
  • GETdcim_rack-roles_read/dcim/rack-roles/:id/Call to super to allow for caching
  • PUTdcim_rack-roles_update/dcim/rack-roles/:id/
  • DELETEdcim_rack-roles_delete/dcim/rack-roles/:id/
  • PATCHdcim_rack-roles_partial_update/dcim/rack-roles/:id/
  • GETdcim_racks_list/dcim/racks/?id=string&name=string&facility_id=string&asset_tag=string&type=string&width=string&u_height=string&desc_units=string&outer_width=string&outer_depth=string&outer_unit=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&region_id=string&region=string&site_id=string&site=string&group_id=string&group=string&status=string&role_id=string&role=string&serial=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&facility_id__n=string&facility_id__ic=string&facility_id__nic=string&facility_id__iew=string&facility_id__niew=string&facility_id__isw=string&facility_id__nisw=string&facility_id__ie=string&facility_id__nie=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&type__n=string&width__n=string&u_height__n=string&u_height__lte=string&u_height__lt=string&u_height__gte=string&u_height__gt=string&outer_width__n=string&outer_width__lte=string&outer_width__lt=string&outer_width__gte=string&outer_width__gt=string&outer_depth__n=string&outer_depth__lte=string&outer_depth__lt=string&outer_depth__gte=string&outer_depth__gt=string&outer_unit__n=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&group_id__n=string&group__n=string&status__n=string&role_id__n=string&role__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_racks_create/dcim/racks/
  • GETdcim_racks_read/dcim/racks/:id/Call to super to allow for caching
  • PUTdcim_racks_update/dcim/racks/:id/
  • DELETEdcim_racks_delete/dcim/racks/:id/
  • PATCHdcim_racks_partial_update/dcim/racks/:id/
  • GETdcim_racks_elevation/dcim/racks/:id/elevation/?q=string&face=front&render=json&unit_width=220&unit_height=22&legend_width=30&exclude=0&expand_devices=true&include_images=trueRack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
  • GETdcim_rear-port-templates_list/dcim/rear-port-templates/?id=string&name=string&type=string&positions=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&type__n=string&positions__n=string&positions__lte=string&positions__lt=string&positions__gte=string&positions__gt=string&devicetype_id__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_rear-port-templates_create/dcim/rear-port-templates/
  • GETdcim_rear-port-templates_read/dcim/rear-port-templates/:id/Call to super to allow for caching
  • PUTdcim_rear-port-templates_update/dcim/rear-port-templates/:id/
  • DELETEdcim_rear-port-templates_delete/dcim/rear-port-templates/:id/
  • PATCHdcim_rear-port-templates_partial_update/dcim/rear-port-templates/:id/
  • GETdcim_rear-ports_list/dcim/rear-ports/?id=string&name=string&type=string&positions=string&description=string&q=string&region_id=string&region=string&site_id=string&site=string&device_id=string&device=string&tag=string&cabled=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&type__n=string&positions__n=string&positions__lte=string&positions__lt=string&positions__gte=string&positions__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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&device_id__n=string&device__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_rear-ports_create/dcim/rear-ports/
  • GETdcim_rear-ports_read/dcim/rear-ports/:id/Call to super to allow for caching
  • PUTdcim_rear-ports_update/dcim/rear-ports/:id/
  • DELETEdcim_rear-ports_delete/dcim/rear-ports/:id/
  • PATCHdcim_rear-ports_partial_update/dcim/rear-ports/:id/
  • GETdcim_rear-ports_trace/dcim/rear-ports/:id/trace/Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
  • GETdcim_regions_list/dcim/regions/?id=string&name=string&slug=string&description=string&q=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&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&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&parent_id__n=string&parent__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_regions_create/dcim/regions/
  • GETdcim_regions_read/dcim/regions/:id/Call to super to allow for caching
  • PUTdcim_regions_update/dcim/regions/:id/
  • DELETEdcim_regions_delete/dcim/regions/:id/
  • PATCHdcim_regions_partial_update/dcim/regions/:id/
  • GETdcim_sites_list/dcim/sites/?id=string&name=string&slug=string&facility=string&asn=string&latitude=string&longitude=string&contact_name=string&contact_phone=string&contact_email=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&status=string&region_id=string&region=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&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&facility__n=string&facility__ic=string&facility__nic=string&facility__iew=string&facility__niew=string&facility__isw=string&facility__nisw=string&facility__ie=string&facility__nie=string&asn__n=string&asn__lte=string&asn__lt=string&asn__gte=string&asn__gt=string&latitude__n=string&latitude__lte=string&latitude__lt=string&latitude__gte=string&latitude__gt=string&longitude__n=string&longitude__lte=string&longitude__lt=string&longitude__gte=string&longitude__gt=string&contact_name__n=string&contact_name__ic=string&contact_name__nic=string&contact_name__iew=string&contact_name__niew=string&contact_name__isw=string&contact_name__nisw=string&contact_name__ie=string&contact_name__nie=string&contact_phone__n=string&contact_phone__ic=string&contact_phone__nic=string&contact_phone__iew=string&contact_phone__niew=string&contact_phone__isw=string&contact_phone__nisw=string&contact_phone__ie=string&contact_phone__nie=string&contact_email__n=string&contact_email__ic=string&contact_email__nic=string&contact_email__iew=string&contact_email__niew=string&contact_email__isw=string&contact_email__nisw=string&contact_email__ie=string&contact_email__nie=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&status__n=string&region_id__n=string&region__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_sites_create/dcim/sites/
  • GETdcim_sites_read/dcim/sites/:id/Call to super to allow for caching
  • PUTdcim_sites_update/dcim/sites/:id/
  • DELETEdcim_sites_delete/dcim/sites/:id/
  • PATCHdcim_sites_partial_update/dcim/sites/:id/
  • GETdcim_sites_graphs/dcim/sites/:id/graphs/A convenience method for rendering graphs for a particular site.
  • GETdcim_virtual-chassis_list/dcim/virtual-chassis/?id=string&domain=string&q=string&region_id=string&region=string&site_id=string&site=string&tenant_id=string&tenant=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&domain__n=string&domain__ic=string&domain__nic=string&domain__iew=string&domain__niew=string&domain__isw=string&domain__nisw=string&domain__ie=string&domain__nie=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&tenant_id__n=string&tenant__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTdcim_virtual-chassis_create/dcim/virtual-chassis/
  • GETdcim_virtual-chassis_read/dcim/virtual-chassis/:id/Call to super to allow for caching
  • PUTdcim_virtual-chassis_update/dcim/virtual-chassis/:id/
  • DELETEdcim_virtual-chassis_delete/dcim/virtual-chassis/:id/
  • PATCHdcim_virtual-chassis_partial_update/dcim/virtual-chassis/:id/

extras

  • GETextras__custom_field_choices_list/extras/_custom_field_choices/
  • GETextras__custom_field_choices_read/extras/_custom_field_choices/:id/
  • GETextras_config-contexts_list/extras/config-contexts/?id=string&name=string&is_active=string&q=string&region_id=string&region=string&site_id=string&site=string&role_id=string&role=string&platform_id=string&platform=string&cluster_group_id=string&cluster_group=string&cluster_id=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=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&region_id__n=string&region__n=string&site_id__n=string&site__n=string&role_id__n=string&role__n=string&platform_id__n=string&platform__n=string&cluster_group_id__n=string&cluster_group__n=string&cluster_id__n=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTextras_config-contexts_create/extras/config-contexts/
  • GETextras_config-contexts_read/extras/config-contexts/:id/Call to super to allow for caching
  • PUTextras_config-contexts_update/extras/config-contexts/:id/
  • DELETEextras_config-contexts_delete/extras/config-contexts/:id/
  • PATCHextras_config-contexts_partial_update/extras/config-contexts/:id/
  • GETextras_export-templates_list/extras/export-templates/?id=string&content_type=string&name=string&template_language=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&content_type__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&template_language__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTextras_export-templates_create/extras/export-templates/
  • GETextras_export-templates_read/extras/export-templates/:id/Call to super to allow for caching
  • PUTextras_export-templates_update/extras/export-templates/:id/
  • DELETEextras_export-templates_delete/extras/export-templates/:id/
  • PATCHextras_export-templates_partial_update/extras/export-templates/:id/
  • GETextras_graphs_list/extras/graphs/?id=string&type=string&name=string&template_language=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&type__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&template_language__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTextras_graphs_create/extras/graphs/
  • GETextras_graphs_read/extras/graphs/:id/Call to super to allow for caching
  • PUTextras_graphs_update/extras/graphs/:id/
  • DELETEextras_graphs_delete/extras/graphs/:id/
  • PATCHextras_graphs_partial_update/extras/graphs/:id/
  • GETextras_image-attachments_list/extras/image-attachments/?limit=0&offset=0Call to super to allow for caching
  • POSTextras_image-attachments_create/extras/image-attachments/
  • GETextras_image-attachments_read/extras/image-attachments/:id/Call to super to allow for caching
  • PUTextras_image-attachments_update/extras/image-attachments/:id/
  • DELETEextras_image-attachments_delete/extras/image-attachments/:id/
  • PATCHextras_image-attachments_partial_update/extras/image-attachments/:id/
  • GETextras_object-changes_list/extras/object-changes/?id=string&user=string&user_name=string&request_id=string&action=string&changed_object_type=string&changed_object_id=string&object_repr=string&q=string&time=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&user__n=string&user_name__n=string&user_name__ic=string&user_name__nic=string&user_name__iew=string&user_name__niew=string&user_name__isw=string&user_name__nisw=string&user_name__ie=string&user_name__nie=string&action__n=string&changed_object_type__n=string&changed_object_id__n=string&changed_object_id__lte=string&changed_object_id__lt=string&changed_object_id__gte=string&changed_object_id__gt=string&object_repr__n=string&object_repr__ic=string&object_repr__nic=string&object_repr__iew=string&object_repr__niew=string&object_repr__isw=string&object_repr__nisw=string&object_repr__ie=string&object_repr__nie=string&limit=0&offset=0Retrieve a list of recent changes.
  • GETextras_object-changes_read/extras/object-changes/:id/Retrieve a list of recent changes.
  • GETextras_reports_list/extras/reports/Compile all reports and their related results (if any). Result data is deferred in the list view.
  • GETextras_reports_read/extras/reports/:id/Retrieve a single Report identified as "<module>.<report>".
  • POSTextras_reports_run/extras/reports/:id/run/Run a Report and create a new ReportResult, overwriting any previous result for the Report.
  • GETextras_scripts_list/extras/scripts/
  • GETextras_scripts_read/extras/scripts/:id/
  • GETextras_tags_list/extras/tags/?id=string&name=string&slug=string&color=string&q=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&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&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&limit=0&offset=0Call to super to allow for caching
  • POSTextras_tags_create/extras/tags/
  • GETextras_tags_read/extras/tags/:id/Call to super to allow for caching
  • PUTextras_tags_update/extras/tags/:id/
  • DELETEextras_tags_delete/extras/tags/:id/
  • PATCHextras_tags_partial_update/extras/tags/:id/

ipam

  • GETipam_aggregates_list/ipam/aggregates/?id=string&date_added=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&family=0.0&prefix=string&rir_id=string&rir=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&date_added__n=string&date_added__lte=string&date_added__lt=string&date_added__gte=string&date_added__gt=string&rir_id__n=string&rir__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTipam_aggregates_create/ipam/aggregates/
  • GETipam_aggregates_read/ipam/aggregates/:id/Call to super to allow for caching
  • PUTipam_aggregates_update/ipam/aggregates/:id/
  • DELETEipam_aggregates_delete/ipam/aggregates/:id/
  • PATCHipam_aggregates_partial_update/ipam/aggregates/:id/
  • GETipam_ip-addresses_list/ipam/ip-addresses/?id=string&dns_name=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&family=0.0&parent=string&address=string&mask_length=0.0&vrf_id=string&vrf=string&device=string&device_id=string&virtual_machine_id=string&virtual_machine=string&interface=string&interface_id=string&assigned_to_interface=string&status=string&role=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&dns_name__n=string&dns_name__ic=string&dns_name__nic=string&dns_name__iew=string&dns_name__niew=string&dns_name__isw=string&dns_name__nisw=string&dns_name__ie=string&dns_name__nie=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&vrf_id__n=string&vrf__n=string&virtual_machine_id__n=string&virtual_machine__n=string&interface__n=string&interface_id__n=string&status__n=string&role__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTipam_ip-addresses_create/ipam/ip-addresses/
  • GETipam_ip-addresses_read/ipam/ip-addresses/:id/Call to super to allow for caching
  • PUTipam_ip-addresses_update/ipam/ip-addresses/:id/
  • DELETEipam_ip-addresses_delete/ipam/ip-addresses/:id/
  • PATCHipam_ip-addresses_partial_update/ipam/ip-addresses/:id/
  • GETipam_prefixes_list/ipam/prefixes/?id=string&is_pool=string&tenant_group_id=string&tenant_group=string&tenant_id=string&tenant=string&created=string&created__gte=string&created__lte=string&last_updated=string&last_updated__gte=string&last_updated__lte=string&q=string&family=0.0&prefix=string&within=string&within_include=string&contains=string&mask_length=0.0&vrf_id=string&vrf=string&region_id=string&region=string&site_id=string&site=string&vlan_id=string&vlan_vid=0.0&role_id=string&role=string&status=string&tag=string&id__n=string&id__lte=string&id__lt=string&id__gte=string&id__gt=string&tenant_group_id__n=string&tenant_group__n=string&tenant_id__n=string&tenant__n=string&vrf_id__n=string&vrf__n=string&region_id__n=string&region__n=string&site_id__n=string&site__n=string&vlan_id__n=string&role_id__n=string&role__n=string&status__n=string&tag__n=string&limit=0&offset=0Call to super to allow for caching
  • POSTipam_prefixes_create/ipam/prefixes/
  • GETipam_prefixes_read/ipam/prefixes/:id/Call to super to allow for caching
  • PUTipam_prefixes_update/ipam/prefixes/:id/
  • DELETEipam_prefixes_delete/ipam/prefixes/:id/
  • PATCHipam_prefixes_partial_update/ipam/prefixes/:id/
  • GETipam_prefixes_available-ips_read/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…
  • POSTipam_prefixes_available-ips_create/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…
  • GETA convenience method for returning available child prefixes within a parent./ipam/prefixes/:id/available-prefixes/The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where…
  • POSTA convenience method for returning available child prefixes within a parent./ipam/prefixes/:id/available-prefixes/The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where…
  • GETipam_rirs_list/ipam/rirs/?id=string&name=string&slug=string&is_private=string&description=string&q=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&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&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&limit=0&offset=0Call to super to allow for caching
  • POSTipam_rirs_create/ipam/rirs/
  • GETipam_rirs_read/ipam/rirs/:id/Call to super to allow for caching
  • PUTipam_rirs_update/ipam/rirs/:id/
  • DELETEipam_rirs_delete/ipam/rirs/:id/
  • PATCHipam_rirs_partial_update/ipam/rirs/:id/

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

API details

Base URL
https://netboxdemo.com/api
Authentication
An API key in the Authorization header
Operations
386 operations on 148 pathsGET 146POST 63PUT 59PATCH 59DELETE 59
Main resources
dcim 208ipam 58extras 39virtualization 30circuits 25secrets 14tenancy 12
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2.8
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/?term_side=string&port_speed=string&upstream_speed=string&xconnect_id=string&q=string&circuit_id=string&site_id=string&site=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&circuit_id__n=string&site_id__n=string&site__n=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 Developer tools and has 386 endpoints.

Who publishes the NetBox API?

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

What is the base URL of the NetBox API?

Requests go to https://netboxdemo.com/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?

386 operations on 148 paths (146 GET, 63 POST, 59 PUT, 59 PATCH, 59 DELETE). The largest groups are dcim, ipam, extras, virtualization.

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.