NetBox Labs circuits API

openapi: 3.0.3
info:
  title: NetBox REST authentication-check circuits API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: circuits
paths:
  /api/circuits/circuit-group-assignments/:
    get:
      operationId: circuits_circuit_group_assignments_list
      description: Get a list of Circuit group assignment objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: circuit
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: circuit_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: group
        schema:
          type: array
          items:
            type: string
        description: Circuit group (slug)
        explode: true
        style: form
      - in: query
        name: group__n
        schema:
          type: array
          items:
            type: string
        description: Circuit group (slug)
        explode: true
        style: form
      - in: query
        name: group_id
        schema:
          type: array
          items:
            type: integer
        description: Circuit group (ID)
        explode: true
        style: form
      - in: query
        name: group_id__n
        schema:
          type: array
          items:
            type: integer
        description: Circuit group (ID)
        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: 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: member_id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_id__empty
        schema:
          type: boolean
      - in: query
        name: member_id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: member_type
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: member_type__n
        schema:
          type: array
          items:
            type: string
        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
      - 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: priority
        schema:
          type: string
          x-spec-enum-id: 0548fc537440bf9d
          nullable: true
          enum:
          - inactive
          - 'null'
          - primary
          - secondary
          - tertiary
        description: '* `primary` - Primary

          * `secondary` - Secondary

          * `tertiary` - Tertiary

          * `inactive` - Inactive'
      - in: query
        name: priority__empty
        schema:
          type: boolean
      - in: query
        name: priority__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__n
        schema:
          type: string
          x-spec-enum-id: 0548fc537440bf9d
          nullable: true
          enum:
          - inactive
          - 'null'
          - primary
          - secondary
          - tertiary
        description: '* `primary` - Primary

          * `secondary` - Secondary

          * `tertiary` - Tertiary

          * `inactive` - Inactive'
      - in: query
        name: priority__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: priority__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: provider
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: provider_id
        schema:
          type: array
          items:
            type: integer
            format: int32
        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
      - in: query
        name: virtual_circuit
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: virtual_circuit_id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      tags:
      - circuits
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCircuitGroupAssignmentList'
          description: ''
    post:
      operationId: circuits_circuit_group_assignments_create
      description: Post a list of Circuit group assignment objects.
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    put:
      operationId: circuits_circuit_group_assignments_bulk_update
      description: Put a list of Circuit group assignment objects.
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkCircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkCircuitGroupAssignmentRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    patch:
      operationId: circuits_circuit_group_assignments_bulk_partial_update
      description: Patch a list of Circuit group assignment objects.
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkCircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkCircuitGroupAssignmentRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    delete:
      operationId: circuits_circuit_group_assignments_bulk_destroy
      description: Delete a list of Circuit group assignment objects.
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CircuitGroupAssignmentRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/circuits/circuit-group-assignments/{id}/:
    get:
      operationId: circuits_circuit_group_assignments_retrieve
      description: Get a Circuit group assignment 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 Circuit group assignment.
        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:
      - circuits
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    put:
      operationId: circuits_circuit_group_assignments_update
      description: Put a Circuit group assignment object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Circuit group assignment.
        required: true
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    patch:
      operationId: circuits_circuit_group_assignments_partial_update
      description: Patch a Circuit group assignment object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Circuit group assignment.
        required: true
      tags:
      - circuits
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CircuitGroupAssignment'
          description: ''
    delete:
      operationId: circuits_circuit_group_assignments_destroy
      description: Delete a Circuit group assignment object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Circuit group assignment.
        required: true
      tags:
      - circuits
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/circuits/circuit-groups/:
    get:
      operationId: circuits_circuit_groups_list
      description: Get a list of circuit group 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
      - in: query
        name: slug
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug__empty
        schema:
          type: boolean
      - in: query
        name: slug__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: slug

# --- truncated at 32 KB (399 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-circuits-api-openapi.yml