NetBox · Capability

NetBox REST API — circuits

NetBox REST API — circuits. 101 operations. Lead operation: circuits. Self-contained Naftiko capability covering one Netbox business surface.

Run with Naftiko Netboxcircuits

What You Can Do

GET
Circuitscircuitgroupassignmentslist — Get a list of Circuit group assignment objects.
/v1/api/circuits/circuit-group-assignments
POST
Circuitscircuitgroupassignmentscreate — Post a list of Circuit group assignment objects.
/v1/api/circuits/circuit-group-assignments
PUT
Circuitscircuitgroupassignmentsbulkupdate — Put a list of Circuit group assignment objects.
/v1/api/circuits/circuit-group-assignments
PATCH
Circuitscircuitgroupassignmentsbulkpartialupdate — Patch a list of Circuit group assignment objects.
/v1/api/circuits/circuit-group-assignments
DELETE
Circuitscircuitgroupassignmentsbulkdestroy — Delete a list of Circuit group assignment objects.
/v1/api/circuits/circuit-group-assignments
GET
Circuitscircuitgroupassignmentsretrieve — Get a Circuit group assignment object.
/v1/api/circuits/circuit-group-assignments/{id}
PUT
Circuitscircuitgroupassignmentsupdate — Put a Circuit group assignment object.
/v1/api/circuits/circuit-group-assignments/{id}
PATCH
Circuitscircuitgroupassignmentspartialupdate — Patch a Circuit group assignment object.
/v1/api/circuits/circuit-group-assignments/{id}
DELETE
Circuitscircuitgroupassignmentsdestroy — Delete a Circuit group assignment object.
/v1/api/circuits/circuit-group-assignments/{id}
GET
Circuitscircuitgroupslist — Get a list of circuit group objects.
/v1/api/circuits/circuit-groups
POST
Circuitscircuitgroupscreate — Post a list of circuit group objects.
/v1/api/circuits/circuit-groups
PUT
Circuitscircuitgroupsbulkupdate — Put a list of circuit group objects.
/v1/api/circuits/circuit-groups
PATCH
Circuitscircuitgroupsbulkpartialupdate — Patch a list of circuit group objects.
/v1/api/circuits/circuit-groups
DELETE
Circuitscircuitgroupsbulkdestroy — Delete a list of circuit group objects.
/v1/api/circuits/circuit-groups
GET
Circuitscircuitgroupsretrieve — Get a circuit group object.
/v1/api/circuits/circuit-groups/{id}
PUT
Circuitscircuitgroupsupdate — Put a circuit group object.
/v1/api/circuits/circuit-groups/{id}
PATCH
Circuitscircuitgroupspartialupdate — Patch a circuit group object.
/v1/api/circuits/circuit-groups/{id}
DELETE
Circuitscircuitgroupsdestroy — Delete a circuit group object.
/v1/api/circuits/circuit-groups/{id}
GET
Circuitscircuitterminationslist — Get a list of circuit termination objects.
/v1/api/circuits/circuit-terminations
POST
Circuitscircuitterminationscreate — Post a list of circuit termination objects.
/v1/api/circuits/circuit-terminations
PUT
Circuitscircuitterminationsbulkupdate — Put a list of circuit termination objects.
/v1/api/circuits/circuit-terminations
PATCH
Circuitscircuitterminationsbulkpartialupdate — Patch a list of circuit termination objects.
/v1/api/circuits/circuit-terminations
DELETE
Circuitscircuitterminationsbulkdestroy — Delete a list of circuit termination objects.
/v1/api/circuits/circuit-terminations
GET
Circuitscircuitterminationsretrieve — Get a circuit termination object.
/v1/api/circuits/circuit-terminations/{id}
PUT
Circuitscircuitterminationsupdate — Put a circuit termination object.
/v1/api/circuits/circuit-terminations/{id}
PATCH
Circuitscircuitterminationspartialupdate — Patch a circuit termination object.
/v1/api/circuits/circuit-terminations/{id}
DELETE
Circuitscircuitterminationsdestroy — Delete a circuit termination object.
/v1/api/circuits/circuit-terminations/{id}
GET
Circuitscircuitterminationspathsretrieve — Return all CablePaths which traverse a given pass-through port.
/v1/api/circuits/circuit-terminations/{id}/paths
GET
Circuitscircuittypeslist — Get a list of circuit type objects.
/v1/api/circuits/circuit-types
POST
Circuitscircuittypescreate — Post a list of circuit type objects.
/v1/api/circuits/circuit-types
PUT
Circuitscircuittypesbulkupdate — Put a list of circuit type objects.
/v1/api/circuits/circuit-types
PATCH
Circuitscircuittypesbulkpartialupdate — Patch a list of circuit type objects.
/v1/api/circuits/circuit-types
DELETE
Circuitscircuittypesbulkdestroy — Delete a list of circuit type objects.
/v1/api/circuits/circuit-types
GET
Circuitscircuittypesretrieve — Get a circuit type object.
/v1/api/circuits/circuit-types/{id}
PUT
Circuitscircuittypesupdate — Put a circuit type object.
/v1/api/circuits/circuit-types/{id}
PATCH
Circuitscircuittypespartialupdate — Patch a circuit type object.
/v1/api/circuits/circuit-types/{id}
DELETE
Circuitscircuittypesdestroy — Delete a circuit type object.
/v1/api/circuits/circuit-types/{id}
GET
Circuitscircuitslist — Get a list of circuit objects.
/v1/api/circuits/circuits
POST
Circuitscircuitscreate — Post a list of circuit objects.
/v1/api/circuits/circuits
PUT
Circuitscircuitsbulkupdate — Put a list of circuit objects.
/v1/api/circuits/circuits
PATCH
Circuitscircuitsbulkpartialupdate — Patch a list of circuit objects.
/v1/api/circuits/circuits
DELETE
Circuitscircuitsbulkdestroy — Delete a list of circuit objects.
/v1/api/circuits/circuits
GET
Circuitscircuitsretrieve — Get a circuit object.
/v1/api/circuits/circuits/{id}
PUT
Circuitscircuitsupdate — Put a circuit object.
/v1/api/circuits/circuits/{id}
PATCH
Circuitscircuitspartialupdate — Patch a circuit object.
/v1/api/circuits/circuits/{id}
DELETE
Circuitscircuitsdestroy — Delete a circuit object.
/v1/api/circuits/circuits/{id}
GET
Circuitsprovideraccountslist — Get a list of provider account objects.
/v1/api/circuits/provider-accounts
POST
Circuitsprovideraccountscreate — Post a list of provider account objects.
/v1/api/circuits/provider-accounts
PUT
Circuitsprovideraccountsbulkupdate — Put a list of provider account objects.
/v1/api/circuits/provider-accounts
PATCH
Circuitsprovideraccountsbulkpartialupdate — Patch a list of provider account objects.
/v1/api/circuits/provider-accounts
DELETE
Circuitsprovideraccountsbulkdestroy — Delete a list of provider account objects.
/v1/api/circuits/provider-accounts
GET
Circuitsprovideraccountsretrieve — Get a provider account object.
/v1/api/circuits/provider-accounts/{id}
PUT
Circuitsprovideraccountsupdate — Put a provider account object.
/v1/api/circuits/provider-accounts/{id}
PATCH
Circuitsprovideraccountspartialupdate — Patch a provider account object.
/v1/api/circuits/provider-accounts/{id}
DELETE
Circuitsprovideraccountsdestroy — Delete a provider account object.
/v1/api/circuits/provider-accounts/{id}
GET
Circuitsprovidernetworkslist — Get a list of provider network objects.
/v1/api/circuits/provider-networks
POST
Circuitsprovidernetworkscreate — Post a list of provider network objects.
/v1/api/circuits/provider-networks
PUT
Circuitsprovidernetworksbulkupdate — Put a list of provider network objects.
/v1/api/circuits/provider-networks
PATCH
Circuitsprovidernetworksbulkpartialupdate — Patch a list of provider network objects.
/v1/api/circuits/provider-networks
DELETE
Circuitsprovidernetworksbulkdestroy — Delete a list of provider network objects.
/v1/api/circuits/provider-networks
GET
Circuitsprovidernetworksretrieve — Get a provider network object.
/v1/api/circuits/provider-networks/{id}
PUT
Circuitsprovidernetworksupdate — Put a provider network object.
/v1/api/circuits/provider-networks/{id}
PATCH
Circuitsprovidernetworkspartialupdate — Patch a provider network object.
/v1/api/circuits/provider-networks/{id}
DELETE
Circuitsprovidernetworksdestroy — Delete a provider network object.
/v1/api/circuits/provider-networks/{id}
GET
Circuitsproviderslist — Get a list of provider objects.
/v1/api/circuits/providers
POST
Circuitsproviderscreate — Post a list of provider objects.
/v1/api/circuits/providers
PUT
Circuitsprovidersbulkupdate — Put a list of provider objects.
/v1/api/circuits/providers
PATCH
Circuitsprovidersbulkpartialupdate — Patch a list of provider objects.
/v1/api/circuits/providers
DELETE
Circuitsprovidersbulkdestroy — Delete a list of provider objects.
/v1/api/circuits/providers
GET
Circuitsprovidersretrieve — Get a provider object.
/v1/api/circuits/providers/{id}
PUT
Circuitsprovidersupdate — Put a provider object.
/v1/api/circuits/providers/{id}
PATCH
Circuitsproviderspartialupdate — Patch a provider object.
/v1/api/circuits/providers/{id}
DELETE
Circuitsprovidersdestroy — Delete a provider object.
/v1/api/circuits/providers/{id}
GET
Circuitsvirtualcircuitterminationslist — Get a list of virtual circuit termination objects.
/v1/api/circuits/virtual-circuit-terminations
POST
Circuitsvirtualcircuitterminationscreate — Post a list of virtual circuit termination objects.
/v1/api/circuits/virtual-circuit-terminations
PUT
Circuitsvirtualcircuitterminationsbulkupdate — Put a list of virtual circuit termination objects.
/v1/api/circuits/virtual-circuit-terminations
PATCH
Circuitsvirtualcircuitterminationsbulkpartialupdate — Patch a list of virtual circuit termination objects.
/v1/api/circuits/virtual-circuit-terminations
DELETE
Circuitsvirtualcircuitterminationsbulkdestroy — Delete a list of virtual circuit termination objects.
/v1/api/circuits/virtual-circuit-terminations
GET
Circuitsvirtualcircuitterminationsretrieve — Get a virtual circuit termination object.
/v1/api/circuits/virtual-circuit-terminations/{id}
PUT
Circuitsvirtualcircuitterminationsupdate — Put a virtual circuit termination object.
/v1/api/circuits/virtual-circuit-terminations/{id}
PATCH
Circuitsvirtualcircuitterminationspartialupdate — Patch a virtual circuit termination object.
/v1/api/circuits/virtual-circuit-terminations/{id}
DELETE
Circuitsvirtualcircuitterminationsdestroy — Delete a virtual circuit termination object.
/v1/api/circuits/virtual-circuit-terminations/{id}
GET
Circuitsvirtualcircuitterminationspathsretrieve — Return all CablePaths which traverse a given pass-through port.
/v1/api/circuits/virtual-circuit-terminations/{id}/paths
GET
Circuitsvirtualcircuittypeslist — Get a list of virtual circuit type objects.
/v1/api/circuits/virtual-circuit-types
POST
Circuitsvirtualcircuittypescreate — Post a list of virtual circuit type objects.
/v1/api/circuits/virtual-circuit-types
PUT
Circuitsvirtualcircuittypesbulkupdate — Put a list of virtual circuit type objects.
/v1/api/circuits/virtual-circuit-types
PATCH
Circuitsvirtualcircuittypesbulkpartialupdate — Patch a list of virtual circuit type objects.
/v1/api/circuits/virtual-circuit-types
DELETE
Circuitsvirtualcircuittypesbulkdestroy — Delete a list of virtual circuit type objects.
/v1/api/circuits/virtual-circuit-types
GET
Circuitsvirtualcircuittypesretrieve — Get a virtual circuit type object.
/v1/api/circuits/virtual-circuit-types/{id}
PUT
Circuitsvirtualcircuittypesupdate — Put a virtual circuit type object.
/v1/api/circuits/virtual-circuit-types/{id}
PATCH
Circuitsvirtualcircuittypespartialupdate — Patch a virtual circuit type object.
/v1/api/circuits/virtual-circuit-types/{id}
DELETE
Circuitsvirtualcircuittypesdestroy — Delete a virtual circuit type object.
/v1/api/circuits/virtual-circuit-types/{id}
GET
Circuitsvirtualcircuitslist — Get a list of virtual circuit objects.
/v1/api/circuits/virtual-circuits
POST
Circuitsvirtualcircuitscreate — Post a list of virtual circuit objects.
/v1/api/circuits/virtual-circuits
PUT
Circuitsvirtualcircuitsbulkupdate — Put a list of virtual circuit objects.
/v1/api/circuits/virtual-circuits
PATCH
Circuitsvirtualcircuitsbulkpartialupdate — Patch a list of virtual circuit objects.
/v1/api/circuits/virtual-circuits
DELETE
Circuitsvirtualcircuitsbulkdestroy — Delete a list of virtual circuit objects.
/v1/api/circuits/virtual-circuits
GET
Circuitsvirtualcircuitsretrieve — Get a virtual circuit object.
/v1/api/circuits/virtual-circuits/{id}
PUT
Circuitsvirtualcircuitsupdate — Put a virtual circuit object.
/v1/api/circuits/virtual-circuits/{id}
PATCH
Circuitsvirtualcircuitspartialupdate — Patch a virtual circuit object.
/v1/api/circuits/virtual-circuits/{id}
DELETE
Circuitsvirtualcircuitsdestroy — Delete a virtual circuit object.
/v1/api/circuits/virtual-circuits/{id}

