@itentialopensource/adapter-netbox_v210

openapi: 3.0.0 info: title: NetBox API description: API to access NetBox contact: {} version: '2.10' servers: - url: https://netbox.core-services.test.leaseplan.systems/api variables: {} paths: /circuits/circuit-terminations/: get: tags: - circuits summary: circuits_circuit-terminations_list description: '' operationId: circuits_circuit-terminations_list parameters: - name: term_side in: query description: '' style: form explode: true schema: type: string - name: port_speed in: query description: '' style: form explode: true schema: type: string - name: upstream_speed in: query description: '' style: form explode: true schema: type: string - name: xconnect_id in: query description: '' style: form explode: true schema: type: string - name: cabled in: query description: '' style: form explode: true schema: type: string - name: connected in: query description: '' style: form explode: true schema: type: string - name: q in: query description: '' style: form explode: true schema: type: string - name: circuit_id in: query description: '' style: form explode: true schema: type: string - name: site_id in: query description: '' style: form explode: true schema: type: string - name: site in: query description: '' style: form explode: true schema: type: string - name: term_side__n in: query description: '' style: form explode: true schema: type: string - name: port_speed__n in: query description: '' style: form explode: true schema: type: string - name: port_speed__lte in: query description: '' style: form explode: true schema: type: string - name: port_speed__lt in: query description: '' style: form explode: true schema: type: string - name: port_speed__gte in: query description: '' style: form explode: true schema: type: string - name: port_speed__gt in: query description: '' style: form explode: true schema: type: string - name: upstream_speed__n in: query description: '' style: form explode: true schema: type: string - name: upstream_speed__lte in: query description: '' style: form explode: true schema: type: string - name: upstream_speed__lt in: query description: '' style: form explode: true schema: type: string - name: upstream_speed__gte in: query description: '' style: form explode: true schema: type: string - name: upstream_speed__gt in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__n in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__ic in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__nic in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__iew in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__niew in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__isw in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__nisw in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__ie in: query description: '' style: form explode: true schema: type: string - name: xconnect_id__nie in: query description: '' style: form explode: true schema: type: string - name: circuit_id__n in: query description: '' style: form explode: true schema: type: string - name: site_id__n in: query description: '' style: form explode: true schema: type: string - name: site__n in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: Number of results to return per page. style: form explode: true schema: type: integer format: int32 - name: offset in: query description: The initial index from which to return the results. style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/circuits_circuit-terminations_listResponse' deprecated: false post: tags: - circuits summary: circuits_circuit-terminations_create description: '' operationId: circuits_circuit-terminations_create parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTermination' required: true responses: '201': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false put: tags: - circuits summary: circuits_circuit-terminations_bulk_update description: '' operationId: circuits_circuit-terminations_bulk_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTermination' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false patch: tags: - circuits summary: circuits_circuit-terminations_bulk_partial_update description: '' operationId: circuits_circuit-terminations_bulk_partial_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTermination' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false delete: tags: - circuits summary: circuits_circuit-terminations_bulk_delete description: '' operationId: circuits_circuit-terminations_bulk_delete parameters: [] responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/circuit-terminations/{id}/: get: tags: - circuits summary: circuits_circuit-terminations_read description: '' operationId: circuits_circuit-terminations_read parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false put: tags: - circuits summary: circuits_circuit-terminations_update description: '' operationId: circuits_circuit-terminations_update parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTermination' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false patch: tags: - circuits summary: circuits_circuit-terminations_partial_update description: '' operationId: circuits_circuit-terminations_partial_update parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTermination' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false delete: tags: - circuits summary: circuits_circuit-terminations_delete description: '' operationId: circuits_circuit-terminations_delete parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true style: simple schema: type: integer format: int32 responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/circuit-terminations/{id}/trace/: get: tags: - circuits summary: circuits_circuit-terminations_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: circuits_circuit-terminations_trace parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' deprecated: false /circuits/circuit-types/: get: tags: - circuits summary: circuits_circuit-types_list description: '' operationId: circuits_circuit-types_list parameters: - name: id in: query description: '' style: form explode: true schema: type: string - name: name in: query description: '' style: form explode: true schema: type: string - name: slug in: query description: '' style: form explode: true schema: type: string - name: q in: query description: '' style: form explode: true schema: type: string - name: id__n in: query description: '' style: form explode: true schema: type: string - name: id__lte in: query description: '' style: form explode: true schema: type: string - name: id__lt in: query description: '' style: form explode: true schema: type: string - name: id__gte in: query description: '' style: form explode: true schema: type: string - name: id__gt in: query description: '' style: form explode: true schema: type: string - name: name__n in: query description: '' style: form explode: true schema: type: string - name: name__ic in: query description: '' style: form explode: true schema: type: string - name: name__nic in: query description: '' style: form explode: true schema: type: string - name: name__iew in: query description: '' style: form explode: true schema: type: string - name: name__niew in: query description: '' style: form explode: true schema: type: string - name: name__isw in: query description: '' style: form explode: true schema: type: string - name: name__nisw in: query description: '' style: form explode: true schema: type: string - name: name__ie in: query description: '' style: form explode: true schema: type: string - name: name__nie in: query description: '' style: form explode: true schema: type: string - name: slug__n in: query description: '' style: form explode: true schema: type: string - name: slug__ic in: query description: '' style: form explode: true schema: type: string - name: slug__nic in: query description: '' style: form explode: true schema: type: string - name: slug__iew in: query description: '' style: form explode: true schema: type: string - name: slug__niew in: query description: '' style: form explode: true schema: type: string - name: slug__isw in: query description: '' style: form explode: true schema: type: string - name: slug__nisw in: query description: '' style: form explode: true schema: type: string - name: slug__ie in: query description: '' style: form explode: true schema: type: string - name: slug__nie in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: Number of results to return per page. style: form explode: true schema: type: integer format: int32 - name: offset in: query description: The initial index from which to return the results. style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/circuits_circuit-types_listResponse' deprecated: false post: tags: - circuits summary: circuits_circuit-types_create description: '' operationId: circuits_circuit-types_create parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CircuitType' required: true responses: '201': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false put: tags: - circuits summary: circuits_circuit-types_bulk_update description: '' operationId: circuits_circuit-types_bulk_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CircuitType' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false patch: tags: - circuits summary: circuits_circuit-types_bulk_partial_update description: '' operationId: circuits_circuit-types_bulk_partial_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CircuitType' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false delete: tags: - circuits summary: circuits_circuit-types_bulk_delete description: '' operationId: circuits_circuit-types_bulk_delete parameters: [] responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/circuit-types/{id}/: get: tags: - circuits summary: circuits_circuit-types_read description: '' operationId: circuits_circuit-types_read parameters: - name: id in: path description: A unique integer value identifying this circuit type. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false put: tags: - circuits summary: circuits_circuit-types_update description: '' operationId: circuits_circuit-types_update parameters: - name: id in: path description: A unique integer value identifying this circuit type. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CircuitType' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false patch: tags: - circuits summary: circuits_circuit-types_partial_update description: '' operationId: circuits_circuit-types_partial_update parameters: - name: id in: path description: A unique integer value identifying this circuit type. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/CircuitType' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/CircuitType' deprecated: false delete: tags: - circuits summary: circuits_circuit-types_delete description: '' operationId: circuits_circuit-types_delete parameters: - name: id in: path description: A unique integer value identifying this circuit type. required: true style: simple schema: type: integer format: int32 responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/circuits/: get: tags: - circuits summary: circuits_circuits_list description: '' operationId: circuits_circuits_list parameters: - name: id in: query description: '' style: form explode: true schema: type: string - name: cid in: query description: '' style: form explode: true schema: type: string - name: install_date in: query description: '' style: form explode: true schema: type: string - name: commit_rate in: query description: '' style: form explode: true schema: type: string - name: tenant_group_id in: query description: '' style: form explode: true schema: type: string - name: tenant_group in: query description: '' style: form explode: true schema: type: string - name: tenant_id in: query description: '' style: form explode: true schema: type: string - name: tenant in: query description: '' style: form explode: true schema: type: string - name: created in: query description: '' style: form explode: true schema: type: string - name: created__gte in: query description: '' style: form explode: true schema: type: string - name: created__lte in: query description: '' style: form explode: true schema: type: string - name: last_updated in: query description: '' style: form explode: true schema: type: string - name: last_updated__gte in: query description: '' style: form explode: true schema: type: string - name: last_updated__lte in: query description: '' style: form explode: true schema: type: string - name: q in: query description: '' style: form explode: true schema: type: string - name: provider_id in: query description: '' style: form explode: true schema: type: string - name: provider in: query description: '' style: form explode: true schema: type: string - name: type_id in: query description: '' style: form explode: true schema: type: string - name: type in: query description: '' style: form explode: true schema: type: string - name: status in: query description: '' style: form explode: true schema: type: string - name: site_id in: query description: '' style: form explode: true schema: type: string - name: site in: query description: '' style: form explode: true schema: type: string - name: region_id in: query description: '' style: form explode: true schema: type: string - name: region in: query description: '' style: form explode: true schema: type: string - name: tag in: query description: '' style: form explode: true schema: type: string - name: id__n in: query description: '' style: form explode: true schema: type: string - name: id__lte in: query description: '' style: form explode: true schema: type: string - name: id__lt in: query description: '' style: form explode: true schema: type: string - name: id__gte in: query description: '' style: form explode: true schema: type: string - name: id__gt in: query description: '' style: form explode: true schema: type: string - name: cid__n in: query description: '' style: form explode: true schema: type: string - name: cid__ic in: query description: '' style: form explode: true schema: type: string - name: cid__nic in: query description: '' style: form explode: true schema: type: string - name: cid__iew in: query description: '' style: form explode: true schema: type: string - name: cid__niew in: query description: '' style: form explode: true schema: type: string - name: cid__isw in: query description: '' style: form explode: true schema: type: string - name: cid__nisw in: query description: '' style: form explode: true schema: type: string - name: cid__ie in: query description: '' style: form explode: true schema: type: string - name: cid__nie in: query description: '' style: form explode: true schema: type: string - name: install_date__n in: query description: '' style: form explode: true schema: type: string - name: install_date__lte in: query description: '' style: form explode: true schema: type: string - name: install_date__lt in: query description: '' style: form explode: true schema: type: string - name: install_date__gte in: query description: '' style: form explode: true schema: type: string - name: install_date__gt in: query description: '' style: form explode: true schema: type: string - name: commit_rate__n in: query description: '' style: form explode: true schema: type: string - name: commit_rate__lte in: query description: '' style: form explode: true schema: type: string - name: commit_rate__lt in: query description: '' style: form explode: true schema: type: string - name: commit_rate__gte in: query description: '' style: form explode: true schema: type: string - name: commit_rate__gt in: query description: '' style: form explode: true schema: type: string - name: tenant_group_id__n in: query description: '' style: form explode: true schema: type: string - name: tenant_group__n in: query description: '' style: form explode: true schema: type: string - name: tenant_id__n in: query description: '' style: form explode: true schema: type: string - name: tenant__n in: query description: '' style: form explode: true schema: type: string - name: provider_id__n in: query description: '' style: form explode: true schema: type: string - name: provider__n in: query description: '' style: form explode: true schema: type: string - name: type_id__n in: query description: '' style: form explode: true schema: type: string - name: type__n in: query description: '' style: form explode: true schema: type: string - name: status__n in: query description: '' style: form explode: true schema: type: string - name: site_id__n in: query description: '' style: form explode: true schema: type: string - name: site__n in: query description: '' style: form explode: true schema: type: string - name: region_id__n in: query description: '' style: form explode: true schema: type: string - name: region__n in: query description: '' style: form explode: true schema: type: string - name: tag__n in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: Number of results to return per page. style: form explode: true schema: type: integer format: int32 - name: offset in: query description: The initial index from which to return the results. style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/circuits_circuits_listResponse' deprecated: false post: tags: - circuits summary: circuits_circuits_create description: '' operationId: circuits_circuits_create parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuit' required: true responses: '201': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false put: tags: - circuits summary: circuits_circuits_bulk_update description: '' operationId: circuits_circuits_bulk_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuit' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false patch: tags: - circuits summary: circuits_circuits_bulk_partial_update description: '' operationId: circuits_circuits_bulk_partial_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuit' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false delete: tags: - circuits summary: circuits_circuits_bulk_delete description: '' operationId: circuits_circuits_bulk_delete parameters: [] responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/circuits/{id}/: get: tags: - circuits summary: circuits_circuits_read description: '' operationId: circuits_circuits_read parameters: - name: id in: path description: A unique integer value identifying this circuit. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false put: tags: - circuits summary: circuits_circuits_update description: '' operationId: circuits_circuits_update parameters: - name: id in: path description: A unique integer value identifying this circuit. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuit' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false patch: tags: - circuits summary: circuits_circuits_partial_update description: '' operationId: circuits_circuits_partial_update parameters: - name: id in: path description: A unique integer value identifying this circuit. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/WritableCircuit' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Circuit' deprecated: false delete: tags: - circuits summary: circuits_circuits_delete description: '' operationId: circuits_circuits_delete parameters: - name: id in: path description: A unique integer value identifying this circuit. required: true style: simple schema: type: integer format: int32 responses: '204': description: '' headers: {} content: {} deprecated: false /circuits/providers/: get: tags: - circuits summary: circuits_providers_list description: '' operationId: circuits_providers_list parameters: - name: id in: query description: '' style: form explode: true schema: type: string - name: name in: query description: '' style: form explode: true schema: type: string - name: slug in: query description: '' style: form explode: true schema: type: string - name: asn in: query description: '' style: form explode: true schema: type: string - name: account in: query description: '' style: form explode: true schema: type: string - name: created in: query description: '' style: form explode: true schema: type: string - name: created__gte in: query description: '' style: form explode: true schema: type: string - name: created__lte in: query description: '' style: form explode: true schema: type: string - name: last_updated in: query description: '' style: form explode: true schema: type: string - name: last_updated__gte in: query description: '' style: form explode: true schema: type: string - name: last_updated__lte in: query description: '' style: form explode: true schema: type: string - name: q in: query description: '' style: form explode: true schema: type: string - name: region_id in: query description: '' style: form explode: true schema: type: string - name: region in: query description: '' style: form explode: true schema: type: string - name: site_id in: query description: '' style: form explode: true schema: type: string - name: site in: query description: '' style: form explode: true schema: type: string - name: tag in: query description: '' style: form explode: true schema: type: string - name: id__n in: query description: '' style: form explode: true schema: type: string - name: id__lte in: query description: '' style: form explode: true schema: type: string - name: id__lt in: query description: '' style: form explode: true schema: type: string - name: id__gte in: query description: '' style: form explode: true schema: type: string - name: id__gt in: query description: '' style: form explode: true schema: type: string - name: name__n in: query description: '' style: form explode: true schema: type: string - name: name__ic in: query description: '' style: form explode: true schema: type: string - name: name__nic in: query description: '' style: form explode: true schema: type: string - name: name__iew in: query description: '' style: form explode: true schema: type: string - name: name__niew in: query description: '' style: form explode: true schema: type: string - name: name__isw in: query description: '' style: form explode: true schema: type: string - name: name__nisw in: query description: '' style: form explode: true schema: type: string - name: name__ie in: query description: '' style: form explode: true schema: type: string - name: name__nie in: query description: '' style: form explode: true schema: type: string - name: slug__n in: query description: '' style: form explode: true schema: type: string - name: slug__ic in: query description: '' style: form explode: true schema: type: string - name: slug__nic in: query description: '' style: form explode: true schema: type: string - name: slug__iew in: query description: '' style: form explode: true schema: type: string - name: slug__niew in: query description: '' style: form explode: true schema: type: string - name: slug__isw in: query description: '' style: form explode: true schema: type: string - name: slug__nisw in: query description: '' style: form explode: true schema: type: string - name: slug__ie in: query description: '' style: form explode: true schema: type: string - name: slug__nie in: query description: '' style: form explode: true schema: type: string - name: asn__n in: query description: '' style: form explode: true schema: type: string - name: asn__lte in: query description: '' style: form explode: true schema: type: string - name: asn__lt in: query description: '' style: form explode: true schema: type: string - name: asn__gte in: query description: '' style: form explode: true schema: type: string - name: asn__gt in: query description: '' style: form explode: true schema: type: string - name: account__n in: query description: '' style: form explode: true schema: type: string - name: account__ic in: query description: '' style: form explode: true schema: type: string - name: account__nic in: query description: '' style: form explode: true schema: type: string - name: account__iew in: query description: '' style: form explode: true schema: type: string - name: account__niew in: query description: '' style: form explode: true schema: type: string - name: account__isw in: query description: '' style: form explode: true schema: type: string - name: account__nisw in: query description: '' style: form explode: true schema: type: string - name: account__ie in: query description: '' style: form explode: true schema: type: string - name: account__nie in: query description: '' style: form explode: true schema: type: string - name: region_id__n in: query description: '' style: form explode: true schema: type: string - name: region__n in: query description: '' style: form explode: true schema: type: string - name: site_id__n in: query description: '' style: form explode: true schema: type: string - name: site__n in: query description: '' style: form explode: true schema: type: string - name: tag__n in: query description: '' style: form explode: true schema: type: string - name: limit in: query description: Number of results to return per page. style: form explode: true schema: type: integer format: int32 - name: offset in: query description: The initial index from which to return the results. style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/circuits_providers_listResponse' deprecated: false post: tags: - circuits summary: circuits_providers_create description: '' operationId: circuits_providers_create parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Provider' required: true responses: '201': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Provider' deprecated: false put: tags: - circuits summary: circuits_providers_bulk_update description: '' operationId: circuits_providers_bulk_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Provider' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/Provider' deprecated: false patch: tags: - circuits summary: circuits_providers_bulk_partial_update description: '' operationId: circuits_providers_bulk_partial_update parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Provider' required: true responses: '200': description: ''