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/
Get a list of cable termination objects.
GET
/api/dcim/cable-terminations/{id}/
Get a cable termination object.
GET
/api/dcim/cables/
Get a list of cable objects.
POST
/api/dcim/cables/
Post a list of cable objects.
PUT
/api/dcim/cables/
Put a list of cable objects.
PATCH
/api/dcim/cables/
Patch a list of cable objects.
DELETE
/api/dcim/cables/
Delete a list of cable objects.
GET
/api/dcim/cables/{id}/
Get a cable object.
PUT
/api/dcim/cables/{id}/
Put a cable object.
PATCH
/api/dcim/cables/{id}/
Patch a cable object.
DELETE
/api/dcim/cables/{id}/
Delete a cable object.
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…
GET
/api/dcim/console-port-templates/
Get a list of console port template objects.
POST
/api/dcim/console-port-templates/
Post a list of console port template objects.
PUT
/api/dcim/console-port-templates/
Put a list of console port template objects.
PATCH
/api/dcim/console-port-templates/
Patch a list of console port template objects.
DELETE
/api/dcim/console-port-templates/
Delete a list of console port template objects.
GET
/api/dcim/console-port-templates/{id}/
Get a console port template object.
PUT
/api/dcim/console-port-templates/{id}/
Put a console port template object.
PATCH
/api/dcim/console-port-templates/{id}/
Patch a console port template object.
DELETE
/api/dcim/console-port-templates/{id}/
Delete a console port template object.
GET
/api/dcim/console-ports/
Get a list of console port objects.
POST
/api/dcim/console-ports/
Post a list of console port objects.
PUT
/api/dcim/console-ports/
Put a list of console port objects.
PATCH
/api/dcim/console-ports/
Patch a list of console port objects.
DELETE
/api/dcim/console-ports/
Delete a list of console port objects.
GET
/api/dcim/console-ports/{id}/
Get a console port object.
PUT
/api/dcim/console-ports/{id}/
Put a console port object.
PATCH
/api/dcim/console-ports/{id}/
Patch a console port object.
DELETE
/api/dcim/console-ports/{id}/
Delete a console port object.
GET
/api/dcim/console-ports/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET
/api/dcim/console-server-port-templates/
Get a list of console server port template objects.
POST
/api/dcim/console-server-port-templates/
Post a list of console server port template objects.
PUT
/api/dcim/console-server-port-templates/
Put a list of console server port template objects.
PATCH
/api/dcim/console-server-port-templates/
Patch a list of console server port template objects.
DELETE
/api/dcim/console-server-port-templates/
Delete a list of console server port template objects.
GET
/api/dcim/console-server-port-templates/{id}/
Get a console server port template object.
PUT
/api/dcim/console-server-port-templates/{id}/
Put a console server port template object.
PATCH
/api/dcim/console-server-port-templates/{id}/
Patch a console server port template object.
DELETE
/api/dcim/console-server-port-templates/{id}/
Delete a console server port template object.
GET
/api/dcim/console-server-ports/
Get a list of console server port objects.
POST
/api/dcim/console-server-ports/
Post a list of console server port objects.
PUT
/api/dcim/console-server-ports/
Put a list of console server port objects.
PATCH
/api/dcim/console-server-ports/
Patch a list of console server port objects.
DELETE
/api/dcim/console-server-ports/
Delete a list of console server port objects.
GET
/api/dcim/console-server-ports/{id}/
Get a console server port object.
PUT
/api/dcim/console-server-ports/{id}/
Put a console server port object.
PATCH
/api/dcim/console-server-ports/{id}/
Patch a console server port object.
DELETE
/api/dcim/console-server-ports/{id}/
Delete a console server port object.
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).
GET
/api/dcim/device-bay-templates/
Get a list of device bay template objects.
POST
/api/dcim/device-bay-templates/
Post a list of device bay template objects.
PUT
/api/dcim/device-bay-templates/
Put a list of device bay template objects.
PATCH
/api/dcim/device-bay-templates/
Patch a list of device bay template objects.
DELETE
/api/dcim/device-bay-templates/
Delete a list of device bay template objects.
GET
/api/dcim/device-bay-templates/{id}/
Get a device bay template object.
PUT
/api/dcim/device-bay-templates/{id}/
Put a device bay template object.
PATCH
/api/dcim/device-bay-templates/{id}/
Patch a device bay template object.
DELETE
/api/dcim/device-bay-templates/{id}/
Delete a device bay template object.
GET
/api/dcim/device-bays/
Get a list of device bay objects.
POST
/api/dcim/device-bays/
Post a list of device bay objects.
PUT
/api/dcim/device-bays/
Put a list of device bay objects.
PATCH
/api/dcim/device-bays/
Patch a list of device bay objects.
DELETE
/api/dcim/device-bays/
Delete a list of device bay objects.
GET
/api/dcim/device-bays/{id}/
Get a device bay object.
PUT
/api/dcim/device-bays/{id}/
Put a device bay object.
PATCH
/api/dcim/device-bays/{id}/
Patch a device bay object.
DELETE
/api/dcim/device-bays/{id}/
Delete a device bay object.
GET
/api/dcim/device-roles/
Get a list of device role objects.
POST
/api/dcim/device-roles/
Post a list of device role objects.
PUT
/api/dcim/device-roles/
Put a list of device role objects.
PATCH
/api/dcim/device-roles/
Patch a list of device role objects.
DELETE
/api/dcim/device-roles/
Delete a list of device role objects.
GET
/api/dcim/device-roles/{id}/
Get a device role object.
PUT
/api/dcim/device-roles/{id}/
Put a device role object.
PATCH
/api/dcim/device-roles/{id}/
Patch a device role object.
DELETE
/api/dcim/device-roles/{id}/
Delete a device role object.
GET
/api/dcim/device-types/
Get a list of device type objects.
POST
/api/dcim/device-types/
Post a list of device type objects.
PUT
/api/dcim/device-types/
Put a list of device type objects.
PATCH
/api/dcim/device-types/
Patch a list of device type objects.
DELETE
/api/dcim/device-types/
Delete a list of device type objects.
GET
/api/dcim/device-types/{id}/
Get a device type object.
PUT
/api/dcim/device-types/{id}/
Put a device type object.
PATCH
/api/dcim/device-types/{id}/
Patch a device type object.
DELETE
/api/dcim/device-types/{id}/
Delete a device type object.
GET
/api/dcim/devices/
Get a list of device objects.
POST
/api/dcim/devices/
Post a list of device objects.
PUT
/api/dcim/devices/
Put a list of device objects.
PATCH
/api/dcim/devices/
Patch a list of device objects.
DELETE
/api/dcim/devices/
Delete a list of device objects.
GET
/api/dcim/devices/{id}/
Get a device object.
PUT
/api/dcim/devices/{id}/
Put a device object.
PATCH
/api/dcim/devices/{id}/
Patch a device object.
DELETE
/api/dcim/devices/{id}/
Delete a device object.
POST
/api/dcim/devices/{id}/render-config/
Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine.
GET
/api/dcim/front-port-templates/
Get a list of front port template objects.
POST
/api/dcim/front-port-templates/
Post a list of front port template objects.
PUT
/api/dcim/front-port-templates/
Put a list of front port template objects.
PATCH
/api/dcim/front-port-templates/
Patch a list of front port template objects.
DELETE
/api/dcim/front-port-templates/
Delete a list of front port template objects.
GET
/api/dcim/front-port-templates/{id}/
Get a front port template object.
PUT
/api/dcim/front-port-templates/{id}/
Put a front port template object.
PATCH
/api/dcim/front-port-templates/{id}/
Patch a front port template object.
DELETE
/api/dcim/front-port-templates/{id}/
Delete a front port template object.
GET
/api/dcim/front-ports/
Get a list of front port objects.
POST
/api/dcim/front-ports/
Post a list of front port objects.
PUT
/api/dcim/front-ports/
Put a list of front port objects.
PATCH
/api/dcim/front-ports/
Patch a list of front port objects.
DELETE
/api/dcim/front-ports/
Delete a list of front port objects.
GET
/api/dcim/front-ports/{id}/
Get a front port object.
PUT
/api/dcim/front-ports/{id}/
Put a front port object.
PATCH
/api/dcim/front-ports/{id}/
Patch a front port object.
DELETE
/api/dcim/front-ports/{id}/
Delete a front port object.
GET
/api/dcim/front-ports/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
GET
/api/dcim/interface-templates/
Get a list of interface template objects.
POST
/api/dcim/interface-templates/
Post a list of interface template objects.
PUT
/api/dcim/interface-templates/
Put a list of interface template objects.
PATCH
/api/dcim/interface-templates/
Patch a list of interface template objects.
DELETE
/api/dcim/interface-templates/
Delete a list of interface template objects.
GET
/api/dcim/interface-templates/{id}/
Get a interface template object.
PUT
/api/dcim/interface-templates/{id}/
Put a interface template object.
PATCH
/api/dcim/interface-templates/{id}/
Patch a interface template object.
DELETE
/api/dcim/interface-templates/{id}/
Delete a interface template object.
GET
/api/dcim/interfaces/
Get a list of interface objects.
POST
/api/dcim/interfaces/
Post a list of interface objects.
PUT
/api/dcim/interfaces/
Put a list of interface objects.
PATCH
/api/dcim/interfaces/
Patch a list of interface objects.
DELETE
/api/dcim/interfaces/
Delete a list of interface objects.
GET
/api/dcim/interfaces/{id}/
Get a interface object.
PUT
/api/dcim/interfaces/{id}/
Put a interface object.
PATCH
/api/dcim/interfaces/{id}/
Patch a interface object.
DELETE
/api/dcim/interfaces/{id}/
Delete a interface object.
GET
/api/dcim/interfaces/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET
/api/dcim/inventory-item-roles/
Get a list of inventory item role objects.
POST
/api/dcim/inventory-item-roles/
Post a list of inventory item role objects.
PUT
/api/dcim/inventory-item-roles/
Put a list of inventory item role objects.
PATCH
/api/dcim/inventory-item-roles/
Patch a list of inventory item role objects.
DELETE
/api/dcim/inventory-item-roles/
Delete a list of inventory item role objects.
GET
/api/dcim/inventory-item-roles/{id}/
Get a inventory item role object.
PUT
/api/dcim/inventory-item-roles/{id}/
Put a inventory item role object.
PATCH
/api/dcim/inventory-item-roles/{id}/
Patch a inventory item role object.
DELETE
/api/dcim/inventory-item-roles/{id}/
Delete a inventory item role object.
GET
/api/dcim/inventory-item-templates/
Get a list of inventory item template objects.
POST
/api/dcim/inventory-item-templates/
Post a list of inventory item template objects.
PUT
/api/dcim/inventory-item-templates/
Put a list of inventory item template objects.
PATCH
/api/dcim/inventory-item-templates/
Patch a list of inventory item template objects.
DELETE
/api/dcim/inventory-item-templates/
Delete a list of inventory item template objects.
GET
/api/dcim/inventory-item-templates/{id}/
Get a inventory item template object.
PUT
/api/dcim/inventory-item-templates/{id}/
Put a inventory item template object.
PATCH
/api/dcim/inventory-item-templates/{id}/
Patch a inventory item template object.
DELETE
/api/dcim/inventory-item-templates/{id}/
Delete a inventory item template object.
GET
/api/dcim/inventory-items/
Get a list of inventory item objects.
POST
/api/dcim/inventory-items/
Post a list of inventory item objects.
PUT
/api/dcim/inventory-items/
Put a list of inventory item objects.
PATCH
/api/dcim/inventory-items/
Patch a list of inventory item objects.
DELETE
/api/dcim/inventory-items/
Delete a list of inventory item objects.
GET
/api/dcim/inventory-items/{id}/
Get a inventory item object.
PUT
/api/dcim/inventory-items/{id}/
Put a inventory item object.
PATCH
/api/dcim/inventory-items/{id}/
Patch a inventory item object.
DELETE
/api/dcim/inventory-items/{id}/
Delete a inventory item object.
GET
/api/dcim/locations/
Get a list of location objects.
POST
/api/dcim/locations/
Post a list of location objects.
PUT
/api/dcim/locations/
Put a list of location objects.
PATCH
/api/dcim/locations/
Patch a list of location objects.
DELETE
/api/dcim/locations/
Delete a list of location objects.
GET
/api/dcim/locations/{id}/
Get a location object.
PUT
/api/dcim/locations/{id}/
Put a location object.
PATCH
/api/dcim/locations/{id}/
Patch a location object.
DELETE
/api/dcim/locations/{id}/
Delete a location object.
GET
/api/dcim/mac-addresses/
Get a list of MAC address objects.
POST
/api/dcim/mac-addresses/
Post a list of MAC address objects.
PUT
/api/dcim/mac-addresses/
Put a list of MAC address objects.
PATCH
/api/dcim/mac-addresses/
Patch a list of MAC address objects.
DELETE
/api/dcim/mac-addresses/
Delete a list of MAC address objects.
GET
/api/dcim/mac-addresses/{id}/
Get a MAC address object.
PUT
/api/dcim/mac-addresses/{id}/
Put a MAC address object.
PATCH
/api/dcim/mac-addresses/{id}/
Patch a MAC address object.
DELETE
/api/dcim/mac-addresses/{id}/
Delete a MAC address object.
GET
/api/dcim/manufacturers/
Get a list of manufacturer objects.
POST
/api/dcim/manufacturers/
Post a list of manufacturer objects.
PUT
/api/dcim/manufacturers/
Put a list of manufacturer objects.
PATCH
/api/dcim/manufacturers/
Patch a list of manufacturer objects.
DELETE
/api/dcim/manufacturers/
Delete a list of manufacturer objects.
GET
/api/dcim/manufacturers/{id}/
Get a manufacturer object.
PUT
/api/dcim/manufacturers/{id}/
Put a manufacturer object.
PATCH
/api/dcim/manufacturers/{id}/
Patch a manufacturer object.
DELETE
/api/dcim/manufacturers/{id}/
Delete a manufacturer object.
GET
/api/dcim/module-bay-templates/
Get a list of module bay template objects.
POST
/api/dcim/module-bay-templates/
Post a list of module bay template objects.
PUT
/api/dcim/module-bay-templates/
Put a list of module bay template objects.
PATCH
/api/dcim/module-bay-templates/
Patch a list of module bay template objects.
DELETE
/api/dcim/module-bay-templates/
Delete a list of module bay template objects.
GET
/api/dcim/module-bay-templates/{id}/
Get a module bay template object.
PUT
/api/dcim/module-bay-templates/{id}/
Put a module bay template object.
PATCH
/api/dcim/module-bay-templates/{id}/
Patch a module bay template object.
DELETE
/api/dcim/module-bay-templates/{id}/
Delete a module bay template object.
GET
/api/dcim/module-bays/
Get a list of module bay objects.
POST
/api/dcim/module-bays/
Post a list of module bay objects.
PUT
/api/dcim/module-bays/
Put a list of module bay objects.
PATCH
/api/dcim/module-bays/
Patch a list of module bay objects.
DELETE
/api/dcim/module-bays/
Delete a list of module bay objects.
GET
/api/dcim/module-bays/{id}/
Get a module bay object.
PUT
/api/dcim/module-bays/{id}/
Put a module bay object.
PATCH
/api/dcim/module-bays/{id}/
Patch a module bay object.
DELETE
/api/dcim/module-bays/{id}/
Delete a module bay object.
GET
/api/dcim/module-type-profiles/
Get a list of module type profile objects.
POST
/api/dcim/module-type-profiles/
Post a list of module type profile objects.
PUT
/api/dcim/module-type-profiles/
Put a list of module type profile objects.
PATCH
/api/dcim/module-type-profiles/
Patch a list of module type profile objects.
DELETE
/api/dcim/module-type-profiles/
Delete a list of module type profile objects.
GET
/api/dcim/module-type-profiles/{id}/
Get a module type profile object.
PUT
/api/dcim/module-type-profiles/{id}/
Put a module type profile object.
PATCH
/api/dcim/module-type-profiles/{id}/
Patch a module type profile object.
DELETE
/api/dcim/module-type-profiles/{id}/
Delete a module type profile object.
GET
/api/dcim/module-types/
Get a list of module type objects.
POST
/api/dcim/module-types/
Post a list of module type objects.
PUT
/api/dcim/module-types/
Put a list of module type objects.
PATCH
/api/dcim/module-types/
Patch a list of module type objects.
DELETE
/api/dcim/module-types/
Delete a list of module type objects.
GET
/api/dcim/module-types/{id}/
Get a module type object.
PUT
/api/dcim/module-types/{id}/
Put a module type object.
PATCH
/api/dcim/module-types/{id}/
Patch a module type object.
DELETE
/api/dcim/module-types/{id}/
Delete a module type object.
GET
/api/dcim/modules/
Get a list of module objects.
POST
/api/dcim/modules/
Post a list of module objects.
PUT
/api/dcim/modules/
Put a list of module objects.
PATCH
/api/dcim/modules/
Patch a list of module objects.
DELETE
/api/dcim/modules/
Delete a list of module objects.
GET
/api/dcim/modules/{id}/
Get a module object.
PUT
/api/dcim/modules/{id}/
Put a module object.
PATCH
/api/dcim/modules/{id}/
Patch a module object.
DELETE
/api/dcim/modules/{id}/
Delete a module object.
GET
/api/dcim/platforms/
Get a list of platform objects.
POST
/api/dcim/platforms/
Post a list of platform objects.
PUT
/api/dcim/platforms/
Put a list of platform objects.
PATCH
/api/dcim/platforms/
Patch a list of platform objects.
DELETE
/api/dcim/platforms/
Delete a list of platform objects.
GET
/api/dcim/platforms/{id}/
Get a platform object.
PUT
/api/dcim/platforms/{id}/
Put a platform object.
PATCH
/api/dcim/platforms/{id}/
Patch a platform object.
DELETE
/api/dcim/platforms/{id}/
Delete a platform object.
GET
/api/dcim/power-feeds/
Get a list of power feed objects.
POST
/api/dcim/power-feeds/
Post a list of power feed objects.
PUT
/api/dcim/power-feeds/
Put a list of power feed objects.
PATCH
/api/dcim/power-feeds/
Patch a list of power feed objects.
DELETE
/api/dcim/power-feeds/
Delete a list of power feed objects.
GET
/api/dcim/power-feeds/{id}/
Get a power feed object.
PUT
/api/dcim/power-feeds/{id}/
Put a power feed object.
PATCH
/api/dcim/power-feeds/{id}/
Patch a power feed object.
DELETE
/api/dcim/power-feeds/{id}/
Delete a power feed object.
GET
/api/dcim/power-feeds/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET
/api/dcim/power-outlet-templates/
Get a list of power outlet template objects.
POST
/api/dcim/power-outlet-templates/
Post a list of power outlet template objects.
PUT
/api/dcim/power-outlet-templates/
Put a list of power outlet template objects.
PATCH
/api/dcim/power-outlet-templates/
Patch a list of power outlet template objects.
DELETE
/api/dcim/power-outlet-templates/
Delete a list of power outlet template objects.
GET
/api/dcim/power-outlet-templates/{id}/
Get a power outlet template object.
PUT
/api/dcim/power-outlet-templates/{id}/
Put a power outlet template object.
PATCH
/api/dcim/power-outlet-templates/{id}/
Patch a power outlet template object.
DELETE
/api/dcim/power-outlet-templates/{id}/
Delete a power outlet template object.
GET
/api/dcim/power-outlets/
Get a list of power outlet objects.
POST
/api/dcim/power-outlets/
Post a list of power outlet objects.
PUT
/api/dcim/power-outlets/
Put a list of power outlet objects.
PATCH
/api/dcim/power-outlets/
Patch a list of power outlet objects.
DELETE
/api/dcim/power-outlets/
Delete a list of power outlet objects.
GET
/api/dcim/power-outlets/{id}/
Get a power outlet object.
PUT
/api/dcim/power-outlets/{id}/
Put a power outlet object.
PATCH
/api/dcim/power-outlets/{id}/
Patch a power outlet object.
DELETE
/api/dcim/power-outlets/{id}/
Delete a power outlet object.
GET
/api/dcim/power-outlets/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET
/api/dcim/power-panels/
Get a list of power panel objects.
POST
/api/dcim/power-panels/
Post a list of power panel objects.
PUT
/api/dcim/power-panels/
Put a list of power panel objects.
PATCH
/api/dcim/power-panels/
Patch a list of power panel objects.
DELETE
/api/dcim/power-panels/
Delete a list of power panel objects.
GET
/api/dcim/power-panels/{id}/
Get a power panel object.
PUT
/api/dcim/power-panels/{id}/
Put a power panel object.
PATCH
/api/dcim/power-panels/{id}/
Patch a power panel object.
DELETE
/api/dcim/power-panels/{id}/
Delete a power panel object.
GET
/api/dcim/power-port-templates/
Get a list of power port template objects.
POST
/api/dcim/power-port-templates/
Post a list of power port template objects.
PUT
/api/dcim/power-port-templates/
Put a list of power port template objects.
PATCH
/api/dcim/power-port-templates/
Patch a list of power port template objects.
DELETE
/api/dcim/power-port-templates/
Delete a list of power port template objects.
GET
/api/dcim/power-port-templates/{id}/
Get a power port template object.
PUT
/api/dcim/power-port-templates/{id}/
Put a power port template object.
PATCH
/api/dcim/power-port-templates/{id}/
Patch a power port template object.
DELETE
/api/dcim/power-port-templates/{id}/
Delete a power port template object.
GET
/api/dcim/power-ports/
Get a list of power port objects.
POST
/api/dcim/power-ports/
Post a list of power port objects.
PUT
/api/dcim/power-ports/
Put a list of power port objects.
PATCH
/api/dcim/power-ports/
Patch a list of power port objects.
DELETE
/api/dcim/power-ports/
Delete a list of power port objects.
GET
/api/dcim/power-ports/{id}/
Get a power port object.
PUT
/api/dcim/power-ports/{id}/
Put a power port object.
PATCH
/api/dcim/power-ports/{id}/
Patch a power port object.
DELETE
/api/dcim/power-ports/{id}/
Delete a power port object.
GET
/api/dcim/power-ports/{id}/trace/
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
GET
/api/dcim/rack-reservations/
Get a list of rack reservation objects.
POST
/api/dcim/rack-reservations/
Post a list of rack reservation objects.
PUT
/api/dcim/rack-reservations/
Put a list of rack reservation objects.
PATCH
/api/dcim/rack-reservations/
Patch a list of rack reservation objects.
DELETE
/api/dcim/rack-reservations/
Delete a list of rack reservation objects.
GET
/api/dcim/rack-reservations/{id}/
Get a rack reservation object.
PUT
/api/dcim/rack-reservations/{id}/
Put a rack reservation object.
PATCH
/api/dcim/rack-reservations/{id}/
Patch a rack reservation object.
DELETE
/api/dcim/rack-reservations/{id}/
Delete a rack reservation object.
GET
/api/dcim/rack-roles/
Get a list of rack role objects.
POST
/api/dcim/rack-roles/
Post a list of rack role objects.
PUT
/api/dcim/rack-roles/
Put a list of rack role objects.
PATCH
/api/dcim/rack-roles/
Patch a list of rack role objects.
DELETE
/api/dcim/rack-roles/
Delete a list of rack role objects.
GET
/api/dcim/rack-roles/{id}/
Get a rack role object.
PUT
/api/dcim/rack-roles/{id}/
Put a rack role object.
PATCH
/api/dcim/rack-roles/{id}/
Patch a rack role object.
DELETE
/api/dcim/rack-roles/{id}/
Delete a rack role object.
GET
/api/dcim/rack-types/
Get a list of rack type objects.
POST
/api/dcim/rack-types/
Post a list of rack type objects.
PUT
/api/dcim/rack-types/
Put a list of rack type objects.
PATCH
/api/dcim/rack-types/
Patch a list of rack type objects.
DELETE
/api/dcim/rack-types/
Delete a list of rack type objects.
GET
/api/dcim/rack-types/{id}/
Get a rack type object.
PUT
/api/dcim/rack-types/{id}/
Put a rack type object.
PATCH
/api/dcim/rack-types/{id}/
Patch a rack type object.
DELETE
/api/dcim/rack-types/{id}/
Delete a rack type object.
GET
/api/dcim/racks/
Get a list of rack objects.
POST
/api/dcim/racks/
Post a list of rack objects.
PUT
/api/dcim/racks/
Put a list of rack objects.
PATCH
/api/dcim/racks/
Patch a list of rack objects.
DELETE
/api/dcim/racks/
Delete a list of rack objects.
GET
/api/dcim/racks/{id}/
Get a rack object.
PUT
/api/dcim/racks/{id}/
Put a rack object.
PATCH
/api/dcim/racks/{id}/
Patch a rack object.
DELETE
/api/dcim/racks/{id}/
Delete a rack object.
GET
/api/dcim/racks/{id}/elevation/
Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
GET
/api/dcim/rear-port-templates/
Get a list of rear port template objects.
POST
/api/dcim/rear-port-templates/
Post a list of rear port template objects.
PUT
/api/dcim/rear-port-templates/
Put a list of rear port template objects.
PATCH
/api/dcim/rear-port-templates/
Patch a list of rear port template objects.
DELETE
/api/dcim/rear-port-templates/
Delete a list of rear port template objects.
GET
/api/dcim/rear-port-templates/{id}/
Get a rear port template object.
PUT
/api/dcim/rear-port-templates/{id}/
Put a rear port template object.
PATCH
/api/dcim/rear-port-templates/{id}/
Patch a rear port template object.
DELETE
/api/dcim/rear-port-templates/{id}/
Delete a rear port template object.
GET
/api/dcim/rear-ports/
Get a list of rear port objects.
POST
/api/dcim/rear-ports/
Post a list of rear port objects.
PUT
/api/dcim/rear-ports/
Put a list of rear port objects.
PATCH
/api/dcim/rear-ports/
Patch a list of rear port objects.
DELETE
/api/dcim/rear-ports/
Delete a list of rear port objects.
GET
/api/dcim/rear-ports/{id}/
Get a rear port object.
PUT
/api/dcim/rear-ports/{id}/
Put a rear port object.
PATCH
/api/dcim/rear-ports/{id}/
Patch a rear port object.
DELETE
/api/dcim/rear-ports/{id}/
Delete a rear port object.
GET
/api/dcim/rear-ports/{id}/paths/
Return all CablePaths which traverse a given pass-through port.
GET
/api/dcim/regions/
Get a list of region objects.
POST
/api/dcim/regions/
Post a list of region objects.
PUT
/api/dcim/regions/
Put a list of region objects.
PATCH
/api/dcim/regions/
Patch a list of region objects.
DELETE
/api/dcim/regions/
Delete a list of region objects.
GET
/api/dcim/regions/{id}/
Get a region object.
PUT
/api/dcim/regions/{id}/
Put a region object.
PATCH
/api/dcim/regions/{id}/
Patch a region object.
DELETE
/api/dcim/regions/{id}/
Delete a region object.
GET
/api/dcim/site-groups/
Get a list of site group objects.
POST
/api/dcim/site-groups/
Post a list of site group objects.
PUT
/api/dcim/site-groups/
Put a list of site group objects.
PATCH
/api/dcim/site-groups/
Patch a list of site group objects.
DELETE
/api/dcim/site-groups/
Delete a list of site group objects.
GET
/api/dcim/site-groups/{id}/
Get a site group object.
PUT
/api/dcim/site-groups/{id}/
Put a site group object.
PATCH
/api/dcim/site-groups/{id}/
Patch a site group object.
DELETE
/api/dcim/site-groups/{id}/
Delete a site group object.
GET
/api/dcim/sites/
Get a list of site objects.
POST
/api/dcim/sites/
Post a list of site objects.
PUT
/api/dcim/sites/
Put a list of site objects.
PATCH
/api/dcim/sites/
Patch a list of site objects.
DELETE
/api/dcim/sites/
Delete a list of site objects.
GET
/api/dcim/sites/{id}/
Get a site object.
PUT
/api/dcim/sites/{id}/
Put a site object.
PATCH
/api/dcim/sites/{id}/
Patch a site object.
DELETE
/api/dcim/sites/{id}/
Delete a site object.
GET
/api/dcim/virtual-chassis/
Get a list of virtual chassis objects.
POST
/api/dcim/virtual-chassis/
Post a list of virtual chassis objects.
PUT
/api/dcim/virtual-chassis/
Put a list of virtual chassis objects.
PATCH
/api/dcim/virtual-chassis/
Patch a list of virtual chassis objects.
DELETE
/api/dcim/virtual-chassis/
Delete a list of virtual chassis objects.
GET
/api/dcim/virtual-chassis/{id}/
Get a virtual chassis object.
PUT
/api/dcim/virtual-chassis/{id}/
Put a virtual chassis object.
PATCH
/api/dcim/virtual-chassis/{id}/
Patch a virtual chassis object.
DELETE
/api/dcim/virtual-chassis/{id}/
Delete a virtual chassis object.
GET
/api/dcim/virtual-device-contexts/
Get a list of virtual device context objects.
POST
/api/dcim/virtual-device-contexts/
Post a list of virtual device context objects.
PUT
/api/dcim/virtual-device-contexts/
Put a list of virtual device context objects.
PATCH
/api/dcim/virtual-device-contexts/
Patch a list of virtual device context objects.
DELETE
/api/dcim/virtual-device-contexts/
Delete a list of virtual device context objects.
GET
/api/dcim/virtual-device-contexts/{id}/
Get a virtual device context object.
PUT
/api/dcim/virtual-device-contexts/{id}/
Put a virtual device context object.
PATCH
/api/dcim/virtual-device-contexts/{id}/
Patch a virtual device context object.
DELETE
/api/dcim/virtual-device-contexts/{id}/
Delete a virtual device context object.
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.
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
7 required
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 required
BriefRackRole
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefPowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 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
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
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
Module
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
9 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
RearPortMappingRequest
object
3 properties
2 required
BriefWirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 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
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
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
BriefDeviceType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
7 required
VirtualDeviceContext
object
Base serializer class for models inheriting from PrimaryModel.
20 properties
11 required
PowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
2 required
PaginatedInventoryItemTemplateList
object
4 properties
2 required
BriefDeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 required
BriefPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PatchedWritablePlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties
BriefClusterRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
PaginatedConsolePortTemplateList
object
4 properties
2 required
Location
object
Base serializer class for models inheriting from NestedGroupModel.
22 properties
13 required
LocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
3 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
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
BriefManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 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
BriefMACAddress
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
PatchedWritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
WritableRearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
PatchedWritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
WritableInventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 required
Manufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
17 properties
12 required
WritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
3 required
FrontPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties
14 required
PowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
26 properties
16 required
ManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
2 required
PaginatedLocationList
object
4 properties
2 required
PatchedWritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PaginatedPlatformList
object
4 properties
2 required
ModuleBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
16 properties
8 required
PatchedWritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
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
DeviceWithConfigContext
object
Base serializer class for models inheriting from PrimaryModel.
49 properties
22 required
WritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
3 required
InventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 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
PaginatedRackRoleList
object
4 properties
2 required
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 required
PaginatedConsolePortList
object
4 properties
2 required
PatchedModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PaginatedRackTypeList
object
4 properties
2 required
PaginatedFrontPortTemplateList
object
4 properties
2 required
PowerPanel
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
9 required
BriefInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 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
BriefVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
1 required
PaginatedModuleBayList
object
4 properties
2 required
WritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
3 required
Interface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
56 properties
24 required
ConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
2 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
PaginatedManufacturerList
object
4 properties
2 required
PowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
2 required
RackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
4 required
PatchedWritableLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
12 properties
Device
object
Base serializer class for models inheriting from PrimaryModel.
48 properties
21 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
PaginatedDeviceBayList
object
4 properties
2 required
PaginatedModuleTypeList
object
4 properties
2 required
ConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 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
FrontPortMappingRequest
object
3 properties
2 required
BriefRack
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
PaginatedPowerPortTemplateList
object
4 properties
2 required
PaginatedRearPortTemplateList
object
4 properties
2 required
WritableCableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
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
PaginatedPowerPortList
object
4 properties
2 required
BriefVirtualChassis
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
5 required
PatchedWritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
RackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
3 required
PaginatedDeviceBayTemplateList
object
4 properties
2 required
ModuleType
object
Base serializer class for models inheriting from PrimaryModel.
20 properties
9 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
InventoryItem
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
10 required
PaginatedModuleBayTemplateList
object
4 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
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
BriefModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
BriefModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
2 required
ModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
7 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
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
PatchedWritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
PatchedWritableRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
PaginatedInventoryItemRoleList
object
4 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
WritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
3 required
RackRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
BriefPlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 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
VirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
3 required
PatchedWritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
BriefVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
SiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties
11 required
BriefRegion
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
BriefDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
3 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
PatchedWritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
SiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefVLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
DeviceRole
object
Base serializer class for models inheriting from NestedGroupModel.
20 properties
11 required
RearPortMapping
object
3 properties
2 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
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
PatchedMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
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
BriefModule
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
5 required
MACAddress
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
8 required
DeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 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
WritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
2 required
Platform
object
Base serializer class for models inheriting from NestedGroupModel.
19 properties
11 required
ModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
2 required
CableRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PatchedRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
InterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
3 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
10 required
BriefRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
3 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
FrontPortTemplateMapping
object
3 properties
2 required
InventoryItemRole
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties
9 required
PatchedInventoryItemRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
DeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
3 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
PatchedWritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 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
WritableSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
2 required
BriefModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
2 required
PatchedWritableInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
35 properties
RackReservation
object
Base serializer class for models inheriting from PrimaryModel.
16 properties
10 required
PatchedWritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
WritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
4 required
BriefModuleType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
6 required
PaginatedInventoryItemList
object
4 properties
2 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
BriefInventoryItemRole
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
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
PaginatedPowerFeedList
object
4 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
BriefSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
BriefRackType
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
7 required
RackType
object
Base serializer class for models inheriting from PrimaryModel.
28 properties
10 required
PatchedPowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 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
BriefLocationRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
PatchedWritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
DeviceType
object
Base serializer class for models inheriting from PrimaryModel.
36 properties
20 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
PaginatedFrontPortList
object
4 properties
2 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
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
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
PaginatedCableTerminationList
object
4 properties
2 required
PaginatedModuleTypeProfileList
object
4 properties
2 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
DeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
2 required
RegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
WritableRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
2 required
PaginatedPowerPanelList
object
4 properties
2 required
WritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
2 required
PatchedWritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
MACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 required
PaginatedVirtualChassisList
object
4 properties
2 required
PowerOutlet
object
Adds an owner field for models which have a ForeignKey to users.Owner.
28 properties
16 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
PaginatedModuleList
object
4 properties
2 required
VirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 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
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
RackRequest
object
Base serializer class for models inheriting from PrimaryModel.
29 properties
2 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
WritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
2 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
5 required
BriefConfigTemplateRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
2 properties
1 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
ModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
1 required
RearPortTemplateMapping
object
3 properties
2 required
PatchedWritableDeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
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
ConsolePort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
16 required
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties
4 required
PatchedWritablePowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
Cable
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
6 required
ModuleBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
10 properties
2 required
PaginatedDeviceTypeList
object
4 properties
2 required
PatchedWritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
5 required
WritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 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
BriefPlatform
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties
8 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
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
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
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
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
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
BriefManufacturer
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties
5 required
PaginatedRackReservationList
object
4 properties
2 required
WritableModuleTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
2 required
FrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
PatchedWritableConsolePortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
RearPortTemplateMappingRequest
object
3 properties
2 required
PatchedWritableRackReservationRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
BriefDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
WritableRackTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
4 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
PaginatedCableList
object
4 properties
2 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
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
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
ConsoleServerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
25 properties
16 required
PaginatedDeviceWithConfigContextList
object
4 properties
2 required
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
6 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
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
PaginatedInterfaceTemplateList
object
4 properties
2 required
PowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
12 properties
2 required
BriefSite
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
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
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
PaginatedSiteList
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
WritablePowerFeedRequest
object
Base serializer class for models inheriting from PrimaryModel.
17 properties
2 required
PaginatedPowerOutletTemplateList
object
4 properties
2 required
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
PatchedWritablePowerOutletRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
PaginatedRackList
object
4 properties
2 required
PatchedWritableDeviceTypeRequest
object
Base serializer class for models inheriting from PrimaryModel.
19 properties
WritableVirtualDeviceContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
3 required
PatchedWritableDeviceRoleRequest
object
Base serializer class for models inheriting from NestedGroupModel.
11 properties
BriefCluster
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
DeviceBay
object
Adds an owner field for models which have a ForeignKey to users.Owner.
14 properties
8 required
PaginatedMACAddressList
object
4 properties
2 required
RearPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
PaginatedRearPortList
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
WirelessLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
8 required
BriefMACAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
WritablePlatformRequest
object
Base serializer class for models inheriting from NestedGroupModel.
10 properties
2 required
PowerFeed
object
Base serializer class for models inheriting from PrimaryModel.
31 properties
16 required
GenericObjectRequest
object
Minimal representation of some generic object identified by ContentType and PK.
2 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
WritableModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
WritableVirtualChassisRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
1 required
Rack
object
Base serializer class for models inheriting from PrimaryModel.
37 properties
10 required
BriefRackRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 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
FrontPortMapping
object
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
Region
object
Base serializer class for models inheriting from NestedGroupModel.
17 properties
11 required
PatchedWritableSiteGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
PaginatedDeviceRoleList
object
4 properties
2 required
BriefModuleTypeProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
PaginatedRegionList
object
4 properties
2 required
BriefRegionRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
InventoryItemRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
17 properties
2 required
BriefRackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
PowerPanelRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
2 required
CableTermination
object
Adds support for custom fields and tags.
12 properties
12 required
PaginatedConsoleServerPortList
object
4 properties
2 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
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
PaginatedConsoleServerPortTemplateList
object
4 properties
2 required
WritableConsoleServerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
11 properties
2 required
RearPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
24 properties
14 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
GenericObject
object
Minimal representation of some generic object identified by ContentType and PK.
3 properties
3 required
BriefPowerPort
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
7 required
BriefPowerPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 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
PatchedDeviceBayRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
PatchedModuleTypeProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
DeviceWithConfigContextRequest
object
Base serializer class for models inheriting from PrimaryModel.
30 properties
3 required
BriefConfigTemplate
object
Adds an owner field for models which have a ForeignKey to users.Owner.
5 properties
4 required
WritableFrontPortRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
13 properties
3 required
SiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
2 required
PaginatedRackUnitList
object
4 properties
2 required
ModuleRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
3 required
RackRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
2 required
BriefSiteGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
PatchedManufacturerRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 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
PaginatedVirtualDeviceContextList
object
4 properties
2 required
PaginatedPowerOutletList
object
4 properties
2 required
BriefLocation
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
FrontPortTemplateMappingRequest
object
3 properties
2 required
PaginatedInterfaceList
object
4 properties
2 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.