MCP Tools

get-list-circuit-group-assignment

Get a list of Circuit group assignment objects.

read-only idempotent
post-list-circuit-group-assignment

Post a list of Circuit group assignment objects.

read-only
put-list-circuit-group-assignment

Put a list of Circuit group assignment objects.

idempotent
patch-list-circuit-group-assignment

Patch a list of Circuit group assignment objects.

idempotent
delete-list-circuit-group-assignment

Delete a list of Circuit group assignment objects.

idempotent
get-circuit-group-assignment-object

Get a Circuit group assignment object.

read-only idempotent
put-circuit-group-assignment-object

Put a Circuit group assignment object.

idempotent
patch-circuit-group-assignment-object

Patch a Circuit group assignment object.

idempotent
delete-circuit-group-assignment-object

Delete a Circuit group assignment object.

idempotent
get-list-circuit-group-objects

Get a list of circuit group objects.

read-only idempotent
post-list-circuit-group-objects

Post a list of circuit group objects.

read-only
put-list-circuit-group-objects

Put a list of circuit group objects.

idempotent
patch-list-circuit-group-objects

Patch a list of circuit group objects.

idempotent
delete-list-circuit-group-objects

Delete a list of circuit group objects.

idempotent
get-circuit-group-object

Get a circuit group object.

