@itentialopensource/adapter-incognito

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/entities": { "post": { "tags": [ "Entity" ], "operationId": "createEntity", "description": "The parameters and request body are for method: createEntity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "Entity" ], "operationId": "getEntities", "description": "The parameters and request body are for method: getEntities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/entities/{entityId}": { "get": { "tags": [ "Entity" ], "operationId": "getEntityById", "description": "The parameters and request body are for method: getEntityById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "title": "entityId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Entity" ], "operationId": "updateEntity", "description": "The parameters and request body are for method: updateEntity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "title": "entityId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Entity" ], "operationId": "deleteEntity", "description": "The parameters and request body are for method: deleteEntity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "title": "entityId", "type": "string" } }, { "name": "cascade", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subnets": { "get": { "tags": [ "Subnet" ], "operationId": "getSubnets", "description": "The parameters and request body are for method: getSubnets. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subnets/{subnetId}": { "get": { "tags": [ "Subnet" ], "operationId": "getSubnetById", "description": "The parameters and request body are for method: getSubnetById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Subnet" ], "operationId": "replaceSubnet", "description": "The parameters and request body are for method: replaceSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "tags": [ "Subnet" ], "operationId": "updateSubnet", "description": "The parameters and request body are for method: updateSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Subnet" ], "operationId": "deleteSubnet", "description": "The parameters and request body are for method: deleteSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subnets/{subnetId}/assign": { "post": { "tags": [ "Subnet" ], "operationId": "assignSubnet", "description": "The parameters and request body are for method: assignSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/reclaim": { "post": { "tags": [ "Subnet" ], "operationId": "reclaimSubnet", "description": "The parameters and request body are for method: reclaimSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/reserve": { "post": { "tags": [ "Subnet" ], "operationId": "reserveSubnet", "description": "The parameters and request body are for method: reserveSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/unreserve": { "post": { "tags": [ "Subnet" ], "operationId": "unreserveSubnet", "description": "The parameters and request body are for method: unreserveSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/subdivide": { "post": { "tags": [ "Subnet" ], "operationId": "subdivideSubnet", "description": "The parameters and request body are for method: subdivideSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/merge": { "post": { "tags": [ "Subnet" ], "operationId": "mergeSubnet", "description": "The parameters and request body are for method: mergeSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/deploy": { "post": { "tags": [ "Subnet" ], "operationId": "deploySubnet", "description": "The parameters and request body are for method: deploySubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/decommission": { "post": { "tags": [ "Subnet" ], "operationId": "decommissionSubnet", "description": "The parameters and request body are for method: decommissionSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/{subnetId}/updatenodes": { "post": { "tags": [ "Subnet" ], "operationId": "updatenodesSubnet", "description": "The parameters and request body are for method: updatenodesSubnet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subnetId", "in": "path", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/subnets/request-assignment": { "post": { "tags": [ "Subnet" ], "operationId": "requestSubnetAssignment", "description": "The parameters and request body are for method: requestSubnetAssignment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devices": { "get": { "tags": [ "Device" ], "operationId": "getDevices", "description": "The parameters and request body are for method: getDevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/devices/{deviceId}/utilization": { "get": { "tags": [ "Device" ], "operationId": "getDeviceUtilization", "description": "The parameters and request body are for method: getDeviceUtilization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/devices/{deviceId}/childutilization": { "get": { "tags": [ "Device" ], "operationId": "getDeviceChildUtilization", "description": "The parameters and request body are for method: getDeviceChildUtilization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/deviceinterfaces/{interfaceId}/utilization": { "get": { "tags": [ "Device" ], "operationId": "getDeviceInterfaceUtilization", "description": "The parameters and request body are for method: getDeviceInterfaceUtilization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "interfaceId", "in": "path", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/iprequests": { "post": { "tags": [ "IP" ], "operationId": "createIPRequest", "description": "The parameters and request body are for method: createIPRequest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "IP" ], "operationId": "getIPRequests", "description": "The parameters and request body are for method: getIPRequests. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/iprequests/{requestId}": { "get": { "tags": [ "IP" ], "operationId": "getIPRequestById", "description": "The parameters and request body are for method: getIPRequestById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "title": "requestId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "IP" ], "operationId": "deleteIPRequest", "description": "The parameters and request body are for method: deleteIPRequest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "title": "requestId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/iprequests/{requestId}/approve": { "post": { "tags": [ "IP" ], "operationId": "approveIPRequest", "description": "The parameters and request body are for method: approveIPRequest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "title": "requestId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/iprequests/{requestId}/reject": { "post": { "tags": [ "IP" ], "operationId": "rejectIPRequest", "description": "The parameters and request body are for method: rejectIPRequest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "title": "requestId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vpns": { "post": { "tags": [ "VPN" ], "operationId": "createVPN", "description": "The parameters and request body are for method: createVPN. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "VPM" ], "operationId": "getVPNs", "description": "The parameters and request body are for method: getVPNs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vpns/{vpnId}": { "get": { "tags": [ "VPN" ], "operationId": "getVPNById", "description": "The parameters and request body are for method: getVPNById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "VPN" ], "operationId": "updateVPN", "description": "The parameters and request body are for method: updateVPN. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "VPN" ], "operationId": "deleteVPN", "description": "The parameters and request body are for method: deleteVPN. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "cascade", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vpndomains": { "post": { "tags": [ "VPN" ], "operationId": "createVPNDomain", "description": "The parameters and request body are for method: createVPNDomain. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "VPM" ], "operationId": "getVPNDomains", "description": "The parameters and request body are for method: getVPNDomains. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vpndomains/{domainId}": { "get": { "tags": [ "VPN" ], "operationId": "getVPNDomainById", "description": "The parameters and request body are for method: getVPNDomainById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "VPN" ], "operationId": "updateVPNDomain", "description": "The parameters and request body are for method: updateVPNDomain. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "VPN" ], "operationId": "deleteVPNDomain", "description": "The parameters and request body are for method: deleteVPNDomain. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "title": "domainId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vpndomains/{domainId}/availabletag": { "get": { "tags": [ "VPN" ], "operationId": "getAvailableVPNTag", "description": "The parameters and request body are for method: getAvailableVPNTag. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "title": "domainId", "type": "string" } }, { "name": "staticPrefix", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }