@itentialopensource/adapter-accedian_skylight

{ "swagger": "2.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", "version": "1.0.0", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "apiteam@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "localhost", "basePath": "/nbapi", "schemes": [ "https", "http" ], "tags": [ { "name": "endpoint", "description": "The endpoint resource provide the api for handling endpoints", "externalDocs": null }, { "name": "session", "description": "The session resource provide the api for handling sessions", "externalDocs": null }, { "name": "sla", "description": "The sla resource provide the api for handling slas", "externalDocs": null }, { "name": "default", "description": "", "externalDocs": { "url": "http://swagger.io" } } ], "paths": { "/endpoint": { "get": { "parameters": [], "tags": [ "endpoint" ], "operationId": "getEndpoints", "summary": "Get endpoints", "description": "Get information (EndpointHead) on all endpoints.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/{id}": { "delete": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "deleteEndpoint", "summary": "Delete endpoint", "description": "Delete endpoint", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/{id}/description": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true }, { "name": "description", "in": "body", "description": "description", "type": "string" } ], "tags": [ "endpoint" ], "operationId": "alterEndpointDescription", "summary": "Alter endpoint description.", "description": "Alter endpoint description.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/{id}/endpointhead": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "getEndpointInformation", "summary": "Get information about a endpoint (EndpointHead).", "description": "Get information about a endpoint (EndpointHead).", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/{id}/name": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true }, { "name": "name", "in": "body", "description": "name", "type": "string" } ], "tags": [ "endpoint" ], "operationId": "changeNameOfEndpoint", "summary": "Change name of endpoint.", "description": "Change name of endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/nbapi/endpoint/{id}/operate": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true }, { "name": "action", "in": "body", "description": "action", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "operationOnEndpoint", "summary": "Operation on endpoint", "description": "Operation on endpoint", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/type/{type}": { "get": { "parameters": [ { "name": "type", "in": "path", "description": "Supported types are: Supervision, Reflector, or All.", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "getInformationOnEndpointsByType", "summary": "Get information on all endpoints of given type.", "description": "Get information (EndpointHead) on all endpoints of given type. Supported types are: Supervision, Reflector, or All.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "body", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "createNewReflectorEndpoint", "summary": "Create a new unmanaged reflector endpoint.", "description": "Create a new unmanaged reflector endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector/{id}": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "getReflectorEndpointByName", "summary": "Get reflector endpoint parameters by name (id).", "description": "Get reflector endpoint parameters by name (id).", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector/{id}/address": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true }, { "name": "ipAddress", "in": "body", "description": "IP Address", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "changeIpAddressUnmanagedEndpoint", "summary": "Change ip address of terminated/unresolved unmanaged endpoint.", "description": "Change ip address of terminated/unresolved unmanaged endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector/{id}/capability": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "id", "type": "string", "required": true }, { "name": "capabilities", "in": "body", "description": "Capabilities", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "changeCapabilityUnmanagedEndpoint", "summary": "Change capability of unmanaged endpoint.", "description": "Change capability of unmanaged endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector/{id}/mac": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "mac address", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "getReflectorEndpointByMAC", "summary": "Get reflector endpoint parameters by mac.", "description": "Get reflector endpoint parameters by mac.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/reflector/{id}/twampcp": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "type": "string", "required": true }, { "name": "TwampCp", "in": "body", "description": "TwampCp", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "changeTwampControlProtocolSettings", "summary": "Change Twamp control protocol settings of unmanaged endpoint.", "description": "Change Twamp control protocol settings of unmanaged endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } }, "delete": { "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "deleteTwampCp", "summary": "Delete twamp cp.", "description": "Delete twamp cp.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/supervision": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "Endpoint", "schema": { "type": "string" } } ], "tags": [ "endpoint" ], "operationId": "createSupervisonEndpoint", "summary": "Create a new supervision endpoint.", "description": "Create a new supervision endpoint.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/endpoint/supervision/{id}": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "endpoint name", "type": "string", "required": true } ], "tags": [ "endpoint" ], "operationId": "getSupervisionEndpointByName", "summary": "Get supervision endpoint parameters by name (id).", "description": "Get supervision endpoint parameters by name (id).", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session": { "get": { "parameters": [], "tags": [ "session" ], "operationId": "getSessionInformation", "summary": "Get information (SessionHead) on all nodes.", "description": "Get information (SessionHead) on all nodes.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}": { "delete": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "deleteSession", "summary": "Delete a session.", "description": "Delete a session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/description": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true }, { "name": "description", "in": "body", "description": "Description", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "alterSessionDescription", "summary": "Alter session description.", "description": "Alter session description.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/head": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "getSessionHeadInformationByName", "summary": "Get information (SessionHead) by name (id).", "description": "Get information (SessionHead) by name (id).", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/lastrr": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "getSessionLastRR", "summary": "Get last RR.", "description": "Get last RR.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/name": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true }, { "name": "body", "in": "body", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "alterTerminatedNotResolvedSessionName", "summary": "Alter a Terminated or NotResolved session name.", "description": "Alter a Terminated or NotResolved session name.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/operate": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true }, { "name": "action", "in": "body", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "operationOnSession", "summary": "Operation on session.", "description": "Operation on session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/{id}/stream": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true }, { "name": "stream", "in": "body", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "alterTerminatedNotResolvedSessionStream", "summary": "Alter Terminated or NotResolved session stream.", "description": "Alter Terminated or NotResolved session stream.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/echo": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "EchoSession", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "createEchoSession", "summary": "Create a new ECHO session.", "description": "Create a new ECHO session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/echo/{id}": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "getEchoSessionInformation", "summary": "Get information about a ECHO session.", "description": "Get information about a ECHO session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/ethoam": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "EthOamSession", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "createEthOamSession", "summary": "Create a new eth-oam session.", "description": "Create a new eth-oam session. Supported types are ETH-DM, ETH-LB, and ETH-VS.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/ethoam/{id}": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "getEthOamSessionInformation", "summary": "Get information about a eth-oam session.", "description": "Get information about a eth-oam session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/twamp": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "TwampSession", "schema": { "type": "string" } } ], "tags": [ "session" ], "operationId": "createTWAMPSession", "summary": "Create a new TWAMP session.", "description": "Create a new TWAMP session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/session/twamp/{id}": { "get": { "parameters": [ { "name": "id", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "session" ], "operationId": "getTWAMPSessionInformation", "summary": "Get information about a TWAMP session.", "description": "Get information about a TWAMP session.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/sla": { "post": { "parameters": [ { "name": "body", "in": "body", "description": "SLA", "schema": { "type": "string" } } ], "tags": [ "sla" ], "operationId": "createSLA", "summary": "Create a new SLA.", "description": "Create a new SLA.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } }, "get": { "parameters": [], "tags": [ "sla" ], "operationId": "getSLAs", "summary": "Get all SLAs", "description": "Get all SLAs.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/sla/{id}": { "delete": { "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "type": "string", "required": true } ], "tags": [ "sla" ], "operationId": "deleteSLA", "summary": "Delete a SLA", "description": "Delete a SLA", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/sla/{id}/session": { "put": { "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "type": "string", "required": true }, { "name": "sessionRef", "in": "body", "description": "session ref", "schema": { "type": "string" } } ], "tags": [ "sla" ], "operationId": "putSessionReferenceToSLA", "summary": "Put session reference to SLA.", "description": "Put session reference to SLA.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } }, "get": { "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "type": "string", "required": true } ], "tags": [ "sla" ], "operationId": "getSessionReferencesForSLA", "summary": "Get all session references for sla.", "description": "Get all session references for sla.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/sla/{id}/session/{ref}": { "delete": { "parameters": [ { "name": "id", "in": "path", "description": "SLA name", "type": "string", "required": true }, { "name": "ref", "in": "path", "description": "session name", "type": "string", "required": true } ], "tags": [ "sla" ], "operationId": "deleteSessionReferenceFromSLA", "summary": "Delete a session reference from a sla.", "description": "Delete a session reference from a sla.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } }, "/version": { "get": { "parameters": [], "tags": [ "default" ], "operationId": "getSystemVersion", "summary": "System Version", "description": "Get system version.", "responses": { "200": { "schema": { "type": "string" }, "description": "successful operation" }, "400": { "description": "failed operation" } } } } }, "definitions": {}, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" } }