NetBox Labs core API

openapi: 3.0.3
info:
  title: NetBox REST authentication-check core API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: core
paths:
  /api/core/background-queues/:
    get:
      operationId: core_background_queues_retrieve
      description: 'Retrieve a list of RQ Queues.

        Note: Queue names are not URL safe, so not returning a detail view.'
      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: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/background-queues/{name}/:
    get:
      operationId: core_background_queues_retrieve_by_name
      description: 'Retrieve a list of RQ Queues.

        Note: Queue names are not URL safe, so not returning a detail view.'
      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: name
        schema:
          type: string
        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:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/background-tasks/:
    get:
      operationId: core_background_tasks_retrieve
      description: Retrieve a list of RQ Tasks.
      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: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/background-tasks/{id}/:
    get:
      operationId: core_background_tasks_retrieve_by_id
      description: Retrieve a list of RQ Tasks.
      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: string
        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:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/background-tasks/{id}/delete/:
    post:
      operationId: core_background_tasks_delete_create
      description: Retrieve a list of RQ Tasks.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundTask'
          description: ''
  /api/core/background-tasks/{id}/enqueue/:
    post:
      operationId: core_background_tasks_enqueue_create
      description: Retrieve a list of RQ Tasks.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundTask'
          description: ''
  /api/core/background-tasks/{id}/requeue/:
    post:
      operationId: core_background_tasks_requeue_create
      description: Retrieve a list of RQ Tasks.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundTask'
          description: ''
  /api/core/background-tasks/{id}/stop/:
    post:
      operationId: core_background_tasks_stop_create
      description: Retrieve a list of RQ Tasks.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BackgroundTaskRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundTask'
          description: ''
  /api/core/background-workers/:
    get:
      operationId: core_background_workers_retrieve
      description: Retrieve a list of RQ Workers.
      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: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/background-workers/{name}/:
    get:
      operationId: core_background_workers_retrieve_by_name
      description: Retrieve a list of RQ Workers.
      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: name
        schema:
          type: string
        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:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/core/data-files/:
    get:
      operationId: core_data_files_list
      description: Get a list of data file 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: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: hash
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__empty
        schema:
          type: boolean
      - in: query
        name: hash__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: hash__regex
        schema:
          type: array
          items:
            type: string
        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: 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: path
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__empty
        schema:
          type: boolean
      - in: query
        name: path__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: path__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: size
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: size__empty
        schema:
          type: boolean
      - in: query
        name: size__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: size__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: size__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: size__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: size__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: source
        schema:
          type: array
          items:
            type: string
        description: Data source (name)
        explode: true
        style: form
      - in: query
        name: source__n
        schema:
          type: array
          items:
            type: string
        description: Data source (name)
        explode: true
        style: form
      - in: query
        name: source_id
        schema:
          type: array
          items:
            type: integer
        description: Data source (ID)
        explode: true
        style: form
      - in: query
        name: source_id__n
        schema:
          type: array
          items:
            type: integer
        description: Data source (ID)
        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: updated_by_request
        schema:
          type: string
          format: uuid
      tags:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataFileList'
          description: ''
  /api/core/data-files/{id}/:
    get:
      operationId: core_data_files_retrieve
      description: Get a data file 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 data file.
        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:
      - core
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFile'
          description: ''
  /api/core/data-sources/:
    get:
      operationId: core_data_sources_list
      description: Get a list of data source 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: enabled
        schema:
          type: boolean
      - 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_synced
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_synced__empty
        schema:
          type: boolean
      - in: query
        name: last_synced__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_synced__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_synced__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_synced__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_synced__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        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_

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