read-only idempotent
put-circuit-group-object

Put a circuit group object.

idempotent
patch-circuit-group-object

Patch a circuit group object.

idempotent
delete-circuit-group-object

Delete a circuit group object.

idempotent
get-list-circuit-termination-objects

Get a list of circuit termination objects.

read-only idempotent
post-list-circuit-termination-objects

Post a list of circuit termination objects.

read-only
put-list-circuit-termination-objects

Put a list of circuit termination objects.

idempotent
patch-list-circuit-termination-objects

Patch a list of circuit termination objects.

idempotent
delete-list-circuit-termination-objects

Delete a list of circuit termination objects.

idempotent
get-circuit-termination-object

Get a circuit termination object.

read-only idempotent
put-circuit-termination-object

Put a circuit termination object.

idempotent
patch-circuit-termination-object

Patch a circuit termination object.

idempotent
delete-circuit-termination-object

Delete a circuit termination object.

idempotent
return-all-cablepaths-which-traverse

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

read-only idempotent
get-list-circuit-type-objects

Get a list of circuit type objects.

read-only idempotent
post-list-circuit-type-objects

Post a list of circuit type objects.

read-only
put-list-circuit-type-objects

Put a list of circuit type objects.

idempotent
patch-list-circuit-type-objects

Patch a list of circuit type objects.

