Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox

NetBox dcim API

The dcim API from NetBox — 99 operation(s) for dcim.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox dcim API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dcim. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 400 operations across 99 paths, and defines 312 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).

Requests are made against the base URL https://demo.netbox.dev/api.

400 operations 99 paths 312 schemas 86 DELETE98 GET86 PATCH44 POST86 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.5.9 (4.5)
Base URL
https://demo.netbox.dev/api
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox dcim API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 400

Across 99 paths, the API surfaces 400 operations — 86 DELETE, 98 GET, 86 PATCH, 44 POST, 86 PUT. Each is listed below with its method, path, parameters, and response codes.

dcim 400
GET
/api/dcim/cable-terminations/
Get a list of cable termination objects.
dcim_cable_terminations_list 51 params → 200
GET
/api/dcim/cable-terminations/{id}/
Get a cable termination object.
dcim_cable_terminations_retrieve 1 param → 200
GET
/api/dcim/cables/
Get a list of cable objects.
dcim_cables_list 170 params → 200
POST
/api/dcim/cables/
Post a list of cable objects.
dcim_cables_create body → 201
PUT
/api/dcim/cables/
Put a list of cable objects.
dcim_cables_bulk_update body → 200
PATCH
/api/dcim/cables/
Patch a list of cable objects.
dcim_cables_bulk_partial_update body → 200
DELETE
/api/dcim/cables/
Delete a list of cable objects.
dcim_cables_bulk_destroy body → 204
GET
/api/dcim/cables/{id}/
Get a cable object.
dcim_cables_retrieve 1 param → 200
PUT
/api/dcim/cables/{id}/
Put a cable object.
dcim_cables_update 1 param body → 200
PATCH
/api/dcim/cables/{id}/
Patch a cable object.
dcim_cables_partial_update 1 param body → 200
DELETE
/api/dcim/cables/{id}/
Delete a cable object.
dcim_cables_destroy 1 param → 204
GET
/api/dcim/connected-device/
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer interface. This is useful in a situation where a device boots with no configuration, but can…
dcim_connected_device_list 2 params → 200
GET
/api/dcim/console-port-templates/
Get a list of console port template objects.
dcim_console_port_templates_list 84 params → 200
POST
/api/dcim/console-port-templates/
Post a list of console port template objects.
dcim_console_port_templates_create body → 201
PUT
/api/dcim/console-port-templates/
Put a list of console port template objects.
dcim_console_port_templates_bulk_update body → 200
PATCH
/api/dcim/console-port-templates/
Patch a list of console port template objects.
dcim_console_port_templates_bulk_partial_update body → 200
DELETE
/api/dcim/console-port-templates/
Delete a list of console port template objects.
dcim_console_port_templates_bulk_destroy body → 204
GET
/api/dcim/console-port-templates/{id}/
Get a console port template object.
dcim_console_port_templates_retrieve 1 param → 200
PUT
/api/dcim/console-port-templates/{id}/
Put a console port template object.
dcim_console_port_templates_update 1 param body → 200
PATCH
/api/dcim/console-port-templates/{id}/
Patch a console port template object.
dcim_console_port_templates_partial_update 1 param body → 200
DELETE
/api/dcim/console-port-templates/{id}/
Delete a console port template object.
dcim_console_port_templates_destroy 1 param → 204
GET
/api/dcim/console-ports/
Get a list of console port objects.
dcim_console_ports_list 185 params → 200
POST
/api/dcim/console-ports/
Post a list of console port objects.
dcim_console_ports_create body → 201
PUT
/api/dcim/console-ports/
Put a list of console port objects.
dcim_console_ports_bulk_update body → 200
PATCH
/api/dcim/console-ports/
Patch a list of console port objects.
dcim_console_ports_bulk_partial_update body → 200
DELETE
/api/dcim/console-ports/
Delete a list of console port objects.
dcim_console_ports_bulk_destroy body → 204
GET
/api/dcim/console-ports/{id}/
Get a console port object.
dcim_console_ports_retrieve 1 param → 200
PUT
/api/dcim/console-ports/{id}/
Put a console port object.
dcim_console_ports_update 1 param body → 200
PATCH
/api/dcim/console-ports/{id}/
Patch a console port object.
dcim_console_ports_partial_update 1 param body → 200
DELETE
/api/dcim/console-ports/{id}/
Delete a console port object.
dcim_console_ports_destroy 1 param → 204
GET
/api/dcim/console-ports/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_console_ports_trace_retrieve 1 param → 200
GET
/api/dcim/console-server-port-templates/
Get a list of console server port template objects.
dcim_console_server_port_templates_list 84 params → 200
POST
/api/dcim/console-server-port-templates/
Post a list of console server port template objects.
dcim_console_server_port_templates_create body → 201
PUT
/api/dcim/console-server-port-templates/
Put a list of console server port template objects.
dcim_console_server_port_templates_bulk_update body → 200
PATCH
/api/dcim/console-server-port-templates/
Patch a list of console server port template objects.
dcim_console_server_port_templates_bulk_partial_update body → 200
DELETE
/api/dcim/console-server-port-templates/
Delete a list of console server port template objects.
dcim_console_server_port_templates_bulk_destroy body → 204
GET
/api/dcim/console-server-port-templates/{id}/
Get a console server port template object.
dcim_console_server_port_templates_retrieve 1 param → 200
PUT
/api/dcim/console-server-port-templates/{id}/
Put a console server port template object.
dcim_console_server_port_templates_update 1 param body → 200
PATCH
/api/dcim/console-server-port-templates/{id}/
Patch a console server port template object.
dcim_console_server_port_templates_partial_update 1 param body → 200
DELETE
/api/dcim/console-server-port-templates/{id}/
Delete a console server port template object.
dcim_console_server_port_templates_destroy 1 param → 204
GET
/api/dcim/console-server-ports/
Get a list of console server port objects.
dcim_console_server_ports_list 185 params → 200
POST
/api/dcim/console-server-ports/
Post a list of console server port objects.
dcim_console_server_ports_create body → 201
PUT
/api/dcim/console-server-ports/
Put a list of console server port objects.
dcim_console_server_ports_bulk_update body → 200
PATCH
/api/dcim/console-server-ports/
Patch a list of console server port objects.
dcim_console_server_ports_bulk_partial_update body → 200
DELETE
/api/dcim/console-server-ports/
Delete a list of console server port objects.
dcim_console_server_ports_bulk_destroy body → 204
GET
/api/dcim/console-server-ports/{id}/
Get a console server port object.
dcim_console_server_ports_retrieve 1 param → 200
PUT
/api/dcim/console-server-ports/{id}/
Put a console server port object.
dcim_console_server_ports_update 1 param body → 200
PATCH
/api/dcim/console-server-ports/{id}/
Patch a console server port object.
dcim_console_server_ports_partial_update 1 param body → 200
DELETE
/api/dcim/console-server-ports/{id}/
Delete a console server port object.
dcim_console_server_ports_destroy 1 param → 204
GET
/api/dcim/console-server-ports/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_console_server_ports_trace_retrieve 1 param → 200
GET
/api/dcim/device-bay-templates/
Get a list of device bay template objects.
dcim_device_bay_templates_list 69 params → 200
POST
/api/dcim/device-bay-templates/
Post a list of device bay template objects.
dcim_device_bay_templates_create body → 201
PUT
/api/dcim/device-bay-templates/
Put a list of device bay template objects.
dcim_device_bay_templates_bulk_update body → 200
PATCH
/api/dcim/device-bay-templates/
Patch a list of device bay template objects.
dcim_device_bay_templates_bulk_partial_update body → 200
DELETE
/api/dcim/device-bay-templates/
Delete a list of device bay template objects.
dcim_device_bay_templates_bulk_destroy body → 204
GET
/api/dcim/device-bay-templates/{id}/
Get a device bay template object.
dcim_device_bay_templates_retrieve 1 param → 200
PUT
/api/dcim/device-bay-templates/{id}/
Put a device bay template object.
dcim_device_bay_templates_update 1 param body → 200
PATCH
/api/dcim/device-bay-templates/{id}/
Patch a device bay template object.
dcim_device_bay_templates_partial_update 1 param body → 200
DELETE
/api/dcim/device-bay-templates/{id}/
Delete a device bay template object.
dcim_device_bay_templates_destroy 1 param → 204
GET
/api/dcim/device-bays/
Get a list of device bay objects.
dcim_device_bays_list 136 params → 200
POST
/api/dcim/device-bays/
Post a list of device bay objects.
dcim_device_bays_create body → 201
PUT
/api/dcim/device-bays/
Put a list of device bay objects.
dcim_device_bays_bulk_update body → 200
PATCH
/api/dcim/device-bays/
Patch a list of device bay objects.
dcim_device_bays_bulk_partial_update body → 200
DELETE
/api/dcim/device-bays/
Delete a list of device bay objects.
dcim_device_bays_bulk_destroy body → 204
GET
/api/dcim/device-bays/{id}/
Get a device bay object.
dcim_device_bays_retrieve 1 param → 200
PUT
/api/dcim/device-bays/{id}/
Put a device bay object.
dcim_device_bays_update 1 param body → 200
PATCH
/api/dcim/device-bays/{id}/
Patch a device bay object.
dcim_device_bays_partial_update 1 param body → 200
DELETE
/api/dcim/device-bays/{id}/
Delete a device bay object.
dcim_device_bays_destroy 1 param → 204
GET
/api/dcim/device-roles/
Get a list of device role objects.
dcim_device_roles_list 103 params → 200
POST
/api/dcim/device-roles/
Post a list of device role objects.
dcim_device_roles_create body → 201
PUT
/api/dcim/device-roles/
Put a list of device role objects.
dcim_device_roles_bulk_update body → 200
PATCH
/api/dcim/device-roles/
Patch a list of device role objects.
dcim_device_roles_bulk_partial_update body → 200
DELETE
/api/dcim/device-roles/
Delete a list of device role objects.
dcim_device_roles_bulk_destroy body → 204
GET
/api/dcim/device-roles/{id}/
Get a device role object.
dcim_device_roles_retrieve 1 param → 200
PUT
/api/dcim/device-roles/{id}/
Put a device role object.
dcim_device_roles_update 1 param body → 200
PATCH
/api/dcim/device-roles/{id}/
Patch a device role object.
dcim_device_roles_partial_update 1 param body → 200
DELETE
/api/dcim/device-roles/{id}/
Delete a device role object.
dcim_device_roles_destroy 1 param → 204
GET
/api/dcim/device-types/
Get a list of device type objects.
dcim_device_types_list 243 params → 200
POST
/api/dcim/device-types/
Post a list of device type objects.
dcim_device_types_create body → 201
PUT
/api/dcim/device-types/
Put a list of device type objects.
dcim_device_types_bulk_update body → 200
PATCH
/api/dcim/device-types/
Patch a list of device type objects.
dcim_device_types_bulk_partial_update body → 200
DELETE
/api/dcim/device-types/
Delete a list of device type objects.
dcim_device_types_bulk_destroy body → 204
GET
/api/dcim/device-types/{id}/
Get a device type object.
dcim_device_types_retrieve 1 param → 200
PUT
/api/dcim/device-types/{id}/
Put a device type object.
dcim_device_types_update 1 param body → 200
PATCH
/api/dcim/device-types/{id}/
Patch a device type object.
dcim_device_types_partial_update 1 param body → 200
DELETE
/api/dcim/device-types/{id}/
Delete a device type object.
dcim_device_types_destroy 1 param → 204
GET
/api/dcim/devices/
Get a list of device objects.
dcim_devices_list 336 params → 200
POST
/api/dcim/devices/
Post a list of device objects.
dcim_devices_create body → 201
PUT
/api/dcim/devices/
Put a list of device objects.
dcim_devices_bulk_update body → 200
PATCH
/api/dcim/devices/
Patch a list of device objects.
dcim_devices_bulk_partial_update body → 200
DELETE
/api/dcim/devices/
Delete a list of device objects.
dcim_devices_bulk_destroy body → 204
GET
/api/dcim/devices/{id}/
Get a device object.
dcim_devices_retrieve 1 param → 200
PUT
/api/dcim/devices/{id}/
Put a device object.
dcim_devices_update 1 param body → 200
PATCH
/api/dcim/devices/{id}/
Patch a device object.
dcim_devices_partial_update 1 param body → 200
DELETE
/api/dcim/devices/{id}/
Delete a device object.
dcim_devices_destroy 1 param → 204
POST
/api/dcim/devices/{id}/render-config/
Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine.
dcim_devices_render_config_create 2 params body → 200
GET
/api/dcim/front-port-templates/
Get a list of front port template objects.
dcim_front_port_templates_list 106 params → 200
POST
/api/dcim/front-port-templates/
Post a list of front port template objects.
dcim_front_port_templates_create body → 201
PUT
/api/dcim/front-port-templates/
Put a list of front port template objects.
dcim_front_port_templates_bulk_update body → 200
PATCH
/api/dcim/front-port-templates/
Patch a list of front port template objects.
dcim_front_port_templates_bulk_partial_update body → 200
DELETE
/api/dcim/front-port-templates/
Delete a list of front port template objects.
dcim_front_port_templates_bulk_destroy body → 204
GET
/api/dcim/front-port-templates/{id}/
Get a front port template object.
dcim_front_port_templates_retrieve 1 param → 200
PUT
/api/dcim/front-port-templates/{id}/
Put a front port template object.
dcim_front_port_templates_update 1 param body → 200
PATCH
/api/dcim/front-port-templates/{id}/
Patch a front port template object.
dcim_front_port_templates_partial_update 1 param body → 200
DELETE
/api/dcim/front-port-templates/{id}/
Delete a front port template object.
dcim_front_port_templates_destroy 1 param → 204
GET
/api/dcim/front-ports/
Get a list of front port objects.
dcim_front_ports_list 194 params → 200
POST
/api/dcim/front-ports/
Post a list of front port objects.
dcim_front_ports_create body → 201
PUT
/api/dcim/front-ports/
Put a list of front port objects.
dcim_front_ports_bulk_update body → 200
PATCH
/api/dcim/front-ports/
Patch a list of front port objects.
dcim_front_ports_bulk_partial_update body → 200
DELETE
/api/dcim/front-ports/
Delete a list of front port objects.
dcim_front_ports_bulk_destroy body → 204
GET
/api/dcim/front-ports/{id}/
Get a front port object.
dcim_front_ports_retrieve 1 param → 200
PUT
/api/dcim/front-ports/{id}/
Put a front port object.
dcim_front_ports_update 1 param body → 200
PATCH
/api/dcim/front-ports/{id}/
Patch a front port object.
dcim_front_ports_partial_update 1 param body → 200
DELETE
/api/dcim/front-ports/{id}/
Delete a front port object.
dcim_front_ports_destroy 1 param → 204
GET
/api/dcim/front-ports/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
dcim_front_ports_paths_retrieve 1 param → 200
GET
/api/dcim/interface-templates/
Get a list of interface template objects.
dcim_interface_templates_list 127 params → 200
POST
/api/dcim/interface-templates/
Post a list of interface template objects.
dcim_interface_templates_create body → 201
PUT
/api/dcim/interface-templates/
Put a list of interface template objects.
dcim_interface_templates_bulk_update body → 200
PATCH
/api/dcim/interface-templates/
Patch a list of interface template objects.
dcim_interface_templates_bulk_partial_update body → 200
DELETE
/api/dcim/interface-templates/
Delete a list of interface template objects.
dcim_interface_templates_bulk_destroy body → 204
GET
/api/dcim/interface-templates/{id}/
Get a interface template object.
dcim_interface_templates_retrieve 1 param → 200
PUT
/api/dcim/interface-templates/{id}/
Put a interface template object.
dcim_interface_templates_update 1 param body → 200
PATCH
/api/dcim/interface-templates/{id}/
Patch a interface template object.
dcim_interface_templates_partial_update 1 param body → 200
DELETE
/api/dcim/interface-templates/{id}/
Delete a interface template object.
dcim_interface_templates_destroy 1 param → 204
GET
/api/dcim/interfaces/
Get a list of interface objects.
dcim_interfaces_list 355 params → 200
POST
/api/dcim/interfaces/
Post a list of interface objects.
dcim_interfaces_create body → 201
PUT
/api/dcim/interfaces/
Put a list of interface objects.
dcim_interfaces_bulk_update body → 200
PATCH
/api/dcim/interfaces/
Patch a list of interface objects.
dcim_interfaces_bulk_partial_update body → 200
DELETE
/api/dcim/interfaces/
Delete a list of interface objects.
dcim_interfaces_bulk_destroy body → 204
GET
/api/dcim/interfaces/{id}/
Get a interface object.
dcim_interfaces_retrieve 1 param → 200
PUT
/api/dcim/interfaces/{id}/
Put a interface object.
dcim_interfaces_update 1 param body → 200
PATCH
/api/dcim/interfaces/{id}/
Patch a interface object.
dcim_interfaces_partial_update 1 param body → 200
DELETE
/api/dcim/interfaces/{id}/
Delete a interface object.
dcim_interfaces_destroy 1 param → 204
GET
/api/dcim/interfaces/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_interfaces_trace_retrieve 1 param → 200
GET
/api/dcim/inventory-item-roles/
Get a list of inventory item role objects.
dcim_inventory_item_roles_list 92 params → 200
POST
/api/dcim/inventory-item-roles/
Post a list of inventory item role objects.
dcim_inventory_item_roles_create body → 201
PUT
/api/dcim/inventory-item-roles/
Put a list of inventory item role objects.
dcim_inventory_item_roles_bulk_update body → 200
PATCH
/api/dcim/inventory-item-roles/
Patch a list of inventory item role objects.
dcim_inventory_item_roles_bulk_partial_update body → 200
DELETE
/api/dcim/inventory-item-roles/
Delete a list of inventory item role objects.
dcim_inventory_item_roles_bulk_destroy body → 204
GET
/api/dcim/inventory-item-roles/{id}/
Get a inventory item role object.
dcim_inventory_item_roles_retrieve 1 param → 200
PUT
/api/dcim/inventory-item-roles/{id}/
Put a inventory item role object.
dcim_inventory_item_roles_update 1 param body → 200
PATCH
/api/dcim/inventory-item-roles/{id}/
Patch a inventory item role object.
dcim_inventory_item_roles_partial_update 1 param body → 200
DELETE
/api/dcim/inventory-item-roles/{id}/
Delete a inventory item role object.
dcim_inventory_item_roles_destroy 1 param → 204
GET
/api/dcim/inventory-item-templates/
Get a list of inventory item template objects.
dcim_inventory_item_templates_list 101 params → 200
POST
/api/dcim/inventory-item-templates/
Post a list of inventory item template objects.
dcim_inventory_item_templates_create body → 201
PUT
/api/dcim/inventory-item-templates/
Put a list of inventory item template objects.
dcim_inventory_item_templates_bulk_update body → 200
PATCH
/api/dcim/inventory-item-templates/
Patch a list of inventory item template objects.
dcim_inventory_item_templates_bulk_partial_update body → 200
DELETE
/api/dcim/inventory-item-templates/
Delete a list of inventory item template objects.
dcim_inventory_item_templates_bulk_destroy body → 204
GET
/api/dcim/inventory-item-templates/{id}/
Get a inventory item template object.
dcim_inventory_item_templates_retrieve 1 param → 200
PUT
/api/dcim/inventory-item-templates/{id}/
Put a inventory item template object.
dcim_inventory_item_templates_update 1 param body → 200
PATCH
/api/dcim/inventory-item-templates/{id}/
Patch a inventory item template object.
dcim_inventory_item_templates_partial_update 1 param body → 200
DELETE
/api/dcim/inventory-item-templates/{id}/
Delete a inventory item template object.
dcim_inventory_item_templates_destroy 1 param → 204
GET
/api/dcim/inventory-items/
Get a list of inventory item objects.
dcim_inventory_items_list 204 params → 200
POST
/api/dcim/inventory-items/
Post a list of inventory item objects.
dcim_inventory_items_create body → 201
PUT
/api/dcim/inventory-items/
Put a list of inventory item objects.
dcim_inventory_items_bulk_update body → 200
PATCH
/api/dcim/inventory-items/
Patch a list of inventory item objects.
dcim_inventory_items_bulk_partial_update body → 200
DELETE
/api/dcim/inventory-items/
Delete a list of inventory item objects.
dcim_inventory_items_bulk_destroy body → 204
GET
/api/dcim/inventory-items/{id}/
Get a inventory item object.
dcim_inventory_items_retrieve 1 param → 200
PUT
/api/dcim/inventory-items/{id}/
Put a inventory item object.
dcim_inventory_items_update 1 param body → 200
PATCH
/api/dcim/inventory-items/{id}/
Patch a inventory item object.
dcim_inventory_items_partial_update 1 param body → 200
DELETE
/api/dcim/inventory-items/{id}/
Delete a inventory item object.
dcim_inventory_items_destroy 1 param → 204
GET
/api/dcim/locations/
Get a list of location objects.
dcim_locations_list 139 params → 200
POST
/api/dcim/locations/
Post a list of location objects.
dcim_locations_create body → 201
PUT
/api/dcim/locations/
Put a list of location objects.
dcim_locations_bulk_update body → 200
PATCH
/api/dcim/locations/
Patch a list of location objects.
dcim_locations_bulk_partial_update body → 200
DELETE
/api/dcim/locations/
Delete a list of location objects.
dcim_locations_bulk_destroy body → 204
GET
/api/dcim/locations/{id}/
Get a location object.
dcim_locations_retrieve 1 param → 200
PUT
/api/dcim/locations/{id}/
Put a location object.
dcim_locations_update 1 param body → 200
PATCH
/api/dcim/locations/{id}/
Patch a location object.
dcim_locations_partial_update 1 param body → 200
DELETE
/api/dcim/locations/{id}/
Delete a location object.
dcim_locations_destroy 1 param → 204
GET
/api/dcim/mac-addresses/
Get a list of MAC address objects.
dcim_mac_addresses_list 88 params → 200
POST
/api/dcim/mac-addresses/
Post a list of MAC address objects.
dcim_mac_addresses_create body → 201
PUT
/api/dcim/mac-addresses/
Put a list of MAC address objects.
dcim_mac_addresses_bulk_update body → 200
PATCH
/api/dcim/mac-addresses/
Patch a list of MAC address objects.
dcim_mac_addresses_bulk_partial_update body → 200
DELETE
/api/dcim/mac-addresses/
Delete a list of MAC address objects.
dcim_mac_addresses_bulk_destroy body → 204
GET
/api/dcim/mac-addresses/{id}/
Get a MAC address object.
dcim_mac_addresses_retrieve 1 param → 200
PUT
/api/dcim/mac-addresses/{id}/
Put a MAC address object.
dcim_mac_addresses_update 1 param body → 200
PATCH
/api/dcim/mac-addresses/{id}/
Patch a MAC address object.
dcim_mac_addresses_partial_update 1 param body → 200
DELETE
/api/dcim/mac-addresses/{id}/
Delete a MAC address object.
dcim_mac_addresses_destroy 1 param → 204
GET
/api/dcim/manufacturers/
Get a list of manufacturer objects.
dcim_manufacturers_list 85 params → 200
POST
/api/dcim/manufacturers/
Post a list of manufacturer objects.
dcim_manufacturers_create body → 201
PUT
/api/dcim/manufacturers/
Put a list of manufacturer objects.
dcim_manufacturers_bulk_update body → 200
PATCH
/api/dcim/manufacturers/
Patch a list of manufacturer objects.
dcim_manufacturers_bulk_partial_update body → 200
DELETE
/api/dcim/manufacturers/
Delete a list of manufacturer objects.
dcim_manufacturers_bulk_destroy body → 204
GET
/api/dcim/manufacturers/{id}/
Get a manufacturer object.
dcim_manufacturers_retrieve 1 param → 200
PUT
/api/dcim/manufacturers/{id}/
Put a manufacturer object.
dcim_manufacturers_update 1 param body → 200
PATCH
/api/dcim/manufacturers/{id}/
Patch a manufacturer object.
dcim_manufacturers_partial_update 1 param body → 200
DELETE
/api/dcim/manufacturers/{id}/
Delete a manufacturer object.
dcim_manufacturers_destroy 1 param → 204
GET
/api/dcim/module-bay-templates/
Get a list of module bay template objects.
dcim_module_bay_templates_list 84 params → 200
POST
/api/dcim/module-bay-templates/
Post a list of module bay template objects.
dcim_module_bay_templates_create body → 201
PUT
/api/dcim/module-bay-templates/
Put a list of module bay template objects.
dcim_module_bay_templates_bulk_update body → 200
PATCH
/api/dcim/module-bay-templates/
Patch a list of module bay template objects.
dcim_module_bay_templates_bulk_partial_update body → 200
DELETE
/api/dcim/module-bay-templates/
Delete a list of module bay template objects.
dcim_module_bay_templates_bulk_destroy body → 204
GET
/api/dcim/module-bay-templates/{id}/
Get a module bay template object.
dcim_module_bay_templates_retrieve 1 param → 200
PUT
/api/dcim/module-bay-templates/{id}/
Put a module bay template object.
dcim_module_bay_templates_update 1 param body → 200
PATCH
/api/dcim/module-bay-templates/{id}/
Patch a module bay template object.
dcim_module_bay_templates_partial_update 1 param body → 200
DELETE
/api/dcim/module-bay-templates/{id}/
Delete a module bay template object.
dcim_module_bay_templates_destroy 1 param → 204
GET
/api/dcim/module-bays/
Get a list of module bay objects.
dcim_module_bays_list 151 params → 200
POST
/api/dcim/module-bays/
Post a list of module bay objects.
dcim_module_bays_create body → 201
PUT
/api/dcim/module-bays/
Put a list of module bay objects.
dcim_module_bays_bulk_update body → 200
PATCH
/api/dcim/module-bays/
Patch a list of module bay objects.
dcim_module_bays_bulk_partial_update body → 200
DELETE
/api/dcim/module-bays/
Delete a list of module bay objects.
dcim_module_bays_bulk_destroy body → 204
GET
/api/dcim/module-bays/{id}/
Get a module bay object.
dcim_module_bays_retrieve 1 param → 200
PUT
/api/dcim/module-bays/{id}/
Put a module bay object.
dcim_module_bays_update 1 param body → 200
PATCH
/api/dcim/module-bays/{id}/
Patch a module bay object.
dcim_module_bays_partial_update 1 param body → 200
DELETE
/api/dcim/module-bays/{id}/
Delete a module bay object.
dcim_module_bays_destroy 1 param → 204
GET
/api/dcim/module-type-profiles/
Get a list of module type profile objects.
dcim_module_type_profiles_list 66 params → 200
POST
/api/dcim/module-type-profiles/
Post a list of module type profile objects.
dcim_module_type_profiles_create body → 201
PUT
/api/dcim/module-type-profiles/
Put a list of module type profile objects.
dcim_module_type_profiles_bulk_update body → 200
PATCH
/api/dcim/module-type-profiles/
Patch a list of module type profile objects.
dcim_module_type_profiles_bulk_partial_update body → 200
DELETE
/api/dcim/module-type-profiles/
Delete a list of module type profile objects.
dcim_module_type_profiles_bulk_destroy body → 204
GET
/api/dcim/module-type-profiles/{id}/
Get a module type profile object.
dcim_module_type_profiles_retrieve 1 param → 200
PUT
/api/dcim/module-type-profiles/{id}/
Put a module type profile object.
dcim_module_type_profiles_update 1 param body → 200
PATCH
/api/dcim/module-type-profiles/{id}/
Patch a module type profile object.
dcim_module_type_profiles_partial_update 1 param body → 200
DELETE
/api/dcim/module-type-profiles/{id}/
Delete a module type profile object.
dcim_module_type_profiles_destroy 1 param → 204
GET
/api/dcim/module-types/
Get a list of module type objects.
dcim_module_types_list 133 params → 200
POST
/api/dcim/module-types/
Post a list of module type objects.
dcim_module_types_create body → 201
PUT
/api/dcim/module-types/
Put a list of module type objects.
dcim_module_types_bulk_update body → 200
PATCH
/api/dcim/module-types/
Patch a list of module type objects.
dcim_module_types_bulk_partial_update body → 200
DELETE
/api/dcim/module-types/
Delete a list of module type objects.
dcim_module_types_bulk_destroy body → 204
GET
/api/dcim/module-types/{id}/
Get a module type object.
dcim_module_types_retrieve 1 param → 200
PUT
/api/dcim/module-types/{id}/
Put a module type object.
dcim_module_types_update 1 param body → 200
PATCH
/api/dcim/module-types/{id}/
Patch a module type object.
dcim_module_types_partial_update 1 param body → 200
DELETE
/api/dcim/module-types/{id}/
Delete a module type object.
dcim_module_types_destroy 1 param → 204
GET
/api/dcim/modules/
Get a list of module objects.
dcim_modules_list 130 params → 200
POST
/api/dcim/modules/
Post a list of module objects.
dcim_modules_create body → 201
PUT
/api/dcim/modules/
Put a list of module objects.
dcim_modules_bulk_update body → 200
PATCH
/api/dcim/modules/
Patch a list of module objects.
dcim_modules_bulk_partial_update body → 200
DELETE
/api/dcim/modules/
Delete a list of module objects.
dcim_modules_bulk_destroy body → 204
GET
/api/dcim/modules/{id}/
Get a module object.
dcim_modules_retrieve 1 param → 200
PUT
/api/dcim/modules/{id}/
Put a module object.
dcim_modules_update 1 param body → 200
PATCH
/api/dcim/modules/{id}/
Patch a module object.
dcim_modules_partial_update 1 param body → 200
DELETE
/api/dcim/modules/{id}/
Delete a module object.
dcim_modules_destroy 1 param → 204
GET
/api/dcim/platforms/
Get a list of platform objects.
dcim_platforms_list 94 params → 200
POST
/api/dcim/platforms/
Post a list of platform objects.
dcim_platforms_create body → 201
PUT
/api/dcim/platforms/
Put a list of platform objects.
dcim_platforms_bulk_update body → 200
PATCH
/api/dcim/platforms/
Patch a list of platform objects.
dcim_platforms_bulk_partial_update body → 200
DELETE
/api/dcim/platforms/
Delete a list of platform objects.
dcim_platforms_bulk_destroy body → 204
GET
/api/dcim/platforms/{id}/
Get a platform object.
dcim_platforms_retrieve 1 param → 200
PUT
/api/dcim/platforms/{id}/
Put a platform object.
dcim_platforms_update 1 param body → 200
PATCH
/api/dcim/platforms/{id}/
Patch a platform object.
dcim_platforms_partial_update 1 param body → 200
DELETE
/api/dcim/platforms/{id}/
Delete a platform object.
dcim_platforms_destroy 1 param → 204
GET
/api/dcim/power-feeds/
Get a list of power feed objects.
dcim_power_feeds_list 196 params → 200
POST
/api/dcim/power-feeds/
Post a list of power feed objects.
dcim_power_feeds_create body → 201
PUT
/api/dcim/power-feeds/
Put a list of power feed objects.
dcim_power_feeds_bulk_update body → 200
PATCH
/api/dcim/power-feeds/
Patch a list of power feed objects.
dcim_power_feeds_bulk_partial_update body → 200
DELETE
/api/dcim/power-feeds/
Delete a list of power feed objects.
dcim_power_feeds_bulk_destroy body → 204
GET
/api/dcim/power-feeds/{id}/
Get a power feed object.
dcim_power_feeds_retrieve 1 param → 200
PUT
/api/dcim/power-feeds/{id}/
Put a power feed object.
dcim_power_feeds_update 1 param body → 200
PATCH
/api/dcim/power-feeds/{id}/
Patch a power feed object.
dcim_power_feeds_partial_update 1 param body → 200
DELETE
/api/dcim/power-feeds/{id}/
Delete a power feed object.
dcim_power_feeds_destroy 1 param → 204
GET
/api/dcim/power-feeds/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_power_feeds_trace_retrieve 1 param → 200
GET
/api/dcim/power-outlet-templates/
Get a list of power outlet template objects.
dcim_power_outlet_templates_list 112 params → 200
POST
/api/dcim/power-outlet-templates/
Post a list of power outlet template objects.
dcim_power_outlet_templates_create body → 201
PUT
/api/dcim/power-outlet-templates/
Put a list of power outlet template objects.
dcim_power_outlet_templates_bulk_update body → 200
PATCH
/api/dcim/power-outlet-templates/
Patch a list of power outlet template objects.
dcim_power_outlet_templates_bulk_partial_update body → 200
DELETE
/api/dcim/power-outlet-templates/
Delete a list of power outlet template objects.
dcim_power_outlet_templates_bulk_destroy body → 204
GET
/api/dcim/power-outlet-templates/{id}/
Get a power outlet template object.
dcim_power_outlet_templates_retrieve 1 param → 200
PUT
/api/dcim/power-outlet-templates/{id}/
Put a power outlet template object.
dcim_power_outlet_templates_update 1 param body → 200
PATCH
/api/dcim/power-outlet-templates/{id}/
Patch a power outlet template object.
dcim_power_outlet_templates_partial_update 1 param body → 200
DELETE
/api/dcim/power-outlet-templates/{id}/
Delete a power outlet template object.
dcim_power_outlet_templates_destroy 1 param → 204
GET
/api/dcim/power-outlets/
Get a list of power outlet objects.
dcim_power_outlets_list 214 params → 200
POST
/api/dcim/power-outlets/
Post a list of power outlet objects.
dcim_power_outlets_create body → 201
PUT
/api/dcim/power-outlets/
Put a list of power outlet objects.
dcim_power_outlets_bulk_update body → 200
PATCH
/api/dcim/power-outlets/
Patch a list of power outlet objects.
dcim_power_outlets_bulk_partial_update body → 200
DELETE
/api/dcim/power-outlets/
Delete a list of power outlet objects.
dcim_power_outlets_bulk_destroy body → 204
GET
/api/dcim/power-outlets/{id}/
Get a power outlet object.
dcim_power_outlets_retrieve 1 param → 200
PUT
/api/dcim/power-outlets/{id}/
Put a power outlet object.
dcim_power_outlets_update 1 param body → 200
PATCH
/api/dcim/power-outlets/{id}/
Patch a power outlet object.
dcim_power_outlets_partial_update 1 param body → 200
DELETE
/api/dcim/power-outlets/{id}/
Delete a power outlet object.
dcim_power_outlets_destroy 1 param → 204
GET
/api/dcim/power-outlets/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_power_outlets_trace_retrieve 1 param → 200
GET
/api/dcim/power-panels/
Get a list of power panel objects.
dcim_power_panels_list 86 params → 200
POST
/api/dcim/power-panels/
Post a list of power panel objects.
dcim_power_panels_create body → 201
PUT
/api/dcim/power-panels/
Put a list of power panel objects.
dcim_power_panels_bulk_update body → 200
PATCH
/api/dcim/power-panels/
Patch a list of power panel objects.
dcim_power_panels_bulk_partial_update body → 200
DELETE
/api/dcim/power-panels/
Delete a list of power panel objects.
dcim_power_panels_bulk_destroy body → 204
GET
/api/dcim/power-panels/{id}/
Get a power panel object.
dcim_power_panels_retrieve 1 param → 200
PUT
/api/dcim/power-panels/{id}/
Put a power panel object.
dcim_power_panels_update 1 param body → 200
PATCH
/api/dcim/power-panels/{id}/
Patch a power panel object.
dcim_power_panels_partial_update 1 param body → 200
DELETE
/api/dcim/power-panels/{id}/
Delete a power panel object.
dcim_power_panels_destroy 1 param → 204
GET
/api/dcim/power-port-templates/
Get a list of power port template objects.
dcim_power_port_templates_list 98 params → 200
POST
/api/dcim/power-port-templates/
Post a list of power port template objects.
dcim_power_port_templates_create body → 201
PUT
/api/dcim/power-port-templates/
Put a list of power port template objects.
dcim_power_port_templates_bulk_update body → 200
PATCH
/api/dcim/power-port-templates/
Patch a list of power port template objects.
dcim_power_port_templates_bulk_partial_update body → 200
DELETE
/api/dcim/power-port-templates/
Delete a list of power port template objects.
dcim_power_port_templates_bulk_destroy body → 204
GET
/api/dcim/power-port-templates/{id}/
Get a power port template object.
dcim_power_port_templates_retrieve 1 param → 200
PUT
/api/dcim/power-port-templates/{id}/
Put a power port template object.
dcim_power_port_templates_update 1 param body → 200
PATCH
/api/dcim/power-port-templates/{id}/
Patch a power port template object.
dcim_power_port_templates_partial_update 1 param body → 200
DELETE
/api/dcim/power-port-templates/{id}/
Delete a power port template object.
dcim_power_port_templates_destroy 1 param → 204
GET
/api/dcim/power-ports/
Get a list of power port objects.
dcim_power_ports_list 187 params → 200
POST
/api/dcim/power-ports/
Post a list of power port objects.
dcim_power_ports_create body → 201
PUT
/api/dcim/power-ports/
Put a list of power port objects.
dcim_power_ports_bulk_update body → 200
PATCH
/api/dcim/power-ports/
Patch a list of power port objects.
dcim_power_ports_bulk_partial_update body → 200
DELETE
/api/dcim/power-ports/
Delete a list of power port objects.
dcim_power_ports_bulk_destroy body → 204
GET
/api/dcim/power-ports/{id}/
Get a power port object.
dcim_power_ports_retrieve 1 param → 200
PUT
/api/dcim/power-ports/{id}/
Put a power port object.
dcim_power_ports_update 1 param body → 200
PATCH
/api/dcim/power-ports/{id}/
Patch a power port object.
dcim_power_ports_partial_update 1 param body → 200
DELETE
/api/dcim/power-ports/{id}/
Delete a power port object.
dcim_power_ports_destroy 1 param → 204
GET
/api/dcim/power-ports/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
dcim_power_ports_trace_retrieve 1 param → 200
GET
/api/dcim/rack-reservations/
Get a list of rack reservation objects.
dcim_rack_reservations_list 103 params → 200
POST
/api/dcim/rack-reservations/
Post a list of rack reservation objects.
dcim_rack_reservations_create body → 201
PUT
/api/dcim/rack-reservations/
Put a list of rack reservation objects.
dcim_rack_reservations_bulk_update body → 200
PATCH
/api/dcim/rack-reservations/
Patch a list of rack reservation objects.
dcim_rack_reservations_bulk_partial_update body → 200
DELETE
/api/dcim/rack-reservations/
Delete a list of rack reservation objects.
dcim_rack_reservations_bulk_destroy body → 204
GET
/api/dcim/rack-reservations/{id}/
Get a rack reservation object.
dcim_rack_reservations_retrieve 1 param → 200
PUT
/api/dcim/rack-reservations/{id}/
Put a rack reservation object.
dcim_rack_reservations_update 1 param body → 200
PATCH
/api/dcim/rack-reservations/{id}/
Patch a rack reservation object.
dcim_rack_reservations_partial_update 1 param body → 200
DELETE
/api/dcim/rack-reservations/{id}/
Delete a rack reservation object.
dcim_rack_reservations_destroy 1 param → 204
GET
/api/dcim/rack-roles/
Get a list of rack role objects.
dcim_rack_roles_list 92 params → 200
POST
/api/dcim/rack-roles/
Post a list of rack role objects.
dcim_rack_roles_create body → 201
PUT
/api/dcim/rack-roles/
Put a list of rack role objects.
dcim_rack_roles_bulk_update body → 200
PATCH
/api/dcim/rack-roles/
Patch a list of rack role objects.
dcim_rack_roles_bulk_partial_update body → 200
DELETE
/api/dcim/rack-roles/
Delete a list of rack role objects.
dcim_rack_roles_bulk_destroy body → 204
GET
/api/dcim/rack-roles/{id}/
Get a rack role object.
dcim_rack_roles_retrieve 1 param → 200
PUT
/api/dcim/rack-roles/{id}/
Put a rack role object.
dcim_rack_roles_update 1 param body → 200
PATCH
/api/dcim/rack-roles/{id}/
Patch a rack role object.
dcim_rack_roles_partial_update 1 param body → 200
DELETE
/api/dcim/rack-roles/{id}/
Delete a rack role object.
dcim_rack_roles_destroy 1 param → 204
GET
/api/dcim/rack-types/
Get a list of rack type objects.
dcim_rack_types_list 198 params → 200
POST
/api/dcim/rack-types/
Post a list of rack type objects.
dcim_rack_types_create body → 201
PUT
/api/dcim/rack-types/
Put a list of rack type objects.
dcim_rack_types_bulk_update body → 200
PATCH
/api/dcim/rack-types/
Patch a list of rack type objects.
dcim_rack_types_bulk_partial_update body → 200
DELETE
/api/dcim/rack-types/
Delete a list of rack type objects.
dcim_rack_types_bulk_destroy body → 204
GET
/api/dcim/rack-types/{id}/
Get a rack type object.
dcim_rack_types_retrieve 1 param → 200
PUT
/api/dcim/rack-types/{id}/
Put a rack type object.
dcim_rack_types_update 1 param body → 200
PATCH
/api/dcim/rack-types/{id}/
Patch a rack type object.
dcim_rack_types_partial_update 1 param body → 200
DELETE
/api/dcim/rack-types/{id}/
Delete a rack type object.
dcim_rack_types_destroy 1 param → 204
GET
/api/dcim/racks/
Get a list of rack objects.
dcim_racks_list 281 params → 200
POST
/api/dcim/racks/
Post a list of rack objects.
dcim_racks_create body → 201
PUT
/api/dcim/racks/
Put a list of rack objects.
dcim_racks_bulk_update body → 200
PATCH
/api/dcim/racks/
Patch a list of rack objects.
dcim_racks_bulk_partial_update body → 200
DELETE
/api/dcim/racks/
Delete a list of rack objects.
dcim_racks_bulk_destroy body → 204
GET
/api/dcim/racks/{id}/
Get a rack object.
dcim_racks_retrieve 1 param → 200
PUT
/api/dcim/racks/{id}/
Put a rack object.
dcim_racks_update 1 param body → 200
PATCH
/api/dcim/racks/{id}/
Patch a rack object.
dcim_racks_partial_update 1 param body → 200
DELETE
/api/dcim/racks/{id}/
Delete a rack object.
dcim_racks_destroy 1 param → 204
GET
/api/dcim/racks/{id}/elevation/
Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
dcim_racks_elevation_retrieve 13 params → 200
GET
/api/dcim/rear-port-templates/
Get a list of rear port template objects.
dcim_rear_port_templates_list 106 params → 200
POST
/api/dcim/rear-port-templates/
Post a list of rear port template objects.
dcim_rear_port_templates_create body → 201
PUT
/api/dcim/rear-port-templates/
Put a list of rear port template objects.
dcim_rear_port_templates_bulk_update body → 200
PATCH
/api/dcim/rear-port-templates/
Patch a list of rear port template objects.
dcim_rear_port_templates_bulk_partial_update body → 200
DELETE
/api/dcim/rear-port-templates/
Delete a list of rear port template objects.
dcim_rear_port_templates_bulk_destroy body → 204
GET
/api/dcim/rear-port-templates/{id}/
Get a rear port template object.
dcim_rear_port_templates_retrieve 1 param → 200
PUT
/api/dcim/rear-port-templates/{id}/
Put a rear port template object.
dcim_rear_port_templates_update 1 param body → 200
PATCH
/api/dcim/rear-port-templates/{id}/
Patch a rear port template object.
dcim_rear_port_templates_partial_update 1 param body → 200
DELETE
/api/dcim/rear-port-templates/{id}/
Delete a rear port template object.
dcim_rear_port_templates_destroy 1 param → 204
GET
/api/dcim/rear-ports/
Get a list of rear port objects.
dcim_rear_ports_list 194 params → 200
POST
/api/dcim/rear-ports/
Post a list of rear port objects.
dcim_rear_ports_create body → 201
PUT
/api/dcim/rear-ports/
Put a list of rear port objects.
dcim_rear_ports_bulk_update body → 200
PATCH
/api/dcim/rear-ports/
Patch a list of rear port objects.
dcim_rear_ports_bulk_partial_update body → 200
DELETE
/api/dcim/rear-ports/
Delete a list of rear port objects.
dcim_rear_ports_bulk_destroy body → 204
GET
/api/dcim/rear-ports/{id}/
Get a rear port object.
dcim_rear_ports_retrieve 1 param → 200
PUT
/api/dcim/rear-ports/{id}/
Put a rear port object.
dcim_rear_ports_update 1 param body → 200
PATCH
/api/dcim/rear-ports/{id}/
Patch a rear port object.
dcim_rear_ports_partial_update 1 param body → 200
DELETE
/api/dcim/rear-ports/{id}/
Delete a rear port object.
dcim_rear_ports_destroy 1 param → 204
GET
/api/dcim/rear-ports/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
dcim_rear_ports_paths_retrieve 1 param → 200
GET
/api/dcim/regions/
Get a list of region objects.
dcim_regions_list 93 params → 200
POST
/api/dcim/regions/
Post a list of region objects.
dcim_regions_create body → 201
PUT
/api/dcim/regions/
Put a list of region objects.
dcim_regions_bulk_update body → 200
PATCH
/api/dcim/regions/
Patch a list of region objects.
dcim_regions_bulk_partial_update body → 200
DELETE
/api/dcim/regions/
Delete a list of region objects.
dcim_regions_bulk_destroy body → 204
GET
/api/dcim/regions/{id}/
Get a region object.
dcim_regions_retrieve 1 param → 200
PUT
/api/dcim/regions/{id}/
Put a region object.
dcim_regions_update 1 param body → 200
PATCH
/api/dcim/regions/{id}/
Patch a region object.
dcim_regions_partial_update 1 param body → 200
DELETE
/api/dcim/regions/{id}/
Delete a region object.
dcim_regions_destroy 1 param → 204
GET
/api/dcim/site-groups/
Get a list of site group objects.
dcim_site_groups_list 93 params → 200
POST
/api/dcim/site-groups/
Post a list of site group objects.
dcim_site_groups_create body → 201
PUT
/api/dcim/site-groups/
Put a list of site group objects.
dcim_site_groups_bulk_update body → 200
PATCH
/api/dcim/site-groups/
Patch a list of site group objects.
dcim_site_groups_bulk_partial_update body → 200
DELETE
/api/dcim/site-groups/
Delete a list of site group objects.
dcim_site_groups_bulk_destroy body → 204
GET
/api/dcim/site-groups/{id}/
Get a site group object.
dcim_site_groups_retrieve 1 param → 200
PUT
/api/dcim/site-groups/{id}/
Put a site group object.
dcim_site_groups_update 1 param body → 200
PATCH
/api/dcim/site-groups/{id}/
Patch a site group object.
dcim_site_groups_partial_update 1 param body → 200
DELETE
/api/dcim/site-groups/{id}/
Delete a site group object.
dcim_site_groups_destroy 1 param → 204
GET
/api/dcim/sites/
Get a list of site objects.
dcim_sites_list 157 params → 200
POST
/api/dcim/sites/
Post a list of site objects.
dcim_sites_create body → 201
PUT
/api/dcim/sites/
Put a list of site objects.
dcim_sites_bulk_update body → 200
PATCH
/api/dcim/sites/
Patch a list of site objects.
dcim_sites_bulk_partial_update body → 200
DELETE
/api/dcim/sites/
Delete a list of site objects.
dcim_sites_bulk_destroy body → 204
GET
/api/dcim/sites/{id}/
Get a site object.
dcim_sites_retrieve 1 param → 200
PUT
/api/dcim/sites/{id}/
Put a site object.
dcim_sites_update 1 param body → 200
PATCH
/api/dcim/sites/{id}/
Patch a site object.
dcim_sites_partial_update 1 param body → 200
DELETE
/api/dcim/sites/{id}/
Delete a site object.
dcim_sites_destroy 1 param → 204
GET
/api/dcim/virtual-chassis/
Get a list of virtual chassis objects.
dcim_virtual_chassis_list 106 params → 200
POST
/api/dcim/virtual-chassis/
Post a list of virtual chassis objects.
dcim_virtual_chassis_create body → 201
PUT
/api/dcim/virtual-chassis/
Put a list of virtual chassis objects.
dcim_virtual_chassis_bulk_update body → 200
PATCH
/api/dcim/virtual-chassis/
Patch a list of virtual chassis objects.
dcim_virtual_chassis_bulk_partial_update body → 200
DELETE
/api/dcim/virtual-chassis/
Delete a list of virtual chassis objects.
dcim_virtual_chassis_bulk_destroy body → 204
GET
/api/dcim/virtual-chassis/{id}/
Get a virtual chassis object.
dcim_virtual_chassis_retrieve 1 param → 200
PUT
/api/dcim/virtual-chassis/{id}/
Put a virtual chassis object.
dcim_virtual_chassis_update 1 param body → 200
PATCH
/api/dcim/virtual-chassis/{id}/
Patch a virtual chassis object.
dcim_virtual_chassis_partial_update 1 param body → 200
DELETE
/api/dcim/virtual-chassis/{id}/
Delete a virtual chassis object.
dcim_virtual_chassis_destroy 1 param → 204
GET
/api/dcim/virtual-device-contexts/
Get a list of virtual device context objects.
dcim_virtual_device_contexts_list 109 params → 200
POST
/api/dcim/virtual-device-contexts/
Post a list of virtual device context objects.
dcim_virtual_device_contexts_create body → 201
PUT
/api/dcim/virtual-device-contexts/
Put a list of virtual device context objects.
dcim_virtual_device_contexts_bulk_update body → 200
PATCH
/api/dcim/virtual-device-contexts/
Patch a list of virtual device context objects.
dcim_virtual_device_contexts_bulk_partial_update body → 200
DELETE
/api/dcim/virtual-device-contexts/
Delete a list of virtual device context objects.
dcim_virtual_device_contexts_bulk_destroy body → 204
GET
/api/dcim/virtual-device-contexts/{id}/
Get a virtual device context object.
dcim_virtual_device_contexts_retrieve 1 param → 200
PUT
/api/dcim/virtual-device-contexts/{id}/
Put a virtual device context object.
dcim_virtual_device_contexts_update 1 param body → 200
PATCH
/api/dcim/virtual-device-contexts/{id}/
Patch a virtual device context object.
dcim_virtual_device_contexts_partial_update 1 param body → 200
DELETE
/api/dcim/virtual-device-contexts/{id}/
Delete a virtual device context object.
dcim_virtual_device_contexts_destroy 1 param → 204

