@itentialopensource/adapter-netbox_v210

{ "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" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } } } } }, "example": { "count": 1, "next": "string", "previous": "string", "results": [ { "id": 8, "url": "string", "circuit": { "id": 6, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 8, "url": "string", "name": "string", "slug": "string" }, "port_speed": 1, "upstream_speed": 8, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 4, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true }, { "id": 9, "url": "string", "circuit": { "id": 4, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 8, "url": "string", "name": "string", "slug": "string" }, "port_speed": 9, "upstream_speed": 3, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 2, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false }, { "id": 4, "url": "string", "circuit": { "id": 4, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 3, "url": "string", "name": "string", "slug": "string" }, "port_speed": 7, "upstream_speed": 2, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 6, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false }, { "id": 9, "url": "string", "circuit": { "id": 10, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 10, "url": "string", "name": "string", "slug": "string" }, "port_speed": 1, "upstream_speed": 6, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 3, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true }, { "id": 8, "url": "string", "circuit": { "id": 1, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 3, "url": "string", "name": "string", "slug": "string" }, "port_speed": 8, "upstream_speed": 2, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 3, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false }, { "id": 10, "url": "string", "circuit": { "id": 6, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 9, "url": "string", "name": "string", "slug": "string" }, "port_speed": 4, "upstream_speed": 1, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 8, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true }, { "id": 3, "url": "string", "circuit": { "id": 7, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 6, "url": "string", "name": "string", "slug": "string" }, "port_speed": 4, "upstream_speed": 9, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 1, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false }, { "id": 4, "url": "string", "circuit": { "id": 9, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 2, "url": "string", "name": "string", "slug": "string" }, "port_speed": 5, "upstream_speed": 7, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 10, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true }, { "id": 4, "url": "string", "circuit": { "id": 7, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 2, "url": "string", "name": "string", "slug": "string" }, "port_speed": 2, "upstream_speed": 10, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 4, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true } ] } } } } }, "parameters": [ { "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": "cabled", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "connected", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "q", "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": "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": "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": "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } }, "example": { "id": 4, "url": "string", "circuit": { "id": 10, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 5, "url": "string", "name": "string", "slug": "string" }, "port_speed": 1, "upstream_speed": 4, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 9, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true } } } } }, "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } }, "example": { "id": 3, "url": "string", "circuit": { "id": 7, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 5, "url": "string", "name": "string", "slug": "string" }, "port_speed": 6, "upstream_speed": 6, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 8, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true } } } } }, "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } }, "example": { "id": 5, "url": "string", "circuit": { "id": 5, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 5, "url": "string", "name": "string", "slug": "string" }, "port_speed": 3, "upstream_speed": 4, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 2, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false } } } } }, "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } }, "example": { "id": 1, "url": "string", "circuit": { "id": 9, "url": "string", "cid": "string" }, "term_side": "A", "site": { "id": 2, "url": "string", "name": "string", "slug": "string" }, "port_speed": 2, "upstream_speed": 3, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 6, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": true } } } } }, "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "string" } } }, "cable_peer": { "type": "object" }, "cable_peer_type": { "type": "string" }, "connected_endpoint": { "type": "object" }, "connected_endpoint_type": { "type": "string" }, "connected_endpoint_reachable": { "type": "boolean" } } }, "example": { "id": 7, "url": "string", "circuit": { "id": 8, "url": "string", "cid": "string" }, "term_side": "Z", "site": { "id": 5, "url": "string", "name": "string", "slug": "string" }, "port_speed": 8, "upstream_speed": 7, "xconnect_id": "string", "pp_info": "string", "description": "string", "cable": { "id": 3, "url": "string", "label": "string" }, "cable_peer": {}, "cable_peer_type": "string", "connected_endpoint": {}, "connected_endpoint_type": "string", "connected_endpoint_reachable": false } } } } }, "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": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "circuit": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "cid": { "type": "string" } } }, "term_side": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "port_speed": { "type": "number" }, "upstream_speed": { "type": "number" }, "xconnect_id": { "type": "string" }, "pp_info": { "type": "string" }, "description": { "type": "string" }, "cable": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "label": { "type": "