idempotent
delete-list-circuit-type-objects

Delete a list of circuit type objects.

idempotent
get-circuit-type-object

Get a circuit type object.

read-only idempotent
put-circuit-type-object

Put a circuit type object.

idempotent
patch-circuit-type-object

Patch a circuit type object.

idempotent
delete-circuit-type-object

Delete a circuit type object.

idempotent
get-list-circuit-objects

Get a list of circuit objects.

read-only idempotent
post-list-circuit-objects

Post a list of circuit objects.

read-only
put-list-circuit-objects

Put a list of circuit objects.

idempotent
patch-list-circuit-objects

Patch a list of circuit objects.

idempotent
delete-list-circuit-objects

Delete a list of circuit objects.

idempotent
get-circuit-object

Get a circuit object.

read-only idempotent
put-circuit-object

Put a circuit object.

idempotent
patch-circuit-object

Patch a circuit object.

idempotent
delete-circuit-object

Delete a circuit object.

idempotent
get-list-provider-account-objects

Get a list of provider account objects.

read-only idempotent
post-list-provider-account-objects

Post a list of provider account objects.

read-only
put-list-provider-account-objects

Put a list of provider account objects.

idempotent
patch-list-provider-account-objects

Patch a list of provider account objects.

idempotent
delete-list-provider-account-objects

