NetBox · Capability

NetBox REST API

NetBox REST API API capability.

Run with Naftiko NetboxAPI

What You Can Do

GET
Authentication check retrieve — Return the user making the request, if authenticated successfully.
/api/authentication-check/
GET
Circuits circuit group assignments list — Get a list of Circuit group assignment objects.
/api/circuits/circuit-group-assignments/
POST
Circuits circuit group assignments create — Post a list of Circuit group assignment objects.
/api/circuits/circuit-group-assignments/
PUT
Circuits circuit group assignments bulk update — Put a list of Circuit group assignment objects.
/api/circuits/circuit-group-assignments/
PATCH
Circuits circuit group assignments bulk partial — Patch a list of Circuit group assignment objects.
/api/circuits/circuit-group-assignments/
DELETE
Circuits circuit group assignments bulk destroy — Delete a list of Circuit group assignment objects.
/api/circuits/circuit-group-assignments/
GET
Circuits circuit group assignments retrieve — Get a Circuit group assignment object.
/api/circuits/circuit-group-assignments/{id}/
PUT
Circuits circuit group assignments update — Put a Circuit group assignment object.
/api/circuits/circuit-group-assignments/{id}/
PATCH
Circuits circuit group assignments partial updat — Patch a Circuit group assignment object.
/api/circuits/circuit-group-assignments/{id}/
DELETE
Circuits circuit group assignments destroy — Delete a Circuit group assignment object.
/api/circuits/circuit-group-assignments/{id}/
GET
Circuits circuit groups list — Get a list of circuit group objects.
/api/circuits/circuit-groups/
POST
Circuits circuit groups create — Post a list of circuit group objects.
/api/circuits/circuit-groups/
PUT
Circuits circuit groups bulk update — Put a list of circuit group objects.
/api/circuits/circuit-groups/
PATCH
Circuits circuit groups bulk partial update — Patch a list of circuit group objects.
/api/circuits/circuit-groups/
DELETE
Circuits circuit groups bulk destroy — Delete a list of circuit group objects.
/api/circuits/circuit-groups/
GET
Circuits circuit groups retrieve — Get a circuit group object.
/api/circuits/circuit-groups/{id}/
PUT
Circuits circuit groups update — Put a circuit group object.
/api/circuits/circuit-groups/{id}/
PATCH
Circuits circuit groups partial update — Patch a circuit group object.
/api/circuits/circuit-groups/{id}/
DELETE
Circuits circuit groups destroy — Delete a circuit group object.
/api/circuits/circuit-groups/{id}/
GET
Circuits circuit terminations list — Get a list of circuit termination objects.
/api/circuits/circuit-terminations/
POST
Circuits circuit terminations create — Post a list of circuit termination objects.
/api/circuits/circuit-terminations/
PUT
Circuits circuit terminations bulk update — Put a list of circuit termination objects.
/api/circuits/circuit-terminations/
PATCH
Circuits circuit terminations bulk partial updat — Patch a list of circuit termination objects.
/api/circuits/circuit-terminations/
DELETE
Circuits circuit terminations bulk destroy — Delete a list of circuit termination objects.
/api/circuits/circuit-terminations/
GET
Circuits circuit terminations retrieve — Get a circuit termination object.
/api/circuits/circuit-terminations/{id}/
PUT
Circuits circuit terminations update — Put a circuit termination object.
/api/circuits/circuit-terminations/{id}/
PATCH
Circuits circuit terminations partial update — Patch a circuit termination object.
/api/circuits/circuit-terminations/{id}/
DELETE
Circuits circuit terminations destroy — Delete a circuit termination object.
/api/circuits/circuit-terminations/{id}/
GET
Circuits circuit terminations paths retrieve — Return all CablePaths which traverse a given pass-through port.
/api/circuits/circuit-terminations/{id}/paths/
GET
Circuits circuit types list — Get a list of circuit type objects.
/api/circuits/circuit-types/
POST
Circuits circuit types create — Post a list of circuit type objects.
/api/circuits/circuit-types/
PUT
Circuits circuit types bulk update — Put a list of circuit type objects.
/api/circuits/circuit-types/
PATCH
Circuits circuit types bulk partial update — Patch a list of circuit type objects.
/api/circuits/circuit-types/
DELETE
Circuits circuit types bulk destroy — Delete a list of circuit type objects.
/api/circuits/circuit-types/
GET
Circuits circuit types retrieve — Get a circuit type object.
/api/circuits/circuit-types/{id}/
PUT
Circuits circuit types update — Put a circuit type object.
/api/circuits/circuit-types/{id}/
PATCH
Circuits circuit types partial update — Patch a circuit type object.
/api/circuits/circuit-types/{id}/
DELETE
Circuits circuit types destroy — Delete a circuit type object.
/api/circuits/circuit-types/{id}/
GET
Circuits circuits list — Get a list of circuit objects.
/api/circuits/circuits/
POST
Circuits circuits create — Post a list of circuit objects.
/api/circuits/circuits/
PUT
Circuits circuits bulk update — Put a list of circuit objects.
/api/circuits/circuits/
PATCH
Circuits circuits bulk partial update — Patch a list of circuit objects.
/api/circuits/circuits/
DELETE
Circuits circuits bulk destroy — Delete a list of circuit objects.
/api/circuits/circuits/
GET
Circuits circuits retrieve — Get a circuit object.
/api/circuits/circuits/{id}/
PUT
Circuits circuits update — Put a circuit object.
/api/circuits/circuits/{id}/
PATCH
Circuits circuits partial update — Patch a circuit object.
/api/circuits/circuits/{id}/
DELETE
Circuits circuits destroy — Delete a circuit object.
/api/circuits/circuits/{id}/
GET
Circuits provider accounts list — Get a list of provider account objects.
/api/circuits/provider-accounts/
POST
Circuits provider accounts create — Post a list of provider account objects.
/api/circuits/provider-accounts/
PUT
Circuits provider accounts bulk update — Put a list of provider account objects.
/api/circuits/provider-accounts/
PATCH
Circuits provider accounts bulk partial update — Patch a list of provider account objects.
/api/circuits/provider-accounts/
DELETE
Circuits provider accounts bulk destroy — Delete a list of provider account objects.
/api/circuits/provider-accounts/
GET
Circuits provider accounts retrieve — Get a provider account object.
/api/circuits/provider-accounts/{id}/
PUT
Circuits provider accounts update — Put a provider account object.
/api/circuits/provider-accounts/{id}/
PATCH
Circuits provider accounts partial update — Patch a provider account object.
/api/circuits/provider-accounts/{id}/
DELETE
Circuits provider accounts destroy — Delete a provider account object.
/api/circuits/provider-accounts/{id}/
GET
Circuits provider networks list — Get a list of provider network objects.
/api/circuits/provider-networks/
POST
Circuits provider networks create — Post a list of provider network objects.
/api/circuits/provider-networks/
PUT
Circuits provider networks bulk update — Put a list of provider network objects.
/api/circuits/provider-networks/
PATCH
Circuits provider networks bulk partial update — Patch a list of provider network objects.
/api/circuits/provider-networks/

