naftiko: 1.0.0-alpha2 info: label: NetBox REST API description: NetBox REST API API capability. tags: - Netbox - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: netbox baseUri: '' description: NetBox REST API HTTP API. authentication: type: apikey in: cookie name: sessionid value: '{{NETBOX_TOKEN}}' resources: - name: api-authentication-check path: /api/authentication-check/ operations: - name: authentication-check-retrieve method: GET description: Return the user making the request, if authenticated successfully. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-group-assignments path: /api/circuits/circuit-group-assignments/ operations: - name: circuits-circuit-group-assignments-list method: GET description: Get a list of Circuit group assignment objects. inputParameters: - name: circuit in: query type: array - name: circuit_id in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: group in: query type: array description: Circuit group (slug) - name: group__n in: query type: array description: Circuit group (slug) - name: group_id in: query type: array description: Circuit group (ID) - name: group_id__n in: query type: array description: Circuit group (ID) - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: member_id in: query type: array - name: member_id__empty in: query type: boolean - name: member_id__gt in: query type: array - name: member_id__gte in: query type: array - name: member_id__lt in: query type: array - name: member_id__lte in: query type: array - name: member_id__n in: query type: array - name: member_type in: query type: array - name: member_type__n in: query type: array - name: modified_by_request in: query type: string - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: priority in: query type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - name: priority__empty in: query type: boolean - name: priority__ic in: query type: array - name: priority__ie in: query type: array - name: priority__iew in: query type: array - name: priority__iregex in: query type: array - name: priority__isw in: query type: array - name: priority__n in: query type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - name: priority__nic in: query type: array - name: priority__nie in: query type: array - name: priority__niew in: query type: array - name: priority__nisw in: query type: array - name: priority__regex in: query type: array - name: provider in: query type: array - name: provider_id in: query type: array - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: virtual_circuit in: query type: array - name: virtual_circuit_id in: query type: array outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-create method: POST description: Post a list of Circuit group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-bulk-update method: PUT description: Put a list of Circuit group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-bulk-partial- method: PATCH description: Patch a list of Circuit group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-bulk-destroy method: DELETE description: Delete a list of Circuit group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-group-assignments-id path: /api/circuits/circuit-group-assignments/{id}/ operations: - name: circuits-circuit-group-assignments-retrieve method: GET description: Get a Circuit group assignment object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this Circuit group assignment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-update method: PUT description: Put a Circuit group assignment object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this Circuit group assignment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-partial-updat method: PATCH description: Patch a Circuit group assignment object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this Circuit group assignment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-group-assignments-destroy method: DELETE description: Delete a Circuit group assignment object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this Circuit group assignment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-groups path: /api/circuits/circuit-groups/ operations: - name: circuits-circuit-groups-list method: GET description: Get a list of circuit group objects. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: slug in: query type: array - name: slug__empty in: query type: boolean - name: slug__ic in: query type: array - name: slug__ie in: query type: array - name: slug__iew in: query type: array - name: slug__iregex in: query type: array - name: slug__isw in: query type: array - name: slug__n in: query type: array - name: slug__nic in: query type: array - name: slug__nie in: query type: array - name: slug__niew in: query type: array - name: slug__nisw in: query type: array - name: slug__regex in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: tenant in: query type: array description: Tenant (slug) - name: tenant__n in: query type: array description: Tenant (slug) - name: tenant_group in: query type: array - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-create method: POST description: Post a list of circuit group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-bulk-update method: PUT description: Put a list of circuit group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-bulk-partial-update method: PATCH description: Patch a list of circuit group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-bulk-destroy method: DELETE description: Delete a list of circuit group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-groups-id path: /api/circuits/circuit-groups/{id}/ operations: - name: circuits-circuit-groups-retrieve method: GET description: Get a circuit group object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit group. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-update method: PUT description: Put a circuit group object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit group. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-partial-update method: PATCH description: Patch a circuit group object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit group. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-groups-destroy method: DELETE description: Delete a circuit group object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit group. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-terminations path: /api/circuits/circuit-terminations/ operations: - name: circuits-circuit-terminations-list method: GET description: Get a list of circuit termination objects. inputParameters: - name: cable_connector in: query type: array - name: cable_connector__empty in: query type: boolean - name: cable_connector__gt in: query type: array - name: cable_connector__gte in: query type: array - name: cable_connector__lt in: query type: array - name: cable_connector__lte in: query type: array - name: cable_connector__n in: query type: array - name: cable_end in: query type: string description: '* `A` - A * `B` - B' - name: cable_end__empty in: query type: boolean - name: cable_end__ic in: query type: array - name: cable_end__ie in: query type: array - name: cable_end__iew in: query type: array - name: cable_end__iregex in: query type: array - name: cable_end__isw in: query type: array - name: cable_end__n in: query type: string description: '* `A` - A * `B` - B' - name: cable_end__nic in: query type: array - name: cable_end__nie in: query type: array - name: cable_end__niew in: query type: array - name: cable_end__nisw in: query type: array - name: cable_end__regex in: query type: array - name: cable_id in: query type: array description: Cable (ID) - name: cable_id__n in: query type: array description: Cable (ID) - name: cabled in: query type: boolean - name: circuit_id in: query type: array description: Circuit - name: circuit_id__n in: query type: array description: Circuit - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: location in: query type: array - name: location__n in: query type: array - name: location_id in: query type: array - name: location_id__n in: query type: array - name: mark_connected in: query type: boolean - name: modified_by_request in: query type: string - name: occupied in: query type: boolean - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: port_speed in: query type: array - name: port_speed__empty in: query type: boolean - name: port_speed__gt in: query type: array - name: port_speed__gte in: query type: array - name: port_speed__lt in: query type: array - name: port_speed__lte in: query type: array - name: port_speed__n in: query type: array - name: pp_info in: query type: array - name: pp_info__empty in: query type: boolean - name: pp_info__ic in: query type: array - name: pp_info__ie in: query type: array - name: pp_info__iew in: query type: array - name: pp_info__iregex in: query type: array - name: pp_info__isw in: query type: array - name: pp_info__n in: query type: array - name: pp_info__nic in: query type: array - name: pp_info__nie in: query type: array - name: pp_info__niew in: query type: array - name: pp_info__nisw in: query type: array - name: pp_info__regex in: query type: array - name: provider in: query type: array description: Provider (slug) - name: provider__n in: query type: array description: Provider (slug) - name: provider_id in: query type: array description: Provider (ID) - name: provider_id__n in: query type: array description: Provider (ID) - name: provider_network_id in: query type: array description: ProviderNetwork (ID) - name: provider_network_id__n in: query type: array description: ProviderNetwork (ID) - name: q in: query type: string description: Search - name: region in: query type: array - name: region__n in: query type: array - name: region_id in: query type: array - name: region_id__n in: query type: array - name: site in: query type: array description: Site (slug) - name: site__n in: query type: array description: Site (slug) - name: site_group in: query type: array - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: term_side in: query type: string description: '* `A` - A * `Z` - Z' - name: term_side__empty in: query type: boolean - name: term_side__ic in: query type: array - name: term_side__ie in: query type: array - name: term_side__iew in: query type: array - name: term_side__iregex in: query type: array - name: term_side__isw in: query type: array - name: term_side__n in: query type: string description: '* `A` - A * `Z` - Z' - name: term_side__nic in: query type: array - name: term_side__nie in: query type: array - name: term_side__niew in: query type: array - name: term_side__nisw in: query type: array - name: term_side__regex in: query type: array - name: termination_id in: query type: array - name: termination_id__empty in: query type: boolean - name: termination_id__gt in: query type: array - name: termination_id__gte in: query type: array - name: termination_id__lt in: query type: array - name: termination_id__lte in: query type: array - name: termination_id__n in: query type: array - name: termination_type in: query type: array - name: termination_type__n in: query type: array - name: updated_by_request in: query type: string - name: upstream_speed in: query type: array - name: upstream_speed__empty in: query type: boolean - name: upstream_speed__gt in: query type: array - name: upstream_speed__gte in: query type: array - name: upstream_speed__lt in: query type: array - name: upstream_speed__lte in: query type: array - name: upstream_speed__n in: query type: array - name: xconnect_id in: query type: array - name: xconnect_id__empty in: query type: boolean - name: xconnect_id__ic in: query type: array - name: xconnect_id__ie in: query type: array - name: xconnect_id__iew in: query type: array - name: xconnect_id__iregex in: query type: array - name: xconnect_id__isw in: query type: array - name: xconnect_id__n in: query type: array - name: xconnect_id__nic in: query type: array - name: xconnect_id__nie in: query type: array - name: xconnect_id__niew in: query type: array - name: xconnect_id__nisw in: query type: array - name: xconnect_id__regex in: query type: array outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-create method: POST description: Post a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-bulk-update method: PUT description: Put a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-bulk-partial-updat method: PATCH description: Patch a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-bulk-destroy method: DELETE description: Delete a list of circuit termination objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-terminations-id path: /api/circuits/circuit-terminations/{id}/ operations: - name: circuits-circuit-terminations-retrieve method: GET description: Get a circuit termination object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit termination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-update method: PUT description: Put a circuit termination object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit termination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-partial-update method: PATCH description: Patch a circuit termination object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit termination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-terminations-destroy method: DELETE description: Delete a circuit termination object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit termination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-terminations-id-paths path: /api/circuits/circuit-terminations/{id}/paths/ operations: - name: circuits-circuit-terminations-paths-retrieve method: GET description: Return all CablePaths which traverse a given pass-through port. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit termination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-types path: /api/circuits/circuit-types/ operations: - name: circuits-circuit-types-list method: GET description: Get a list of circuit type objects. 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 outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-create method: POST description: Post a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-bulk-update method: PUT description: Put a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-bulk-partial-update method: PATCH description: Patch a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-bulk-destroy method: DELETE description: Delete a list of circuit type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuit-types-id path: /api/circuits/circuit-types/{id}/ operations: - name: circuits-circuit-types-retrieve method: GET description: Get a circuit type object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-update method: PUT description: Put a circuit type object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-partial-update method: PATCH description: Patch a circuit type object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuit-types-destroy method: DELETE description: Delete a circuit type object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuits path: /api/circuits/circuits/ operations: - name: circuits-circuits-list method: GET description: Get a list of circuit objects. 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 * `m` - Meters * `mi` - Miles * `ft` - Feet' - 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 * `m` - Meters * `mi` - Miles * `ft` - Feet' - 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 outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-create method: POST description: Post a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-bulk-update method: PUT description: Put a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-bulk-partial-update method: PATCH description: Patch a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-bulk-destroy method: DELETE description: Delete a list of circuit objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-circuits-id path: /api/circuits/circuits/{id}/ operations: - name: circuits-circuits-retrieve method: GET description: Get a circuit object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-update method: PUT description: Put a circuit object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-partial-update method: PATCH description: Patch a circuit object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-circuits-destroy method: DELETE description: Delete a circuit object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this circuit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-provider-accounts path: /api/circuits/provider-accounts/ operations: - name: circuits-provider-accounts-list method: GET description: Get a list of provider account objects. 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 outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-create method: POST description: Post a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-bulk-update method: PUT description: Put a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-bulk-partial-update method: PATCH description: Patch a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-bulk-destroy method: DELETE description: Delete a list of provider account objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-provider-accounts-id path: /api/circuits/provider-accounts/{id}/ operations: - name: circuits-provider-accounts-retrieve method: GET description: Get a provider account object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this provider account. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-update method: PUT description: Put a provider account object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this provider account. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-partial-update method: PATCH description: Patch a provider account object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this provider account. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-accounts-destroy method: DELETE description: Delete a provider account object. inputParameters: - name: id in: path type: integer required: true description: A unique integer value identifying this provider account. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-circuits-provider-networks path: /api/circuits/provider-networks/ operations: - name: circuits-provider-networks-list method: GET description: Get a list of provider network objects. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: 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 outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-networks-create method: POST description: Post a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-networks-bulk-update method: PUT description: Put a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: circuits-provider-networks-bulk-partial-update method: PATCH description: Patch a list of provider network objects. outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: netbox-rest description: REST adapter for NetBox REST API. resources: - path: /api/authentication-check/ name: authentication-check-retrieve operations: - method: GET name: authentication-check-retrieve description: Return the user making the request, if authenticated successfully. call: netbox.authentication-check-retrieve outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/ name: circuits-circuit-group-assignments-list operations: - method: GET name: circuits-circuit-group-assignments-list description: Get a list of Circuit group assignment objects. call: netbox.circuits-circuit-group-assignments-list outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/ name: circuits-circuit-group-assignments-create operations: - method: POST name: circuits-circuit-group-assignments-create description: Post a list of Circuit group assignment objects. call: netbox.circuits-circuit-group-assignments-create outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/ name: circuits-circuit-group-assignments-bulk-update operations: - method: PUT name: circuits-circuit-group-assignments-bulk-update description: Put a list of Circuit group assignment objects. call: netbox.circuits-circuit-group-assignments-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/ name: circuits-circuit-group-assignments-bulk-partial operations: - method: PATCH name: circuits-circuit-group-assignments-bulk-partial- description: Patch a list of Circuit group assignment objects. call: netbox.circuits-circuit-group-assignments-bulk-partial- outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/ name: circuits-circuit-group-assignments-bulk-destroy operations: - method: DELETE name: circuits-circuit-group-assignments-bulk-destroy description: Delete a list of Circuit group assignment objects. call: netbox.circuits-circuit-group-assignments-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/{id}/ name: circuits-circuit-group-assignments-retrieve operations: - method: GET name: circuits-circuit-group-assignments-retrieve description: Get a Circuit group assignment object. call: netbox.circuits-circuit-group-assignments-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/{id}/ name: circuits-circuit-group-assignments-update operations: - method: PUT name: circuits-circuit-group-assignments-update description: Put a Circuit group assignment object. call: netbox.circuits-circuit-group-assignments-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/{id}/ name: circuits-circuit-group-assignments-partial-updat operations: - method: PATCH name: circuits-circuit-group-assignments-partial-updat description: Patch a Circuit group assignment object. call: netbox.circuits-circuit-group-assignments-partial-updat with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-group-assignments/{id}/ name: circuits-circuit-group-assignments-destroy operations: - method: DELETE name: circuits-circuit-group-assignments-destroy description: Delete a Circuit group assignment object. call: netbox.circuits-circuit-group-assignments-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/ name: circuits-circuit-groups-list operations: - method: GET name: circuits-circuit-groups-list description: Get a list of circuit group objects. call: netbox.circuits-circuit-groups-list outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/ name: circuits-circuit-groups-create operations: - method: POST name: circuits-circuit-groups-create description: Post a list of circuit group objects. call: netbox.circuits-circuit-groups-create outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/ name: circuits-circuit-groups-bulk-update operations: - method: PUT name: circuits-circuit-groups-bulk-update description: Put a list of circuit group objects. call: netbox.circuits-circuit-groups-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/ name: circuits-circuit-groups-bulk-partial-update operations: - method: PATCH name: circuits-circuit-groups-bulk-partial-update description: Patch a list of circuit group objects. call: netbox.circuits-circuit-groups-bulk-partial-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/ name: circuits-circuit-groups-bulk-destroy operations: - method: DELETE name: circuits-circuit-groups-bulk-destroy description: Delete a list of circuit group objects. call: netbox.circuits-circuit-groups-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/{id}/ name: circuits-circuit-groups-retrieve operations: - method: GET name: circuits-circuit-groups-retrieve description: Get a circuit group object. call: netbox.circuits-circuit-groups-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/{id}/ name: circuits-circuit-groups-update operations: - method: PUT name: circuits-circuit-groups-update description: Put a circuit group object. call: netbox.circuits-circuit-groups-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/{id}/ name: circuits-circuit-groups-partial-update operations: - method: PATCH name: circuits-circuit-groups-partial-update description: Patch a circuit group object. call: netbox.circuits-circuit-groups-partial-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-groups/{id}/ name: circuits-circuit-groups-destroy operations: - method: DELETE name: circuits-circuit-groups-destroy description: Delete a circuit group object. call: netbox.circuits-circuit-groups-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/ name: circuits-circuit-terminations-list operations: - method: GET name: circuits-circuit-terminations-list description: Get a list of circuit termination objects. call: netbox.circuits-circuit-terminations-list outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/ name: circuits-circuit-terminations-create operations: - method: POST name: circuits-circuit-terminations-create description: Post a list of circuit termination objects. call: netbox.circuits-circuit-terminations-create outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/ name: circuits-circuit-terminations-bulk-update operations: - method: PUT name: circuits-circuit-terminations-bulk-update description: Put a list of circuit termination objects. call: netbox.circuits-circuit-terminations-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/ name: circuits-circuit-terminations-bulk-partial-updat operations: - method: PATCH name: circuits-circuit-terminations-bulk-partial-updat description: Patch a list of circuit termination objects. call: netbox.circuits-circuit-terminations-bulk-partial-updat outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/ name: circuits-circuit-terminations-bulk-destroy operations: - method: DELETE name: circuits-circuit-terminations-bulk-destroy description: Delete a list of circuit termination objects. call: netbox.circuits-circuit-terminations-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/{id}/ name: circuits-circuit-terminations-retrieve operations: - method: GET name: circuits-circuit-terminations-retrieve description: Get a circuit termination object. call: netbox.circuits-circuit-terminations-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/{id}/ name: circuits-circuit-terminations-update operations: - method: PUT name: circuits-circuit-terminations-update description: Put a circuit termination object. call: netbox.circuits-circuit-terminations-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/{id}/ name: circuits-circuit-terminations-partial-update operations: - method: PATCH name: circuits-circuit-terminations-partial-update description: Patch a circuit termination object. call: netbox.circuits-circuit-terminations-partial-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/{id}/ name: circuits-circuit-terminations-destroy operations: - method: DELETE name: circuits-circuit-terminations-destroy description: Delete a circuit termination object. call: netbox.circuits-circuit-terminations-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-terminations/{id}/paths/ name: circuits-circuit-terminations-paths-retrieve operations: - method: GET name: circuits-circuit-terminations-paths-retrieve description: Return all CablePaths which traverse a given pass-through port. call: netbox.circuits-circuit-terminations-paths-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/ name: circuits-circuit-types-list operations: - method: GET name: circuits-circuit-types-list description: Get a list of circuit type objects. call: netbox.circuits-circuit-types-list outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/ name: circuits-circuit-types-create operations: - method: POST name: circuits-circuit-types-create description: Post a list of circuit type objects. call: netbox.circuits-circuit-types-create outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/ name: circuits-circuit-types-bulk-update operations: - method: PUT name: circuits-circuit-types-bulk-update description: Put a list of circuit type objects. call: netbox.circuits-circuit-types-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/ name: circuits-circuit-types-bulk-partial-update operations: - method: PATCH name: circuits-circuit-types-bulk-partial-update description: Patch a list of circuit type objects. call: netbox.circuits-circuit-types-bulk-partial-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/ name: circuits-circuit-types-bulk-destroy operations: - method: DELETE name: circuits-circuit-types-bulk-destroy description: Delete a list of circuit type objects. call: netbox.circuits-circuit-types-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/{id}/ name: circuits-circuit-types-retrieve operations: - method: GET name: circuits-circuit-types-retrieve description: Get a circuit type object. call: netbox.circuits-circuit-types-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/{id}/ name: circuits-circuit-types-update operations: - method: PUT name: circuits-circuit-types-update description: Put a circuit type object. call: netbox.circuits-circuit-types-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/{id}/ name: circuits-circuit-types-partial-update operations: - method: PATCH name: circuits-circuit-types-partial-update description: Patch a circuit type object. call: netbox.circuits-circuit-types-partial-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuit-types/{id}/ name: circuits-circuit-types-destroy operations: - method: DELETE name: circuits-circuit-types-destroy description: Delete a circuit type object. call: netbox.circuits-circuit-types-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/ name: circuits-circuits-list operations: - method: GET name: circuits-circuits-list description: Get a list of circuit objects. call: netbox.circuits-circuits-list outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/ name: circuits-circuits-create operations: - method: POST name: circuits-circuits-create description: Post a list of circuit objects. call: netbox.circuits-circuits-create outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/ name: circuits-circuits-bulk-update operations: - method: PUT name: circuits-circuits-bulk-update description: Put a list of circuit objects. call: netbox.circuits-circuits-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/ name: circuits-circuits-bulk-partial-update operations: - method: PATCH name: circuits-circuits-bulk-partial-update description: Patch a list of circuit objects. call: netbox.circuits-circuits-bulk-partial-update outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/ name: circuits-circuits-bulk-destroy operations: - method: DELETE name: circuits-circuits-bulk-destroy description: Delete a list of circuit objects. call: netbox.circuits-circuits-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/{id}/ name: circuits-circuits-retrieve operations: - method: GET name: circuits-circuits-retrieve description: Get a circuit object. call: netbox.circuits-circuits-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/{id}/ name: circuits-circuits-update operations: - method: PUT name: circuits-circuits-update description: Put a circuit object. call: netbox.circuits-circuits-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/{id}/ name: circuits-circuits-partial-update operations: - method: PATCH name: circuits-circuits-partial-update description: Patch a circuit object. call: netbox.circuits-circuits-partial-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/circuits/{id}/ name: circuits-circuits-destroy operations: - method: DELETE name: circuits-circuits-destroy description: Delete a circuit object. call: netbox.circuits-circuits-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/ name: circuits-provider-accounts-list operations: - method: GET name: circuits-provider-accounts-list description: Get a list of provider account objects. call: netbox.circuits-provider-accounts-list outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/ name: circuits-provider-accounts-create operations: - method: POST name: circuits-provider-accounts-create description: Post a list of provider account objects. call: netbox.circuits-provider-accounts-create outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/ name: circuits-provider-accounts-bulk-update operations: - method: PUT name: circuits-provider-accounts-bulk-update description: Put a list of provider account objects. call: netbox.circuits-provider-accounts-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/ name: circuits-provider-accounts-bulk-partial-update operations: - method: PATCH name: circuits-provider-accounts-bulk-partial-update description: Patch a list of provider account objects. call: netbox.circuits-provider-accounts-bulk-partial-update outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/ name: circuits-provider-accounts-bulk-destroy operations: - method: DELETE name: circuits-provider-accounts-bulk-destroy description: Delete a list of provider account objects. call: netbox.circuits-provider-accounts-bulk-destroy outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/{id}/ name: circuits-provider-accounts-retrieve operations: - method: GET name: circuits-provider-accounts-retrieve description: Get a provider account object. call: netbox.circuits-provider-accounts-retrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/{id}/ name: circuits-provider-accounts-update operations: - method: PUT name: circuits-provider-accounts-update description: Put a provider account object. call: netbox.circuits-provider-accounts-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/{id}/ name: circuits-provider-accounts-partial-update operations: - method: PATCH name: circuits-provider-accounts-partial-update description: Patch a provider account object. call: netbox.circuits-provider-accounts-partial-update with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/provider-accounts/{id}/ name: circuits-provider-accounts-destroy operations: - method: DELETE name: circuits-provider-accounts-destroy description: Delete a provider account object. call: netbox.circuits-provider-accounts-destroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /api/circuits/provider-networks/ name: circuits-provider-networks-list operations: - method: GET name: circuits-provider-networks-list description: Get a list of provider network objects. call: netbox.circuits-provider-networks-list outputParameters: - type: object mapping: $. - path: /api/circuits/provider-networks/ name: circuits-provider-networks-create operations: - method: POST name: circuits-provider-networks-create description: Post a list of provider network objects. call: netbox.circuits-provider-networks-create outputParameters: - type: object mapping: $. - path: /api/circuits/provider-networks/ name: circuits-provider-networks-bulk-update operations: - method: PUT name: circuits-provider-networks-bulk-update description: Put a list of provider network objects. call: netbox.circuits-provider-networks-bulk-update outputParameters: - type: object mapping: $. - path: /api/circuits/provider-networks/ name: circuits-provider-networks-bulk-partial-update operations: - method: PATCH name: circuits-provider-networks-bulk-partial-update description: Patch a list of provider network objects. call: netbox.circuits-provider-networks-bulk-partial-update outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: netbox-mcp transport: http description: MCP adapter for NetBox REST API for AI agent use. tools: - name: authentication-check-retrieve description: Return the user making the request, if authenticated successfully. hints: readOnly: true destructive: false idempotent: true call: netbox.authentication-check-retrieve outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-list description: Get a list of Circuit group assignment objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-group-assignments-list 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 inputParameters: - name: circuit type: array description: circuit - name: circuit_id type: array description: circuit_id - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: group type: array description: Circuit group (slug) - name: group__n type: array description: Circuit group (slug) - name: group_id type: array description: Circuit group (ID) - name: group_id__n type: array description: Circuit group (ID) - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: member_id type: array description: member_id - name: member_id__empty type: boolean description: member_id__empty - name: member_id__gt type: array description: member_id__gt - name: member_id__gte type: array description: member_id__gte - name: member_id__lt type: array description: member_id__lt - name: member_id__lte type: array description: member_id__lte - name: member_id__n type: array description: member_id__n - name: member_type type: array description: member_type - name: member_type__n type: array description: member_type__n - name: modified_by_request type: string description: modified_by_request - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: priority type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - name: priority__empty type: boolean description: priority__empty - name: priority__ic type: array description: priority__ic - name: priority__ie type: array description: priority__ie - name: priority__iew type: array description: priority__iew - name: priority__iregex type: array description: priority__iregex - name: priority__isw type: array description: priority__isw - name: priority__n type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - name: priority__nic type: array description: priority__nic - name: priority__nie type: array description: priority__nie - name: priority__niew type: array description: priority__niew - name: priority__nisw type: array description: priority__nisw - name: priority__regex type: array description: priority__regex - name: provider type: array description: provider - name: provider_id type: array description: provider_id - name: q type: string description: Search - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: updated_by_request type: string description: updated_by_request - name: virtual_circuit type: array description: virtual_circuit - name: virtual_circuit_id type: array description: virtual_circuit_id outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-create description: Post a list of Circuit group assignment objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-group-assignments-create outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-bulk-update description: Put a list of Circuit group assignment objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-group-assignments-bulk-update outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-bulk-partial- description: Patch a list of Circuit group assignment objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-group-assignments-bulk-partial- outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-bulk-destroy description: Delete a list of Circuit group assignment objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-group-assignments-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-retrieve description: Get a Circuit group assignment object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-group-assignments-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this Circuit group assignment. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-update description: Put a Circuit group assignment object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-group-assignments-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this Circuit group assignment. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-partial-updat description: Patch a Circuit group assignment object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-group-assignments-partial-updat with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this Circuit group assignment. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-group-assignments-destroy description: Delete a Circuit group assignment object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-group-assignments-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this Circuit group assignment. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-list description: Get a list of circuit group objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-groups-list 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 inputParameters: - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: modified_by_request type: string description: modified_by_request - name: name type: array description: name - name: name__empty type: boolean description: name__empty - name: name__ic type: array description: name__ic - name: name__ie type: array description: name__ie - name: name__iew type: array description: name__iew - name: name__iregex type: array description: name__iregex - name: name__isw type: array description: name__isw - name: name__n type: array description: name__n - name: name__nic type: array description: name__nic - name: name__nie type: array description: name__nie - name: name__niew type: array description: name__niew - name: name__nisw type: array description: name__nisw - name: name__regex type: array description: name__regex - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: owner type: array description: Owner (name) - name: owner__n type: array description: Owner (name) - name: owner_group type: array description: Owner Group (name) - name: owner_group__n type: array description: Owner Group (name) - name: owner_group_id type: array description: Owner Group (ID) - name: owner_group_id__n type: array description: Owner Group (ID) - name: owner_id type: array description: Owner (ID) - name: owner_id__n type: array description: Owner (ID) - name: q type: string description: Search - name: slug type: array description: slug - name: slug__empty type: boolean description: slug__empty - name: slug__ic type: array description: slug__ic - name: slug__ie type: array description: slug__ie - name: slug__iew type: array description: slug__iew - name: slug__iregex type: array description: slug__iregex - name: slug__isw type: array description: slug__isw - name: slug__n type: array description: slug__n - name: slug__nic type: array description: slug__nic - name: slug__nie type: array description: slug__nie - name: slug__niew type: array description: slug__niew - name: slug__nisw type: array description: slug__nisw - name: slug__regex type: array description: slug__regex - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: tenant type: array description: Tenant (slug) - name: tenant__n type: array description: Tenant (slug) - name: tenant_group type: array description: tenant_group - name: tenant_group__n type: array description: tenant_group__n - name: tenant_group_id type: array description: tenant_group_id - name: tenant_group_id__n type: array description: tenant_group_id__n - name: tenant_id type: array description: Tenant (ID) - name: tenant_id__n type: array description: Tenant (ID) - name: updated_by_request type: string description: updated_by_request outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-create description: Post a list of circuit group objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-groups-create outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-bulk-update description: Put a list of circuit group objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-groups-bulk-update outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-bulk-partial-update description: Patch a list of circuit group objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-groups-bulk-partial-update outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-bulk-destroy description: Delete a list of circuit group objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-groups-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-retrieve description: Get a circuit group object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-groups-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit group. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-update description: Put a circuit group object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-groups-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit group. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-partial-update description: Patch a circuit group object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-groups-partial-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit group. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-groups-destroy description: Delete a circuit group object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-groups-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit group. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-list description: Get a list of circuit termination objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-terminations-list 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 inputParameters: - name: cable_connector type: array description: cable_connector - name: cable_connector__empty type: boolean description: cable_connector__empty - name: cable_connector__gt type: array description: cable_connector__gt - name: cable_connector__gte type: array description: cable_connector__gte - name: cable_connector__lt type: array description: cable_connector__lt - name: cable_connector__lte type: array description: cable_connector__lte - name: cable_connector__n type: array description: cable_connector__n - name: cable_end type: string description: '* `A` - A * `B` - B' - name: cable_end__empty type: boolean description: cable_end__empty - name: cable_end__ic type: array description: cable_end__ic - name: cable_end__ie type: array description: cable_end__ie - name: cable_end__iew type: array description: cable_end__iew - name: cable_end__iregex type: array description: cable_end__iregex - name: cable_end__isw type: array description: cable_end__isw - name: cable_end__n type: string description: '* `A` - A * `B` - B' - name: cable_end__nic type: array description: cable_end__nic - name: cable_end__nie type: array description: cable_end__nie - name: cable_end__niew type: array description: cable_end__niew - name: cable_end__nisw type: array description: cable_end__nisw - name: cable_end__regex type: array description: cable_end__regex - name: cable_id type: array description: Cable (ID) - name: cable_id__n type: array description: Cable (ID) - name: cabled type: boolean description: cabled - name: circuit_id type: array description: Circuit - name: circuit_id__n type: array description: Circuit - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: location type: array description: location - name: location__n type: array description: location__n - name: location_id type: array description: location_id - name: location_id__n type: array description: location_id__n - name: mark_connected type: boolean description: mark_connected - name: modified_by_request type: string description: modified_by_request - name: occupied type: boolean description: occupied - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: port_speed type: array description: port_speed - name: port_speed__empty type: boolean description: port_speed__empty - name: port_speed__gt type: array description: port_speed__gt - name: port_speed__gte type: array description: port_speed__gte - name: port_speed__lt type: array description: port_speed__lt - name: port_speed__lte type: array description: port_speed__lte - name: port_speed__n type: array description: port_speed__n - name: pp_info type: array description: pp_info - name: pp_info__empty type: boolean description: pp_info__empty - name: pp_info__ic type: array description: pp_info__ic - name: pp_info__ie type: array description: pp_info__ie - name: pp_info__iew type: array description: pp_info__iew - name: pp_info__iregex type: array description: pp_info__iregex - name: pp_info__isw type: array description: pp_info__isw - name: pp_info__n type: array description: pp_info__n - name: pp_info__nic type: array description: pp_info__nic - name: pp_info__nie type: array description: pp_info__nie - name: pp_info__niew type: array description: pp_info__niew - name: pp_info__nisw type: array description: pp_info__nisw - name: pp_info__regex type: array description: pp_info__regex - name: provider type: array description: Provider (slug) - name: provider__n type: array description: Provider (slug) - name: provider_id type: array description: Provider (ID) - name: provider_id__n type: array description: Provider (ID) - name: provider_network_id type: array description: ProviderNetwork (ID) - name: provider_network_id__n type: array description: ProviderNetwork (ID) - name: q type: string description: Search - name: region type: array description: region - name: region__n type: array description: region__n - name: region_id type: array description: region_id - name: region_id__n type: array description: region_id__n - name: site type: array description: Site (slug) - name: site__n type: array description: Site (slug) - name: site_group type: array description: site_group - name: site_group__n type: array description: site_group__n - name: site_group_id type: array description: site_group_id - name: site_group_id__n type: array description: site_group_id__n - name: site_id type: array description: Site (ID) - name: site_id__n type: array description: Site (ID) - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: term_side type: string description: '* `A` - A * `Z` - Z' - name: term_side__empty type: boolean description: term_side__empty - name: term_side__ic type: array description: term_side__ic - name: term_side__ie type: array description: term_side__ie - name: term_side__iew type: array description: term_side__iew - name: term_side__iregex type: array description: term_side__iregex - name: term_side__isw type: array description: term_side__isw - name: term_side__n type: string description: '* `A` - A * `Z` - Z' - name: term_side__nic type: array description: term_side__nic - name: term_side__nie type: array description: term_side__nie - name: term_side__niew type: array description: term_side__niew - name: term_side__nisw type: array description: term_side__nisw - name: term_side__regex type: array description: term_side__regex - name: termination_id type: array description: termination_id - name: termination_id__empty type: boolean description: termination_id__empty - name: termination_id__gt type: array description: termination_id__gt - name: termination_id__gte type: array description: termination_id__gte - name: termination_id__lt type: array description: termination_id__lt - name: termination_id__lte type: array description: termination_id__lte - name: termination_id__n type: array description: termination_id__n - name: termination_type type: array description: termination_type - name: termination_type__n type: array description: termination_type__n - name: updated_by_request type: string description: updated_by_request - name: upstream_speed type: array description: upstream_speed - name: upstream_speed__empty type: boolean description: upstream_speed__empty - name: upstream_speed__gt type: array description: upstream_speed__gt - name: upstream_speed__gte type: array description: upstream_speed__gte - name: upstream_speed__lt type: array description: upstream_speed__lt - name: upstream_speed__lte type: array description: upstream_speed__lte - name: upstream_speed__n type: array description: upstream_speed__n - name: xconnect_id type: array description: xconnect_id - name: xconnect_id__empty type: boolean description: xconnect_id__empty - name: xconnect_id__ic type: array description: xconnect_id__ic - name: xconnect_id__ie type: array description: xconnect_id__ie - name: xconnect_id__iew type: array description: xconnect_id__iew - name: xconnect_id__iregex type: array description: xconnect_id__iregex - name: xconnect_id__isw type: array description: xconnect_id__isw - name: xconnect_id__n type: array description: xconnect_id__n - name: xconnect_id__nic type: array description: xconnect_id__nic - name: xconnect_id__nie type: array description: xconnect_id__nie - name: xconnect_id__niew type: array description: xconnect_id__niew - name: xconnect_id__nisw type: array description: xconnect_id__nisw - name: xconnect_id__regex type: array description: xconnect_id__regex outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-create description: Post a list of circuit termination objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-terminations-create outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-bulk-update description: Put a list of circuit termination objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-terminations-bulk-update outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-bulk-partial-updat description: Patch a list of circuit termination objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-terminations-bulk-partial-updat outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-bulk-destroy description: Delete a list of circuit termination objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-terminations-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-retrieve description: Get a circuit termination object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-terminations-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit termination. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-update description: Put a circuit termination object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-terminations-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit termination. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-partial-update description: Patch a circuit termination object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-terminations-partial-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit termination. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-destroy description: Delete a circuit termination object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-terminations-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit termination. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-terminations-paths-retrieve description: Return all CablePaths which traverse a given pass-through port. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-terminations-paths-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit termination. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-types-list description: Get a list of circuit type objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-types-list 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 inputParameters: - name: color type: array description: color - name: color__empty type: boolean description: color__empty - name: color__ic type: array description: color__ic - name: color__ie type: array description: color__ie - name: color__iew type: array description: color__iew - name: color__iregex type: array description: color__iregex - name: color__isw type: array description: color__isw - name: color__n type: array description: color__n - name: color__nic type: array description: color__nic - name: color__nie type: array description: color__nie - name: color__niew type: array description: color__niew - name: color__nisw type: array description: color__nisw - name: color__regex type: array description: color__regex - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: modified_by_request type: string description: modified_by_request - name: name type: array description: name - name: name__empty type: boolean description: name__empty - name: name__ic type: array description: name__ic - name: name__ie type: array description: name__ie - name: name__iew type: array description: name__iew - name: name__iregex type: array description: name__iregex - name: name__isw type: array description: name__isw - name: name__n type: array description: name__n - name: name__nic type: array description: name__nic - name: name__nie type: array description: name__nie - name: name__niew type: array description: name__niew - name: name__nisw type: array description: name__nisw - name: name__regex type: array description: name__regex - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: owner type: array description: Owner (name) - name: owner__n type: array description: Owner (name) - name: owner_group type: array description: Owner Group (name) - name: owner_group__n type: array description: Owner Group (name) - name: owner_group_id type: array description: Owner Group (ID) - name: owner_group_id__n type: array description: Owner Group (ID) - name: owner_id type: array description: Owner (ID) - name: owner_id__n type: array description: Owner (ID) - name: q type: string description: Search - name: slug type: array description: slug - name: slug__empty type: boolean description: slug__empty - name: slug__ic type: array description: slug__ic - name: slug__ie type: array description: slug__ie - name: slug__iew type: array description: slug__iew - name: slug__iregex type: array description: slug__iregex - name: slug__isw type: array description: slug__isw - name: slug__n type: array description: slug__n - name: slug__nic type: array description: slug__nic - name: slug__nie type: array description: slug__nie - name: slug__niew type: array description: slug__niew - name: slug__nisw type: array description: slug__nisw - name: slug__regex type: array description: slug__regex - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: updated_by_request type: string description: updated_by_request outputParameters: - type: object mapping: $. - name: circuits-circuit-types-create description: Post a list of circuit type objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-types-create outputParameters: - type: object mapping: $. - name: circuits-circuit-types-bulk-update description: Put a list of circuit type objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-types-bulk-update outputParameters: - type: object mapping: $. - name: circuits-circuit-types-bulk-partial-update description: Patch a list of circuit type objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-types-bulk-partial-update outputParameters: - type: object mapping: $. - name: circuits-circuit-types-bulk-destroy description: Delete a list of circuit type objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-types-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-circuit-types-retrieve description: Get a circuit type object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuit-types-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit type. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-types-update description: Put a circuit type object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuit-types-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit type. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-types-partial-update description: Patch a circuit type object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuit-types-partial-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit type. required: true outputParameters: - type: object mapping: $. - name: circuits-circuit-types-destroy description: Delete a circuit type object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuit-types-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit type. required: true outputParameters: - type: object mapping: $. - name: circuits-circuits-list description: Get a list of circuit objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuits-list 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 inputParameters: - name: cid type: array description: cid - name: cid__empty type: boolean description: cid__empty - name: cid__ic type: array description: cid__ic - name: cid__ie type: array description: cid__ie - name: cid__iew type: array description: cid__iew - name: cid__iregex type: array description: cid__iregex - name: cid__isw type: array description: cid__isw - name: cid__n type: array description: cid__n - name: cid__nic type: array description: cid__nic - name: cid__nie type: array description: cid__nie - name: cid__niew type: array description: cid__niew - name: cid__nisw type: array description: cid__nisw - name: cid__regex type: array description: cid__regex - name: commit_rate type: array description: commit_rate - name: commit_rate__empty type: boolean description: commit_rate__empty - name: commit_rate__gt type: array description: commit_rate__gt - name: commit_rate__gte type: array description: commit_rate__gte - name: commit_rate__lt type: array description: commit_rate__lt - name: commit_rate__lte type: array description: commit_rate__lte - name: commit_rate__n type: array description: commit_rate__n - name: contact type: array description: Contact - name: contact__n type: array description: Contact - name: contact_group type: array description: contact_group - name: contact_group__n type: array description: contact_group__n - name: contact_role type: array description: Contact Role - name: contact_role__n type: array description: Contact Role - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: distance type: array description: distance - name: distance__empty type: boolean description: distance__empty - name: distance__gt type: array description: distance__gt - name: distance__gte type: array description: distance__gte - name: distance__lt type: array description: distance__lt - name: distance__lte type: array description: distance__lte - name: distance__n type: array description: distance__n - name: distance_unit type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' - name: distance_unit__empty type: boolean description: distance_unit__empty - name: distance_unit__ic type: array description: distance_unit__ic - name: distance_unit__ie type: array description: distance_unit__ie - name: distance_unit__iew type: array description: distance_unit__iew - name: distance_unit__iregex type: array description: distance_unit__iregex - name: distance_unit__isw type: array description: distance_unit__isw - name: distance_unit__n type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' - name: distance_unit__nic type: array description: distance_unit__nic - name: distance_unit__nie type: array description: distance_unit__nie - name: distance_unit__niew type: array description: distance_unit__niew - name: distance_unit__nisw type: array description: distance_unit__nisw - name: distance_unit__regex type: array description: distance_unit__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: install_date type: array description: install_date - name: install_date__empty type: boolean description: install_date__empty - name: install_date__gt type: array description: install_date__gt - name: install_date__gte type: array description: install_date__gte - name: install_date__lt type: array description: install_date__lt - name: install_date__lte type: array description: install_date__lte - name: install_date__n type: array description: install_date__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: location_id type: array description: Location (ID) - name: location_id__n type: array description: Location (ID) - name: modified_by_request type: string description: modified_by_request - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: owner type: array description: Owner (name) - name: owner__n type: array description: Owner (name) - name: owner_group type: array description: Owner Group (name) - name: owner_group__n type: array description: Owner Group (name) - name: owner_group_id type: array description: Owner Group (ID) - name: owner_group_id__n type: array description: Owner Group (ID) - name: owner_id type: array description: Owner (ID) - name: owner_id__n type: array description: Owner (ID) - name: provider type: array description: Provider (slug) - name: provider__n type: array description: Provider (slug) - name: provider_account type: array description: Provider account (account) - name: provider_account__n type: array description: Provider account (account) - name: provider_account_id type: array description: Provider account (ID) - name: provider_account_id__n type: array description: Provider account (ID) - name: provider_id type: array description: Provider (ID) - name: provider_id__n type: array description: Provider (ID) - name: provider_network_id type: array description: Provider network (ID) - name: provider_network_id__n type: array description: Provider network (ID) - name: q type: string description: Search - name: region type: array description: region - name: region__n type: array description: region__n - name: region_id type: array description: region_id - name: region_id__n type: array description: region_id__n - name: site type: array description: Site (slug) - name: site__n type: array description: Site (slug) - name: site_group type: array description: site_group - name: site_group__n type: array description: site_group__n - name: site_group_id type: array description: site_group_id - name: site_group_id__n type: array description: site_group_id__n - name: site_id type: array description: Site (ID) - name: site_id__n type: array description: Site (ID) - name: status type: array description: status - name: status__empty type: boolean description: status__empty - name: status__ic type: array description: status__ic - name: status__ie type: array description: status__ie - name: status__iew type: array description: status__iew - name: status__iregex type: array description: status__iregex - name: status__isw type: array description: status__isw - name: status__n type: array description: status__n - name: status__nic type: array description: status__nic - name: status__nie type: array description: status__nie - name: status__niew type: array description: status__niew - name: status__nisw type: array description: status__nisw - name: status__regex type: array description: status__regex - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: tenant type: array description: Tenant (slug) - name: tenant__n type: array description: Tenant (slug) - name: tenant_group type: array description: tenant_group - name: tenant_group__n type: array description: tenant_group__n - name: tenant_group_id type: array description: tenant_group_id - name: tenant_group_id__n type: array description: tenant_group_id__n - name: tenant_id type: array description: Tenant (ID) - name: tenant_id__n type: array description: Tenant (ID) - name: termination_a_id type: array description: Termination A (ID) - name: termination_a_id__n type: array description: Termination A (ID) - name: termination_date type: array description: termination_date - name: termination_date__empty type: boolean description: termination_date__empty - name: termination_date__gt type: array description: termination_date__gt - name: termination_date__gte type: array description: termination_date__gte - name: termination_date__lt type: array description: termination_date__lt - name: termination_date__lte type: array description: termination_date__lte - name: termination_date__n type: array description: termination_date__n - name: termination_z_id type: array description: Termination A (ID) - name: termination_z_id__n type: array description: Termination A (ID) - name: type type: array description: Circuit type (slug) - name: type__n type: array description: Circuit type (slug) - name: type_id type: array description: Circuit type (ID) - name: type_id__n type: array description: Circuit type (ID) - name: updated_by_request type: string description: updated_by_request outputParameters: - type: object mapping: $. - name: circuits-circuits-create description: Post a list of circuit objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuits-create outputParameters: - type: object mapping: $. - name: circuits-circuits-bulk-update description: Put a list of circuit objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuits-bulk-update outputParameters: - type: object mapping: $. - name: circuits-circuits-bulk-partial-update description: Patch a list of circuit objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuits-bulk-partial-update outputParameters: - type: object mapping: $. - name: circuits-circuits-bulk-destroy description: Delete a list of circuit objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuits-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-circuits-retrieve description: Get a circuit object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-circuits-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit. required: true outputParameters: - type: object mapping: $. - name: circuits-circuits-update description: Put a circuit object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-circuits-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit. required: true outputParameters: - type: object mapping: $. - name: circuits-circuits-partial-update description: Patch a circuit object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-circuits-partial-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit. required: true outputParameters: - type: object mapping: $. - name: circuits-circuits-destroy description: Delete a circuit object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-circuits-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this circuit. required: true outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-list description: Get a list of provider account objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-provider-accounts-list 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 inputParameters: - name: account type: array description: account - name: account__empty type: boolean description: account__empty - name: account__ic type: array description: account__ic - name: account__ie type: array description: account__ie - name: account__iew type: array description: account__iew - name: account__iregex type: array description: account__iregex - name: account__isw type: array description: account__isw - name: account__n type: array description: account__n - name: account__nic type: array description: account__nic - name: account__nie type: array description: account__nie - name: account__niew type: array description: account__niew - name: account__nisw type: array description: account__nisw - name: account__regex type: array description: account__regex - name: contact type: array description: Contact - name: contact__n type: array description: Contact - name: contact_group type: array description: contact_group - name: contact_group__n type: array description: contact_group__n - name: contact_role type: array description: Contact Role - name: contact_role__n type: array description: Contact Role - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: modified_by_request type: string description: modified_by_request - name: name type: array description: name - name: name__empty type: boolean description: name__empty - name: name__ic type: array description: name__ic - name: name__ie type: array description: name__ie - name: name__iew type: array description: name__iew - name: name__iregex type: array description: name__iregex - name: name__isw type: array description: name__isw - name: name__n type: array description: name__n - name: name__nic type: array description: name__nic - name: name__nie type: array description: name__nie - name: name__niew type: array description: name__niew - name: name__nisw type: array description: name__nisw - name: name__regex type: array description: name__regex - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: owner type: array description: Owner (name) - name: owner__n type: array description: Owner (name) - name: owner_group type: array description: Owner Group (name) - name: owner_group__n type: array description: Owner Group (name) - name: owner_group_id type: array description: Owner Group (ID) - name: owner_group_id__n type: array description: Owner Group (ID) - name: owner_id type: array description: Owner (ID) - name: owner_id__n type: array description: Owner (ID) - name: provider type: array description: Provider (slug) - name: provider__n type: array description: Provider (slug) - name: provider_id type: array description: Provider (ID) - name: provider_id__n type: array description: Provider (ID) - name: q type: string description: Search - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: updated_by_request type: string description: updated_by_request outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-create description: Post a list of provider account objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-provider-accounts-create outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-bulk-update description: Put a list of provider account objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-provider-accounts-bulk-update outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-bulk-partial-update description: Patch a list of provider account objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-provider-accounts-bulk-partial-update outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-bulk-destroy description: Delete a list of provider account objects. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-provider-accounts-bulk-destroy outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-retrieve description: Get a provider account object. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-provider-accounts-retrieve with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this provider account. required: true outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-update description: Put a provider account object. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-provider-accounts-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this provider account. required: true outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-partial-update description: Patch a provider account object. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-provider-accounts-partial-update with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this provider account. required: true outputParameters: - type: object mapping: $. - name: circuits-provider-accounts-destroy description: Delete a provider account object. hints: readOnly: false destructive: true idempotent: true call: netbox.circuits-provider-accounts-destroy with: id: tools.id inputParameters: - name: id type: integer description: A unique integer value identifying this provider account. required: true outputParameters: - type: object mapping: $. - name: circuits-provider-networks-list description: Get a list of provider network objects. hints: readOnly: true destructive: false idempotent: true call: netbox.circuits-provider-networks-list 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 inputParameters: - name: created type: array description: created - name: created__empty type: array description: created__empty - name: created__gt type: array description: created__gt - name: created__gte type: array description: created__gte - name: created__lt type: array description: created__lt - name: created__lte type: array description: created__lte - name: created__n type: array description: created__n - name: created_by_request type: string description: created_by_request - name: description type: array description: description - name: description__empty type: boolean description: description__empty - name: description__ic type: array description: description__ic - name: description__ie type: array description: description__ie - name: description__iew type: array description: description__iew - name: description__iregex type: array description: description__iregex - name: description__isw type: array description: description__isw - name: description__n type: array description: description__n - name: description__nic type: array description: description__nic - name: description__nie type: array description: description__nie - name: description__niew type: array description: description__niew - name: description__nisw type: array description: description__nisw - name: description__regex type: array description: description__regex - name: id type: array description: id - name: id__empty type: boolean description: id__empty - name: id__gt type: array description: id__gt - name: id__gte type: array description: id__gte - name: id__lt type: array description: id__lt - name: id__lte type: array description: id__lte - name: id__n type: array description: id__n - name: last_updated type: array description: last_updated - name: last_updated__empty type: array description: last_updated__empty - name: last_updated__gt type: array description: last_updated__gt - name: last_updated__gte type: array description: last_updated__gte - name: last_updated__lt type: array description: last_updated__lt - name: last_updated__lte type: array description: last_updated__lte - name: last_updated__n type: array description: last_updated__n - name: limit type: integer description: Number of results to return per page. - name: modified_by_request type: string description: modified_by_request - name: name type: array description: name - name: name__empty type: boolean description: name__empty - name: name__ic type: array description: name__ic - name: name__ie type: array description: name__ie - name: name__iew type: array description: name__iew - name: name__iregex type: array description: name__iregex - name: name__isw type: array description: name__isw - name: name__n type: array description: name__n - name: name__nic type: array description: name__nic - name: name__nie type: array description: name__nie - name: name__niew type: array description: name__niew - name: name__nisw type: array description: name__nisw - name: name__regex type: array description: name__regex - name: offset type: integer description: The initial index from which to return the results. - name: ordering type: string description: Which field to use when ordering the results. - name: owner type: array description: Owner (name) - name: owner__n type: array description: Owner (name) - name: owner_group type: array description: Owner Group (name) - name: owner_group__n type: array description: Owner Group (name) - name: owner_group_id type: array description: Owner Group (ID) - name: owner_group_id__n type: array description: Owner Group (ID) - name: owner_id type: array description: Owner (ID) - name: owner_id__n type: array description: Owner (ID) - name: provider type: array description: Provider (slug) - name: provider__n type: array description: Provider (slug) - name: provider_id type: array description: Provider (ID) - name: provider_id__n type: array description: Provider (ID) - name: q type: string description: Search - name: service_id type: array description: service_id - name: service_id__empty type: boolean description: service_id__empty - name: service_id__ic type: array description: service_id__ic - name: service_id__ie type: array description: service_id__ie - name: service_id__iew type: array description: service_id__iew - name: service_id__iregex type: array description: service_id__iregex - name: service_id__isw type: array description: service_id__isw - name: service_id__n type: array description: service_id__n - name: service_id__nic type: array description: service_id__nic - name: service_id__nie type: array description: service_id__nie - name: service_id__niew type: array description: service_id__niew - name: service_id__nisw type: array description: service_id__nisw - name: service_id__regex type: array description: service_id__regex - name: tag type: array description: tag - name: tag__n type: array description: tag__n - name: tag_id type: array description: tag_id - name: tag_id__n type: array description: tag_id__n - name: updated_by_request type: string description: updated_by_request outputParameters: - type: object mapping: $. - name: circuits-provider-networks-create description: Post a list of provider network objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-provider-networks-create outputParameters: - type: object mapping: $. - name: circuits-provider-networks-bulk-update description: Put a list of provider network objects. hints: readOnly: false destructive: false idempotent: true call: netbox.circuits-provider-networks-bulk-update outputParameters: - type: object mapping: $. - name: circuits-provider-networks-bulk-partial-update description: Patch a list of provider network objects. hints: readOnly: false destructive: false idempotent: false call: netbox.circuits-provider-networks-bulk-partial-update outputParameters: - type: object mapping: $. binds: - namespace: env keys: NETBOX_TOKEN: NETBOX_TOKEN