Delete a list of provider account objects.

idempotent
get-provider-account-object

Get a provider account object.

read-only idempotent
put-provider-account-object

Put a provider account object.

idempotent
patch-provider-account-object

Patch a provider account object.

idempotent
delete-provider-account-object

Delete a provider account object.

idempotent
get-list-provider-network-objects

Get a list of provider network objects.

read-only idempotent
post-list-provider-network-objects

Post a list of provider network objects.

read-only
put-list-provider-network-objects

Put a list of provider network objects.

idempotent
patch-list-provider-network-objects

Patch a list of provider network objects.

idempotent
delete-list-provider-network-objects

Delete a list of provider network objects.

idempotent
get-provider-network-object

Get a provider network object.

read-only idempotent
put-provider-network-object

Put a provider network object.

idempotent
patch-provider-network-object

Patch a provider network object.

idempotent
delete-provider-network-object

Delete a provider network object.

idempotent
get-list-provider-objects

Get a list of provider objects.

read-only idempotent
post-list-provider-objects

Post a list of provider objects.

read-only
put-list-provider-objects

Put a list of provider objects.

idempotent
patch-list-provider-objects

Patch a list of provider objects.

idempotent
delete-list-provider-objects

Delete a list of provider objects.

idempotent
get-provider-object

Get a provider object.

read-only idempotent
put-provider-object

Put a provider object.

idempotent
patch-provider-object

Patch a provider object.

idempotent
delete-provider-object

Delete a provider object.

idempotent
get-list-virtual-circuit-termination

Get a list of virtual circuit termination objects.

read-only idempotent
post-list-virtual-circuit-termination

Post a list of virtual circuit termination objects.

read-only
put-list-virtual-circuit-termination

Put a list of virtual circuit termination objects.

idempotent
patch-list-virtual-circuit-termination

Patch a list of virtual circuit termination objects.

idempotent
delete-list-virtual-circuit-termination

Delete a list of virtual circuit termination objects.

idempotent
get-virtual-circuit-termination-object

Get a virtual circuit termination object.

read-only idempotent
put-virtual-circuit-termination-object

Put a virtual circuit termination object.

idempotent
patch-virtual-circuit-termination-object

Patch a virtual circuit termination object.

idempotent
delete-virtual-circuit-termination-object

Delete a virtual circuit termination object.

idempotent
return-all-cablepaths-which-traverse-2

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

read-only idempotent
get-list-virtual-circuit-type

Get a list of virtual circuit type objects.

read-only idempotent
post-list-virtual-circuit-type

Post a list of virtual circuit type objects.

read-only
put-list-virtual-circuit-type

Put a list of virtual circuit type objects.

idempotent
patch-list-virtual-circuit-type

Patch a list of virtual circuit type objects.

idempotent
delete-list-virtual-circuit-type

Delete a list of virtual circuit type objects.

