@itentialopensource/adapter-cisco_prime
Version:
This adapter integrates with system described as: cisco prime
1,343 lines (1,342 loc) • 849 kB
JSON
{
"openapi": "3.0.2",
"info": {
"title": "https://developer.cisco.com",
"version": "1.0.0"
},
"paths": {
"/webacs/api/v4/op/aaa/tacacsPlusServer": {
"delete": {
"summary": "DELETE Delete Server\nDELETE op/aaa/tacacsPlusServer",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationSucceeded": {
"type": "boolean",
"description": "A flag of a successful operation"
},
"resultMessage": {
"type": "string",
"description": "Description of the operation result"
},
"serverHostName": {
"type": "string",
"description": "Server host name."
},
"serverIp": {
"type": "string",
"description": "Server IP address"
}
}
}
}
}
}
},
"parameters": [
{
"name": "serverIp",
"in": "query",
"required": false,
"description": "IP address of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.",
"schema": {
"type": "string"
}
},
{
"name": "serverHostName",
"in": "query",
"required": false,
"description": "Host name of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.",
"schema": {
"type": "string"
}
}
]
},
"get": {
"summary": "GET List Servers\nGET op/aaa/tacacsPlusServer",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationSucceeded": {
"type": "boolean",
"description": "A flag of a successful operation"
},
"resultMessage": {
"type": "string",
"description": "Description of the operation result"
},
"servers": {
"type": "array",
"description": "List of all TACACS+ servers in the system",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "POST Add Server\nPOST op/aaa/tacacsPlusServer",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationSucceeded": {
"type": "boolean",
"description": "A flag of a successful operation"
},
"resultMessage": {
"type": "string",
"description": "Description of the operation result"
},
"server": {
"type": "object",
"description": "TACACS+ server data from the parameters"
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authenticationType": {
"type": "object",
"description": "Authentication method (can be PAP or CHAP)\nAllowed values:\n\nPAP\nCHAP"
},
"localInterfaceIp": {
"type": "object",
"description": "IP address of the local interface"
},
"numberOfTries": {
"type": "object",
"description": "The number of attempts to access the server. Value should be in the range of 0 and 3"
},
"port": {
"type": "object",
"description": "IP port of the TACACS+ server. Value should be in the range of 1 and 65535"
},
"retransmitTimeout": {
"type": "object",
"description": "The delay between attempts in seconds. Value should be in the range of 2 and 15"
},
"secretKey": {
"type": "string",
"description": "Secret key (can be ASCII or HEX)"
},
"secretKeyType": {
"type": "object",
"description": "Type of the secret key (ASCII or HEX)\nAllowed values:\n\nASCII\nHEX"
},
"serverHostName": {
"type": "string",
"description": "FQDN of the TACACS+ server. Either serverIp or serverHostName is required."
},
"serverIp": {
"type": "object",
"description": "IP address of the TACACS+ server. Either serverIp or serverHostName is required."
}
}
}
}
}
}
},
"put": {
"summary": "PUT Update Server\nPUT op/aaa/tacacsPlusServer",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operationSucceeded": {
"type": "boolean",
"description": "A flag of a successful operation"
},
"resultMessage": {
"type": "string",
"description": "Description of the operation result"
},
"server": {
"type": "object",
"description": "TACACS+ server data from the parameters"
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authenticationType": {
"type": "object",
"description": "Authentication method (can be PAP or CHAP)\nAllowed values:\n\nPAP\nCHAP"
},
"localInterfaceIp": {
"type": "object",
"description": "IP address of the local interface"
},
"numberOfTries": {
"type": "object",
"description": "The number of attempts to access the server. Value should be in the range of 0 and 3"
},
"port": {
"type": "object",
"description": "IP port of the TACACS+ server. Value should be in the range of 1 and 65535"
},
"retransmitTimeout": {
"type": "object",
"description": "The delay between attempts in seconds. Value should be in the range of 2 and 15"
},
"secretKey": {
"type": "string",
"description": "Secret key (can be ASCII or HEX)"
},
"secretKeyType": {
"type": "object",
"description": "Type of the secret key (ASCII or HEX)\nAllowed values:\n\nASCII\nHEX"
},
"serverHostName": {
"type": "string",
"description": "FQDN of the TACACS+ server. Either serverIp or serverHostName is required."
},
"serverIp": {
"type": "object",
"description": "IP address of the TACACS+ server. Either serverIp or serverHostName is required."
}
}
}
}
}
}
}
},
"/webacs/api/v4/data/ApOnboardingProfile": {
"get": {
"summary": "GET Get AP onboarding profiles\nGET data/ApOnboardingProfile",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apName": {
"type": "string",
"description": "Access point name.\nIf the AP name is not configured the field will be equal 'Not Configured'"
},
"apTemplateOne": {
"type": "string",
"description": "Name of the first lightweight access point template.\nIf the profile hasn't got an first template this field will be equal 'NONE'"
},
"apTemplateThree": {
"type": "string",
"description": "Name of the third lightweight access point template.\nIf the profile hasn't got an third template this field will be equal 'NONE'"
},
"apTemplateTwo": {
"type": "string",
"description": "Name of the second lightweight access point template.\nIf the profile hasn't got an second template this field will be equal 'NONE'"
},
"associatedControllerName": {
"type": "string",
"description": "WLAN controller name associated with the profile.\nIf the profile hasn't got an associated controller this field will be equal 'ANY'"
},
"macAddress": {
"type": "object",
"description": "MAC Address.\nA serial number or MAC address should be specified for the profile"
},
"nextStage": {
"type": "object",
"description": "Next stage\nAllowed values:\n\nNONE\nAP_NAME\nAP_TEMPLATE_ONE\nAP_TEMPLATE_TWO\nAP_TEMPLATE_THREE"
},
"profileGroup": {
"type": "string",
"description": "Name of the profile group"
},
"profileMode": {
"type": "object",
"description": "Profile mode\nAllowed values:\n\nENABLE\nDISABLE\nCOMPLETE"
},
"profileStatus": {
"type": "object",
"description": "Profile status\nAllowed values:\n\nNOT_INITIATED\nINITIATED\nIN_PROGRESS\nSUCCESS\nFAILURE"
},
"reason": {
"type": "string",
"description": "Status reason"
},
"serialNumber": {
"type": "string",
"description": "Serial number. Serial number is a sequence of 11 letters/digits.\nEither serial number or MAC address should be specified for the profile"
},
"updateTime": {
"type": "number",
"description": "Time of the last update.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/apOnboarding/profile": {
"delete": {
"summary": "DELETE Delete AP onboarding profiles\nDELETE op/apOnboarding/profile",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operation": {
"type": "object",
"description": "eration type\nAllowed values:\n\nADD_PROFILES\nDELETE_PROFILES"
},
"results": {
"type": "array",
"description": "Result list",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileIds": {
"type": "array",
"description": "Profile IDs",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"post": {
"summary": "POST Create AP onboarding profiles\nPOST op/apOnboarding/profile",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profiles": {
"type": "array",
"description": "AP Onboarding Profiles",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "overrideOption",
"in": "query",
"required": false,
"description": "verride existing profiles",
"schema": {
"type": "boolean"
}
}
]
},
"put": {
"summary": "PUT Modify AP onboarding profile\nPUT op/apOnboarding/profile",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apName": {
"type": "string",
"description": "Access point name. Optional"
},
"apTemplateOne": {
"type": "string",
"description": "Name of the first lightweight access point template. Optional"
},
"apTemplateThree": {
"type": "string",
"description": "Name of the third lightweight access point template. Optional"
},
"apTemplateTwo": {
"type": "string",
"description": "Name of the second lightweight access point template. Optional"
},
"associatedControllerName": {
"type": "string",
"description": "WLAN controller name associated with the profile. Optional"
},
"profileGroup": {
"type": "string",
"description": "Name of the profile group. Optional.\nIf the group name is not specified the profile will be included in the \"Unassigned\" group."
},
"profileId": {
"type": "number",
"description": "The profile ID to update"
},
"profileMode": {
"type": "object",
"description": "Profile mode\nAllowed values:\n\nENABLE\nDISABLE\nCOMPLETE"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/data/ApiHealthRecords": {
"get": {
"summary": "GET API Health Record\nGET data/ApiHealthRecords",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"clientIp": {
"type": "object",
"description": "The requestor's IP address."
},
"method": {
"type": "string",
"description": "HTTP method used for the request."
},
"path": {
"type": "string",
"description": "The path component of the URL for the request."
},
"query": {
"type": "string",
"description": "The query string from the request, if any."
},
"requestAcceptHeader": {
"type": "string",
"description": "Content of the request Accept header, if present."
},
"requestReceivedTime": {
"type": "number",
"description": "The time the request was received, as milliseconds from the Unix epoch."
},
"responseSentTime": {
"type": "number",
"description": "The time the response was sent, as milliseconds from the Unix epoch."
},
"responseStatus": {
"type": "number",
"description": "HTTP response status."
},
"responseTime": {
"type": "number",
"description": "Total time from received to sent, measured in milliseconds."
},
"userAgent": {
"type": "string",
"description": "The user agent reported."
},
"username": {
"type": "string",
"description": "The username of the requestor."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/data/ApiResponseTimeSummary": {
"get": {
"summary": "GET API Response Time Summary\nGET data/ApiResponseTimeSummary",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"average": {
"type": "number",
"description": "The arithmetic mean, or average response time, measured in milliseconds."
},
"latest": {
"type": "number",
"description": "The latest response time, measured in milliseconds."
},
"max": {
"type": "number",
"description": "The maximum response time, measured in milliseconds."
},
"min": {
"type": "number",
"description": "The minimum response time, measured in milliseconds."
},
"path": {
"type": "string",
"description": "The path of the service."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/apiHealth/callsPerClient": {
"get": {
"summary": "GET API Calls Per Client\nGET op/apiHealth/callsPerClient",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"clientIp": {
"type": "object",
"description": "The client IP address."
},
"requestCount": {
"type": "number",
"description": "The number of requests this client has made over the given period."
}
}
}
}
}
}
},
"parameters": [
{
"name": "service",
"in": "query",
"required": false,
"description": "The service path. If unspecified, data will be returned for all services.",
"schema": {
"type": "string"
}
}
]
}
},
"/webacs/api/v4/op/apiHealth/requestCountTrend": {
"get": {
"summary": "GET API Request Count Trend\nGET op/apiHealth/requestCountTrend",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"responseCount": {
"type": "number",
"description": "The number of responses for this day and HTTP status."
},
"responseStatus": {
"type": "number",
"description": "The HTTP status of these responses."
},
"startOfDay": {
"type": "number",
"description": "The start of the day for this record, represented as milliseconds since the Unix epoch."
}
}
}
}
}
}
},
"parameters": [
{
"name": "service",
"in": "query",
"required": false,
"description": "The service path. If unspecified, data will be returned for all services.",
"schema": {
"type": "string"
}
}
]
}
},
"/webacs/api/v4/op/apiHealth/responseTimeTrend": {
"get": {
"summary": "GET API Response Time Trend\nGET op/apiHealth/responseTimeTrend",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requestReceivedTime": {
"type": "number",
"description": "The time the request was received, as milliseconds from the Unix epoch."
},
"responseTime": {
"type": "number",
"description": "Total time from received to sent, measured in milliseconds."
}
}
}
}
}
}
},
"parameters": [
{
"name": "service",
"in": "query",
"required": false,
"description": "The service path. If unspecified, data will be returned for all services.",
"schema": {
"type": "string"
}
}
]
}
},
"/webacs/api/v4/op/apiHealth/serviceNameList": {
"get": {
"summary": "GET API Service Name List\nGET op/apiHealth/serviceNameList",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The path of the service."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/apService/rxNeighbors": {
"get": {
"summary": "GET Get Rx Neighbors\nGET op/apService/rxNeighbors",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"macAddress": {
"type": "object",
"description": "MAC address of the access point's radio interface that discovered the Rx neighbor"
},
"neighborApId": {
"type": "number",
"description": "Id of the neighbor's parent access point. Null if the access point is not known."
},
"neighborApName": {
"type": "string",
"description": "Name of the neighbor's parent access point. Null if the access point is not known."
},
"neighborChannel": {
"type": "number",
"description": "Represents Channel information which neighboring access point is using"
},
"neighborChannelBandwidth": {
"type": "string",
"description": "Bandwidth of the channel which neighboring access point is using\nAllowed values:\n\n5 MHz\n10 MHz\n20 MHz\n40 MHz\nBelow 40 MHz\nAbove 40 MHz\n80 MHz\n160 MHz"
},
"neighborIpAddress": {
"type": "object",
"description": "Rx Neighbor IP address"
},
"neighborMacAddress": {
"type": "object",
"description": "Rx Neighbor MAC address"
},
"neighborMapLocation": {
"type": "string",
"description": "Name of the service domain the Rx neighbor is located at. Null if there are no associated service domain or the parent access point is not known."
},
"neighborRSSI": {
"type": "number",
"description": "RSSI value of the Rx Neighbor"
},
"neighborSlotId": {
"type": "number",
"description": "Slot value of the Rx Neighbor"
},
"radioBand": {
"type": "string",
"description": "Radio band of the access point's radio interface that discovered the Rx neighbor\nAllowed values:\n\n2.4 GHz\n5 GHz\nUnknown"
},
"slotId": {
"type": "number",
"description": "Slot Id of the access point's radio interface that discovered the Rx neighbor"
}
}
}
}
}
}
},
"parameters": [
{
"name": "apId",
"in": "query",
"required": true,
"description": "RequiredId of an access point to get Rx Neighbors.",
"schema": {
"type": "number"
}
}
]
}
},
"/webacs/api/v4/op/apService/deleteById": {
"put": {
"summary": "PUT Delete Access Points By IDs\nPUT op/apService/deleteById",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"failure": {
"type": "array",
"description": "A list of access point names that fail in the operation",
"items": {
"type": "object"
}
},
"operation": {
"type": "number",
"description": "The name of the performed operation\nAllowed values:\n\nDELETEAP"
},
"success": {
"type": "array",
"description": "A list of access point names that succeed in the operation",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apID": {
"type": "array",
"description": "Access point ID",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/apService/deleteAp": {
"put": {
"summary": "PUT Delete Access Points By Names\nPUT op/apService/deleteAp",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"failure": {
"type": "array",
"description": "A list of access point names that fail in the operation",
"items": {
"type": "object"
}
},
"operation": {
"type": "number",
"description": "The name of the performed operation\nAllowed values:\n\nDELETEAP"
},
"success": {
"type": "array",
"description": "A list of access point names that succeed in the operation",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apName": {
"type": "array",
"description": "An access point name",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/apService/accessPoint": {
"put": {
"summary": "PUT Modify Unified Access Point\nPUT op/apService/accessPoint",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"jobName": {
"type": "string",
"description": "The unique job name for this job."
},
"jobType": {
"type": "string",
"description": "The non-unique job type for this job."
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accessPointId": {
"type": "object",
"description": "ID used to identify the access point. Required."
},
"adminStatus": {
"type": "boolean",
"description": "Administrative status of the access point."
},
"location": {
"type": "string",
"description": "User specified location of the access point. While configuring AP, user should specify a location for the AP so that its easy to figure out for some one where the AP is located."
},
"name": {
"type": "string",
"description": "Name of the access point. Can not be empty or contain spaces."
},
"primaryMwar": {
"type": "object",
"description": "Primary controller this access point has affinity to, which is supposed to be the Primary MWAR(switch) of the AP with which AP should associate."
},
"secondaryMwar": {
"type": "object",
"description": "Secondary controller this access point has affinity to, which is supposed to be the Secondary MWAR(switch) of the AP with which AP should associate."
},
"tertiaryMwar": {
"type": "object",
"description": "Tertiary controller this access point has affinity to, which is supposed to be the Tertiary MWAR(switch) of the AP with which AP should associate."
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/rogueAp/classification": {
"put": {
"summary": "PUT Set Classification Type And Rogue State\nPUT op/rogueAp/classification",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"classificationTypeAndRogueState": {
"type": "object",
"description": "Classification type and rogue state which can be configured manually. Mandatory.\nUNCLASSIFIED_ALERT - classification is UNCLASSIFIED and state is ALERT,\nMALICIOUS_ALERT - classification is MALICIOUS and state is ALERT,\nFRIENDLY_EXTERNAL - classification is FRIENDLY and state is ACKNOWLEDGED (or EXTERNAL),\nFRIENDLY_INTERNAL - classification is FRIENDLY and state is KNOWN (or INTERNAL)\nAllowed values:\n\nUNCLASSIFIED_ALERT\nMALICIOUS_ALERT\nFRIENDLY_EXTERNAL\nFRIENDLY_INTERNAL"
},
"rogueApAlarmId": {
"type": "number",
"description": "Rogue access point alarm ID. Can be retrieved from the \"GET data/RogueApAlarms\" resource.\nEither rogueApAlarmId or rogueApMacAddress must be specified.\nThe attribute rogueApMacAddress will be ignored if rogueApAlarmId is specified."
},
"rogueApMacAddress": {
"type": "object",
"description": "MAC address of the rogue access point. Can be retrieved from the \"GET data/RogueApAlarms\" resource.\nEither rogueApAlarmId or rogueApMacAddress must be specified.\nThe attribute rogueApMacAddress will be ignored if rogueApAlarmId is specified."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/alarms/acknowledge": {
"put": {
"summary": "PUT Acknowledges Alarms\nPUT op/alarms/acknowledge",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "number",
"description": "List of alarms identificators"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/alarms/annotate": {
"put": {
"summary": "PUT Annotates Alarms\nPUT op/alarms/annotate",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "number",
"description": "List of alarms identificators"
}
}
}
}
}
}
},
"parameters": [
{
"name": "note",
"in": "query",
"required": false,
"description": "Annotation note",
"schema": {
"type": "string"
}
}
]
}
},
"/webacs/api/v4/op/alarms/clear": {
"put": {
"summary": "PUT Clears Alarms\nPUT op/alarms/clear",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "number",
"description": "List of alarms identificators"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/alarms/clearByEventType": {
"put": {
"summary": "PUT Clears Alarms with provided event type\nPUT op/alarms/clearByEventType",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Alarm event type"
}
}
}
}
}
}
},
"parameters": [
{
"name": "setSeverityToInfo",
"in": "query",
"required": false,
"description": "True if need to set alarm severity to Info once it's cleared. False by default",
"schema": {
"type": "boolean"
}
}
]
}
},
"/webacs/api/v4/op/alarms/unacknowledge": {
"put": {
"summary": "PUT Unacknowledges Alarms\nPUT op/alarms/unacknowledge",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "number",
"description": "List of alarms identificators"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/data/Applications": {
"get": {
"summary": "GET Predefined and User-defined Applications\nGET data/Applications",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "number",
"description": "Id of the application."
},
"applicationName": {
"type": "string",
"description": "Name of the application."
},
"businessCritical": {
"type": "boolean",
"description": "Is the application business critical?"
},
"category": {
"type": "string",
"description": "A first-level categorization for each Application Id."
},
"encrypted": {
"type": "string",
"description": "Specifies if the application is an encrypted networking protocol.\nAllowed values:\n\nYES\nNO\nUNASSIGNED"
},
"engineId": {
"type": "string",
"description": "A unique identifier for the engine that determined the Selector Id."
},
"modified": {
"type": "number",
"description": "Specifies the date when the application was modified."
},
"outOfBox": {
"type": "boolean",
"description": "Is the application predefined? When 'true' then the application is predefined, otherwise it is user-defined."
},
"p2p": {
"type": "string",
"description": "Specifies if the application is based on peer-to-peer technology.\nAllowed values:\n\nYES\nNO\nUNASSIGNED"
},
"selector": {
"type": "number",
"description": "Selector Id. It is a a unique identifier of the application for a specific Engine ID."
},
"serviceGroup": {
"type": "array",
"description": "Service groups the application is the member of",
"items": {
"type": "object"
}
},
"subcategory": {
"type": "string",
"description": "A second-level categorization for each Application Id."
},
"tunnel": {
"type": "string",
"description": "Specifies if the application is used as a tunnel technology.\nAllowed values:\n\nYES\nNO\nUNASSIGNED"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/data/CliTemplate": {
"get": {
"summary": "GET CLI Configuration Templates\nGET data/CliTemplate",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"author": {
"type": "string",
"description": "Template author"
},
"configContainerId": {
"type": "number",
"description": "Config container ID"
},
"content": {
"type": "string",
"description": "Content of the template"
},
"createdOn": {
"type": "number",
"description": "Time when template was created or uploaded"
},
"deployCount": {
"type": "number",
"description": "Number of deployments of this template"
},
"deployJobCount": {
"type": "number",
"description": "Number of jobs to deploy this template"
},
"description": {
"type": "string",
"description": "Human-readable description of the template"
},
"deviceType": {
"type": "string",
"description": "Comma-separated list of devices on which the template is allowed to be deployed"
},
"lastDeployTime": {
"type": "number",
"description": "Time of last successful deployment of this template"
},
"name": {
"type": "string",
"description": "Name of the template"
},
"path": {
"type": "string",
"description": "Full name of folder where the template is stored"
},
"tags": {
"type": "string",
"description": "Tag list separated by comma"
},
"templateId": {
"type": "number",
"description": "Template ID"
},
"userTags": {
"type": "array",
"description": "User-defined tags list",
"items": {
"type": "object"
}
},
"variable": {
"type": "array",
"description": "CLI Template variables used in content. Variables have the same order in which they were created",
"items": {
"type": "object"
}
},
"version": {
"type": "string",
"description": "S version"
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/cliTemplateConfiguration/deleteTemplate": {
"delete": {
"summary": "DELETE Delete Configuration Template\nDELETE op/cliTemplateConfiguration/deleteTemplate",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"templateName": {
"type": "string",
"description": "RequiredThe template to delete."
}
}
}
}
}
}
}
}
},
"/webacs/api/v4/op/cliTemplateConfiguration/folder": {
"delete": {
"summary": "DELETE Delete Configuration Template Folder\nDELETE op/cliTemplateConfiguration/folder",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folderFQN": {
"type": "string",
"description": "RequiredFully qualified name of the folder"
}
}
}
}
}
}
}
},
"get": {
"summary": "GET List Configuration Template Folders\nGET op/cliTemplateConfiguration/folder",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folderFQN": {
"type": "string",
"description": "Fully qualified name of the group"
},
"groupId": {
"type": "number",
"description": "Identifier for the fully qualified name folder"
}
}
}