@itentialopensource/adapter-accedian_skylight

{ "openapi": "3.0.0", "info": { "title": "Accedian Skylight", "description": "Welcome to the Accedian Skylight orchestrator North-Bound REST API documentation.\nThe API allows you to operate the Skylight orchestrator in a simple, programmatic way using conventional HTTP requests. The goal of the API is to be intuitive and powerful, allowing you to easily create, manage, delete and operate key Skylight orchestrator resources.\nMost of the functionality that you are familiar with in the Skylight orchestrator CLI is also available through the API, allowing you to script the complex actions that your situation requires.\nThe API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific resources.\n", "contact": { "email": "apiteam@swagger.io" }, "version": "1.0.0" }, "servers": [ { "url": "https://localhost/nbapi", "variables": {} }, { "url": "http://localhost/nbapi", "variables": {} } ], "paths": { "/endpoint": { "get": { "tags": [ "endpoint" ], "summary": "getEndpoints", "description": "Get information (EndpointHead) on all endpoints.", "operationId": "getEndpoints", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/{id}": { "delete": { "tags": [ "endpoint" ], "summary": "deleteEndpoint", "description": "Delete endpoint", "operationId": "deleteEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/{id}/description": { "put": { "tags": [ "endpoint" ], "summary": "alterEndpointDescription", "description": "Alter endpoint description.", "operationId": "alterEndpointDescription", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "description", "content": { "text/plain": { "schema": { "type": "string", "description": "description" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/{id}/endpointhead": { "get": { "tags": [ "endpoint" ], "summary": "getEndpointInformation", "description": "Get information about a endpoint (EndpointHead).", "operationId": "getEndpointInformation", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/{id}/name": { "put": { "tags": [ "endpoint" ], "summary": "changeNameOfEndpoint", "description": "Change name of endpoint.", "operationId": "changeNameOfEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "name", "content": { "text/plain": { "schema": { "type": "string", "description": "name" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/nbapi/endpoint/{id}/operate": { "put": { "tags": [ "endpoint" ], "summary": "operationOnEndpoint", "description": "Operation on endpoint", "operationId": "operationOnEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "action", "content": { "text/plain": { "schema": { "type": "string", "description": "action" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/type/{type}": { "get": { "tags": [ "endpoint" ], "summary": "getInformationOnEndpointsByType", "description": "Get information (EndpointHead) on all endpoints of given type. Supported types are: Supervision, Reflector, or All.", "operationId": "getInformationOnEndpointsByType", "parameters": [ { "name": "type", "in": "path", "description": "Supported types are: Supervision, Reflector, or All.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector": { "post": { "tags": [ "endpoint" ], "summary": "createNewReflectorEndpoint", "description": "Create a new unmanaged reflector endpoint.", "operationId": "createNewReflectorEndpoint", "parameters": [], "requestBody": { "description": "body", "content": { "text/plain": { "schema": { "type": "string", "description": "body" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector/{id}": { "get": { "tags": [ "endpoint" ], "summary": "getReflectorEndpointByName", "description": "Get reflector endpoint parameters by name (id).", "operationId": "getReflectorEndpointByName", "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector/{id}/address": { "put": { "tags": [ "endpoint" ], "summary": "changeIpAddressUnmanagedEndpoint", "description": "Change ip address of terminated/unresolved unmanaged endpoint.", "operationId": "changeIpAddressUnmanagedEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "IP Address", "content": { "text/plain": { "schema": { "type": "string", "description": "IP Address" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector/{id}/capability": { "put": { "tags": [ "endpoint" ], "summary": "changeCapabilityUnmanagedEndpoint", "description": "Change capability of unmanaged endpoint.", "operationId": "changeCapabilityUnmanagedEndpoint", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Capabilities", "content": { "text/plain": { "schema": { "type": "string", "description": "Capabilities" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector/{id}/mac": { "get": { "tags": [ "endpoint" ], "summary": "getReflectorEndpointByMAC", "description": "Get reflector endpoint parameters by mac.", "operationId": "getReflectorEndpointByMAC", "parameters": [ { "name": "id", "in": "path", "description": "mac address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/reflector/{id}/twampcp": { "put": { "tags": [ "endpoint" ], "summary": "changeTwampControlProtocolSettings", "description": "Change Twamp control protocol settings of unmanaged endpoint.", "operationId": "changeTwampControlProtocolSettings", "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "TwampCp", "content": { "text/plain": { "schema": { "type": "string", "description": "TwampCp" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "endpoint" ], "summary": "deleteTwampCp", "description": "Delete twamp cp.", "operationId": "deleteTwampCp", "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/supervision": { "post": { "tags": [ "endpoint" ], "summary": "createSupervisonEndpoint", "description": "Create a new supervision endpoint.", "operationId": "createSupervisonEndpoint", "parameters": [], "requestBody": { "description": "Endpoint", "content": { "text/plain": { "schema": { "type": "string", "description": "Endpoint" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/endpoint/supervision/{id}": { "get": { "tags": [ "endpoint" ], "summary": "getSupervisionEndpointByName", "description": "Get supervision endpoint parameters by name (id).", "operationId": "getSupervisionEndpointByName", "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session": { "get": { "tags": [ "session" ], "summary": "getSessionInformation", "description": "Get information (SessionHead) on all nodes.", "operationId": "getSessionInformation", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}": { "delete": { "tags": [ "session" ], "summary": "deleteSession", "description": "Delete a session.", "operationId": "deleteSession", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/description": { "put": { "tags": [ "session" ], "summary": "alterSessionDescription", "description": "Alter session description.", "operationId": "alterSessionDescription", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Description", "content": { "text/plain": { "schema": { "type": "string", "description": "Description" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/head": { "get": { "tags": [ "session" ], "summary": "getSessionHeadInformationByName", "description": "Get information (SessionHead) by name (id).", "operationId": "getSessionHeadInformationByName", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/lastrr": { "get": { "tags": [ "session" ], "summary": "getSessionLastRR", "description": "Get last RR.", "operationId": "getSessionLastRR", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/name": { "put": { "tags": [ "session" ], "summary": "alterTerminatedNotResolvedSessionName", "description": "Alter a Terminated or NotResolved session name.", "operationId": "alterTerminatedNotResolvedSessionName", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/operate": { "put": { "tags": [ "session" ], "summary": "operationOnSession", "description": "Operation on session.", "operationId": "operationOnSession", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/{id}/stream": { "put": { "tags": [ "session" ], "summary": "alterTerminatedNotResolvedSessionStream", "description": "Alter Terminated or NotResolved session stream.", "operationId": "alterTerminatedNotResolvedSessionStream", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/echo": { "post": { "tags": [ "session" ], "summary": "createEchoSession", "description": "Create a new ECHO session.", "operationId": "createEchoSession", "parameters": [], "requestBody": { "description": "EchoSession", "content": { "text/plain": { "schema": { "type": "string", "description": "EchoSession" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/echo/{id}": { "get": { "tags": [ "session" ], "summary": "getEchoSessionInformation", "description": "Get information about a ECHO session.", "operationId": "getEchoSessionInformation", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/ethoam": { "post": { "tags": [ "session" ], "summary": "createEthOamSession", "description": "Create a new eth-oam session. Supported types are ETH-DM, ETH-LB, and ETH-VS.", "operationId": "createEthOamSession", "parameters": [], "requestBody": { "description": "EthOamSession", "content": { "text/plain": { "schema": { "type": "string", "description": "EthOamSession" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/ethoam/{id}": { "get": { "tags": [ "session" ], "summary": "getEthOamSessionInformation", "description": "Get information about a eth-oam session.", "operationId": "getEthOamSessionInformation", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/twamp": { "post": { "tags": [ "session" ], "summary": "createTWAMPSession", "description": "Create a new TWAMP session.", "operationId": "createTWAMPSession", "parameters": [], "requestBody": { "description": "TwampSession", "content": { "text/plain": { "schema": { "type": "string", "description": "TwampSession" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/session/twamp/{id}": { "get": { "tags": [ "session" ], "summary": "getTWAMPSessionInformation", "description": "Get information about a TWAMP session.", "operationId": "getTWAMPSessionInformation", "parameters": [ { "name": "id", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/sla": { "post": { "tags": [ "sla" ], "summary": "createSLA", "description": "Create a new SLA.", "operationId": "createSLA", "parameters": [], "requestBody": { "description": "SLA", "content": { "text/plain": { "schema": { "type": "string", "description": "SLA" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "get": { "tags": [ "sla" ], "summary": "getSLAs", "description": "Get all SLAs.", "operationId": "getSLAs", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/sla/{id}": { "delete": { "tags": [ "sla" ], "summary": "deleteSLA", "description": "Delete a SLA", "operationId": "deleteSLA", "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/sla/{id}/session": { "put": { "tags": [ "sla" ], "summary": "putSessionReferenceToSLA", "description": "Put session reference to SLA.", "operationId": "putSessionReferenceToSLA", "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "session ref", "content": { "text/plain": { "schema": { "type": "string", "description": "session ref" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "get": { "tags": [ "sla" ], "summary": "getSessionReferencesForSLA", "description": "Get all session references for sla.", "operationId": "getSessionReferencesForSLA", "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/sla/{id}/session/{ref}": { "delete": { "tags": [ "sla" ], "summary": "deleteSessionReferenceFromSLA", "description": "Delete a session reference from a sla.", "operationId": "deleteSessionReferenceFromSLA", "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "ref", "in": "path", "description": "session name", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/version": { "get": { "tags": [ "default" ], "summary": "getSystemVersion", "description": "Get system version.", "operationId": "getSystemVersion", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } } }, "tags": [ { "name": "endpoint", "description": "The endpoint resource provide the api for handling endpoints" }, { "name": "session", "description": "The session resource provide the api for handling sessions" }, { "name": "sla", "description": "The sla resource provide the api for handling slas" }, { "name": "default", "description": "", "externalDocs": { "url": "http://swagger.io" } } ], "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" } }