NetBox Dcim API
The dcim API from NetBox — 99 operation(s) for dcim.
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.2.0, 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.
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/
Dcim cable terminations list
GET
/api/dcim/cable-terminations/{id}/
Dcim cable terminations retrieve
GET
/api/dcim/cables/
Dcim cables list
POST
/api/dcim/cables/
Dcim cables create
PUT
/api/dcim/cables/
Dcim cables bulk update
PATCH
/api/dcim/cables/
Dcim cables bulk partial update
DELETE
/api/dcim/cables/
Dcim cables bulk destroy
GET
/api/dcim/cables/{id}/
Dcim cables retrieve
PUT
/api/dcim/cables/{id}/
Dcim cables update
PATCH
/api/dcim/cables/{id}/
Dcim cables partial update
DELETE
/api/dcim/cables/{id}/
Dcim cables destroy
GET
/api/dcim/connected-device/
Dcim connected device list
GET
/api/dcim/console-port-templates/
Dcim console port templates list
POST
/api/dcim/console-port-templates/
Dcim console port templates create
PUT
/api/dcim/console-port-templates/
Dcim console port templates bulk update
PATCH
/api/dcim/console-port-templates/
Dcim console port templates bulk partial update
DELETE
/api/dcim/console-port-templates/
Dcim console port templates bulk destroy
GET
/api/dcim/console-port-templates/{id}/
Dcim console port templates retrieve
PUT
/api/dcim/console-port-templates/{id}/
Dcim console port templates update
PATCH
/api/dcim/console-port-templates/{id}/
Dcim console port templates partial update
DELETE
/api/dcim/console-port-templates/{id}/
Dcim console port templates destroy
GET
/api/dcim/console-ports/
Dcim console ports list
POST
/api/dcim/console-ports/
Dcim console ports create
PUT
/api/dcim/console-ports/
Dcim console ports bulk update
PATCH
/api/dcim/console-ports/
Dcim console ports bulk partial update
DELETE
/api/dcim/console-ports/
Dcim console ports bulk destroy
GET
/api/dcim/console-ports/{id}/
Dcim console ports retrieve
PUT
/api/dcim/console-ports/{id}/
Dcim console ports update
PATCH
/api/dcim/console-ports/{id}/
Dcim console ports partial update
DELETE
/api/dcim/console-ports/{id}/
Dcim console ports destroy
GET
/api/dcim/console-ports/{id}/trace/
Dcim console ports trace retrieve
GET
/api/dcim/console-server-port-templates/
Dcim console server port templates list
POST
/api/dcim/console-server-port-templates/
Dcim console server port templates create
PUT
/api/dcim/console-server-port-templates/
Dcim console server port templates bulk update
PATCH
/api/dcim/console-server-port-templates/
Dcim console server port templates bulk partial update
DELETE
/api/dcim/console-server-port-templates/
Dcim console server port templates bulk destroy
GET
/api/dcim/console-server-port-templates/{id}/
Dcim console server port templates retrieve
PUT
/api/dcim/console-server-port-templates/{id}/
Dcim console server port templates update
PATCH
/api/dcim/console-server-port-templates/{id}/
Dcim console server port templates partial update
DELETE
/api/dcim/console-server-port-templates/{id}/
Dcim console server port templates destroy
GET
/api/dcim/console-server-ports/
Dcim console server ports list
POST
/api/dcim/console-server-ports/
Dcim console server ports create
PUT
/api/dcim/console-server-ports/
Dcim console server ports bulk update
PATCH
/api/dcim/console-server-ports/
Dcim console server ports bulk partial update
DELETE
/api/dcim/console-server-ports/
Dcim console server ports bulk destroy
GET
/api/dcim/console-server-ports/{id}/
Dcim console server ports retrieve
PUT
/api/dcim/console-server-ports/{id}/
Dcim console server ports update
PATCH
/api/dcim/console-server-ports/{id}/
Dcim console server ports partial update
DELETE
/api/dcim/console-server-ports/{id}/
Dcim console server ports destroy
GET
/api/dcim/console-server-ports/{id}/trace/
Dcim console server ports trace retrieve
GET
/api/dcim/device-bay-templates/
Dcim device bay templates list
POST
/api/dcim/device-bay-templates/
Dcim device bay templates create
PUT
/api/dcim/device-bay-templates/
Dcim device bay templates bulk update
PATCH
/api/dcim/device-bay-templates/
Dcim device bay templates bulk partial update
DELETE
/api/dcim/device-bay-templates/
Dcim device bay templates bulk destroy
GET
/api/dcim/device-bay-templates/{id}/
Dcim device bay templates retrieve
PUT
/api/dcim/device-bay-templates/{id}/
Dcim device bay templates update
PATCH
/api/dcim/device-bay-templates/{id}/
Dcim device bay templates partial update
DELETE
/api/dcim/device-bay-templates/{id}/
Dcim device bay templates destroy
GET
/api/dcim/device-bays/
Dcim device bays list
POST
/api/dcim/device-bays/
Dcim device bays create
PUT
/api/dcim/device-bays/
Dcim device bays bulk update
PATCH
/api/dcim/device-bays/
Dcim device bays bulk partial update
DELETE
/api/dcim/device-bays/
Dcim device bays bulk destroy
GET
/api/dcim/device-bays/{id}/
Dcim device bays retrieve
PUT
/api/dcim/device-bays/{id}/
Dcim device bays update
PATCH
/api/dcim/device-bays/{id}/
Dcim device bays partial update
DELETE
/api/dcim/device-bays/{id}/
Dcim device bays destroy
GET
/api/dcim/device-roles/
Dcim device roles list
POST
/api/dcim/device-roles/
Dcim device roles create
PUT
/api/dcim/device-roles/
Dcim device roles bulk update
PATCH
/api/dcim/device-roles/
Dcim device roles bulk partial update
DELETE
/api/dcim/device-roles/
Dcim device roles bulk destroy
GET
/api/dcim/device-roles/{id}/
Dcim device roles retrieve
PUT
/api/dcim/device-roles/{id}/
Dcim device roles update
PATCH
/api/dcim/device-roles/{id}/
Dcim device roles partial update
DELETE
/api/dcim/device-roles/{id}/
Dcim device roles destroy
GET
/api/dcim/device-types/
Dcim device types list
POST
/api/dcim/device-types/
Dcim device types create
PUT
/api/dcim/device-types/
Dcim device types bulk update
PATCH
/api/dcim/device-types/
Dcim device types bulk partial update
DELETE
/api/dcim/device-types/
Dcim device types bulk destroy
GET
/api/dcim/device-types/{id}/
Dcim device types retrieve
PUT
/api/dcim/device-types/{id}/
Dcim device types update
PATCH
/api/dcim/device-types/{id}/
Dcim device types partial update
DELETE
/api/dcim/device-types/{id}/
Dcim device types destroy
GET
/api/dcim/devices/
Dcim devices list
POST
/api/dcim/devices/
Dcim devices create
PUT
/api/dcim/devices/
Dcim devices bulk update
PATCH
/api/dcim/devices/
Dcim devices bulk partial update
DELETE
/api/dcim/devices/
Dcim devices bulk destroy
GET
/api/dcim/devices/{id}/
Dcim devices retrieve
PUT
/api/dcim/devices/{id}/
Dcim devices update
PATCH
/api/dcim/devices/{id}/
Dcim devices partial update
DELETE
/api/dcim/devices/{id}/
Dcim devices destroy
POST
/api/dcim/devices/{id}/render-config/
Dcim devices render config create
GET
/api/dcim/front-port-templates/
Dcim front port templates list
POST
/api/dcim/front-port-templates/
Dcim front port templates create
PUT
/api/dcim/front-port-templates/
Dcim front port templates bulk update
PATCH
/api/dcim/front-port-templates/
Dcim front port templates bulk partial update
DELETE
/api/dcim/front-port-templates/
Dcim front port templates bulk destroy
GET
/api/dcim/front-port-templates/{id}/
Dcim front port templates retrieve
PUT
/api/dcim/front-port-templates/{id}/
Dcim front port templates update
PATCH
/api/dcim/front-port-templates/{id}/
Dcim front port templates partial update
DELETE
/api/dcim/front-port-templates/{id}/
Dcim front port templates destroy
GET
/api/dcim/front-ports/
Dcim front ports list
POST
/api/dcim/front-ports/
Dcim front ports create
PUT
/api/dcim/front-ports/
Dcim front ports bulk update
PATCH
/api/dcim/front-ports/
Dcim front ports bulk partial update
DELETE
/api/dcim/front-ports/
Dcim front ports bulk destroy
GET
/api/dcim/front-ports/{id}/
Dcim front ports retrieve
PUT
/api/dcim/front-ports/{id}/
Dcim front ports update
PATCH
/api/dcim/front-ports/{id}/
Dcim front ports partial update
DELETE
/api/dcim/front-ports/{id}/
Dcim front ports destroy
GET
/api/dcim/front-ports/{id}/paths/
Dcim front ports paths retrieve
GET
/api/dcim/interface-templates/
Dcim interface templates list
POST
/api/dcim/interface-templates/
Dcim interface templates create
PUT
/api/dcim/interface-templates/
Dcim interface templates bulk update
PATCH
/api/dcim/interface-templates/
Dcim interface templates bulk partial update
DELETE
/api/dcim/interface-templates/
Dcim interface templates bulk destroy
GET
/api/dcim/interface-templates/{id}/
Dcim interface templates retrieve
PUT
/api/dcim/interface-templates/{id}/
Dcim interface templates update
PATCH
/api/dcim/interface-templates/{id}/
Dcim interface templates partial update
DELETE
/api/dcim/interface-templates/{id}/
Dcim interface templates destroy
GET
/api/dcim/interfaces/
Dcim interfaces list
POST
/api/dcim/interfaces/
Dcim interfaces create
PUT
/api/dcim/interfaces/
Dcim interfaces bulk update
PATCH
/api/dcim/interfaces/
Dcim interfaces bulk partial update
DELETE
/api/dcim/interfaces/
Dcim interfaces bulk destroy
GET
/api/dcim/interfaces/{id}/
Dcim interfaces retrieve
PUT
/api/dcim/interfaces/{id}/
Dcim interfaces update
PATCH
/api/dcim/interfaces/{id}/
Dcim interfaces partial update
DELETE
/api/dcim/interfaces/{id}/
Dcim interfaces destroy
GET
/api/dcim/interfaces/{id}/trace/
Dcim interfaces trace retrieve
GET
/api/dcim/inventory-item-roles/
Dcim inventory item roles list
POST
/api/dcim/inventory-item-roles/
Dcim inventory item roles create
PUT
/api/dcim/inventory-item-roles/
Dcim inventory item roles bulk update
PATCH
/api/dcim/inventory-item-roles/
Dcim inventory item roles bulk partial update
DELETE
/api/dcim/inventory-item-roles/
Dcim inventory item roles bulk destroy
GET
/api/dcim/inventory-item-roles/{id}/
Dcim inventory item roles retrieve
PUT
/api/dcim/inventory-item-roles/{id}/
Dcim inventory item roles update
PATCH
/api/dcim/inventory-item-roles/{id}/
Dcim inventory item roles partial update
DELETE
/api/dcim/inventory-item-roles/{id}/
Dcim inventory item roles destroy
GET
/api/dcim/inventory-item-templates/
Dcim inventory item templates list
POST
/api/dcim/inventory-item-templates/
Dcim inventory item templates create
PUT
/api/dcim/inventory-item-templates/
Dcim inventory item templates bulk update
PATCH
/api/dcim/inventory-item-templates/
Dcim inventory item templates bulk partial update
DELETE
/api/dcim/inventory-item-templates/
Dcim inventory item templates bulk destroy
GET
/api/dcim/inventory-item-templates/{id}/
Dcim inventory item templates retrieve
PUT
/api/dcim/inventory-item-templates/{id}/
Dcim inventory item templates update
PATCH
/api/dcim/inventory-item-templates/{id}/
Dcim inventory item templates partial update
DELETE
/api/dcim/inventory-item-templates/{id}/
Dcim inventory item templates destroy
GET
/api/dcim/inventory-items/
Dcim inventory items list
POST
/api/dcim/inventory-items/
Dcim inventory items create
PUT
/api/dcim/inventory-items/
Dcim inventory items bulk update
PATCH
/api/dcim/inventory-items/
Dcim inventory items bulk partial update
DELETE
/api/dcim/inventory-items/
Dcim inventory items bulk destroy
GET
/api/dcim/inventory-items/{id}/
Dcim inventory items retrieve
PUT
/api/dcim/inventory-items/{id}/
Dcim inventory items update
PATCH
/api/dcim/inventory-items/{id}/
Dcim inventory items partial update
DELETE
/api/dcim/inventory-items/{id}/
Dcim inventory items destroy
GET
/api/dcim/locations/
Dcim locations list
POST
/api/dcim/locations/
Dcim locations create
PUT
/api/dcim/locations/
Dcim locations bulk update
PATCH
/api/dcim/locations/
Dcim locations bulk partial update
DELETE
/api/dcim/locations/
Dcim locations bulk destroy
GET
/api/dcim/locations/{id}/
Dcim locations retrieve
PUT
/api/dcim/locations/{id}/
Dcim locations update
PATCH
/api/dcim/locations/{id}/
Dcim locations partial update
DELETE
/api/dcim/locations/{id}/
Dcim locations destroy
GET
/api/dcim/mac-addresses/
Dcim mac addresses list
POST
/api/dcim/mac-addresses/
Dcim mac addresses create
PUT
/api/dcim/mac-addresses/
Dcim mac addresses bulk update
PATCH
/api/dcim/mac-addresses/
Dcim mac addresses bulk partial update
DELETE
/api/dcim/mac-addresses/
Dcim mac addresses bulk destroy
GET
/api/dcim/mac-addresses/{id}/
Dcim mac addresses retrieve
PUT
/api/dcim/mac-addresses/{id}/
Dcim mac addresses update
PATCH
/api/dcim/mac-addresses/{id}/
Dcim mac addresses partial update
DELETE
/api/dcim/mac-addresses/{id}/
Dcim mac addresses destroy
GET
/api/dcim/manufacturers/
Dcim manufacturers list
POST
/api/dcim/manufacturers/
Dcim manufacturers create
PUT
/api/dcim/manufacturers/
Dcim manufacturers bulk update
PATCH
/api/dcim/manufacturers/
Dcim manufacturers bulk partial update
DELETE
/api/dcim/manufacturers/
Dcim manufacturers bulk destroy
GET
/api/dcim/manufacturers/{id}/
Dcim manufacturers retrieve
PUT
/api/dcim/manufacturers/{id}/
Dcim manufacturers update
PATCH
/api/dcim/manufacturers/{id}/
Dcim manufacturers partial update
DELETE
/api/dcim/manufacturers/{id}/
Dcim manufacturers destroy
GET
/api/dcim/module-bay-templates/
Dcim module bay templates list
POST
/api/dcim/module-bay-templates/
Dcim module bay templates create
PUT
/api/dcim/module-bay-templates/
Dcim module bay templates bulk update
PATCH
/api/dcim/module-bay-templates/
Dcim module bay templates bulk partial update
DELETE
/api/dcim/module-bay-templates/
Dcim module bay templates bulk destroy
GET
/api/dcim/module-bay-templates/{id}/
Dcim module bay templates retrieve
PUT
/api/dcim/module-bay-templates/{id}/
Dcim module bay templates update
PATCH
/api/dcim/module-bay-templates/{id}/
Dcim module bay templates partial update
DELETE
/api/dcim/module-bay-templates/{id}/
Dcim module bay templates destroy
GET
/api/dcim/module-bays/
Dcim module bays list
POST
/api/dcim/module-bays/
Dcim module bays create
PUT
/api/dcim/module-bays/
Dcim module bays bulk update
PATCH
/api/dcim/module-bays/
Dcim module bays bulk partial update
DELETE
/api/dcim/module-bays/
Dcim module bays bulk destroy
GET
/api/dcim/module-bays/{id}/
Dcim module bays retrieve
PUT
/api/dcim/module-bays/{id}/
Dcim module bays update
PATCH
/api/dcim/module-bays/{id}/
Dcim module bays partial update
DELETE
/api/dcim/module-bays/{id}/
Dcim module bays destroy
GET
/api/dcim/module-type-profiles/
Dcim module type profiles list
POST
/api/dcim/module-type-profiles/
Dcim module type profiles create
PUT
/api/dcim/module-type-profiles/
Dcim module type profiles bulk update
PATCH
/api/dcim/module-type-profiles/
Dcim module type profiles bulk partial update
DELETE
/api/dcim/module-type-profiles/
Dcim module type profiles bulk destroy
GET
/api/dcim/module-type-profiles/{id}/
Dcim module type profiles retrieve
PUT
/api/dcim/module-type-profiles/{id}/
Dcim module type profiles update
PATCH
/api/dcim/module-type-profiles/{id}/
Dcim module type profiles partial update
DELETE
/api/dcim/module-type-profiles/{id}/
Dcim module type profiles destroy
GET
/api/dcim/module-types/
Dcim module types list
POST
/api/dcim/module-types/
Dcim module types create
PUT
/api/dcim/module-types/
Dcim module types bulk update
PATCH
/api/dcim/module-types/
Dcim module types bulk partial update
DELETE
/api/dcim/module-types/
Dcim module types bulk destroy
GET
/api/dcim/module-types/{id}/
Dcim module types retrieve
PUT
/api/dcim/module-types/{id}/
Dcim module types update
PATCH
/api/dcim/module-types/{id}/
Dcim module types partial update
DELETE
/api/dcim/module-types/{id}/
Dcim module types destroy
GET
/api/dcim/modules/
Dcim modules list
POST
/api/dcim/modules/
Dcim modules create
PUT
/api/dcim/modules/
Dcim modules bulk update
PATCH
/api/dcim/modules/
Dcim modules bulk partial update
DELETE
/api/dcim/modules/
Dcim modules bulk destroy
GET
/api/dcim/modules/{id}/
Dcim modules retrieve
PUT
/api/dcim/modules/{id}/
Dcim modules update
PATCH
/api/dcim/modules/{id}/
Dcim modules partial update
DELETE
/api/dcim/modules/{id}/
Dcim modules destroy
GET
/api/dcim/platforms/
Dcim platforms list
POST
/api/dcim/platforms/
Dcim platforms create
PUT
/api/dcim/platforms/
Dcim platforms bulk update
PATCH
/api/dcim/platforms/
Dcim platforms bulk partial update
DELETE
/api/dcim/platforms/
Dcim platforms bulk destroy
GET
/api/dcim/platforms/{id}/
Dcim platforms retrieve
PUT
/api/dcim/platforms/{id}/
Dcim platforms update
PATCH
/api/dcim/platforms/{id}/
Dcim platforms partial update
DELETE
/api/dcim/platforms/{id}/
Dcim platforms destroy
GET
/api/dcim/power-feeds/
Dcim power feeds list
POST
/api/dcim/power-feeds/
Dcim power feeds create
PUT
/api/dcim/power-feeds/
Dcim power feeds bulk update
PATCH
/api/dcim/power-feeds/
Dcim power feeds bulk partial update
DELETE
/api/dcim/power-feeds/
Dcim power feeds bulk destroy
GET
/api/dcim/power-feeds/{id}/
Dcim power feeds retrieve
PUT
/api/dcim/power-feeds/{id}/
Dcim power feeds update
PATCH
/api/dcim/power-feeds/{id}/
Dcim power feeds partial update
DELETE
/api/dcim/power-feeds/{id}/
Dcim power feeds destroy
GET
/api/dcim/power-feeds/{id}/trace/
Dcim power feeds trace retrieve
GET
/api/dcim/power-outlet-templates/
Dcim power outlet templates list
POST
/api/dcim/power-outlet-templates/
Dcim power outlet templates create
PUT
/api/dcim/power-outlet-templates/
Dcim power outlet templates bulk update
PATCH
/api/dcim/power-outlet-templates/
Dcim power outlet templates bulk partial update
DELETE
/api/dcim/power-outlet-templates/
Dcim power outlet templates bulk destroy
GET
/api/dcim/power-outlet-templates/{id}/
Dcim power outlet templates retrieve
PUT
/api/dcim/power-outlet-templates/{id}/
Dcim power outlet templates update
PATCH
/api/dcim/power-outlet-templates/{id}/
Dcim power outlet templates partial update
DELETE
/api/dcim/power-outlet-templates/{id}/
Dcim power outlet templates destroy
GET
/api/dcim/power-outlets/
Dcim power outlets list
POST
/api/dcim/power-outlets/
Dcim power outlets create
PUT
/api/dcim/power-outlets/
Dcim power outlets bulk update
PATCH
/api/dcim/power-outlets/
Dcim power outlets bulk partial update
DELETE
/api/dcim/power-outlets/
Dcim power outlets bulk destroy
GET
/api/dcim/power-outlets/{id}/
Dcim power outlets retrieve
PUT
/api/dcim/power-outlets/{id}/
Dcim power outlets update
PATCH
/api/dcim/power-outlets/{id}/
Dcim power outlets partial update
DELETE
/api/dcim/power-outlets/{id}/
Dcim power outlets destroy
GET
/api/dcim/power-outlets/{id}/trace/
Dcim power outlets trace retrieve
GET
/api/dcim/power-panels/
Dcim power panels list
POST
/api/dcim/power-panels/
Dcim power panels create
PUT
/api/dcim/power-panels/
Dcim power panels bulk update
PATCH
/api/dcim/power-panels/
Dcim power panels bulk partial update
DELETE
/api/dcim/power-panels/
Dcim power panels bulk destroy
GET
/api/dcim/power-panels/{id}/
Dcim power panels retrieve
PUT
/api/dcim/power-panels/{id}/
Dcim power panels update
PATCH
/api/dcim/power-panels/{id}/
Dcim power panels partial update
DELETE
/api/dcim/power-panels/{id}/
Dcim power panels destroy
GET
/api/dcim/power-port-templates/
Dcim power port templates list
POST
/api/dcim/power-port-templates/
Dcim power port templates create
PUT
/api/dcim/power-port-templates/
Dcim power port templates bulk update
PATCH
/api/dcim/power-port-templates/
Dcim power port templates bulk partial update
DELETE
/api/dcim/power-port-templates/
Dcim power port templates bulk destroy
GET
/api/dcim/power-port-templates/{id}/
Dcim power port templates retrieve
PUT
/api/dcim/power-port-templates/{id}/
Dcim power port templates update
PATCH
/api/dcim/power-port-templates/{id}/
Dcim power port templates partial update
DELETE
/api/dcim/power-port-templates/{id}/
Dcim power port templates destroy
GET
/api/dcim/power-ports/
Dcim power ports list
POST
/api/dcim/power-ports/
Dcim power ports create
PUT
/api/dcim/power-ports/
Dcim power ports bulk update
PATCH
/api/dcim/power-ports/
Dcim power ports bulk partial update
DELETE
/api/dcim/power-ports/
Dcim power ports bulk destroy
GET
/api/dcim/power-ports/{id}/
Dcim power ports retrieve
PUT
/api/dcim/power-ports/{id}/
Dcim power ports update
PATCH
/api/dcim/power-ports/{id}/
Dcim power ports partial update
DELETE
/api/dcim/power-ports/{id}/
Dcim power ports destroy
GET
/api/dcim/power-ports/{id}/trace/
Dcim power ports trace retrieve
GET
/api/dcim/rack-reservations/
Dcim rack reservations list
POST
/api/dcim/rack-reservations/
Dcim rack reservations create
PUT
/api/dcim/rack-reservations/
Dcim rack reservations bulk update
PATCH
/api/dcim/rack-reservations/
Dcim rack reservations bulk partial update
DELETE
/api/dcim/rack-reservations/
Dcim rack reservations bulk destroy
GET
/api/dcim/rack-reservations/{id}/
Dcim rack reservations retrieve
PUT
/api/dcim/rack-reservations/{id}/
Dcim rack reservations update
PATCH
/api/dcim/rack-reservations/{id}/
Dcim rack reservations partial update
DELETE
/api/dcim/rack-reservations/{id}/
Dcim rack reservations destroy
GET
/api/dcim/rack-roles/
Dcim rack roles list
POST
/api/dcim/rack-roles/
Dcim rack roles create
PUT
/api/dcim/rack-roles/
Dcim rack roles bulk update
PATCH
/api/dcim/rack-roles/
Dcim rack roles bulk partial update
DELETE
/api/dcim/rack-roles/
Dcim rack roles bulk destroy
GET
/api/dcim/rack-roles/{id}/
Dcim rack roles retrieve
PUT
/api/dcim/rack-roles/{id}/
Dcim rack roles update
PATCH
/api/dcim/rack-roles/{id}/
Dcim rack roles partial update
DELETE
/api/dcim/rack-roles/{id}/
Dcim rack roles destroy
GET
/api/dcim/rack-types/
Dcim rack types list
POST
/api/dcim/rack-types/
Dcim rack types create
PUT
/api/dcim/rack-types/
Dcim rack types bulk update
PATCH
/api/dcim/rack-types/
Dcim rack types bulk partial update
DELETE
/api/dcim/rack-types/
Dcim rack types bulk destroy
GET
/api/dcim/rack-types/{id}/
Dcim rack types retrieve
PUT
/api/dcim/rack-types/{id}/
Dcim rack types update
PATCH
/api/dcim/rack-types/{id}/
Dcim rack types partial update
DELETE
/api/dcim/rack-types/{id}/
Dcim rack types destroy
GET
/api/dcim/racks/
Dcim racks list
POST
/api/dcim/racks/
Dcim racks create
PUT
/api/dcim/racks/
Dcim racks bulk update
PATCH
/api/dcim/racks/
Dcim racks bulk partial update
DELETE
/api/dcim/racks/
Dcim racks bulk destroy
GET
/api/dcim/racks/{id}/
Dcim racks retrieve
PUT
/api/dcim/racks/{id}/
Dcim racks update
PATCH
/api/dcim/racks/{id}/
Dcim racks partial update
DELETE
/api/dcim/racks/{id}/
Dcim racks destroy
GET
/api/dcim/racks/{id}/elevation/
Dcim racks elevation retrieve
GET
/api/dcim/rear-port-templates/
Dcim rear port templates list
POST
/api/dcim/rear-port-templates/
Dcim rear port templates create
PUT
/api/dcim/rear-port-templates/
Dcim rear port templates bulk update
PATCH
/api/dcim/rear-port-templates/
Dcim rear port templates bulk partial update
DELETE
/api/dcim/rear-port-templates/
Dcim rear port templates bulk destroy
GET
/api/dcim/rear-port-templates/{id}/
Dcim rear port templates retrieve
PUT
/api/dcim/rear-port-templates/{id}/
Dcim rear port templates update
PATCH
/api/dcim/rear-port-templates/{id}/
Dcim rear port templates partial update
DELETE
/api/dcim/rear-port-templates/{id}/
Dcim rear port templates destroy
GET
/api/dcim/rear-ports/
Dcim rear ports list
POST
/api/dcim/rear-ports/
Dcim rear ports create
PUT
/api/dcim/rear-ports/
Dcim rear ports bulk update
PATCH
/api/dcim/rear-ports/
Dcim rear ports bulk partial update
DELETE
/api/dcim/rear-ports/
Dcim rear ports bulk destroy
GET
/api/dcim/rear-ports/{id}/
Dcim rear ports retrieve
PUT
/api/dcim/rear-ports/{id}/
Dcim rear ports update
PATCH
/api/dcim/rear-ports/{id}/
Dcim rear ports partial update
DELETE
/api/dcim/rear-ports/{id}/
Dcim rear ports destroy
GET
/api/dcim/rear-ports/{id}/paths/
Dcim rear ports paths retrieve
GET
/api/dcim/regions/
Dcim regions list
POST
/api/dcim/regions/
Dcim regions create
PUT
/api/dcim/regions/
Dcim regions bulk update
PATCH
/api/dcim/regions/
Dcim regions bulk partial update
DELETE
/api/dcim/regions/
Dcim regions bulk destroy
GET
/api/dcim/regions/{id}/
Dcim regions retrieve
PUT
/api/dcim/regions/{id}/
Dcim regions update
PATCH
/api/dcim/regions/{id}/
Dcim regions partial update
DELETE
/api/dcim/regions/{id}/
Dcim regions destroy
GET
/api/dcim/site-groups/
Dcim site groups list
POST
/api/dcim/site-groups/
Dcim site groups create
PUT
/api/dcim/site-groups/
Dcim site groups bulk update
PATCH
/api/dcim/site-groups/
Dcim site groups bulk partial update
DELETE
/api/dcim/site-groups/
Dcim site groups bulk destroy
GET
/api/dcim/site-groups/{id}/
Dcim site groups retrieve
PUT
/api/dcim/site-groups/{id}/
Dcim site groups update
PATCH
/api/dcim/site-groups/{id}/
Dcim site groups partial update
DELETE
/api/dcim/site-groups/{id}/
Dcim site groups destroy
GET
/api/dcim/sites/
Dcim sites list
POST
/api/dcim/sites/
Dcim sites create
PUT
/api/dcim/sites/
Dcim sites bulk update
PATCH
/api/dcim/sites/
Dcim sites bulk partial update
DELETE
/api/dcim/sites/
Dcim sites bulk destroy
GET
/api/dcim/sites/{id}/
Dcim sites retrieve
PUT
/api/dcim/sites/{id}/
Dcim sites update
PATCH
/api/dcim/sites/{id}/
Dcim sites partial update
DELETE
/api/dcim/sites/{id}/
Dcim sites destroy
GET
/api/dcim/virtual-chassis/
Dcim virtual chassis list
POST
/api/dcim/virtual-chassis/
Dcim virtual chassis create
PUT
/api/dcim/virtual-chassis/
Dcim virtual chassis bulk update
PATCH
/api/dcim/virtual-chassis/
Dcim virtual chassis bulk partial update
DELETE
/api/dcim/virtual-chassis/
Dcim virtual chassis bulk destroy
GET
/api/dcim/virtual-chassis/{id}/
Dcim virtual chassis retrieve
PUT
/api/dcim/virtual-chassis/{id}/
Dcim virtual chassis update
PATCH
/api/dcim/virtual-chassis/{id}/
Dcim virtual chassis partial update
DELETE
/api/dcim/virtual-chassis/{id}/
Dcim virtual chassis destroy
GET
/api/dcim/virtual-device-contexts/
Dcim virtual device contexts list
POST
/api/dcim/virtual-device-contexts/
Dcim virtual device contexts create
PUT
/api/dcim/virtual-device-contexts/
Dcim virtual device contexts bulk update
PATCH
/api/dcim/virtual-device-contexts/
Dcim virtual device contexts bulk partial update
DELETE
/api/dcim/virtual-device-contexts/
Dcim virtual device contexts bulk destroy
GET
/api/dcim/virtual-device-contexts/{id}/
Dcim virtual device contexts retrieve
PUT
/api/dcim/virtual-device-contexts/{id}/
Dcim virtual device contexts update
PATCH
/api/dcim/virtual-device-contexts/{id}/
Dcim virtual device contexts partial update
DELETE
/api/dcim/virtual-device-contexts/{id}/
Dcim virtual device contexts destroy
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.
PaginatedSiteGroupList
object
4 properties
2 required
WritableConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
2 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties
4 required
BriefRackRole
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 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
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
WritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
PaginatedRackReservationList
object
4 properties
2 required
CableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
BriefDeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 required
PaginatedRackList
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
GenericObject
object
Minimal representation of some generic object identified by ContentType and PK.
3 properties
3 required
PatchedWritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
PatchedWritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
ConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
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
ConsoleServerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
16 required
BriefInventoryItemRole
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
BriefModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
2 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
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
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
PatchedWritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
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
PatchedWritableRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
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
FrontPortMappingRequest
object
3 properties
2 required
WritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
2 required
WritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
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
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
WritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 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
BriefConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties
1 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
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
InterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
3 required
PowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
2 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
SiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties
11 required
DeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
3 required
RackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
RackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
3 required
PaginatedModuleTypeProfileList
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
SiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 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
PaginatedConsolePortTemplateList
object
4 properties
2 required
BriefIPAddressRequest
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
BriefVirtualChassis
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
5 required
BriefRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PatchedWritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
RackType
object
Base serializer class for models inheriting from PrimaryModel.
28 properties
10 required
CableTermination
object
Adds support for custom fields and tags.
12 properties
12 required
PatchedRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
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
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties
4 required
BriefDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
3 required
PowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
2 required
DeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
2 required
PaginatedDeviceWithConfigContextList
object
4 properties
2 required
PaginatedRackRoleList
object
4 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
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
PatchedWritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
Cable
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
6 required
PowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
2 required
BriefRackType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
7 required
PaginatedModuleTypeList
object
4 properties
2 required
PaginatedModuleList
object
4 properties
2 required
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
PatchedWritableConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
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
PaginatedConsoleServerPortList
object
4 properties
2 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
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
InventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
BriefVLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
PaginatedDeviceBayList
object
4 properties
2 required
SiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 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
Interface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
56 properties
24 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
PowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 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
BriefPowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
7 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
WritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 required
PlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties
2 required
WritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
3 required
BriefDeviceType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
7 required
PatchedModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
PaginatedMACAddressList
object
4 properties
2 required
PaginatedInterfaceTemplateList
object
4 properties
2 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
PaginatedVirtualChassisList
object
4 properties
2 required
RearPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties
14 required
DeviceBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
8 required
PaginatedPowerOutletTemplateList
object
4 properties
2 required
ModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
7 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
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
BriefPowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties
2 required
BriefManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 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
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PatchedWritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
DeviceWithConfigContext
object
Base serializer class for models inheriting from PrimaryModel.
49 properties
22 required
BriefLocation
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
PatchedWritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
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
PaginatedDeviceBayTemplateList
object
4 properties
2 required
Rack
object
Base serializer class for models inheriting from PrimaryModel.
37 properties
10 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
PaginatedPowerOutletList
object
4 properties
2 required
PaginatedPowerFeedList
object
4 properties
2 required
BriefModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
WritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
MACAddress
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
8 required
FrontPortTemplateMapping
object
3 properties
2 required
PaginatedCableList
object
4 properties
2 required
VirtualDeviceContext
object
Base serializer class for models inheriting from PrimaryModel.
20 properties
11 required
WritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PaginatedCableTerminationList
object
4 properties
2 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
BriefSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
DeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
20 properties
11 required
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
BriefClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PatchedDeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
BriefLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
RackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 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
PatchedWritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
RearPortMapping
object
3 properties
2 required
PaginatedRegionList
object
4 properties
2 required
WritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
2 required
ModuleBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties
8 required
WirelessLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
8 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
PatchedWritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
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
InventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 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
GenericObjectRequest
object
Minimal representation of some generic object identified by ContentType and PK.
2 properties
2 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
BriefRack
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
BriefPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
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
PatchedWritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
PaginatedDeviceTypeList
object
4 properties
2 required
FrontPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties
14 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
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
ModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
2 required
PatchedWritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
BriefDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
VirtualChassis
object
Base serializer class for models inheriting from PrimaryModel.
16 properties
9 required
Site
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
14 required
BriefRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
BriefModule
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
5 required
ManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 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
BriefRegion
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 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
PaginatedManufacturerList
object
4 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
PatchedPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PowerOutlet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
28 properties
16 required
PaginatedRearPortList
object
4 properties
2 required
BriefCluster
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
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
PaginatedPowerPanelList
object
4 properties
2 required
BriefModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
PaginatedModuleBayList
object
4 properties
2 required
Device
object
Base serializer class for models inheriting from PrimaryModel.
48 properties
21 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
PatchedInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
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
WritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
3 required
Platform
object
Base serializer class for models inheriting from NestedGroupModel.
19 properties
11 required
PaginatedRearPortTemplateList
object
4 properties
2 required
FrontPortMapping
object
3 properties
2 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
DeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
2 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
PaginatedSiteList
object
4 properties
2 required
FrontPortTemplateMappingRequest
object
3 properties
2 required
WritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
2 required
PaginatedPowerPortTemplateList
object
4 properties
2 required
InventoryItemRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
BriefInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
PatchedWritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
PaginatedConsoleServerPortTemplateList
object
4 properties
2 required
PatchedWritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
PatchedManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
BriefMACAddress
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
WritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
2 required
FrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
PaginatedDeviceRoleList
object
4 properties
2 required
BriefWirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
PatchedModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 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
WritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
3 required
PaginatedFrontPortList
object
4 properties
2 required
PatchedWritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
ModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
1 required
PatchedWritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
PaginatedConsolePortList
object
4 properties
2 required
DeviceType
object
Base serializer class for models inheriting from PrimaryModel.
36 properties
20 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
10 required
InventoryItem
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
10 required
BriefMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
RearPortTemplateMappingRequest
object
3 properties
2 required
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefSiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 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
PowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
9 required
MACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 required
PatchedWritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
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
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 required
BriefVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 required
RackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
4 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
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
PatchedWritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
ConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
2 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
7 required
PatchedWritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
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
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 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
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 required
PatchedMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
RearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
Module
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 required
LocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
3 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
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
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
5 required
WritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
3 required
ModuleType
object
Base serializer class for models inheriting from PrimaryModel.
20 properties
9 required
WritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
2 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
PaginatedModuleBayTemplateList
object
4 properties
2 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
PatchedWritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
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
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
PaginatedFrontPortTemplateList
object
4 properties
2 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
5 required
Manufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
17 properties
12 required
WritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
4 required
WritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
BriefManufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties
5 required
DeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
3 required
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
RearPortMappingRequest
object
3 properties
2 required
PowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
26 properties
16 required
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
PaginatedInterfaceList
object
4 properties
2 required
Location
object
Base serializer class for models inheriting from NestedGroupModel.
22 properties
13 required
WritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
4 required
WritableRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 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
PaginatedRackUnitList
object
4 properties
2 required
PaginatedRackTypeList
object
4 properties
2 required
BriefPlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
RackReservation
object
Base serializer class for models inheriting from PrimaryModel.
16 properties
10 required
PaginatedLocationList
object
4 properties
2 required
PatchedWritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
PowerFeed
object
Base serializer class for models inheriting from PrimaryModel.
31 properties
16 required
PatchedWritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
BriefPowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
WritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 required
PaginatedPowerPortList
object
4 properties
2 required
Region
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties
11 required
ModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
VirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
3 required
PaginatedPlatformList
object
4 properties
2 required
WritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
3 required
PaginatedInventoryItemTemplateList
object
4 properties
2 required
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
PaginatedInventoryItemList
object
4 properties
2 required
BriefVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 required
PaginatedVirtualDeviceContextList
object
4 properties
2 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
ConsolePort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
16 required
WritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
RearPortTemplateMapping
object
3 properties
2 required
PatchedWritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
BriefRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
3 required
ModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 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
BriefModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
2 required
WritablePlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 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
WritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
2 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
RackRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
VirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 required
BriefModuleType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.
NetBox GraphQL API
NetBox Authentication Check API
NetBox Circuits API
NetBox Core API
NetBox Extras API
NetBox Ipam API
NetBox Schema API
NetBox Status API
NetBox Tenancy API
NetBox Users API
NetBox Virtualization API
NetBox Vpn API
#DCIM
Where this information came from
This is an independent, third-party profile of NetBox Dcim API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.