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: 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 - name: circuitscircuitterminationscreate method: POST description: Post a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitterminationsbulkupdate method: PUT description: Put a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitterminationsbulkpartialupdate method: PATCH description: Patch a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitterminationsbulkdestroy method: DELETE description: Delete a list of circuit termination 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-terminations-id path: /api/circuits/circuit-terminations/{id}/ operations: - name: circuitscircuitterminationsretrieve method: GET description: Get a circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit termination. required: true - name: circuitscircuitterminationsupdate method: PUT description: Put a circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit termination. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitterminationspartialupdate method: PATCH description: Patch a circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit termination. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitscircuitterminationsdestroy method: DELETE description: Delete a circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit termination. required: true - name: api-circuits-circuit-terminations-id-paths path: /api/circuits/circuit-terminations/{id}/paths/ operations: - name: circuitscircuitterminationspathsretrieve method: GET description: Return all CablePaths which traverse a given pass-through port. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit termination. required: true - name: api-circuits-circuit-types path: /api/circuits/circuit-types/ operations: - name: circuitscircuittypeslist method: GET description: Get a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: color in: query type: array - name: color__empty in: query type: boolean - name: color__ic in: query type: array - name: color__ie in: query type: array - name: color__iew in: query type: array - name: color__iregex in: query type: array - name: color__isw in: query type: array - name: color__n in: query type: array - name: color__nic in: query type: array - name: color__nie in: query type: array - name: color__niew in: query type: array - name: color__nisw in: query type: array - name: color__regex 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: 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: updated_by_request in: query type: string - name: circuitscircuittypescreate method: POST description: Post a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuittypesbulkupdate method: PUT description: Put a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuittypesbulkpartialupdate method: PATCH description: Patch a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuittypesbulkdestroy method: DELETE description: Delete a list of circuit type 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-types-id path: /api/circuits/circuit-types/{id}/ operations: - name: circuitscircuittypesretrieve method: GET description: Get a circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit type. required: true - name: circuitscircuittypesupdate method: PUT description: Put a circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit type. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuittypespartialupdate method: PATCH description: Patch a circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit type. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitscircuittypesdestroy method: DELETE description: Delete a circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit type. required: true - name: api-circuits-circuits path: /api/circuits/circuits/ operations: - name: circuitscircuitslist method: GET description: Get a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: cid in: query type: array - name: cid__empty in: query type: boolean - name: cid__ic in: query type: array - name: cid__ie in: query type: array - name: cid__iew in: query type: array - name: cid__iregex in: query type: array - name: cid__isw in: query type: array - name: cid__n in: query type: array - name: cid__nic in: query type: array - name: cid__nie in: query type: array - name: cid__niew in: query type: array - name: cid__nisw in: query type: array - name: cid__regex in: query type: array - name: commit_rate in: query type: array - name: commit_rate__empty in: query type: boolean - name: commit_rate__gt in: query type: array - name: commit_rate__gte in: query type: array - name: commit_rate__lt in: query type: array - name: commit_rate__lte in: query type: array - name: commit_rate__n in: query type: array - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: distance in: query type: array - name: distance__empty in: query type: boolean - name: distance__gt in: query type: array - name: distance__gte in: query type: array - name: distance__lt in: query type: array - name: distance__lte in: query type: array - name: distance__n in: query type: array - name: distance_unit in: query type: string description: '* `km` - Kilometers' - name: distance_unit__empty in: query type: boolean - name: distance_unit__ic in: query type: array - name: distance_unit__ie in: query type: array - name: distance_unit__iew in: query type: array - name: distance_unit__iregex in: query type: array - name: distance_unit__isw in: query type: array - name: distance_unit__n in: query type: string description: '* `km` - Kilometers' - name: distance_unit__nic in: query type: array - name: distance_unit__nie in: query type: array - name: distance_unit__niew in: query type: array - name: distance_unit__nisw in: query type: array - name: distance_unit__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: install_date in: query type: array - name: install_date__empty in: query type: boolean - name: install_date__gt in: query type: array - name: install_date__gte in: query type: array - name: install_date__lt in: query type: array - name: install_date__lte in: query type: array - name: install_date__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_id in: query type: array description: Location (ID) - name: location_id__n in: query type: array description: Location (ID) - 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: 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: provider in: query type: array description: Provider (slug) - name: provider__n in: query type: array description: Provider (slug) - name: provider_account in: query type: array description: Provider account (account) - name: provider_account__n in: query type: array description: Provider account (account) - name: provider_account_id in: query type: array description: Provider account (ID) - name: provider_account_id__n in: query type: array description: Provider account (ID) - 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: Provider network (ID) - name: provider_network_id__n in: query type: array description: Provider network (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: status in: query type: array - name: status__empty in: query type: boolean - name: status__ic in: query type: array - name: status__ie in: query type: array - name: status__iew in: query type: array - name: status__iregex in: query type: array - name: status__isw in: query type: array - name: status__n in: query type: array - name: status__nic in: query type: array - name: status__nie in: query type: array - name: status__niew in: query type: array - name: status__nisw in: query type: array - name: status__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: termination_a_id in: query type: array description: Termination A (ID) - name: termination_a_id__n in: query type: array description: Termination A (ID) - name: termination_date in: query type: array - name: termination_date__empty in: query type: boolean - name: termination_date__gt in: query type: array - name: termination_date__gte in: query type: array - name: termination_date__lt in: query type: array - name: termination_date__lte in: query type: array - name: termination_date__n in: query type: array - name: termination_z_id in: query type: array description: Termination A (ID) - name: termination_z_id__n in: query type: array description: Termination A (ID) - name: type in: query type: array description: Circuit type (slug) - name: type__n in: query type: array description: Circuit type (slug) - name: type_id in: query type: array description: Circuit type (ID) - name: type_id__n in: query type: array description: Circuit type (ID) - name: updated_by_request in: query type: string - name: circuitscircuitscreate method: POST description: Post a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitsbulkupdate method: PUT description: Put a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitsbulkpartialupdate method: PATCH description: Patch a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitsbulkdestroy method: DELETE description: Delete a list of circuit 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-circuits-id path: /api/circuits/circuits/{id}/ operations: - name: circuitscircuitsretrieve method: GET description: Get a circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit. required: true - name: circuitscircuitsupdate method: PUT description: Put a circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitscircuitspartialupdate method: PATCH description: Patch a circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitscircuitsdestroy method: DELETE description: Delete a circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this circuit. required: true - name: api-circuits-provider-accounts path: /api/circuits/provider-accounts/ operations: - name: circuitsprovideraccountslist method: GET description: Get a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: account in: query type: array - name: account__empty in: query type: boolean - name: account__ic in: query type: array - name: account__ie in: query type: array - name: account__iew in: query type: array - name: account__iregex in: query type: array - name: account__isw in: query type: array - name: account__n in: query type: array - name: account__nic in: query type: array - name: account__nie in: query type: array - name: account__niew in: query type: array - name: account__nisw in: query type: array - name: account__regex in: query type: array - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: 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: 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: circuitsprovideraccountscreate method: POST description: Post a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovideraccountsbulkupdate method: PUT description: Put a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovideraccountsbulkpartialupdate method: PATCH description: Patch a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovideraccountsbulkdestroy method: DELETE description: Delete a list of provider account 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-provider-accounts-id path: /api/circuits/provider-accounts/{id}/ operations: - name: circuitsprovideraccountsretrieve method: GET description: Get a provider account object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider account. required: true - name: circuitsprovideraccountsupdate method: PUT description: Put a provider account object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider account. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovideraccountspartialupdate method: PATCH description: Patch a provider account object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider account. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsprovideraccountsdestroy method: DELETE description: Delete a provider account object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider account. required: true - name: api-circuits-provider-networks path: /api/circuits/provider-networks/ operations: - name: circuitsprovidernetworkslist method: GET description: Get a list of provider network 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: 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: q in: query type: string description: Search - name: service_id in: query type: array - name: service_id__empty in: query type: boolean - name: service_id__ic in: query type: array - name: service_id__ie in: query type: array - name: service_id__iew in: query type: array - name: service_id__iregex in: query type: array - name: service_id__isw in: query type: array - name: service_id__n in: query type: array - name: service_id__nic in: query type: array - name: service_id__nie in: query type: array - name: service_id__niew in: query type: array - name: service_id__nisw in: query type: array - name: service_id__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: updated_by_request in: query type: string - name: circuitsprovidernetworkscreate method: POST description: Post a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidernetworksbulkupdate method: PUT description: Put a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidernetworksbulkpartialupdate method: PATCH description: Patch a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidernetworksbulkdestroy method: DELETE description: Delete a list of provider network 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-provider-networks-id path: /api/circuits/provider-networks/{id}/ operations: - name: circuitsprovidernetworksretrieve method: GET description: Get a provider network object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider network. required: true - name: circuitsprovidernetworksupdate method: PUT description: Put a provider network object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider network. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidernetworkspartialupdate method: PATCH description: Patch a provider network object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider network. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsprovidernetworksdestroy method: DELETE description: Delete a provider network object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider network. required: true - name: api-circuits-providers path: /api/circuits/providers/ operations: - name: circuitsproviderslist method: GET description: Get a list of provider objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: asn in: query type: array description: ASN - name: asn__n in: query type: array description: ASN - name: asn_id in: query type: array description: ASN (ID) - name: asn_id__n in: query type: array description: ASN (ID) - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: 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 - name: site_id__n in: query type: array description: Site - 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: updated_by_request in: query type: string - name: circuitsproviderscreate method: POST description: Post a list of provider objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidersbulkupdate method: PUT description: Put a list of provider objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidersbulkpartialupdate method: PATCH description: Patch a list of provider objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsprovidersbulkdestroy method: DELETE description: Delete a list of provider 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-providers-id path: /api/circuits/providers/{id}/ operations: - name: circuitsprovidersretrieve method: GET description: Get a provider object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider. required: true - name: circuitsprovidersupdate method: PUT description: Put a provider object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsproviderspartialupdate method: PATCH description: Patch a provider object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsprovidersdestroy method: DELETE description: Delete a provider object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this provider. required: true - name: api-circuits-virtual-circuit-terminations path: /api/circuits/virtual-circuit-terminations/ operations: - name: circuitsvirtualcircuitterminationslist method: GET description: Get a list of virtual circuit termination 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: interface_id in: query type: array description: Interface (ID) - name: interface_id__n in: query type: array description: Interface (ID) - 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: 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: provider in: query type: array description: Provider (slug) - name: provider__n in: query type: array description: Provider (slug) - name: provider_account in: query type: array description: Provider account (account) - name: provider_account__n in: query type: array description: Provider account (account) - name: provider_account_id in: query type: array description: Provider account (ID) - name: provider_account_id__n in: query type: array description: Provider account (ID) - 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: Provider network (ID) - name: provider_network_id__n in: query type: array description: Provider network (ID) - name: q in: query type: string description: Search - name: role in: query type: array - name: role__empty in: query type: boolean - name: role__ic in: query type: array - name: role__ie in: query type: array - name: role__iew in: query type: array - name: role__iregex in: query type: array - name: role__isw in: query type: array - name: role__n in: query type: array - name: role__nic in: query type: array - name: role__nie in: query type: array - name: role__niew in: query type: array - name: role__nisw in: query type: array - name: role__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: updated_by_request in: query type: string - name: virtual_circuit_id in: query type: array description: Virtual circuit - name: virtual_circuit_id__n in: query type: array description: Virtual circuit - name: circuitsvirtualcircuitterminationscreate method: POST description: Post a list of virtual circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitterminationsbulkupdate method: PUT description: Put a list of virtual circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitterminationsbulkpartialupdate method: PATCH description: Patch a list of virtual circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitterminationsbulkdestroy method: DELETE description: Delete a list of virtual circuit termination 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-virtual-circuit-terminations-id path: /api/circuits/virtual-circuit-terminations/{id}/ operations: - name: circuitsvirtualcircuitterminationsretrieve method: GET description: Get a virtual circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit termination. required: true - name: circuitsvirtualcircuitterminationsupdate method: PUT description: Put a virtual circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit termination. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitterminationspartialupdate method: PATCH description: Patch a virtual circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit termination. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsvirtualcircuitterminationsdestroy method: DELETE description: Delete a virtual circuit termination object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit termination. required: true - name: api-circuits-virtual-circuit-terminations-id-paths path: /api/circuits/virtual-circuit-terminations/{id}/paths/ operations: - name: circuitsvirtualcircuitterminationspathsretrieve method: GET description: Return all CablePaths which traverse a given pass-through port. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit termination. required: true - name: api-circuits-virtual-circuit-types path: /api/circuits/virtual-circuit-types/ operations: - name: circuitsvirtualcircuittypeslist method: GET description: Get a list of virtual circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: color in: query type: array - name: color__empty in: query type: boolean - name: color__ic in: query type: array - name: color__ie in: query type: array - name: color__iew in: query type: array - name: color__iregex in: query type: array - name: color__isw in: query type: array - name: color__n in: query type: array - name: color__nic in: query type: array - name: color__nie in: query type: array - name: color__niew in: query type: array - name: color__nisw in: query type: array - name: color__regex 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: 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: updated_by_request in: query type: string - name: circuitsvirtualcircuittypescreate method: POST description: Post a list of virtual circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuittypesbulkupdate method: PUT description: Put a list of virtual circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuittypesbulkpartialupdate method: PATCH description: Patch a list of virtual circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuittypesbulkdestroy method: DELETE description: Delete a list of virtual circuit type 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-virtual-circuit-types-id path: /api/circuits/virtual-circuit-types/{id}/ operations: - name: circuitsvirtualcircuittypesretrieve method: GET description: Get a virtual circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit type. required: true - name: circuitsvirtualcircuittypesupdate method: PUT description: Put a virtual circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit type. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuittypespartialupdate method: PATCH description: Patch a virtual circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit type. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsvirtualcircuittypesdestroy method: DELETE description: Delete a virtual circuit type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit type. required: true - name: api-circuits-virtual-circuits path: /api/circuits/virtual-circuits/ operations: - name: circuitsvirtualcircuitslist method: GET description: Get a list of virtual circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: cid in: query type: array - name: cid__empty in: query type: boolean - name: cid__ic in: query type: array - name: cid__ie in: query type: array - name: cid__iew in: query type: array - name: cid__iregex in: query type: array - name: cid__isw in: query type: array - name: cid__n in: query type: array - name: cid__nic in: query type: array - name: cid__nie in: query type: array - name: cid__niew in: query type: array - name: cid__nisw in: query type: array - name: cid__regex 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: 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: 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: provider in: query type: array description: Provider (slug) - name: provider__n in: query type: array description: Provider (slug) - name: provider_account in: query type: array description: Provider account (account) - name: provider_account__n in: query type: array description: Provider account (account) - name: provider_account_id in: query type: array description: Provider account (ID) - name: provider_account_id__n in: query type: array description: Provider account (ID) - 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: Provider network (ID) - name: provider_network_id__n in: query type: array description: Provider network (ID) - name: q in: query type: string description: Search - name: status in: query type: array - name: status__empty in: query type: boolean - name: status__ic in: query type: array - name: status__ie in: query type: array - name: status__iew in: query type: array - name: status__iregex in: query type: array - name: status__isw in: query type: array - name: status__n in: query type: array - name: status__nic in: query type: array - name: status__nie in: query type: array - name: status__niew in: query type: array - name: status__nisw in: query type: array - name: status__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: type in: query type: array description: Virtual circuit type (slug) - name: type__n in: query type: array description: Virtual circuit type (slug) - name: type_id in: query type: array description: Virtual circuit type (ID) - name: type_id__n in: query type: array description: Virtual circuit type (ID) - name: updated_by_request in: query type: string - name: circuitsvirtualcircuitscreate method: POST description: Post a list of virtual circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitsbulkupdate method: PUT description: Put a list of virtual circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitsbulkpartialupdate method: PATCH description: Patch a list of virtual circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitsbulkdestroy method: DELETE description: Delete a list of virtual circuit 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-virtual-circuits-id path: /api/circuits/virtual-circuits/{id}/ operations: - name: circuitsvirtualcircuitsretrieve method: GET description: Get a virtual circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit. required: true - name: circuitsvirtualcircuitsupdate method: PUT description: Put a virtual circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: circuitsvirtualcircuitspartialupdate method: PATCH description: Patch a virtual circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: circuitsvirtualcircuitsdestroy method: DELETE description: Delete a virtual circuit object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual circuit. required: true authentication: type: apikey key: sessionid value: '{{env.NETBOX_API_KEY}}' placement: cookie exposes: - type: rest namespace: netbox-circuits-rest port: 8080 description: REST adapter for NetBox REST API — circuits. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/circuits/circuit-group-assignments name: api-circuits-circuit-group-assignments description: REST surface for api-circuits-circuit-group-assignments. operations: - method: GET name: circuitscircuitgroupassignmentslist description: Get a list of Circuit group assignment objects. call: netbox-circuits.circuitscircuitgroupassignmentslist with: circuit: rest.circuit circuit_id: rest.circuit_id created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit member_id: rest.member_id member_id__empty: rest.member_id__empty member_id__gt: rest.member_id__gt member_id__gte: rest.member_id__gte member_id__lt: rest.member_id__lt member_id__lte: rest.member_id__lte member_id__n: rest.member_id__n member_type: rest.member_type member_type__n: rest.member_type__n modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering priority: rest.priority priority__empty: rest.priority__empty priority__ic: rest.priority__ic priority__ie: rest.priority__ie priority__iew: rest.priority__iew priority__iregex: rest.priority__iregex priority__isw: rest.priority__isw priority__n: rest.priority__n priority__nic: rest.priority__nic priority__nie: rest.priority__nie priority__niew: rest.priority__niew priority__nisw: rest.priority__nisw priority__regex: rest.priority__regex provider: rest.provider provider_id: rest.provider_id q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request virtual_circuit: rest.virtual_circuit virtual_circuit_id: rest.virtual_circuit_id outputParameters: - type: object mapping: $. - method: POST name: circuitscircuitgroupassignmentscreate description: Post a list of Circuit group assignment objects. call: netbox-circuits.circuitscircuitgroupassignmentscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitgroupassignmentsbulkupdate description: Put a list of Circuit group assignment objects. call: netbox-circuits.circuitscircuitgroupassignmentsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitgroupassignmentsbulkpartialupdate description: Patch a list of Circuit group assignment objects. call: netbox-circuits.circuitscircuitgroupassignmentsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitgroupassignmentsbulkdestroy description: Delete a list of Circuit group assignment objects. call: netbox-circuits.circuitscircuitgroupassignmentsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-group-assignments/{id} name: api-circuits-circuit-group-assignments-id description: REST surface for api-circuits-circuit-group-assignments-id. operations: - method: GET name: circuitscircuitgroupassignmentsretrieve description: Get a Circuit group assignment object. call: netbox-circuits.circuitscircuitgroupassignmentsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitgroupassignmentsupdate description: Put a Circuit group assignment object. call: netbox-circuits.circuitscircuitgroupassignmentsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitgroupassignmentspartialupdate description: Patch a Circuit group assignment object. call: netbox-circuits.circuitscircuitgroupassignmentspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitgroupassignmentsdestroy description: Delete a Circuit group assignment object. call: netbox-circuits.circuitscircuitgroupassignmentsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-groups name: api-circuits-circuit-groups description: REST surface for api-circuits-circuit-groups. operations: - method: GET name: circuitscircuitgroupslist description: Get a list of circuit group objects. call: netbox-circuits.circuitscircuitgroupslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitscircuitgroupscreate description: Post a list of circuit group objects. call: netbox-circuits.circuitscircuitgroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitgroupsbulkupdate description: Put a list of circuit group objects. call: netbox-circuits.circuitscircuitgroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitgroupsbulkpartialupdate description: Patch a list of circuit group objects. call: netbox-circuits.circuitscircuitgroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitgroupsbulkdestroy description: Delete a list of circuit group objects. call: netbox-circuits.circuitscircuitgroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-groups/{id} name: api-circuits-circuit-groups-id description: REST surface for api-circuits-circuit-groups-id. operations: - method: GET name: circuitscircuitgroupsretrieve description: Get a circuit group object. call: netbox-circuits.circuitscircuitgroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitgroupsupdate description: Put a circuit group object. call: netbox-circuits.circuitscircuitgroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitgroupspartialupdate description: Patch a circuit group object. call: netbox-circuits.circuitscircuitgroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitgroupsdestroy description: Delete a circuit group object. call: netbox-circuits.circuitscircuitgroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-terminations name: api-circuits-circuit-terminations description: REST surface for api-circuits-circuit-terminations. operations: - method: GET name: circuitscircuitterminationslist description: Get a list of circuit termination objects. call: netbox-circuits.circuitscircuitterminationslist with: cable_connector: rest.cable_connector cable_connector__empty: rest.cable_connector__empty cable_connector__gt: rest.cable_connector__gt cable_connector__gte: rest.cable_connector__gte cable_connector__lt: rest.cable_connector__lt cable_connector__lte: rest.cable_connector__lte cable_connector__n: rest.cable_connector__n cable_end: rest.cable_end cable_end__empty: rest.cable_end__empty cable_end__ic: rest.cable_end__ic cable_end__ie: rest.cable_end__ie cable_end__iew: rest.cable_end__iew cable_end__iregex: rest.cable_end__iregex cable_end__isw: rest.cable_end__isw cable_end__n: rest.cable_end__n cable_end__nic: rest.cable_end__nic cable_end__nie: rest.cable_end__nie cable_end__niew: rest.cable_end__niew cable_end__nisw: rest.cable_end__nisw cable_end__regex: rest.cable_end__regex cable_id: rest.cable_id cable_id__n: rest.cable_id__n cabled: rest.cabled circuit_id: rest.circuit_id circuit_id__n: rest.circuit_id__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit location: rest.location location__n: rest.location__n location_id: rest.location_id location_id__n: rest.location_id__n mark_connected: rest.mark_connected modified_by_request: rest.modified_by_request occupied: rest.occupied offset: rest.offset ordering: rest.ordering port_speed: rest.port_speed port_speed__empty: rest.port_speed__empty port_speed__gt: rest.port_speed__gt port_speed__gte: rest.port_speed__gte port_speed__lt: rest.port_speed__lt port_speed__lte: rest.port_speed__lte port_speed__n: rest.port_speed__n pp_info: rest.pp_info pp_info__empty: rest.pp_info__empty pp_info__ic: rest.pp_info__ic pp_info__ie: rest.pp_info__ie pp_info__iew: rest.pp_info__iew pp_info__iregex: rest.pp_info__iregex pp_info__isw: rest.pp_info__isw pp_info__n: rest.pp_info__n pp_info__nic: rest.pp_info__nic pp_info__nie: rest.pp_info__nie pp_info__niew: rest.pp_info__niew pp_info__nisw: rest.pp_info__nisw pp_info__regex: rest.pp_info__regex provider: rest.provider provider__n: rest.provider__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n provider_network_id: rest.provider_network_id provider_network_id__n: rest.provider_network_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n term_side: rest.term_side term_side__empty: rest.term_side__empty term_side__ic: rest.term_side__ic term_side__ie: rest.term_side__ie term_side__iew: rest.term_side__iew term_side__iregex: rest.term_side__iregex term_side__isw: rest.term_side__isw term_side__n: rest.term_side__n term_side__nic: rest.term_side__nic term_side__nie: rest.term_side__nie term_side__niew: rest.term_side__niew term_side__nisw: rest.term_side__nisw term_side__regex: rest.term_side__regex termination_id: rest.termination_id termination_id__empty: rest.termination_id__empty termination_id__gt: rest.termination_id__gt termination_id__gte: rest.termination_id__gte termination_id__lt: rest.termination_id__lt termination_id__lte: rest.termination_id__lte termination_id__n: rest.termination_id__n termination_type: rest.termination_type termination_type__n: rest.termination_type__n updated_by_request: rest.updated_by_request upstream_speed: rest.upstream_speed upstream_speed__empty: rest.upstream_speed__empty upstream_speed__gt: rest.upstream_speed__gt upstream_speed__gte: rest.upstream_speed__gte upstream_speed__lt: rest.upstream_speed__lt upstream_speed__lte: rest.upstream_speed__lte upstream_speed__n: rest.upstream_speed__n xconnect_id: rest.xconnect_id xconnect_id__empty: rest.xconnect_id__empty xconnect_id__ic: rest.xconnect_id__ic xconnect_id__ie: rest.xconnect_id__ie xconnect_id__iew: rest.xconnect_id__iew xconnect_id__iregex: rest.xconnect_id__iregex xconnect_id__isw: rest.xconnect_id__isw xconnect_id__n: rest.xconnect_id__n xconnect_id__nic: rest.xconnect_id__nic xconnect_id__nie: rest.xconnect_id__nie xconnect_id__niew: rest.xconnect_id__niew xconnect_id__nisw: rest.xconnect_id__nisw xconnect_id__regex: rest.xconnect_id__regex outputParameters: - type: object mapping: $. - method: POST name: circuitscircuitterminationscreate description: Post a list of circuit termination objects. call: netbox-circuits.circuitscircuitterminationscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitterminationsbulkupdate description: Put a list of circuit termination objects. call: netbox-circuits.circuitscircuitterminationsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitterminationsbulkpartialupdate description: Patch a list of circuit termination objects. call: netbox-circuits.circuitscircuitterminationsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitterminationsbulkdestroy description: Delete a list of circuit termination objects. call: netbox-circuits.circuitscircuitterminationsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-terminations/{id} name: api-circuits-circuit-terminations-id description: REST surface for api-circuits-circuit-terminations-id. operations: - method: GET name: circuitscircuitterminationsretrieve description: Get a circuit termination object. call: netbox-circuits.circuitscircuitterminationsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitterminationsupdate description: Put a circuit termination object. call: netbox-circuits.circuitscircuitterminationsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitterminationspartialupdate description: Patch a circuit termination object. call: netbox-circuits.circuitscircuitterminationspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitterminationsdestroy description: Delete a circuit termination object. call: netbox-circuits.circuitscircuitterminationsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-terminations/{id}/paths name: api-circuits-circuit-terminations-id-paths description: REST surface for api-circuits-circuit-terminations-id-paths. operations: - method: GET name: circuitscircuitterminationspathsretrieve description: Return all CablePaths which traverse a given pass-through port. call: netbox-circuits.circuitscircuitterminationspathsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-types name: api-circuits-circuit-types description: REST surface for api-circuits-circuit-types. operations: - method: GET name: circuitscircuittypeslist description: Get a list of circuit type objects. call: netbox-circuits.circuitscircuittypeslist with: color: rest.color color__empty: rest.color__empty color__ic: rest.color__ic color__ie: rest.color__ie color__iew: rest.color__iew color__iregex: rest.color__iregex color__isw: rest.color__isw color__n: rest.color__n color__nic: rest.color__nic color__nie: rest.color__nie color__niew: rest.color__niew color__nisw: rest.color__nisw color__regex: rest.color__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitscircuittypescreate description: Post a list of circuit type objects. call: netbox-circuits.circuitscircuittypescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuittypesbulkupdate description: Put a list of circuit type objects. call: netbox-circuits.circuitscircuittypesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuittypesbulkpartialupdate description: Patch a list of circuit type objects. call: netbox-circuits.circuitscircuittypesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuittypesbulkdestroy description: Delete a list of circuit type objects. call: netbox-circuits.circuitscircuittypesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuit-types/{id} name: api-circuits-circuit-types-id description: REST surface for api-circuits-circuit-types-id. operations: - method: GET name: circuitscircuittypesretrieve description: Get a circuit type object. call: netbox-circuits.circuitscircuittypesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuittypesupdate description: Put a circuit type object. call: netbox-circuits.circuitscircuittypesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuittypespartialupdate description: Patch a circuit type object. call: netbox-circuits.circuitscircuittypespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuittypesdestroy description: Delete a circuit type object. call: netbox-circuits.circuitscircuittypesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuits name: api-circuits-circuits description: REST surface for api-circuits-circuits. operations: - method: GET name: circuitscircuitslist description: Get a list of circuit objects. call: netbox-circuits.circuitscircuitslist with: cid: rest.cid cid__empty: rest.cid__empty cid__ic: rest.cid__ic cid__ie: rest.cid__ie cid__iew: rest.cid__iew cid__iregex: rest.cid__iregex cid__isw: rest.cid__isw cid__n: rest.cid__n cid__nic: rest.cid__nic cid__nie: rest.cid__nie cid__niew: rest.cid__niew cid__nisw: rest.cid__nisw cid__regex: rest.cid__regex commit_rate: rest.commit_rate commit_rate__empty: rest.commit_rate__empty commit_rate__gt: rest.commit_rate__gt commit_rate__gte: rest.commit_rate__gte commit_rate__lt: rest.commit_rate__lt commit_rate__lte: rest.commit_rate__lte commit_rate__n: rest.commit_rate__n contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex distance: rest.distance distance__empty: rest.distance__empty distance__gt: rest.distance__gt distance__gte: rest.distance__gte distance__lt: rest.distance__lt distance__lte: rest.distance__lte distance__n: rest.distance__n distance_unit: rest.distance_unit distance_unit__empty: rest.distance_unit__empty distance_unit__ic: rest.distance_unit__ic distance_unit__ie: rest.distance_unit__ie distance_unit__iew: rest.distance_unit__iew distance_unit__iregex: rest.distance_unit__iregex distance_unit__isw: rest.distance_unit__isw distance_unit__n: rest.distance_unit__n distance_unit__nic: rest.distance_unit__nic distance_unit__nie: rest.distance_unit__nie distance_unit__niew: rest.distance_unit__niew distance_unit__nisw: rest.distance_unit__nisw distance_unit__regex: rest.distance_unit__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n install_date: rest.install_date install_date__empty: rest.install_date__empty install_date__gt: rest.install_date__gt install_date__gte: rest.install_date__gte install_date__lt: rest.install_date__lt install_date__lte: rest.install_date__lte install_date__n: rest.install_date__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit location_id: rest.location_id location_id__n: rest.location_id__n modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n provider: rest.provider provider__n: rest.provider__n provider_account: rest.provider_account provider_account__n: rest.provider_account__n provider_account_id: rest.provider_account_id provider_account_id__n: rest.provider_account_id__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n provider_network_id: rest.provider_network_id provider_network_id__n: rest.provider_network_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n termination_a_id: rest.termination_a_id termination_a_id__n: rest.termination_a_id__n termination_date: rest.termination_date termination_date__empty: rest.termination_date__empty termination_date__gt: rest.termination_date__gt termination_date__gte: rest.termination_date__gte termination_date__lt: rest.termination_date__lt termination_date__lte: rest.termination_date__lte termination_date__n: rest.termination_date__n termination_z_id: rest.termination_z_id termination_z_id__n: rest.termination_z_id__n type: rest.type type__n: rest.type__n type_id: rest.type_id type_id__n: rest.type_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitscircuitscreate description: Post a list of circuit objects. call: netbox-circuits.circuitscircuitscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitsbulkupdate description: Put a list of circuit objects. call: netbox-circuits.circuitscircuitsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitsbulkpartialupdate description: Patch a list of circuit objects. call: netbox-circuits.circuitscircuitsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitsbulkdestroy description: Delete a list of circuit objects. call: netbox-circuits.circuitscircuitsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/circuits/{id} name: api-circuits-circuits-id description: REST surface for api-circuits-circuits-id. operations: - method: GET name: circuitscircuitsretrieve description: Get a circuit object. call: netbox-circuits.circuitscircuitsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitscircuitsupdate description: Put a circuit object. call: netbox-circuits.circuitscircuitsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitscircuitspartialupdate description: Patch a circuit object. call: netbox-circuits.circuitscircuitspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitscircuitsdestroy description: Delete a circuit object. call: netbox-circuits.circuitscircuitsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/provider-accounts name: api-circuits-provider-accounts description: REST surface for api-circuits-provider-accounts. operations: - method: GET name: circuitsprovideraccountslist description: Get a list of provider account objects. call: netbox-circuits.circuitsprovideraccountslist with: account: rest.account account__empty: rest.account__empty account__ic: rest.account__ic account__ie: rest.account__ie account__iew: rest.account__iew account__iregex: rest.account__iregex account__isw: rest.account__isw account__n: rest.account__n account__nic: rest.account__nic account__nie: rest.account__nie account__niew: rest.account__niew account__nisw: rest.account__nisw account__regex: rest.account__regex contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n provider: rest.provider provider__n: rest.provider__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitsprovideraccountscreate description: Post a list of provider account objects. call: netbox-circuits.circuitsprovideraccountscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovideraccountsbulkupdate description: Put a list of provider account objects. call: netbox-circuits.circuitsprovideraccountsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsprovideraccountsbulkpartialupdate description: Patch a list of provider account objects. call: netbox-circuits.circuitsprovideraccountsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovideraccountsbulkdestroy description: Delete a list of provider account objects. call: netbox-circuits.circuitsprovideraccountsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/provider-accounts/{id} name: api-circuits-provider-accounts-id description: REST surface for api-circuits-provider-accounts-id. operations: - method: GET name: circuitsprovideraccountsretrieve description: Get a provider account object. call: netbox-circuits.circuitsprovideraccountsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovideraccountsupdate description: Put a provider account object. call: netbox-circuits.circuitsprovideraccountsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsprovideraccountspartialupdate description: Patch a provider account object. call: netbox-circuits.circuitsprovideraccountspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovideraccountsdestroy description: Delete a provider account object. call: netbox-circuits.circuitsprovideraccountsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/provider-networks name: api-circuits-provider-networks description: REST surface for api-circuits-provider-networks. operations: - method: GET name: circuitsprovidernetworkslist description: Get a list of provider network objects. call: netbox-circuits.circuitsprovidernetworkslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n provider: rest.provider provider__n: rest.provider__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n q: rest.q service_id: rest.service_id service_id__empty: rest.service_id__empty service_id__ic: rest.service_id__ic service_id__ie: rest.service_id__ie service_id__iew: rest.service_id__iew service_id__iregex: rest.service_id__iregex service_id__isw: rest.service_id__isw service_id__n: rest.service_id__n service_id__nic: rest.service_id__nic service_id__nie: rest.service_id__nie service_id__niew: rest.service_id__niew service_id__nisw: rest.service_id__nisw service_id__regex: rest.service_id__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitsprovidernetworkscreate description: Post a list of provider network objects. call: netbox-circuits.circuitsprovidernetworkscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovidernetworksbulkupdate description: Put a list of provider network objects. call: netbox-circuits.circuitsprovidernetworksbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsprovidernetworksbulkpartialupdate description: Patch a list of provider network objects. call: netbox-circuits.circuitsprovidernetworksbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovidernetworksbulkdestroy description: Delete a list of provider network objects. call: netbox-circuits.circuitsprovidernetworksbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/provider-networks/{id} name: api-circuits-provider-networks-id description: REST surface for api-circuits-provider-networks-id. operations: - method: GET name: circuitsprovidernetworksretrieve description: Get a provider network object. call: netbox-circuits.circuitsprovidernetworksretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovidernetworksupdate description: Put a provider network object. call: netbox-circuits.circuitsprovidernetworksupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsprovidernetworkspartialupdate description: Patch a provider network object. call: netbox-circuits.circuitsprovidernetworkspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovidernetworksdestroy description: Delete a provider network object. call: netbox-circuits.circuitsprovidernetworksdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/providers name: api-circuits-providers description: REST surface for api-circuits-providers. operations: - method: GET name: circuitsproviderslist description: Get a list of provider objects. call: netbox-circuits.circuitsproviderslist with: asn: rest.asn asn__n: rest.asn__n asn_id: rest.asn_id asn_id__n: rest.asn_id__n contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitsproviderscreate description: Post a list of provider objects. call: netbox-circuits.circuitsproviderscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovidersbulkupdate description: Put a list of provider objects. call: netbox-circuits.circuitsprovidersbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsprovidersbulkpartialupdate description: Patch a list of provider objects. call: netbox-circuits.circuitsprovidersbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovidersbulkdestroy description: Delete a list of provider objects. call: netbox-circuits.circuitsprovidersbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/providers/{id} name: api-circuits-providers-id description: REST surface for api-circuits-providers-id. operations: - method: GET name: circuitsprovidersretrieve description: Get a provider object. call: netbox-circuits.circuitsprovidersretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsprovidersupdate description: Put a provider object. call: netbox-circuits.circuitsprovidersupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsproviderspartialupdate description: Patch a provider object. call: netbox-circuits.circuitsproviderspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsprovidersdestroy description: Delete a provider object. call: netbox-circuits.circuitsprovidersdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuit-terminations name: api-circuits-virtual-circuit-terminations description: REST surface for api-circuits-virtual-circuit-terminations. operations: - method: GET name: circuitsvirtualcircuitterminationslist description: Get a list of virtual circuit termination objects. call: netbox-circuits.circuitsvirtualcircuitterminationslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n interface_id: rest.interface_id interface_id__n: rest.interface_id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering provider: rest.provider provider__n: rest.provider__n provider_account: rest.provider_account provider_account__n: rest.provider_account__n provider_account_id: rest.provider_account_id provider_account_id__n: rest.provider_account_id__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n provider_network_id: rest.provider_network_id provider_network_id__n: rest.provider_network_id__n q: rest.q role: rest.role role__empty: rest.role__empty role__ic: rest.role__ic role__ie: rest.role__ie role__iew: rest.role__iew role__iregex: rest.role__iregex role__isw: rest.role__isw role__n: rest.role__n role__nic: rest.role__nic role__nie: rest.role__nie role__niew: rest.role__niew role__nisw: rest.role__nisw role__regex: rest.role__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request virtual_circuit_id: rest.virtual_circuit_id virtual_circuit_id__n: rest.virtual_circuit_id__n outputParameters: - type: object mapping: $. - method: POST name: circuitsvirtualcircuitterminationscreate description: Post a list of virtual circuit termination objects. call: netbox-circuits.circuitsvirtualcircuitterminationscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuitterminationsbulkupdate description: Put a list of virtual circuit termination objects. call: netbox-circuits.circuitsvirtualcircuitterminationsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuitterminationsbulkpartialupdate description: Patch a list of virtual circuit termination objects. call: netbox-circuits.circuitsvirtualcircuitterminationsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuitterminationsbulkdestroy description: Delete a list of virtual circuit termination objects. call: netbox-circuits.circuitsvirtualcircuitterminationsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuit-terminations/{id} name: api-circuits-virtual-circuit-terminations-id description: REST surface for api-circuits-virtual-circuit-terminations-id. operations: - method: GET name: circuitsvirtualcircuitterminationsretrieve description: Get a virtual circuit termination object. call: netbox-circuits.circuitsvirtualcircuitterminationsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuitterminationsupdate description: Put a virtual circuit termination object. call: netbox-circuits.circuitsvirtualcircuitterminationsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuitterminationspartialupdate description: Patch a virtual circuit termination object. call: netbox-circuits.circuitsvirtualcircuitterminationspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuitterminationsdestroy description: Delete a virtual circuit termination object. call: netbox-circuits.circuitsvirtualcircuitterminationsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuit-terminations/{id}/paths name: api-circuits-virtual-circuit-terminations-id-paths description: REST surface for api-circuits-virtual-circuit-terminations-id-paths. operations: - method: GET name: circuitsvirtualcircuitterminationspathsretrieve description: Return all CablePaths which traverse a given pass-through port. call: netbox-circuits.circuitsvirtualcircuitterminationspathsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuit-types name: api-circuits-virtual-circuit-types description: REST surface for api-circuits-virtual-circuit-types. operations: - method: GET name: circuitsvirtualcircuittypeslist description: Get a list of virtual circuit type objects. call: netbox-circuits.circuitsvirtualcircuittypeslist with: color: rest.color color__empty: rest.color__empty color__ic: rest.color__ic color__ie: rest.color__ie color__iew: rest.color__iew color__iregex: rest.color__iregex color__isw: rest.color__isw color__n: rest.color__n color__nic: rest.color__nic color__nie: rest.color__nie color__niew: rest.color__niew color__nisw: rest.color__nisw color__regex: rest.color__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitsvirtualcircuittypescreate description: Post a list of virtual circuit type objects. call: netbox-circuits.circuitsvirtualcircuittypescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuittypesbulkupdate description: Put a list of virtual circuit type objects. call: netbox-circuits.circuitsvirtualcircuittypesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuittypesbulkpartialupdate description: Patch a list of virtual circuit type objects. call: netbox-circuits.circuitsvirtualcircuittypesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuittypesbulkdestroy description: Delete a list of virtual circuit type objects. call: netbox-circuits.circuitsvirtualcircuittypesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuit-types/{id} name: api-circuits-virtual-circuit-types-id description: REST surface for api-circuits-virtual-circuit-types-id. operations: - method: GET name: circuitsvirtualcircuittypesretrieve description: Get a virtual circuit type object. call: netbox-circuits.circuitsvirtualcircuittypesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuittypesupdate description: Put a virtual circuit type object. call: netbox-circuits.circuitsvirtualcircuittypesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuittypespartialupdate description: Patch a virtual circuit type object. call: netbox-circuits.circuitsvirtualcircuittypespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuittypesdestroy description: Delete a virtual circuit type object. call: netbox-circuits.circuitsvirtualcircuittypesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuits name: api-circuits-virtual-circuits description: REST surface for api-circuits-virtual-circuits. operations: - method: GET name: circuitsvirtualcircuitslist description: Get a list of virtual circuit objects. call: netbox-circuits.circuitsvirtualcircuitslist with: cid: rest.cid cid__empty: rest.cid__empty cid__ic: rest.cid__ic cid__ie: rest.cid__ie cid__iew: rest.cid__iew cid__iregex: rest.cid__iregex cid__isw: rest.cid__isw cid__n: rest.cid__n cid__nic: rest.cid__nic cid__nie: rest.cid__nie cid__niew: rest.cid__niew cid__nisw: rest.cid__nisw cid__regex: rest.cid__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n provider: rest.provider provider__n: rest.provider__n provider_account: rest.provider_account provider_account__n: rest.provider_account__n provider_account_id: rest.provider_account_id provider_account_id__n: rest.provider_account_id__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n provider_network_id: rest.provider_network_id provider_network_id__n: rest.provider_network_id__n q: rest.q status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n type: rest.type type__n: rest.type__n type_id: rest.type_id type_id__n: rest.type_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: circuitsvirtualcircuitscreate description: Post a list of virtual circuit objects. call: netbox-circuits.circuitsvirtualcircuitscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuitsbulkupdate description: Put a list of virtual circuit objects. call: netbox-circuits.circuitsvirtualcircuitsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuitsbulkpartialupdate description: Patch a list of virtual circuit objects. call: netbox-circuits.circuitsvirtualcircuitsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuitsbulkdestroy description: Delete a list of virtual circuit objects. call: netbox-circuits.circuitsvirtualcircuitsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/circuits/virtual-circuits/{id} name: api-circuits-virtual-circuits-id description: REST surface for api-circuits-virtual-circuits-id. operations: - method: GET name: circuitsvirtualcircuitsretrieve description: Get a virtual circuit object. call: netbox-circuits.circuitsvirtualcircuitsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: circuitsvirtualcircuitsupdate description: Put a virtual circuit object. call: netbox-circuits.circuitsvirtualcircuitsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: circuitsvirtualcircuitspartialupdate description: Patch a virtual circuit object. call: netbox-circuits.circuitsvirtualcircuitspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: circuitsvirtualcircuitsdestroy description: Delete a virtual circuit object. call: netbox-circuits.circuitsvirtualcircuitsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp namespace: netbox-circuits-mcp port: 9090 transport: http description: MCP adapter for NetBox REST API — circuits. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-list-circuit-group-assignment description: Get a list of Circuit group assignment objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentslist with: circuit: tools.circuit circuit_id: tools.circuit_id created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit member_id: tools.member_id member_id__empty: tools.member_id__empty member_id__gt: tools.member_id__gt member_id__gte: tools.member_id__gte member_id__lt: tools.member_id__lt member_id__lte: tools.member_id__lte member_id__n: tools.member_id__n member_type: tools.member_type member_type__n: tools.member_type__n modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering priority: tools.priority priority__empty: tools.priority__empty priority__ic: tools.priority__ic priority__ie: tools.priority__ie priority__iew: tools.priority__iew priority__iregex: tools.priority__iregex priority__isw: tools.priority__isw priority__n: tools.priority__n priority__nic: tools.priority__nic priority__nie: tools.priority__nie priority__niew: tools.priority__niew priority__nisw: tools.priority__nisw priority__regex: tools.priority__regex provider: tools.provider provider_id: tools.provider_id q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request virtual_circuit: tools.virtual_circuit virtual_circuit_id: tools.virtual_circuit_id outputParameters: - type: object mapping: $. - name: post-list-circuit-group-assignment description: Post a list of Circuit group assignment objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitscircuitgroupassignmentscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-circuit-group-assignment description: Put a list of Circuit group assignment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-circuit-group-assignment description: Patch a list of Circuit group assignment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-circuit-group-assignment description: Delete a list of Circuit group assignment objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-circuit-group-assignment-object description: Get a Circuit group assignment object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-circuit-group-assignment-object description: Put a Circuit group assignment object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-circuit-group-assignment-object description: Patch a Circuit group assignment object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-circuit-group-assignment-object description: Delete a Circuit group assignment object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitgroupassignmentsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-circuit-group-objects description: Get a list of circuit group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-circuit-group-objects description: Post a list of circuit group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitscircuitgroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-circuit-group-objects description: Put a list of circuit group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-circuit-group-objects description: Patch a list of circuit group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-circuit-group-objects description: Delete a list of circuit group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitgroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-circuit-group-object description: Get a circuit group object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-circuit-group-object description: Put a circuit group object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-circuit-group-object description: Patch a circuit group object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitgroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-circuit-group-object description: Delete a circuit group object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitgroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-circuit-termination-objects description: Get a list of circuit termination objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationslist with: cable_connector: tools.cable_connector cable_connector__empty: tools.cable_connector__empty cable_connector__gt: tools.cable_connector__gt cable_connector__gte: tools.cable_connector__gte cable_connector__lt: tools.cable_connector__lt cable_connector__lte: tools.cable_connector__lte cable_connector__n: tools.cable_connector__n cable_end: tools.cable_end cable_end__empty: tools.cable_end__empty cable_end__ic: tools.cable_end__ic cable_end__ie: tools.cable_end__ie cable_end__iew: tools.cable_end__iew cable_end__iregex: tools.cable_end__iregex cable_end__isw: tools.cable_end__isw cable_end__n: tools.cable_end__n cable_end__nic: tools.cable_end__nic cable_end__nie: tools.cable_end__nie cable_end__niew: tools.cable_end__niew cable_end__nisw: tools.cable_end__nisw cable_end__regex: tools.cable_end__regex cable_id: tools.cable_id cable_id__n: tools.cable_id__n cabled: tools.cabled circuit_id: tools.circuit_id circuit_id__n: tools.circuit_id__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit location: tools.location location__n: tools.location__n location_id: tools.location_id location_id__n: tools.location_id__n mark_connected: tools.mark_connected modified_by_request: tools.modified_by_request occupied: tools.occupied offset: tools.offset ordering: tools.ordering port_speed: tools.port_speed port_speed__empty: tools.port_speed__empty port_speed__gt: tools.port_speed__gt port_speed__gte: tools.port_speed__gte port_speed__lt: tools.port_speed__lt port_speed__lte: tools.port_speed__lte port_speed__n: tools.port_speed__n pp_info: tools.pp_info pp_info__empty: tools.pp_info__empty pp_info__ic: tools.pp_info__ic pp_info__ie: tools.pp_info__ie pp_info__iew: tools.pp_info__iew pp_info__iregex: tools.pp_info__iregex pp_info__isw: tools.pp_info__isw pp_info__n: tools.pp_info__n pp_info__nic: tools.pp_info__nic pp_info__nie: tools.pp_info__nie pp_info__niew: tools.pp_info__niew pp_info__nisw: tools.pp_info__nisw pp_info__regex: tools.pp_info__regex provider: tools.provider provider__n: tools.provider__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n provider_network_id: tools.provider_network_id provider_network_id__n: tools.provider_network_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n term_side: tools.term_side term_side__empty: tools.term_side__empty term_side__ic: tools.term_side__ic term_side__ie: tools.term_side__ie term_side__iew: tools.term_side__iew term_side__iregex: tools.term_side__iregex term_side__isw: tools.term_side__isw term_side__n: tools.term_side__n term_side__nic: tools.term_side__nic term_side__nie: tools.term_side__nie term_side__niew: tools.term_side__niew term_side__nisw: tools.term_side__nisw term_side__regex: tools.term_side__regex termination_id: tools.termination_id termination_id__empty: tools.termination_id__empty termination_id__gt: tools.termination_id__gt termination_id__gte: tools.termination_id__gte termination_id__lt: tools.termination_id__lt termination_id__lte: tools.termination_id__lte termination_id__n: tools.termination_id__n termination_type: tools.termination_type termination_type__n: tools.termination_type__n updated_by_request: tools.updated_by_request upstream_speed: tools.upstream_speed upstream_speed__empty: tools.upstream_speed__empty upstream_speed__gt: tools.upstream_speed__gt upstream_speed__gte: tools.upstream_speed__gte upstream_speed__lt: tools.upstream_speed__lt upstream_speed__lte: tools.upstream_speed__lte upstream_speed__n: tools.upstream_speed__n xconnect_id: tools.xconnect_id xconnect_id__empty: tools.xconnect_id__empty xconnect_id__ic: tools.xconnect_id__ic xconnect_id__ie: tools.xconnect_id__ie xconnect_id__iew: tools.xconnect_id__iew xconnect_id__iregex: tools.xconnect_id__iregex xconnect_id__isw: tools.xconnect_id__isw xconnect_id__n: tools.xconnect_id__n xconnect_id__nic: tools.xconnect_id__nic xconnect_id__nie: tools.xconnect_id__nie xconnect_id__niew: tools.xconnect_id__niew xconnect_id__nisw: tools.xconnect_id__nisw xconnect_id__regex: tools.xconnect_id__regex outputParameters: - type: object mapping: $. - name: post-list-circuit-termination-objects description: Post a list of circuit termination objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitscircuitterminationscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-circuit-termination-objects description: Put a list of circuit termination objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-circuit-termination-objects description: Patch a list of circuit termination objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-circuit-termination-objects description: Delete a list of circuit termination objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitterminationsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-circuit-termination-object description: Get a circuit termination object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-circuit-termination-object description: Put a circuit termination object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-circuit-termination-object description: Patch a circuit termination object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-circuit-termination-object description: Delete a circuit termination object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitterminationsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: return-all-cablepaths-which-traverse description: Return all CablePaths which traverse a given pass-through port. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitterminationspathsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-circuit-type-objects description: Get a list of circuit type objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuittypeslist with: color: tools.color color__empty: tools.color__empty color__ic: tools.color__ic color__ie: tools.color__ie color__iew: tools.color__iew color__iregex: tools.color__iregex color__isw: tools.color__isw color__n: tools.color__n color__nic: tools.color__nic color__nie: tools.color__nie color__niew: tools.color__niew color__nisw: tools.color__nisw color__regex: tools.color__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-circuit-type-objects description: Post a list of circuit type objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitscircuittypescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-circuit-type-objects description: Put a list of circuit type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuittypesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-circuit-type-objects description: Patch a list of circuit type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuittypesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-circuit-type-objects description: Delete a list of circuit type objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuittypesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-circuit-type-object description: Get a circuit type object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuittypesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-circuit-type-object description: Put a circuit type object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuittypesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-circuit-type-object description: Patch a circuit type object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuittypespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-circuit-type-object description: Delete a circuit type object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuittypesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-circuit-objects description: Get a list of circuit objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitslist with: cid: tools.cid cid__empty: tools.cid__empty cid__ic: tools.cid__ic cid__ie: tools.cid__ie cid__iew: tools.cid__iew cid__iregex: tools.cid__iregex cid__isw: tools.cid__isw cid__n: tools.cid__n cid__nic: tools.cid__nic cid__nie: tools.cid__nie cid__niew: tools.cid__niew cid__nisw: tools.cid__nisw cid__regex: tools.cid__regex commit_rate: tools.commit_rate commit_rate__empty: tools.commit_rate__empty commit_rate__gt: tools.commit_rate__gt commit_rate__gte: tools.commit_rate__gte commit_rate__lt: tools.commit_rate__lt commit_rate__lte: tools.commit_rate__lte commit_rate__n: tools.commit_rate__n contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex distance: tools.distance distance__empty: tools.distance__empty distance__gt: tools.distance__gt distance__gte: tools.distance__gte distance__lt: tools.distance__lt distance__lte: tools.distance__lte distance__n: tools.distance__n distance_unit: tools.distance_unit distance_unit__empty: tools.distance_unit__empty distance_unit__ic: tools.distance_unit__ic distance_unit__ie: tools.distance_unit__ie distance_unit__iew: tools.distance_unit__iew distance_unit__iregex: tools.distance_unit__iregex distance_unit__isw: tools.distance_unit__isw distance_unit__n: tools.distance_unit__n distance_unit__nic: tools.distance_unit__nic distance_unit__nie: tools.distance_unit__nie distance_unit__niew: tools.distance_unit__niew distance_unit__nisw: tools.distance_unit__nisw distance_unit__regex: tools.distance_unit__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n install_date: tools.install_date install_date__empty: tools.install_date__empty install_date__gt: tools.install_date__gt install_date__gte: tools.install_date__gte install_date__lt: tools.install_date__lt install_date__lte: tools.install_date__lte install_date__n: tools.install_date__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit location_id: tools.location_id location_id__n: tools.location_id__n modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n provider: tools.provider provider__n: tools.provider__n provider_account: tools.provider_account provider_account__n: tools.provider_account__n provider_account_id: tools.provider_account_id provider_account_id__n: tools.provider_account_id__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n provider_network_id: tools.provider_network_id provider_network_id__n: tools.provider_network_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n termination_a_id: tools.termination_a_id termination_a_id__n: tools.termination_a_id__n termination_date: tools.termination_date termination_date__empty: tools.termination_date__empty termination_date__gt: tools.termination_date__gt termination_date__gte: tools.termination_date__gte termination_date__lt: tools.termination_date__lt termination_date__lte: tools.termination_date__lte termination_date__n: tools.termination_date__n termination_z_id: tools.termination_z_id termination_z_id__n: tools.termination_z_id__n type: tools.type type__n: tools.type__n type_id: tools.type_id type_id__n: tools.type_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-circuit-objects description: Post a list of circuit objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitscircuitscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-circuit-objects description: Put a list of circuit objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-circuit-objects description: Patch a list of circuit objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-circuit-objects description: Delete a list of circuit objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-circuit-object description: Get a circuit object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitscircuitsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-circuit-object description: Put a circuit object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-circuit-object description: Patch a circuit object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitscircuitspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-circuit-object description: Delete a circuit object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitscircuitsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-provider-account-objects description: Get a list of provider account objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountslist with: account: tools.account account__empty: tools.account__empty account__ic: tools.account__ic account__ie: tools.account__ie account__iew: tools.account__iew account__iregex: tools.account__iregex account__isw: tools.account__isw account__n: tools.account__n account__nic: tools.account__nic account__nie: tools.account__nie account__niew: tools.account__niew account__nisw: tools.account__nisw account__regex: tools.account__regex contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n provider: tools.provider provider__n: tools.provider__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-provider-account-objects description: Post a list of provider account objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsprovideraccountscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-provider-account-objects description: Put a list of provider account objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-provider-account-objects description: Patch a list of provider account objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-provider-account-objects description: Delete a list of provider account objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovideraccountsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-provider-account-object description: Get a provider account object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-provider-account-object description: Put a provider account object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-provider-account-object description: Patch a provider account object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovideraccountspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-provider-account-object description: Delete a provider account object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovideraccountsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-provider-network-objects description: Get a list of provider network objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworkslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n provider: tools.provider provider__n: tools.provider__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n q: tools.q service_id: tools.service_id service_id__empty: tools.service_id__empty service_id__ic: tools.service_id__ic service_id__ie: tools.service_id__ie service_id__iew: tools.service_id__iew service_id__iregex: tools.service_id__iregex service_id__isw: tools.service_id__isw service_id__n: tools.service_id__n service_id__nic: tools.service_id__nic service_id__nie: tools.service_id__nie service_id__niew: tools.service_id__niew service_id__nisw: tools.service_id__nisw service_id__regex: tools.service_id__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-provider-network-objects description: Post a list of provider network objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsprovidernetworkscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-provider-network-objects description: Put a list of provider network objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworksbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-provider-network-objects description: Patch a list of provider network objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworksbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-provider-network-objects description: Delete a list of provider network objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovidernetworksbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-provider-network-object description: Get a provider network object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworksretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-provider-network-object description: Put a provider network object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworksupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-provider-network-object description: Patch a provider network object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidernetworkspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-provider-network-object description: Delete a provider network object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovidernetworksdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-provider-objects description: Get a list of provider objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsproviderslist with: asn: tools.asn asn__n: tools.asn__n asn_id: tools.asn_id asn_id__n: tools.asn_id__n contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-provider-objects description: Post a list of provider objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsproviderscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-provider-objects description: Put a list of provider objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidersbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-provider-objects description: Patch a list of provider objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidersbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-provider-objects description: Delete a list of provider objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovidersbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-provider-object description: Get a provider object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsprovidersretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-provider-object description: Put a provider object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsprovidersupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-provider-object description: Patch a provider object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsproviderspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-provider-object description: Delete a provider object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsprovidersdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-virtual-circuit-termination description: Get a list of virtual circuit termination objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n interface_id: tools.interface_id interface_id__n: tools.interface_id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering provider: tools.provider provider__n: tools.provider__n provider_account: tools.provider_account provider_account__n: tools.provider_account__n provider_account_id: tools.provider_account_id provider_account_id__n: tools.provider_account_id__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n provider_network_id: tools.provider_network_id provider_network_id__n: tools.provider_network_id__n q: tools.q role: tools.role role__empty: tools.role__empty role__ic: tools.role__ic role__ie: tools.role__ie role__iew: tools.role__iew role__iregex: tools.role__iregex role__isw: tools.role__isw role__n: tools.role__n role__nic: tools.role__nic role__nie: tools.role__nie role__niew: tools.role__niew role__nisw: tools.role__nisw role__regex: tools.role__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request virtual_circuit_id: tools.virtual_circuit_id virtual_circuit_id__n: tools.virtual_circuit_id__n outputParameters: - type: object mapping: $. - name: post-list-virtual-circuit-termination description: Post a list of virtual circuit termination objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsvirtualcircuitterminationscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-virtual-circuit-termination description: Put a list of virtual circuit termination objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-virtual-circuit-termination description: Patch a list of virtual circuit termination objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-virtual-circuit-termination description: Delete a list of virtual circuit termination objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-virtual-circuit-termination-object description: Get a virtual circuit termination object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-virtual-circuit-termination-object description: Put a virtual circuit termination object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-virtual-circuit-termination-object description: Patch a virtual circuit termination object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-virtual-circuit-termination-object description: Delete a virtual circuit termination object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: return-all-cablepaths-which-traverse-2 description: Return all CablePaths which traverse a given pass-through port. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitterminationspathsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-virtual-circuit-type description: Get a list of virtual circuit type objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypeslist with: color: tools.color color__empty: tools.color__empty color__ic: tools.color__ic color__ie: tools.color__ie color__iew: tools.color__iew color__iregex: tools.color__iregex color__isw: tools.color__isw color__n: tools.color__n color__nic: tools.color__nic color__nie: tools.color__nie color__niew: tools.color__niew color__nisw: tools.color__nisw color__regex: tools.color__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-virtual-circuit-type description: Post a list of virtual circuit type objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsvirtualcircuittypescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-virtual-circuit-type description: Put a list of virtual circuit type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-virtual-circuit-type description: Patch a list of virtual circuit type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-virtual-circuit-type description: Delete a list of virtual circuit type objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-virtual-circuit-type-object description: Get a virtual circuit type object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-virtual-circuit-type-object description: Put a virtual circuit type object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-virtual-circuit-type-object description: Patch a virtual circuit type object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuittypespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-virtual-circuit-type-object description: Delete a virtual circuit type object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuittypesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-virtual-circuit-objects description: Get a list of virtual circuit objects. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitslist with: cid: tools.cid cid__empty: tools.cid__empty cid__ic: tools.cid__ic cid__ie: tools.cid__ie cid__iew: tools.cid__iew cid__iregex: tools.cid__iregex cid__isw: tools.cid__isw cid__n: tools.cid__n cid__nic: tools.cid__nic cid__nie: tools.cid__nie cid__niew: tools.cid__niew cid__nisw: tools.cid__nisw cid__regex: tools.cid__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n provider: tools.provider provider__n: tools.provider__n provider_account: tools.provider_account provider_account__n: tools.provider_account__n provider_account_id: tools.provider_account_id provider_account_id__n: tools.provider_account_id__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n provider_network_id: tools.provider_network_id provider_network_id__n: tools.provider_network_id__n q: tools.q status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n type: tools.type type__n: tools.type__n type_id: tools.type_id type_id__n: tools.type_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-virtual-circuit-objects description: Post a list of virtual circuit objects. hints: readOnly: true destructive: false idempotent: false call: netbox-circuits.circuitsvirtualcircuitscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-virtual-circuit-objects description: Put a list of virtual circuit objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-virtual-circuit-objects description: Patch a list of virtual circuit objects. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-virtual-circuit-objects description: Delete a list of virtual circuit objects. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuitsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-virtual-circuit-object description: Get a virtual circuit object. hints: readOnly: true destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-virtual-circuit-object description: Put a virtual circuit object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-virtual-circuit-object description: Patch a virtual circuit object. hints: readOnly: false destructive: false idempotent: true call: netbox-circuits.circuitsvirtualcircuitspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-virtual-circuit-object description: Delete a virtual circuit object. hints: readOnly: false destructive: true idempotent: true call: netbox-circuits.circuitsvirtualcircuitsdestroy with: id: tools.id outputParameters: - type: object mapping: $.