NetBox Labs dcim API

The dcim API from NetBox Labs — 103 operation(s) for dcim.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: NetBox REST authentication-check dcim API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: dcim
paths:
  /api/dcim/cable-bundles/:
    get:
      operationId: dcim_cable_bundles_list
      description: Get a list of cable bundle objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - 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: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - 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
      - in: query
        name: name
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__empty
        schema:
          type: boolean
      - in: query
        name: name__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - 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: q
        schema:
          type: string
        description: Search
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      - in: query
        name: tag
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag_id
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: tag_id__n
        schema:
          type: array
          items:
            type: integer
        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/PaginatedCableBundleList'
          description: ''
    post:
      operationId: dcim_cable_bundles_create
      description: Post a list of cable bundle objects.
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CableBundleRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/CableBundleRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CableBundleRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/CableBundleRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CableBundle'
          description: ''
    put:
      operationId: dcim_cable_bundles_bulk_update
      description: Put a list of cable bundle objects.
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkCableBundleRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkCableBundleRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CableBundle'
          description: ''
    patch:
      operationId: dcim_cable_bundles_bulk_partial_update
      description: Patch a list of cable bundle objects.
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkCableBundleRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkCableBundleRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CableBundle'
          description: ''
    delete:
      operationId: dcim_cable_bundles_bulk_destroy
      description: Delete a list of cable bundle objects.
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CableBundleRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CableBundleRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/dcim/cable-bundles/{id}/:
    get:
      operationId: dcim_cable_bundles_retrieve
      description: Get a cable bundle object.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this cable bundle.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - dcim
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CableBundle'
          description: ''
    put:
      operationId: dcim_cable_bundles_update
      description: Put a cable bundle object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this cable bundle.
        required: true
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CableBundleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CableBundleRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CableBundle'
          description: ''
    patch:
      operationId: dcim_cable_bundles_partial_update
      description: Patch a cable bundle object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this cable bundle.
        required: true
      tags:
      - dcim
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCableBundleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCableBundleRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CableBundle'
          description: ''
    delete:
      operationId: dcim_cable_bundles_destroy
      description: Delete a cable bundle object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this cable bundle.
        required: true
      tags:
      - dcim
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/dcim/cable-terminations/:
    get:
      operationId: dcim_cable_terminations_list
      description: Get a list of cable termination objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - 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: cable_id
        schema:
          type: array
          items:
            type: integer
        description: Cable (ID)
        explode: true
        style: form
      - in: query
        name: cable_id__n
        schema:
          type: array
          items:
            type: integer
        description: Cable (ID)
        explode: true
        style: form
      - in: query
        name: circuittermination_id
        schema:
          type: array
          items:
            type: integer
            format: int32
        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: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - 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: 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
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - 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: rearport_id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      - 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: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this cable termination.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - dcim
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
               

# --- truncated at 32 KB (2823 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-dcim-api-openapi.yml
NetBox Labs dcim API

Documentation

Specifications

Other Resources

OpenAPI Specification