idempotent
get-virtual-circuit-type-object

Get a virtual circuit type object.

read-only idempotent
put-virtual-circuit-type-object

Put a virtual circuit type object.

idempotent
patch-virtual-circuit-type-object

Patch a virtual circuit type object.

idempotent
delete-virtual-circuit-type-object

Delete a virtual circuit type object.

idempotent
get-list-virtual-circuit-objects

Get a list of virtual circuit objects.

read-only idempotent
post-list-virtual-circuit-objects

Post a list of virtual circuit objects.

read-only
put-list-virtual-circuit-objects

Put a list of virtual circuit objects.

idempotent
patch-list-virtual-circuit-objects

Patch a list of virtual circuit objects.

idempotent
delete-list-virtual-circuit-objects

Delete a list of virtual circuit objects.

idempotent
get-virtual-circuit-object

Get a virtual circuit object.

read-only idempotent
put-virtual-circuit-object

Put a virtual circuit object.

idempotent
patch-virtual-circuit-object

Patch a virtual circuit object.

idempotent
delete-virtual-circuit-object

Delete a virtual circuit object.

idempotent

Capability Spec

netbox-circuits.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: NetBox REST API — circuits
  description: 'NetBox REST API — circuits. 101 operations. Lead operation: circuits. Self-contained Naftiko capability covering
    one Netbox business surface.'
  tags:
  - Netbox
  - circuits
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBOX_API_KEY: NETBOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbox-circuits
    baseUri: ''
    description: NetBox REST API — circuits business capability. Self-contained, no shared references.
    resources:
    - name: api-circuits-circuit-group-assignments
      path: /api/circuits/circuit-group-assignments/
      operations:
      - name: circuitscircuitgroupassignmentslist
        method: GET
        description: Get a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        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'
        - 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'
        - 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
      - name: circuitscircuitgroupassignmentscreate
        method: POST
        description: Post a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupassignmentsbulkupdate
        method: PUT
        description: Put a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupassignmentsbulkpartialupdate
        method: PATCH
        description: Patch a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupassignmentsbulkdestroy
        method: DELETE
        description: Delete a list of Circuit group assignment objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-circuits-circuit-group-assignments-id
      path: /api/circuits/circuit-group-assignments/{id}/
      operations:
      - name: circuitscircuitgroupassignmentsretrieve
        method: GET
        description: Get a Circuit group assignment object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this Circuit group assignment.
          required: true
      - name: circuitscircuitgroupassignmentsupdate
        method: PUT
        description: Put a Circuit group assignment object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this Circuit group assignment.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupassignmentspartialupdate
        method: PATCH
        description: Patch a Circuit group assignment object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this Circuit group assignment.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: circuitscircuitgroupassignmentsdestroy
        method: DELETE
        description: Delete a Circuit group assignment object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this Circuit group assignment.
          required: true
    - name: api-circuits-circuit-groups
      path: /api/circuits/circuit-groups/
      operations:
      - name: circuitscircuitgroupslist
        method: GET
        description: Get a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        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
      - name: circuitscircuitgroupscreate
        method: POST
        description: Post a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupsbulkupdate
        method: PUT
        description: Put a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupsbulkpartialupdate
        method: PATCH
        description: Patch a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupsbulkdestroy
        method: DELETE
        description: Delete a list of circuit group objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-circuits-circuit-groups-id
      path: /api/circuits/circuit-groups/{id}/
      operations:
      - name: circuitscircuitgroupsretrieve
        method: GET
        description: Get a circuit group object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this circuit group.
          required: true
      - name: circuitscircuitgroupsupdate
        method: PUT
        description: Put a circuit group object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this circuit group.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: circuitscircuitgroupspartialupdate
        method: PATCH
        description: Patch a circuit group object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this circuit group.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: circuitscircuitgroupsdestroy
        method: DELETE
        description: Delete a circuit group object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this circuit group.
          required: true
    - name: api-circuits-circuit-terminations
      path: /api/circuits/circuit-terminations/
      operations:
      - name: circuitscircuitterminationslist
        method: GET
        description: Get a list of circuit termination objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        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'
        - 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'
        - 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'
        - 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'
        - 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: xco

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