MCP Tools

authentication-check-retrieve

Return the user making the request, if authenticated successfully.

read-only idempotent
circuits-circuit-group-assignments-list

Get a list of Circuit group assignment objects.

read-only idempotent
circuits-circuit-group-assignments-create

Post a list of Circuit group assignment objects.

circuits-circuit-group-assignments-bulk-update

Put a list of Circuit group assignment objects.

idempotent
circuits-circuit-group-assignments-bulk-partial-

Patch a list of Circuit group assignment objects.

circuits-circuit-group-assignments-bulk-destroy

Delete a list of Circuit group assignment objects.

idempotent
circuits-circuit-group-assignments-retrieve

Get a Circuit group assignment object.

read-only idempotent
circuits-circuit-group-assignments-update

Put a Circuit group assignment object.

idempotent
circuits-circuit-group-assignments-partial-updat

Patch a Circuit group assignment object.

circuits-circuit-group-assignments-destroy

Delete a Circuit group assignment object.

idempotent
circuits-circuit-groups-list

Get a list of circuit group objects.

read-only idempotent
circuits-circuit-groups-create

Post a list of circuit group objects.

circuits-circuit-groups-bulk-update

Put a list of circuit group objects.

idempotent
circuits-circuit-groups-bulk-partial-update

Patch a list of circuit group objects.

