NetBox

NetBox Dcim API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 400

Showing the first 250 of 400. The full set is in the contract, and via get_provider_operations.

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 #

Documentation

📖
Documentation
https://docs.netbox.dev/en/stable/integrations/rest-api/
📖
Authentication
https://docs.netbox.dev/en/stable/integrations/rest-api/#authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/netbox/openapi/netbox-dcim-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netbox:netbox-dcim-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netbox-dcim-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NetBox REST Dcim API
  version: 4.5.9 (4.5)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:


# --- truncated at 32 KB (2330 KB total) ---
# Full source: https://artifacts.apis.io/netbox/openapi/netbox-dcim-api-openapi.yml