Schemas 312

The contract defines 312 schemas that model the data the API accepts and returns. The most detailed are Interface (56 properties), DeviceWithConfigContext (49 properties), Device (48 properties), Rack (37 properties). Each schema is shown below with its type and property counts.

CableTermination
object
Adds support for custom fields and tags.
12 properties 12 required
FrontPortMappingRequest
object
3 properties 2 required
WritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties 2 required
InterfaceTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
12 properties 2 required
BriefPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 3 required
NestedLocation
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
BriefManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
WritableConsolePortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties 1 required
ConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 2 required
GenericObjectRequest
object
Minimal representation of some generic object identified by ContentType and PK.
2 properties 2 required
PaginatedPowerOutletList
object
4 properties 2 required
PaginatedInventoryItemList
object
4 properties 2 required
RearPortTemplateMapping
object
3 properties 2 required
FrontPortTemplateMappingRequest
object
3 properties 2 required
RackType
object
Base serializer class for models inheriting from PrimaryModel.
28 properties 10 required
BriefClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
NestedInterface
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
8 properties 7 required
PatchedWritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
NestedModuleBayRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
ModuleBayTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
11 properties 6 required
CableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
26 properties 16 required
PatchedWritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
PaginatedCableList
object
4 properties 2 required
BriefModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 2 required
PatchedInventoryItemTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties
InventoryItemRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
PaginatedModuleTypeProfileList
object
4 properties 2 required
PatchedWritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
WritablePowerOutletTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 1 required
PaginatedPowerPortList
object
4 properties 2 required
RearPortMappingRequest
object
3 properties 2 required
RearPortTemplateMappingRequest
object
3 properties 2 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 10 required
VirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 3 required
PowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 9 required
PaginatedPowerPortTemplateList
object
4 properties 2 required
NestedInterfaceRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
2 properties 1 required
NestedModuleBay
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
BriefPowerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
PatchedModuleBayTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties
PatchedWritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
PaginatedDeviceWithConfigContextList
object
4 properties 2 required
BriefRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
BriefRackType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 7 required
NestedRegionRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
2 properties 2 required
ConsolePortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties 1 required
PatchedWritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 7 required
WritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 3 required
RackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 4 required
WritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 4 required
PatchedWritableRearPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
DeviceType
object
Base serializer class for models inheriting from PrimaryModel.
36 properties 20 required
PaginatedConsolePortList
object
4 properties 2 required
BriefSiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
PowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
PaginatedConsoleServerPortTemplateList
object
4 properties 2 required
BriefModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
WirelessLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 8 required
ModuleBayTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties 1 required
WritableInterfaceTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
12 properties 2 required
DeviceBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties 8 required
PatchedModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
Cable
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 6 required
BriefSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
PatchedWritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
PatchedManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
PaginatedDeviceRoleList
object
4 properties 2 required
ASNSite
object
This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.
6 properties 5 required
BriefRack
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
WritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
NestedWirelessLink
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 4 required
ModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties 2 required
FrontPortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
14 properties 7 required
BriefDeviceType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 7 required
ModuleType
object
Base serializer class for models inheriting from PrimaryModel.
20 properties 9 required
RearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 3 required
WritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties 2 required
PatchedInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
BriefVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
BriefMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
WritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 2 required
Platform
object
Base serializer class for models inheriting from NestedGroupModel.
19 properties 11 required
NestedSiteGroupRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
2 properties 2 required
BriefManufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
BriefRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
RegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
LocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties 3 required
PaginatedLocationList
object
4 properties 2 required
PatchedWritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
PaginatedInventoryItemTemplateList
object
4 properties 2 required
InterfaceTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
17 properties 7 required
WritablePlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties 2 required
PowerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 1 required
BriefModule
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 5 required
BriefInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
WritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties 3 required
PatchedWritableConsoleServerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties
PatchedWritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
MACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
RackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 3 required
RearPortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
14 properties 7 required
Rack
object
Base serializer class for models inheriting from PrimaryModel.
37 properties 10 required
PatchedWritableConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
PaginatedManufacturerList
object
4 properties 2 required
NestedInterfaceTemplate
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
4 properties 4 required
PatchedDeviceBayTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties
WritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 4 required
ConsolePort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties 16 required
ModuleBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties 8 required
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PatchedWritablePlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties
BriefCluster
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritablePowerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties
PatchedWritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
PatchedWritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
BriefModuleType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 6 required
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
WritableConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 2 required
WritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 2 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritableFrontPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
PaginatedInventoryItemRoleList
object
4 properties 2 required
RackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
PaginatedDeviceTypeList
object
4 properties 2 required
BriefDeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 8 required
BriefPowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
ManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
ConsolePortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
11 properties 6 required
RearPortMapping
object
3 properties 2 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
PaginatedConsolePortTemplateList
object
4 properties 2 required
PatchedWritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
BriefPowerPortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
PaginatedConsoleServerPortList
object
4 properties 2 required
InventoryItemTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
10 properties 2 required
PatchedWritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
NestedVLAN
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 5 required
VirtualDeviceContext
object
Base serializer class for models inheriting from PrimaryModel.
20 properties 11 required
PatchedWritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
BriefVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PaginatedRackTypeList
object
4 properties 2 required
MACAddress
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 8 required
PaginatedRackRoleList
object
4 properties 2 required
PatchedWritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
Manufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
17 properties 12 required
Site
object
Base serializer class for models inheriting from PrimaryModel.
30 properties 14 required
PlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties 2 required
NestedRegion
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
Interface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
56 properties 24 required
PaginatedMACAddressList
object
4 properties 2 required
ModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 1 required
BriefVLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
NestedLocationRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
2 properties 2 required
NestedTag
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 6 required
BriefRackRole
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PaginatedSiteGroupList
object
4 properties 2 required
BriefInventoryItemRole
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PaginatedCableTerminationList
object
4 properties 2 required
PaginatedModuleBayTemplateList
object
4 properties 2 required
InterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties 3 required
PatchedWritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
SiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
WritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
WritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 2 required
BriefLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
PaginatedPlatformList
object
4 properties 2 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties 4 required
WritableFrontPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 2 required
PatchedDeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
DeviceWithConfigContext
object
Base serializer class for models inheriting from PrimaryModel.
49 properties 22 required
ConsoleServerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties 16 required
PatchedWritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
NestedDevice
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 4 required
DeviceBayTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties 2 required
PaginatedPowerFeedList
object
4 properties 2 required
Region
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
PatchedWritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
WritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 2 required
BriefPowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 7 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PaginatedFrontPortTemplateList
object
4 properties 2 required
WritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritableRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
PaginatedModuleBayList
object
4 properties 2 required
BriefRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
PatchedWritableInterfaceTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
12 properties
PatchedWritablePowerOutletTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties
PaginatedFrontPortList
object
4 properties 2 required
ConsoleServerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties 1 required
ModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
PaginatedDeviceBayList
object
4 properties 2 required
BriefRegion
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
WritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties 3 required
NestedInterfaceTemplateRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
PaginatedInterfaceTemplateList
object
4 properties 2 required
WritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
NestedPlatformRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
Device
object
Base serializer class for models inheriting from PrimaryModel.
48 properties 21 required
BriefVirtualChassis
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 5 required
BriefPowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties 2 required
WritablePowerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
8 properties 1 required
PatchedWritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
DeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 2 required
BriefModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
DeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties 3 required
PatchedWritableConsolePortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties
BriefWirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
InventoryItemTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
17 properties 9 required
PowerOutletTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 1 required
NestedDeviceRole
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
NestedPlatform
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
BriefUser
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties 4 required
WritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties 2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
VirtualChassis
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
BriefConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties 1 required
NestedDeviceRoleRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
ConsoleServerPortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
11 properties 6 required
PowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties 2 required
PatchedWritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
WritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
WritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties 3 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
PaginatedRearPortTemplateList
object
4 properties 2 required
PowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties 2 required
BriefUserRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
1 property 1 required
PaginatedVirtualChassisList
object
4 properties 2 required
BriefPlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
FrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 3 required
RearPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 2 required
FrontPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties 14 required
SiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 2 required
RackRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
PatchedMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 2 required
SiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties 11 required
PaginatedRearPortList
object
4 properties 2 required
BriefMACAddress
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PaginatedVirtualDeviceContextList
object
4 properties 2 required
PaginatedRackUnitList
object
4 properties 2 required
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties 4 required
RackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties 2 required
FrontPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 2 required
DeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
20 properties 11 required
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
PatchedWritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
PatchedRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
DeviceBayTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 7 required
WritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties 2 required
DeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 3 required
InventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
ModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
DeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties 2 required
InventoryItem
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties 10 required
BriefModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 2 required
WritableRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
PowerOutletTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
14 properties 6 required
PaginatedSiteList
object
4 properties 2 required
ModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
BriefRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 3 required
NestedDeviceRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property
PaginatedRackReservationList
object
4 properties 2 required
WritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 3 required
InventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties 2 required
NestedSiteGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 7 required
RearPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties 14 required
VirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
PaginatedRegionList
object
4 properties 2 required
PatchedModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
PowerFeed
object
Base serializer class for models inheriting from PrimaryModel.
31 properties 16 required
FrontPortMapping
object
3 properties 2 required
ConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties 2 required
RackUnit
object
A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database.
6 properties 6 required
RackReservation
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 10 required
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PowerPortTemplate
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
13 properties 6 required
PaginatedModuleList
object
4 properties 2 required
WritableConsoleServerPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
6 properties 1 required
WritableRearPortTemplateRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
9 properties 2 required
PatchedWritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
WritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 3 required
PatchedPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PaginatedPowerPanelList
object
4 properties 2 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
Location
object
Base serializer class for models inheriting from NestedGroupModel.
22 properties 13 required
FrontPortTemplateMapping
object
3 properties 2 required
PaginatedDeviceBayTemplateList
object
4 properties 2 required
BriefLocation
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
WritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties 3 required
PaginatedPowerOutletTemplateList
object
4 properties 2 required
PaginatedInterfaceList
object
4 properties 2 required
BriefDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 5 required
GenericObject
object
Minimal representation of some generic object identified by ContentType and PK.
3 properties 3 required
PatchedWritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
Module
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
PaginatedModuleTypeList
object
4 properties 2 required
PaginatedRackList
object
4 properties 2 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
PowerOutlet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
28 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-dcim-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
AE Profile APIs.io
NetBox authentication-check API
AE Profile APIs.io
NetBox circuits API
AE Profile APIs.io
NetBox core API
AE Profile APIs.io
NetBox extras API
AE Profile APIs.io
NetBox ipam API
AE Profile APIs.io
NetBox schema API
AE Profile APIs.io
NetBox status API
AE Profile APIs.io
NetBox tenancy API
AE Profile APIs.io
NetBox users API
AE Profile APIs.io
NetBox virtualization API
AE Profile APIs.io
NetBox vpn API
AE Profile APIs.io
#dcim
← Back to N APIs
API Details
ID
netbox:netbox-dcim-api
Base URL
https://demo.netbox.dev/api
Docs
https://docs.netbox.dev/en/stable/
Provider
NetBox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network