circuits-circuit-groups-bulk-destroy

Delete a list of circuit group objects.

idempotent
circuits-circuit-groups-retrieve

Get a circuit group object.

read-only idempotent
circuits-circuit-groups-update

Put a circuit group object.

idempotent
circuits-circuit-groups-partial-update

Patch a circuit group object.

circuits-circuit-groups-destroy

Delete a circuit group object.

idempotent
circuits-circuit-terminations-list

Get a list of circuit termination objects.

read-only idempotent
circuits-circuit-terminations-create

Post a list of circuit termination objects.

circuits-circuit-terminations-bulk-update

Put a list of circuit termination objects.

idempotent
circuits-circuit-terminations-bulk-partial-updat

Patch a list of circuit termination objects.

circuits-circuit-terminations-bulk-destroy

Delete a list of circuit termination objects.

idempotent
circuits-circuit-terminations-retrieve

Get a circuit termination object.

read-only idempotent
circuits-circuit-terminations-update

Put a circuit termination object.

idempotent
circuits-circuit-terminations-partial-update

Patch a circuit termination object.

circuits-circuit-terminations-destroy

Delete a circuit termination object.

idempotent
circuits-circuit-terminations-paths-retrieve

Return all CablePaths which traverse a given pass-through port.

read-only idempotent
circuits-circuit-types-list

Get a list of circuit type objects.

read-only idempotent
circuits-circuit-types-create

Post a list of circuit type objects.

circuits-circuit-types-bulk-update

Put a list of circuit type objects.

idempotent
circuits-circuit-types-bulk-partial-update

Patch a list of circuit type objects.

circuits-circuit-types-bulk-destroy

Delete a list of circuit type objects.

idempotent
circuits-circuit-types-retrieve

Get a circuit type object.

read-only idempotent
circuits-circuit-types-update

Put a circuit type object.

idempotent
circuits-circuit-types-partial-update

Patch a circuit type object.

circuits-circuit-types-destroy

Delete a circuit type object.

idempotent
circuits-circuits-list

Get a list of circuit objects.

read-only idempotent
circuits-circuits-create

Post a list of circuit objects.

circuits-circuits-bulk-update

Put a list of circuit objects.

idempotent
circuits-circuits-bulk-partial-update

Patch a list of circuit objects.

circuits-circuits-bulk-destroy

Delete a list of circuit objects.

idempotent
circuits-circuits-retrieve

Get a circuit object.

read-only idempotent
circuits-circuits-update

Put a circuit object.

idempotent
circuits-circuits-partial-update

Patch a circuit object.

circuits-circuits-destroy

Delete a circuit object.

idempotent
circuits-provider-accounts-list

Get a list of provider account objects.

read-only idempotent
circuits-provider-accounts-create

Post a list of provider account objects.

circuits-provider-accounts-bulk-update

Put a list of provider account objects.

idempotent
circuits-provider-accounts-bulk-partial-update

Patch a list of provider account objects.

circuits-provider-accounts-bulk-destroy

Delete a list of provider account objects.

idempotent
circuits-provider-accounts-retrieve

Get a provider account object.

read-only idempotent
circuits-provider-accounts-update

Put a provider account object.

