@itentialopensource/adapter-netbox_v33

{ "swagger":"2.0", "info":{ "title":"NetBox API", "description":"API to access NetBox", "termsOfService":"https://github.com/netbox-community/netbox", "license":{ "name":"Apache v2 License" }, "version":"3.4" }, "host":"10.219.97.211:8000", "schemes":[ "http" ], "basePath":"/api", "consumes":[ "application/json" ], "produces":[ "application/json" ], "securityDefinitions":{ "Bearer":{ "type":"apiKey", "name":"Authorization", "in":"header" } }, "security":[ { "Bearer":[ ] } ], "paths":{ "/circuits/circuit-terminations/":{ "get":{ "operationId":"circuits_circuit-terminations_list", "description":"", "parameters":[ { "name":"id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"term_side", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cable_end", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tag", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cabled", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"occupied", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"circuit_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"provider_network_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"term_side__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"port_speed__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"upstream_speed__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__ic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__nic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__iew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__niew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__isw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__nisw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__ie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__nie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"xconnect_id__empty", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__ic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__iew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__niew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__isw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nisw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__ie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__empty", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cable_end__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tag__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"circuit_id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site_id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"provider_network_id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"ordering", "in":"query", "description":"Which field to use when ordering the results.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Number of results to return per page.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"The initial index from which to return the results.", "required":false, "type":"integer" } ], "responses":{ "200":{ "description":"", "schema":{ "required":[ "count", "results" ], "type":"object", "properties":{ "count":{ "type":"integer" }, "next":{ "type":"string", "format":"uri", "x-nullable":true }, "previous":{ "type":"string", "format":"uri", "x-nullable":true }, "results":{ "type":"array", "items":{ "$ref":"#/definitions/CircuitTermination" } } } } } }, "tags":[ "circuits" ] }, "post":{ "operationId":"circuits_circuit-terminations_create", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/WritableCircuitTermination" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "put":{ "operationId":"circuits_circuit-terminations_bulk_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/WritableCircuitTermination" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "patch":{ "operationId":"circuits_circuit-terminations_bulk_partial_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/WritableCircuitTermination" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "delete":{ "operationId":"circuits_circuit-terminations_bulk_delete", "description":"", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "tags":[ "circuits" ] }, "parameters":[ ] }, "/circuits/circuit-terminations/{id}/":{ "get":{ "operationId":"circuits_circuit-terminations_read", "description":"", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "put":{ "operationId":"circuits_circuit-terminations_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/WritableCircuitTermination" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "patch":{ "operationId":"circuits_circuit-terminations_partial_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/WritableCircuitTermination" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "delete":{ "operationId":"circuits_circuit-terminations_delete", "description":"", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "tags":[ "circuits" ] }, "parameters":[ { "name":"id", "in":"path", "description":"A unique integer value identifying this circuit termination.", "required":true, "type":"integer" } ] }, "/circuits/circuit-terminations/{id}/paths/":{ "get":{ "operationId":"circuits_circuit-terminations_paths", "description":"Return all CablePaths which traverse a given pass-through port.", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitTermination" } } }, "tags":[ "circuits" ] }, "parameters":[ { "name":"id", "in":"path", "description":"A unique integer value identifying this circuit termination.", "required":true, "type":"integer" } ] }, "/circuits/circuit-types/":{ "get":{ "operationId":"circuits_circuit-types_list", "description":"", "parameters":[ { "name":"id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tag", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__ic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__nic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__iew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__niew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__isw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__nisw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__ie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__nie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"name__empty", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__ic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__nic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__iew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__niew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__isw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__nisw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__ie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__nie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"slug__empty", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__ic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nic", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__iew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__niew", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__isw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nisw", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__ie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__nie", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description__empty", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tag__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"ordering", "in":"query", "description":"Which field to use when ordering the results.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Number of results to return per page.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"The initial index from which to return the results.", "required":false, "type":"integer" } ], "responses":{ "200":{ "description":"", "schema":{ "required":[ "count", "results" ], "type":"object", "properties":{ "count":{ "type":"integer" }, "next":{ "type":"string", "format":"uri", "x-nullable":true }, "previous":{ "type":"string", "format":"uri", "x-nullable":true }, "results":{ "type":"array", "items":{ "$ref":"#/definitions/CircuitType" } } } } } }, "tags":[ "circuits" ] }, "post":{ "operationId":"circuits_circuit-types_create", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CircuitType" } } ], "responses":{ "201":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "put":{ "operationId":"circuits_circuit-types_bulk_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CircuitType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "patch":{ "operationId":"circuits_circuit-types_bulk_partial_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CircuitType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "delete":{ "operationId":"circuits_circuit-types_bulk_delete", "description":"", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "tags":[ "circuits" ] }, "parameters":[ ] }, "/circuits/circuit-types/{id}/":{ "get":{ "operationId":"circuits_circuit-types_read", "description":"", "parameters":[ ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "put":{ "operationId":"circuits_circuit-types_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CircuitType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "patch":{ "operationId":"circuits_circuit-types_partial_update", "description":"", "parameters":[ { "name":"data", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CircuitType" } } ], "responses":{ "200":{ "description":"", "schema":{ "$ref":"#/definitions/CircuitType" } } }, "tags":[ "circuits" ] }, "delete":{ "operationId":"circuits_circuit-types_delete", "description":"", "parameters":[ ], "responses":{ "204":{ "description":"" } }, "tags":[ "circuits" ] }, "parameters":[ { "name":"id", "in":"path", "description":"A unique integer value identifying this circuit type.", "required":true, "type":"integer" } ] }, "/circuits/circuits/":{ "get":{ "operationId":"circuits_circuits_list", "description":"", "parameters":[ { "name":"id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cid", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"description", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"install_date", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"termination_date", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"commit_rate", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"created", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"last_updated", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tag", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tenant_group_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tenant_group", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tenant_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"tenant", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"contact", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"contact_role", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"contact_group", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"provider_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"provider", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"provider_network_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"type_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"status", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"region_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"region", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site_group_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site_group", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site_id", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"site", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__lt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gte", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"id__gt", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cid__n", "in":"query", "description":"", "required":false, "type":"string" }, { "name":"cid__ic", "in":"query", "description":"", "required":false, "type":"string" },