@itentialopensource/adapter-netbox_v33

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/circuits/circuit-terminations/": { "get": { "tags": [ "Circuits" ], "operationId": "getCircuitsCircuitTerminations", "description": "The parameters and request body are for method: getCircuitsCircuitTerminations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "next": { "type": "string" }, "previous": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "provider_network": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "name": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "mark_connected": { "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "label": { "type": "string" } } }, "cable_end": { "type": "string" }, "link_peers": { "type": "array", "items": { "type": "string" } }, "link_peers_type": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "string" } } } }, "custom_fields": { "type": "object" }, "created": { "type": "string" }, "last_updated": { "type": "string" }, "_occupied": { "type": "boolean" } } } } } }, "example": { "count": 5, "next": "string", "previous": "string", "results": [ { "id": 7, "url": "string", "display": "string", "circuit": { "id": 3, "url": "string", "display": "string", "cid": "string" }, "term_side": "A", "site": { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string" }, "provider_network": { "id": 1, "url": "string", "display": "string", "name": "string" }, "port_speed": 9, "upstream_speed": 10, "xconnect_id": "string", "pp_info": "string", "description": "string", "mark_connected": false, "cable": { "id": 5, "url": "string", "display": "string", "label": "string" }, "cable_end": "string", "link_peers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "link_peers_type": "string", "tags": [ { "id": 1, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 3, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 6, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 8, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 5, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 1, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 3, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" } ], "custom_fields": {}, "created": "string", "last_updated": "string", "_occupied": false }, { "id": 9, "url": "string", "display": "string", "circuit": { "id": 2, "url": "string", "display": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string" }, "provider_network": { "id": 4, "url": "string", "display": "string", "name": "string" }, "port_speed": 5, "upstream_speed": 1, "xconnect_id": "string", "pp_info": "string", "description": "string", "mark_connected": false, "cable": { "id": 4, "url": "string", "display": "string", "label": "string" }, "cable_end": "string", "link_peers": [ "string", "string" ], "link_peers_type": "string", "tags": [ { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 10, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 3, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 2, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 5, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 3, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 1, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" } ], "custom_fields": {}, "created": "string", "last_updated": "string", "_occupied": true }, { "id": 10, "url": "string", "display": "string", "circuit": { "id": 6, "url": "string", "display": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string" }, "provider_network": { "id": 5, "url": "string", "display": "string", "name": "string" }, "port_speed": 9, "upstream_speed": 5, "xconnect_id": "string", "pp_info": "string", "description": "string", "mark_connected": false, "cable": { "id": 3, "url": "string", "display": "string", "label": "string" }, "cable_end": "string", "link_peers": [ "string" ], "link_peers_type": "string", "tags": [ { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" } ], "custom_fields": {}, "created": "string", "last_updated": "string", "_occupied": false }, { "id": 7, "url": "string", "display": "string", "circuit": { "id": 3, "url": "string", "display": "string", "cid": "string" }, "term_side": "A", "site": { "id": 10, "url": "string", "display": "string", "name": "string", "slug": "string" }, "provider_network": { "id": 1, "url": "string", "display": "string", "name": "string" }, "port_speed": 8, "upstream_speed": 2, "xconnect_id": "string", "pp_info": "string", "description": "string", "mark_connected": true, "cable": { "id": 6, "url": "string", "display": "string", "label": "string" }, "cable_end": "string", "link_peers": [ "string", "string", "string", "string", "string", "string" ], "link_peers_type": "string", "tags": [ { "id": 1, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 2, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 8, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 1, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" } ], "custom_fields": {}, "created": "string", "last_updated": "string", "_occupied": true } ] } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "termSide", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeed", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeed", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cableEnd", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "created", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdated", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cabled", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "occupied", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "circuitId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "providerNetworkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "idN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "idLte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "idLt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "idGte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "idGt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "termSideN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeedN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeedLte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeedLt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeedGte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portSpeedGt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeedN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeedLte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeedLt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeedGte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upstreamSpeedGt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdIc", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdNic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdIew", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdNiew", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdIsw", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdNisw", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdIe", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xconnectIdNie", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionIc", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionNic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionIew", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionNiew", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionIsw", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionNisw", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionIe", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "descriptionNie", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cableEndN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdLte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdLt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdGte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdGt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdatedN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdatedLte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdatedLt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdatedGte", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastUpdatedGt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tagN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "circuitIdN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "siteIdN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "siteN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "providerNetworkIdN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ordering", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Circuits" ], "operationId": "postCircuitsCircuitTerminations", "description": "The parameters and request body are for method: postCircuitsCircuitTerminations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "data" } } } }, "put": { "tags": [ "Circuits" ], "operationId": "putCircuitsCircuitTerminations", "description": "The parameters and request body are for method: putCircuitsCircuitTerminations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "data" } } } }, "patch": { "tags": [ "Circuits" ], "operationId": "patchCircuitsCircuitTerminations", "description": "The parameters and request body are for method: patchCircuitsCircuitTerminations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "data" } } } }, "delete": { "tags": [ "Circuits" ], "operationId": "deleteCircuitsCircuitTerminations", "description": "The parameters and request body are for method: deleteCircuitsCircuitTerminations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/circuits/circuit-terminations/{id}/": { "get": { "tags": [ "Circuits" ], "operationId": "getCircuitsCircuitTerminationsId", "description": "The parameters and request body are for method: getCircuitsCircuitTerminationsId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Circuits" ], "operationId": "putCircuitsCircuitTerminationsId", "description": "The parameters and request body are for method: putCircuitsCircuitTerminationsId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "data" } } } }, "patch": { "tags": [ "Circuits" ], "operationId": "patchCircuitsCircuitTerminationsId", "description": "The parameters and request body are for method: patchCircuitsCircuitTerminationsId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "data" } } } }, "delete": { "tags": [ "Circuits" ], "operationId": "deleteCircuitsCircuitTerminationsId", "description": "The parameters and request body are for method: deleteCircuitsCircuitTerminationsId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/circuits/circuit-terminations/{id}/paths/": { "get": { "tags": [ "Circuits" ], "operationId": "getCircuitsCircuitTerminationsIdPaths", "description": "The parameters and request body are for method: getCircuitsCircuitTerminationsIdPaths. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/circuits/circuit-types/": { "get": { "tags": [ "Circuits" ], "operationId": "getCircuitsCircuitTypes", "description": "The parameters and request body are for method: getCircuitsCircuitTypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "next": { "type": "string" }, "previous": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "display": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "string" } } } }, "custom_fields": { "type": "object" }, "created": { "type": "string" }, "last_updated": { "type": "string" }, "circuit_count": { "type": "number" } } } } } }, "example": { "count": 8, "next": "string", "previous": "string", "results": [ { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "description": "string", "tags": [ { "id": 2, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 4, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 6, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string" }, { "id": 9, "url": "string", "display": "string", "name": "string", "slug": "string", "color": "string"