idempotent
circuits-provider-accounts-partial-update

Patch a provider account object.

circuits-provider-accounts-destroy

Delete a provider account object.

idempotent
circuits-provider-networks-list

Get a list of provider network objects.

read-only idempotent
circuits-provider-networks-create

Post a list of provider network objects.

circuits-provider-networks-bulk-update

Put a list of provider network objects.

idempotent
circuits-provider-networks-bulk-partial-update

Patch a list of provider network objects.

Capability Spec

netbox-capability.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: NetBox REST API
  description: NetBox REST API API capability.
  tags:
  - Netbox
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: netbox
    baseUri: ''
    description: NetBox REST API HTTP API.
    authentication:
      type: apikey
      in: cookie
      name: sessionid
      value: '{{NETBOX_TOKEN}}'
    resources:
    - name: api-authentication-check
      path: /api/authentication-check/
      operations:
      - name: authentication-check-retrieve
        method: GET
        description: Return the user making the request, if authenticated successfully.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-circuits-circuit-group-assignments
      path: /api/circuits/circuit-group-assignments/
      operations:
      - name: circuits-circuit-group-assignments-list
        method: GET
        description: Get a list of Circuit group assignment objects.
        inputParameters:
        - name: circuit
          in: query
          type: array
        - name: circuit_id
          in: query
          type: array
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: group
          in: query
          type: array
          description: Circuit group (slug)
        - name: group__n
          in: query
          type: array
          description: Circuit group (slug)
        - name: group_id
          in: query
          type: array
          description: Circuit group (ID)
        - name: group_id__n
          in: query
          type: array
          description: Circuit group (ID)
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: member_id
          in: query
          type: array
        - name: member_id__empty
          in: query
          type: boolean
        - name: member_id__gt
          in: query
          type: array
        - name: member_id__gte
          in: query
          type: array
        - name: member_id__lt
          in: query
          type: array
        - name: member_id__lte
          in: query
          type: array
        - name: member_id__n
          in: query
          type: array
        - name: member_type
          in: query
          type: array
        - name: member_type__n
          in: query
          type: array
        - name: modified_by_request
          in: query
          type: string
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: priority
          in: query
          type: string
          description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive'
        - name: priority__empty
          in: query
          type: boolean
        - name: priority__ic
          in: query
          type: array
        - name: priority__ie
          in: query
          type: array
        - name: priority__iew
          in: query
          type: array
        - name: priority__iregex
          in: query
          type: array
        - name: priority__isw
          in: query
          type: array
        - name: priority__n
          in: query
          type: string
          description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive'
        - name: priority__nic
          in: query
          type: array
        - name: priority__nie
          in: query
          type: array
        - name: priority__niew
          in: query
          type: array
        - name: priority__nisw
          in: query
          type: array
        - name: priority__regex
          in: query
          type: array
        - name: provider
          in: query
          type: array
        - name: provider_id
          in: query
          type: array
        - name: q
          in: query
          type: string
          description: Search
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: updated_by_request
          in: query
          type: string
        - name: virtual_circuit
          in: query
          type: array
        - name: virtual_circuit_id
          in: query
          type: array
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-create
        method: POST
        description: Post a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-bulk-update
        method: PUT
        description: Put a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-bulk-partial-
        method: PATCH
        description: Patch a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-bulk-destroy
        method: DELETE
        description: Delete a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-circuits-circuit-group-assignments-id
      path: /api/circuits/circuit-group-assignments/{id}/
      operations:
      - name: circuits-circuit-group-assignments-retrieve
        method: GET
        description: Get a Circuit group assignment object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this Circuit group assignment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-update
        method: PUT
        description: Put a Circuit group assignment object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this Circuit group assignment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-partial-updat
        method: PATCH
        description: Patch a Circuit group assignment object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this Circuit group assignment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-group-assignments-destroy
        method: DELETE
        description: Delete a Circuit group assignment object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this Circuit group assignment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-circuits-circuit-groups
      path: /api/circuits/circuit-groups/
      operations:
      - name: circuits-circuit-groups-list
        method: GET
        description: Get a list of circuit group objects.
        inputParameters:
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: description
          in: query
          type: array
        - name: description__empty
          in: query
          type: boolean
        - name: description__ic
          in: query
          type: array
        - name: description__ie
          in: query
          type: array
        - name: description__iew
          in: query
          type: array
        - name: description__iregex
          in: query
          type: array
        - name: description__isw
          in: query
          type: array
        - name: description__n
          in: query
          type: array
        - name: description__nic
          in: query
          type: array
        - name: description__nie
          in: query
          type: array
        - name: description__niew
          in: query
          type: array
        - name: description__nisw
          in: query
          type: array
        - name: description__regex
          in: query
          type: array
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: modified_by_request
          in: query
          type: string
        - name: name
          in: query
          type: array
        - name: name__empty
          in: query
          type: boolean
        - name: name__ic
          in: query
          type: array
        - name: name__ie
          in: query
          type: array
        - name: name__iew
          in: query
          type: array
        - name: name__iregex
          in: query
          type: array
        - name: name__isw
          in: query
          type: array
        - name: name__n
          in: query
          type: array
        - name: name__nic
          in: query
          type: array
        - name: name__nie
          in: query
          type: array
        - name: name__niew
          in: query
          type: array
        - name: name__nisw
          in: query
          type: array
        - name: name__regex
          in: query
          type: array
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: owner
          in: query
          type: array
          description: Owner (name)
        - name: owner__n
          in: query
          type: array
          description: Owner (name)
        - name: owner_group
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group__n
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group_id
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_group_id__n
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_id
          in: query
          type: array
          description: Owner (ID)
        - name: owner_id__n
          in: query
          type: array
          description: Owner (ID)
        - name: q
          in: query
          type: string
          description: Search
        - name: slug
          in: query
          type: array
        - name: slug__empty
          in: query
          type: boolean
        - name: slug__ic
          in: query
          type: array
        - name: slug__ie
          in: query
          type: array
        - name: slug__iew
          in: query
          type: array
        - name: slug__iregex
          in: query
          type: array
        - name: slug__isw
          in: query
          type: array
        - name: slug__n
          in: query
          type: array
        - name: slug__nic
          in: query
          type: array
        - name: slug__nie
          in: query
          type: array
        - name: slug__niew
          in: query
          type: array
        - name: slug__nisw
          in: query
          type: array
        - name: slug__regex
          in: query
          type: array
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: tenant
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant__n
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant_group
          in: query
          type: array
        - name: tenant_group__n
          in: query
          type: array
        - name: tenant_group_id
          in: query
          type: array
        - name: tenant_group_id__n
          in: query
          type: array
        - name: tenant_id
          in: query
          type: array
          description: Tenant (ID)
        - name: tenant_id__n
          in: query
          type: array
          description: Tenant (ID)
        - name: updated_by_request
          in: query
          type: string
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-create
        method: POST
        description: Post a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-bulk-update
        method: PUT
        description: Put a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-bulk-partial-update
        method: PATCH
        description: Patch a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-bulk-destroy
        method: DELETE
        description: Delete a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-circuits-circuit-groups-id
      path: /api/circuits/circuit-groups/{id}/
      operations:
      - name: circuits-circuit-groups-retrieve
        method: GET
        description: Get a circuit group object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this circuit group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-update
        method: PUT
        description: Put a circuit group object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this circuit group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-partial-update
        method: PATCH
        description: Patch a circuit group object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this circuit group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-groups-destroy
        method: DELETE
        description: Delete a circuit group object.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this circuit group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-circuits-circuit-terminations
      path: /api/circuits/circuit-terminations/
      operations:
      - name: circuits-circuit-terminations-list
        method: GET
        description: Get a list of circuit termination objects.
        inputParameters:
        - name: cable_connector
          in: query
          type: array
        - name: cable_connector__empty
          in: query
          type: boolean
        - name: cable_connector__gt
          in: query
          type: array
        - name: cable_connector__gte
          in: query
          type: array
        - name: cable_connector__lt
          in: query
          type: array
        - name: cable_connector__lte
          in: query
          type: array
        - name: cable_connector__n
          in: query
          type: array
        - name: cable_end
          in: query
          type: string
          description: '* `A` - A * `B` - B'
        - name: cable_end__empty
          in: query
          type: boolean
        - name: cable_end__ic
          in: query
          type: array
        - name: cable_end__ie
          in: query
          type: array
        - name: cable_end__iew
          in: query
          type: array
        - name: cable_end__iregex
          in: query
          type: array
        - name: cable_end__isw
          in: query
          type: array
        - name: cable_end__n
          in: query
          type: string
          description: '* `A` - A * `B` - B'
        - name: cable_end__nic
          in: query
          type: array
        - name: cable_end__nie
          in: query
          type: array
        - name: cable_end__niew
          in: query
          type: array
        - name: cable_end__nisw
          in: query
          type: array
        - name: cable_end__regex
          in: query
          type: array
        - name: cable_id
          in: query
          type: array
          description: Cable (ID)
        - name: cable_id__n
          in: query
          type: array
          description: Cable (ID)
        - name: cabled
          in: query
          type: boolean
        - name: circuit_id
          in: query
          type: array
          description: Circuit
        - name: circuit_id__n
          in: query
          type: array
          description: Circuit
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: description
          in: query
          type: array
        - name: description__empty
          in: query
          type: boolean
        - name: description__ic
          in: query
          type: array
        - name: description__ie
          in: query
          type: array
        - name: description__iew
          in: query
          type: array
        - name: description__iregex
          in: query
          type: array
        - name: description__isw
          in: query
          type: array
        - name: description__n
          in: query
          type: array
        - name: description__nic
          in: query
          type: array
        - name: description__nie
          in: query
          type: array
        - name: description__niew
          in: query
          type: array
        - name: description__nisw
          in: query
          type: array
        - name: description__regex
          in: query
          type: array
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: location
          in: query
          type: array
        - name: location__n
          in: query
          type: array
        - name: location_id
          in: query
          type: array
        - name: location_id__n
          in: query
          type: array
        - name: mark_connected
          in: query
          type: boolean
        - name: modified_by_request
          in: query
          type: string
        - name: occupied
          in: query
          type: boolean
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: port_speed
          in: query
          type: array
        - name: port_speed__empty
          in: query
          type: boolean
        - name: port_speed__gt
          in: query
          type: array
        - name: port_speed__gte
          in: query
          type: array
        - name: port_speed__lt
          in: query
          type: array
        - name: port_speed__lte
          in: query
          type: array
        - name: port_speed__n
          in: query
          type: array
        - name: pp_info
          in: query
          type: array
        - name: pp_info__empty
          in: query
          type: boolean
        - name: pp_info__ic
          in: query
          type: array
        - name: pp_info__ie
          in: query
          type: array
        - name: pp_info__iew
          in: query
          type: array
        - name: pp_info__iregex
          in: query
          type: array
        - name: pp_info__isw
          in: query
          type: array
        - name: pp_info__n
          in: query
          type: array
        - name: pp_info__nic
          in: query
          type: array
        - name: pp_info__nie
          in: query
          type: array
        - name: pp_info__niew
          in: query
          type: array
        - name: pp_info__nisw
          in: query
          type: array
        - name: pp_info__regex
          in: query
          type: array
        - name: provider
          in: query
          type: array
          description: Provider (slug)
        - name: provider__n
          in: query
          type: array
          description: Provider (slug)
        - name: provider_id
          in: query
          type: array
          description: Provider (ID)
        - name: provider_id__n
          in: query
          type: array
          description: Provider (ID)
        - name: provider_network_id
          in: query
          type: array
          description: ProviderNetwork (ID)
        - name: provider_network_id__n
          in: query
          type: array
          description: ProviderNetwork (ID)
        - name: q
          in: query
          type: string
          description: Search
        - name: region
          in: query
          type: array
        - name: region__n
          in: query
          type: array
        - name: region_id
          in: query
          type: array
        - name: region_id__n
          in: query
          type: array
        - name: site
          in: query
          type: array
          description: Site (slug)
        - name: site__n
          in: query
          type: array
          description: Site (slug)
        - name: site_group
          in: query
          type: array
        - name: site_group__n
          in: query
          type: array
        - name: site_group_id
          in: query
          type: array
        - name: site_group_id__n
          in: query
          type: array
        - name: site_id
          in: query
          type: array
          description: Site (ID)
        - name: site_id__n
          in: query
          type: array
          description: Site (ID)
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: term_side
          in: query
          type: string
          description: '* `A` - A * `Z` - Z'
        - name: term_side__empty
          in: query
          type: boolean
        - name: term_side__ic
          in: query
          type: array
        - name: term_side__ie
          in: query
          type: array
        - name: term_side__iew
          in: query
          type: array
        - name: term_side__iregex
          in: query
          type: array
        - name: term_side__isw
          in: query
          type: array
        - name: term_side__n
          in: query
          type: string
          description: '* `A` - A * `Z` - Z'
        - name: term_side__nic
          in: query
          type: array
        - name: term_side__nie
          in: query
          type: array
        - name: term_side__niew
          in: query
          type: array
        - name: term_side__nisw
          in: query
          type: array
        - name: term_side__regex
          in: query
          type: array
        - name: termination_id
          in: query
          type: array
        - name: termination_id__empty
          in: query
          type: boolean
        - name: termination_id__gt
          in: query
          type: array
        - name: termination_id__gte
          in: query
          type: array
        - name: termination_id__lt
          in: query
          type: array
        - name: termination_id__lte
          in: query
          type: array
        - name: termination_id__n
          in: query
          type: array
        - name: termination_type
          in: query
          type: array
        - name: termination_type__n
          in: query
          type: array
        - name: updated_by_request
          in: query
          type: string
        - name: upstream_speed
          in: query
          type: array
        - name: upstream_speed__empty
          in: query
          type: boolean
        - name: upstream_speed__gt
          in: query
          type: array
        - name: upstream_speed__gte
          in: query
          type: array
        - name: upstream_speed__lt
          in: query
          type: array
        - name: upstream_speed__lte
          in: query
          type: array
        - name: upstream_speed__n
          in: query
          type: array
        - name: xconnect_id
          in: query
          type: array
        - name: xconnect_id__empty
          in: query
          type: boolean
        - name: xconnect_id__ic
          in: query
          type: array
        - name: xconnect_id__ie
          in: query
          type: array
        - name: xconnect_id__iew
          in: query
          type: array
        - name: xconnect_id__iregex
          in: query
          type: array
        - name: xconnect_id__isw
          in: query
          type: array
        - name: xconnect_id__n
          in: query
          type: array
        - name: xconnect_id__nic
          in: query
          type: array
        - name: xconnect_id__nie
          in: query
          type: array
        - name: xconnect_id__niew
          in: query
          type: array
        - name: xconnect_id__nisw
          in: query
          type: array
        - name: xconnect_id__regex
          in: query
          type: array
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-terminations-create
        method: POST
        description: Post a list of circuit termination objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-terminations-bulk-update
        method: PUT
        description: Put a list of circuit termination objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: circuits-circuit-terminations-bulk-partial-updat
        method: PATCH
        description: Patch a list of circuit termination o

# --- truncated at 32 KB (215 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/capabilities/netbox-capability.yaml