NetBox dcim API
The dcim API from NetBox — 99 operation(s) for dcim.
OpenAPI Specification
openapi: 3.0.3
info:
title: NetBox REST authentication-check dcim API
version: 4.5.9 (4.5)
license:
name: Apache v2 License
servers:
- url: ''
description: NetBox
tags:
- name: dcim
paths:
/api/dcim/cable-terminations/:
get:
operationId: dcim_cable_terminations_list
description: Get a list of cable termination objects.
parameters:
- in: query
name: cable
schema:
type: integer
- in: query
name: cable__n
schema:
type: integer
- in: query
name: cable_end
schema:
type: string
x-spec-enum-id: 1db84f9b93b261c8
title: End
enum:
- A
- B
- 'null'
description: '* `A` - A
* `B` - B'
- in: query
name: cable_end__empty
schema:
type: boolean
- in: query
name: cable_end__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__n
schema:
type: string
x-spec-enum-id: 1db84f9b93b261c8
title: End
enum:
- A
- B
- 'null'
description: '* `A` - A
* `B` - B'
- in: query
name: cable_end__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: cable_end__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: termination_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_id__empty
schema:
type: boolean
- in: query
name: termination_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: termination_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: termination_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- dcim
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCableTerminationList'
description: ''
/api/dcim/cable-terminations/{id}/:
get:
operationId: dcim_cable_terminations_retrieve
description: Get a cable termination object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this cable termination.
required: true
tags:
- dcim
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CableTermination'
description: ''
/api/dcim/cables/:
get:
operationId: dcim_cables_list
description: Get a list of cable objects.
parameters:
- in: query
name: circuittermination_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: color
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__empty
schema:
type: boolean
- in: query
name: color__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: consoleport_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: consoleserverport_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: device
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: device_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: frontport_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: interface_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: label
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__empty
schema:
type: boolean
- in: query
name: label__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: length
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length__empty
schema:
type: boolean
- in: query
name: length__gt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length__gte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length__lt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length__lte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length__n
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: length_unit
schema:
type: string
x-spec-enum-id: 6e7645525ba02462
nullable: true
enum:
- cm
- ft
- in
- km
- m
- mi
- 'null'
description: '* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches'
- in: query
name: length_unit__empty
schema:
type: boolean
- in: query
name: length_unit__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__n
schema:
type: string
x-spec-enum-id: 6e7645525ba02462
nullable: true
enum:
- cm
- ft
- in
- km
- m
- mi
- 'null'
description: '* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches'
- in: query
name: length_unit__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: length_unit__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: location
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: location_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: powerfeed_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: poweroutlet_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: powerport_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: profile
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__empty
schema:
type: boolean
- in: query
name: profile__ic
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__ie
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__iew
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__isw
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__n
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__nic
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__nie
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__niew
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: profile__regex
schema:
type: array
items:
type: string
x-spec-enum-id: f566e6df6572f5d0
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: rack
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: rack_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: rearport_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: site
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: site_id
schema:
type: array
it
# --- truncated at 32 KB (2314 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/openapi/netbox-dcim-api-openapi.yml