{ "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" } } } } } } } } }, "/webacs/api/v4/op/cliTemplateConfiguration/deviceTypes": { "get": { "summary": "GET List Device Types\nGET op/cliTemplateConfiguration/deviceTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceTypes": { "type": "array", "description": "A list of device types.", "items": { "type": "object" } } } } } } } } }, "post": { "summary": "POST Create Configuration Template Folder\nPOST op/cliTemplateConfiguration/folder", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "folderFQN": { "type": "string", "description": "Fully qualified name of a folder" } } } } } } } } }, "/webacs/api/v4/op/cliTemplateConfiguration/upload": { "post": { "summary": "POST Upload Configuration Template\nPOST op/cliTemplateConfiguration/upload", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the template that will be populated with variable values and sent to devices." }, "description": { "type": "string", "description": "A description of the template" }, "deviceType": { "type": "string", "description": "The types of devices this template is applicable for, comma seperated." }, "name": { "type": "string", "description": "The name of the template." }, "path": { "type": "string", "description": "Template path" }, "tags": { "type": "string", "description": "Tags list separated by comma" }, "variables": { "type": "array", "description": "A list of variables needed for this template", "items": { "type": "object" } }, "version": { "type": "string", "description": "S version" } } } } } } } } }, "/webacs/api/v4/op/cliTemplateConfiguration/deployTemplateThroughJob": { "put": { "summary": "PUT Deploy Configuration Template Through Job\nPUT op/cliTemplateConfiguration/deployTemplateThroughJob", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "object", "description": "The deploy options." }, "targetDeviceAndVariableValues": { "type": "array", "description": "The devices to execute the template configuration against along with template variable values.", "items": { "type": "object" } }, "templateName": { "type": "string", "description": "The template to apply." } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": false, "description": "The time when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/cliTemplateConfiguration/template": { "put": { "summary": "PUT Modify Configuration Template Content\nPUT op/cliTemplateConfiguration/template", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the template that will be populated with variable values and sent to devices." }, "description": { "type": "string", "description": "A description of the template" }, "deviceType": { "type": "string", "description": "The types of devices this template is applicable for, comma seperated." }, "name": { "type": "string", "description": "The name of the template." }, "path": { "type": "string", "description": "Template path" }, "tags": { "type": "string", "description": "Tags list separated by comma" }, "variables": { "type": "array", "description": "A list of variables needed for this template", "items": { "type": "object" } }, "version": { "type": "string", "description": "S version" } } } } } } } } }, "/webacs/api/v4/data/ClientCounts": { "get": { "summary": "GET Client Counts\nGET data/ClientCounts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "authCount": { "type": "number", "description": " authenticated client count on the element in last collection time" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "count": { "type": "number", "description": " client count on the element in last collection time" }, "dot11aAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11a" }, "dot11aCount": { "type": "number", "description": "umber of clients using 802.11a" }, "dot11acAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11ac" }, "dot11acCount": { "type": "number", "description": "umber of clients using 802.11ac" }, "dot11bAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11b" }, "dot11bCount": { "type": "number", "description": "umber of clients using 802.11b" }, "dot11gAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11g" }, "dot11gCount": { "type": "number", "description": "umber of clients using 802.11g" }, "dot11n24AuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11n on 2.4 GHz band" }, "dot11n24Count": { "type": "number", "description": "umber of clients using 802.11n in 2.4 GHz band" }, "dot11n5AuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11n on 5 GHz band" }, "dot11n5Count": { "type": "number", "description": "umber of clients using 802.11n in 5GHz band" }, "key": { "type": "string", "description": "The wireless MAC address for an access point, the management IP for all other devices, or the name of the virtual domain, SSID, or map location." }, "subkey": { "type": "string", "description": "Subkey is used to further categorize client count, and will generally be an SSID or virtual domain." }, "type": { "type": "string", "description": "Type of count element\nAllowed values:\n\nDEVICE\nACCESSPOINT\nMAPLOCATION\nSSID\nVIRTUALDOMAIN\nGUEST" }, "wgbAuthCount": { "type": "number", "description": "umber of authenticated clients connected as WGB or wired guest" }, "wgbCount": { "type": "number", "description": "umber of clients connected as WGB or wired guest" }, "wired100MAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 100Mbps port" }, "wired100MCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 100Mbps port" }, "wired10GAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 10Gbps port" }, "wired10GCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 10Gbps port" }, "wired10MAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 10Mbps port" }, "wired10MCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 10Mbps port" }, "wired1GAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 1Gbps port" }, "wired1GCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 1Gbps port" } } } } } } } } }, "/webacs/api/v4/data/ClientSessions": { "get": { "summary": "GET Client Sessions\nGET data/ClientSessions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adDomainName": { "type": "string", "description": "AD domain name acquired from Cisco Identity Service Engine" }, "anchorIpAddress": { "type": "object", "description": "IP address of the mobility anchor controller if any" }, "apMacAddress": { "type": "object", "description": "Associated AP MAC address" }, "authenticationAlgorithm": { "type": "string", "description": "Client authentication algorithm\nAllowed values:\n\nOPENSYSTEM\nSHAREDKEY\nUNKNOW\nOPENANDEAP" }, "authorizationPolicy": { "type": "string", "description": "Authorization Policy acquired from Cisco Identity Service Engine" }, "bytesReceived": { "type": "number", "description": "Number of bytes received during the session" }, "bytesSent": { "type": "number", "description": "Number of bytes sent during the session" }, "clientInterface": { "type": "string", "description": "Client Interface" }, "connectionType": { "type": "string", "description": "Type of connection (Lightweight AP, Autonomous AP, or Wired)\nAllowed values:\n\nLIGHTWEIGHTWIRELESS\nAUTONOMOUSWIRELESS\nWIRED" }, "ctsSecurityGroup": { "type": "string", "description": "CTS security group acquired from Cisco Identity Service Engine" }, "deviceMgmtAddress": { "type": "object", "description": "Associated device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname." }, "deviceName": { "type": "string", "description": "Associated device name (controller or switch)" }, "eapType": { "type": "string", "description": "EAP type\nAllowed values:\n\nEAPTLS\nTTLS\nPEAP\nLEAP\nSPEKE\nEAPFAST\nNA\nUNNOWN\nMD5\nEAPSIM" }, "encryptionCypher": { "type": "string", "description": "Client encryption cypher\nAllowed values:\n\nCCMPAES\nTKIPMIC\nLITERAL2\nWEP140\nWEP128\nNONE\nNA\nUNKNOWN" }, "ipAddress": { "type": "object", "description": "Client IP Address" }, "ipType": { "type": "string", "description": "Client IP type (IPv4, IPv6 or Dual Stack)\nAllowed values:\n\nIPV4\nIPV6\nDUALSTACK\nNOTDETECTED" }, "location": { "type": "string", "description": "Associated AP or switch Map location" }, "macAddress": { "type": "object", "description": "Client MAC Address" }, "packetsReceived": { "type": "number", "description": "Number of packets received during the session" }, "packetsSent": { "type": "number", "description": "Number of bytes sent during the session" }, "policyTypeStatus": { "type": "string", "description": "Client policy status\nAllowed values:\n\nIDLE\nRUNNING\nNOMETHOD\nAUTHENTICATIONSUCEEDED\nAUTHENTICATIONFAILED\nAUTHORIZATIONSUCCEEDED\nAUTHORIZATIONFAILED\nDISASSOCIATED" }, "portSpeed": { "type": "string", "description": "Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps) for wired client\nAllowed values:\n\nUNKNOWN\nSPEED10M\nSPEED100M\nSPEED1G\nSPEED10G" }, "postureStatus": { "type": "string", "description": "Client posture status acquired from Cisco Identity Service Engine\nAllowed values:\n\nUNKNOWN\nCOMPLIANT\nNONCOMPLIANT\nPENDING\nNA\nERROR" }, "profileName": { "type": "string", "description": "Profile name" }, "protocol": { "type": "string", "description": "client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3)\nAllowed values:\n\nUNDEFINED\nDOT11A\nDOT11B\nDOT11G\nUNKNOWN\nMOBILE\nDOT11N2_4GNZ\nDOT11N5GHZ\nDOT3\nDOT3GUEST\nDOT11AC" }, "roamReason": { "type": "string", "description": "The reason reported from controller why client is moved to another AP" }, "rssi": { "type": "number", "description": "RSSI observed from last polling during the session" }, "securityPolicy": { "type": "string", "description": "Client security policy type\nAllowed values:\n\nDOT1X\nWPA1\nWPA2\nWPA2VFF\nNA\nUNKNOWN\nCCKM\nMACAUTHBYPASS\nWEBAUTH\nWPA" }, "sessionEndTime": { "type": "number", "description": "Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100)." }, "sessionStartTime": { "type": "number", "description": "Session start time is the time the session started, measured in milliseconds since the Unix epoch." }, "snr": { "type": "number", "description": "SNR (Signal to Noise Ratio) observed from last polling during the session" }, "ssid": { "type": "string", "description": "SSID" }, "throughput": { "type": "number", "description": "Average session throughput" }, "userName": { "type": "string", "description": "Client Username" }, "vlan": { "type": "number", "description": "Vlan name" }, "webSecurity": { "type": "string", "description": "flag to indicate whether the client is authenticated via WebAuth\nAllowed values:\n\nDISABLED\nENABLED" }, "wgbMacAddress": { "type": "object", "description": "WGB MAC Address if it is a WGB client" }, "wgbStatus": { "type": "string", "description": "flag to indicate whether the client is WGB client, WGB AP or local client\nAllowed values:\n\nREGULARCLIENT\nWGBCLIENT\nWGBAP" } } } } } } } } }, "/webacs/api/v4/data/ClientTraffics": { "get": { "summary": "GET Client Traffic Information\nGET data/ClientTraffics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "dot11aReceived": { "type": "number", "description": "Total bytes received using 802.11a protocol" }, "dot11aSent": { "type": "number", "description": "Total bytes sent using 802.11a protocol" }, "dot11aThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11a protocol" }, "dot11acReceived": { "type": "number", "description": "Total bytes received using 802.11ac protocol" }, "dot11acSent": { "type": "number", "description": "Total bytes sent using 802.11ac protocol" }, "dot11acThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11ac protocol" }, "dot11bReceived": { "type": "number", "description": "Total bytes received using 802.11b protocol" }, "dot11bSent": { "type": "number", "description": "Total bytes sent using 802.11b protocol" }, "dot11bThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11b protocol" }, "dot11gReceived": { "type": "number", "description": "Total bytes received using 802.11g protocol" }, "dot11gSent": { "type": "number", "description": "Total bytes sent using 802.11g protocol" }, "dot11gThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11g protocol" }, "dot11n24Received": { "type": "number", "description": "Total bytes received using 802.11n protocol in 2.4GHz band" }, "dot11n24Sent": { "type": "number", "description": "Total bytes sent using 802.11n protocol in 2.4GHz band" }, "dot11n24Throughput": { "type": "number", "description": "Total throughput in Kbps using 802.11n protocol in 2.4GHz band" }, "dot11n5Received": { "type": "number", "description": "Total bytes received using 802.11n protocol in 5GHz band" }, "dot11n5Sent": { "type": "number", "description": "Total bytes sent using 802.11n protocol in 5GHz band" }, "dot11n5Throughput": { "type": "number", "description": "Total throughput in Kbps using 802.11n protocol in 5GHz band" }, "key": { "type": "string", "description": "key represents the element" }, "received": { "type": "number", "description": "Total bytes received" }, "sent": { "type": "number", "description": " bytes sent" }, "subkey": { "type": "string", "description": "subkey is used to further categorize client count" }, "throughput": { "type": "number", "description": " throughput in Kbps" }, "type": { "type": "string", "description": "Type of count element\nAllowed values:\n\nDEVICE\nACCESSPOINT\nMAPLOCATION\nSSID\nVIRTUALDOMAIN\nGUEST" }, "wired100MReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 100Mbps port" }, "wired100MSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 100Mbps port" }, "wired100MThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 100Mbps port" }, "wired10GReceived": { "type": "number", "description": "Total bytes received by wired clients connected to wired switch on 10Gbps port" }, "wired10GSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 10Gbps port" }, "wired10GThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 10Gbps port" }, "wired10MReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 10Mbps port" }, "wired10MSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 10Mbps port" }, "wired10MThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 10Mbps port" }, "wired1GReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 1Gbps port" }, "wired1GSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 1Gbps port" }, "wired1GThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 1Gbps port" } } } } } } } } }, "/webacs/api/v4/data/HistoricalClientCounts": { "get": { "summary": "GET Historical Client Counts\nGET data/HistoricalClientCounts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "authCount": { "type": "number", "description": " authenticated client count on the element in last collection time" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "count": { "type": "number", "description": " client count on the element in last collection time" }, "dot11aAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11a" }, "dot11aCount": { "type": "number", "description": "umber of clients using 802.11a" }, "dot11acAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11ac" }, "dot11acCount": { "type": "number", "description": "umber of clients using 802.11ac" }, "dot11bAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11b" }, "dot11bCount": { "type": "number", "description": "umber of clients using 802.11b" }, "dot11gAuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11g" }, "dot11gCount": { "type": "number", "description": "umber of clients using 802.11g" }, "dot11n24AuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11n on 2.4 GHz band" }, "dot11n24Count": { "type": "number", "description": "umber of clients using 802.11n in 2.4 GHz band" }, "dot11n5AuthCount": { "type": "number", "description": "umber of authenticated clients using 802.11n on 5 GHz band" }, "dot11n5Count": { "type": "number", "description": "umber of clients using 802.11n in 5GHz band" }, "key": { "type": "string", "description": "key represents the element" }, "subkey": { "type": "string", "description": "subkey is used to further categorize client count" }, "type": { "type": "string", "description": "Type of count element\nAllowed values:\n\nDEVICE\nACCESSPOINT\nMAPLOCATION\nSSID\nVIRTUALDOMAIN\nGUEST" }, "wgbAuthCount": { "type": "number", "description": "umber of authenticated clients connected as WGB or wired guest" }, "wgbCount": { "type": "number", "description": "umber of clients connected as WGB or wired guest" }, "wired100MAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 100Mbps port" }, "wired100MCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 100Mbps port" }, "wired10GAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 10Gbps port" }, "wired10GCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 10Gbps port" }, "wired10MAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 10Mbps port" }, "wired10MCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 10Mbps port" }, "wired1GAuthCount": { "type": "number", "description": "umber of authenticated wired clients connected to wired switch on 1Gbps port" }, "wired1GCount": { "type": "number", "description": "umber of wired clients connected to wired switch on 1Gbps port" } } } } } } } } }, "/webacs/api/v4/data/HistoricalClientTraffics": { "get": { "summary": "GET Historical Client Traffic Information\nGET data/HistoricalClientTraffics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "dot11aReceived": { "type": "number", "description": "Total bytes received using 802.11a protocol" }, "dot11aSent": { "type": "number", "description": "Total bytes sent using 802.11a protocol" }, "dot11aThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11a protocol" }, "dot11acReceived": { "type": "number", "description": "Total bytes received using 802.11ac protocol" }, "dot11acSent": { "type": "number", "description": "Total bytes sent using 802.11ac protocol" }, "dot11acThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11ac protocol" }, "dot11bReceived": { "type": "number", "description": "Total bytes received using 802.11b protocol" }, "dot11bSent": { "type": "number", "description": "Total bytes sent using 802.11b protocol" }, "dot11bThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11b protocol" }, "dot11gReceived": { "type": "number", "description": "Total bytes received using 802.11g protocol" }, "dot11gSent": { "type": "number", "description": "Total bytes sent using 802.11g protocol" }, "dot11gThroughput": { "type": "number", "description": "Total throughput in Kbps using 802.11g protocol" }, "dot11n24Received": { "type": "number", "description": "Total bytes received using 802.11n protocol in 2.4GHz band" }, "dot11n24Sent": { "type": "number", "description": "Total bytes sent using 802.11n protocol in 2.4GHz band" }, "dot11n24Throughput": { "type": "number", "description": "Total throughput in Kbps using 802.11n protocol in 2.4GHz band" }, "dot11n5Received": { "type": "number", "description": "Total bytes received using 802.11n protocol in 5GHz band" }, "dot11n5Sent": { "type": "number", "description": "Total bytes sent using 802.11n protocol in 5GHz band" }, "dot11n5Throughput": { "type": "number", "description": "Total throughput in Kbps using 802.11n protocol in 5GHz band" }, "key": { "type": "string", "description": "key represents the element" }, "received": { "type": "number", "description": "Total bytes received" }, "sent": { "type": "number", "description": "Total bytes sent" }, "subkey": { "type": "string", "description": "subkey is used to further categorize client count" }, "throughput": { "type": "number", "description": "Total throughput in Kbps" }, "type": { "type": "string", "description": "Type of count element\nAllowed values:\n\nDEVICE\nACCESSPOINT\nMAPLOCATION\nSSID\nVIRTUALDOMAIN\nGUEST" }, "wired100MReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 100Mbps port" }, "wired100MSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 100Mbps port" }, "wired100MThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 100Mbps port" }, "wired10GReceived": { "type": "number", "description": "Total bytes received by wired clients connected to wired switch on 10Gbps port" }, "wired10GSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 10Gbps port" }, "wired10GThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 10Gbps port" }, "wired10MReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 10Mbps port" }, "wired10MSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 10Mbps port" }, "wired10MThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 10Mbps port" }, "wired1GReceived": { "type": "number", "description": "Total bytes sent from wired clients connected to wired switch on 1Gbps port" }, "wired1GSent": { "type": "number", "description": "Total bytes send from wired clients connected to wired switch on 1Gbps port" }, "wired1GThroughput": { "type": "number", "description": "Total throughput from wired clients connected to wired switch on 1Gbps port" } } } } } } } } }, "/webacs/api/v4/op/compliance/check": { "get": { "summary": "GET Checks status of Check Job\nGET op/compliance/check", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "description": "Devices details.", "items": { "type": "object" } }, "isSuccess": { "type": "boolean", "description": "If true, the action was successfully performed. If false, it ended in some failure condition." }, "message": { "type": "string", "description": "The action status message." } } } } } } }, "parameters": [ { "name": "jobName", "in": "query", "required": true, "description": "RequiredName of check compliance job", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/compliance/policy": { "post": { "summary": "POST Add policy\nPOST op/compliance/policy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "If true, the action was successfully performed. If false, it ended in some failure condition." }, "message": { "type": "string", "description": "The action status message." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policyDescription": { "type": "string", "description": "Description." }, "policyId": { "type": "string", "description": "Policy ID. Required." }, "policyTitle": { "type": "string", "description": "Policy title. Required." }, "ruleList": { "type": "array", "description": "At least one should be provided.", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/compliance/profile": { "post": { "summary": "POST Add profile\nPOST op/compliance/profile", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "If true, the action was successfully performed. If false, it ended in some failure condition." }, "message": { "type": "string", "description": "The action status message." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "group": { "type": "object", "description": "" }, "name": { "type": "string", "description": "" }, "policies": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/compliance/policy/import": { "post": { "summary": "POST Import policy\nPOST op/compliance/policy/import", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "If true, the action was successfully performed. If false, it ended in some failure condition." }, "message": { "type": "string", "description": "The action status message." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policyXml": { "type": "string", "description": "CustomPolicy XML to import." } } } } } } } }, "/webacs/api/v4/op/compliance/run": { "post": { "summary": "POST Schedule a Check Job\nPOST op/compliance/run", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "If true, the action was successfully performed. If false, it ended in some failure condition." }, "message": { "type": "string", "description": "The action status message." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configFileFrom": { "type": "string", "description": "e of LATEST_FROM_DEVICE (collects the config from Device), LATEST_FROM_ARCHIVE (collects the config from Database which already collected). By default LATEST_FROM_DEVICE." }, "jobDto": { "type": "object", "description": "Job details." }, "policyProfileName": { "type": "string", "description": "Profile name." }, "targets": { "type": "array", "description": "Targets to check, devices or groups.", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/data/BulkSanitizedConfigArchives": { "get": { "summary": "GET Bulk export sanitized configuration archives\nGET data/BulkSanitizedConfigArchives", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "comments": { "type": "string", "description": "Comments from the system of configuration archive" }, "createdAt": { "type": "number", "description": "Date and time of creation" }, "createdBy": { "type": "string", "description": "Initiator of creation" }, "deviceId": { "type": "number", "description": "Unique identifier of device entity" }, "deviceIpAddress": { "type": "string", "description": "Device IP address" }, "deviceName": { "type": "string", "description": "Device host name" }, "diffType": { "type": "string", "description": "The result of comparison with the previous version of the configuration files\nAllowed values:\n\nOUT_OF_SYNC\nIN_SYNC\nNOT_APPLICABLE" }, "files": { "type": "array", "description": "Configuration files", "items": { "type": "object" } }, "isFirst": { "type": "boolean", "description": "Indicates that current version is the first collected version of configuration files" }, "isLast": { "type": "boolean", "description": "Indicates that current version is the latest collected version of configuration files" }, "outOfBand": { "type": "boolean", "description": "The out-of-band change flag" }, "tags": { "type": "array", "description": "User's tags for the version", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/data/BulkUnsanitizedConfigArchives": { "get": { "summary": "GET Bulk export unsanitized configuration archives\nGET data/BulkUnsanitizedConfigArchives", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "comments": { "type": "string", "description": "Comments from the system of configuration archive" }, "createdAt": { "type": "number", "description": "Date and time of creation" }, "createdBy": { "type": "string", "description": "Initiator of creation" }, "deviceId": { "type": "number", "description": "Unique identifier of device entity" }, "deviceIpAddress": { "type": "string", "description": "Device IP address" }, "deviceName": { "type": "string", "description": "Device host name" }, "diffType": { "type": "string", "description": "The result of comparison with the previous version of the configuration files\nAllowed values:\n\nOUT_OF_SYNC\nIN_SYNC\nNOT_APPLICABLE" }, "files": { "type": "array", "description": "Configuration files", "items": { "type": "object" } }, "isFirst": { "type": "boolean", "description": "Indicates that current version is the first collected version of configuration files" }, "isLast": { "type": "boolean", "description": "Indicates that current version is the latest collected version of configuration files" }, "outOfBand": { "type": "boolean", "description": "The out-of-band change flag" }, "tags": { "type": "array", "description": "User's tags for the version", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/data/ConfigArchives": { "get": { "summary": "GET Configuration archive list\nGET data/ConfigArchives", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIpAddress": { "type": "string", "description": "Device IP address" }, "deviceName": { "type": "string", "description": "Device host name" }, "lastMessage": { "type": "string", "description": "Contains error message, If last collection of configuration files was failed" }, "lastSuccessful": { "type": "boolean", "description": "Result of the last collection of configuration files" } } } } } } } } }, "/webacs/api/v4/data/ConfigVersions": { "get": { "summary": "GET Configuration versions and files list\nGET data/ConfigVersions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "comments": { "type": "string", "description": "Comments from the system of configuration archive" }, "createdAt": { "type": "number", "description": "Date and time of creation" }, "createdBy": { "type": "string", "description": "Initiator of creation" }, "deviceIpAddress": { "type": "string", "description": "Device IP address" }, "deviceName": { "type": "string", "description": "Device host name" }, "diffType": { "type": "string", "description": "The result of comparison with the previous version of the configuration files\nAllowed values:\n\nOUT_OF_SYNC\nIN_SYNC\nNOT_APPLICABLE" }, "fileInfos": { "type": "array", "description": "List of configuration file info", "items": { "type": "object" } }, "isFirst": { "type": "boolean", "description": "Indicates the first collected version of configuration files" }, "isLast": { "type": "boolean", "description": "Indicates the last collected version of configuration files" }, "outOfBand": { "type": "boolean", "description": "The out-of-band change flag" }, "tags": { "type": "array", "description": "User's tags for the version", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/configArchiveService/configDiff/{device}": { "get": { "summary": "GET Configuration Diff\nGET op/configArchiveService/configDiff/{device}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "configChanged": { "type": "boolean", "description": "flag indicating if config has changed for a given device from given timeStamp," }, "configDiffs": { "type": "array", "description": "Config diff payload", "items": { "type": "object" } }, "deviceIp": { "type": "string", "description": "The management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname." }, "deviceName": { "type": "string", "description": "Device Name of the device" } } } } } } }, "parameters": [ { "name": "device", "in": "path", "required": true, "description": "RequiredThe device name or the management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.", "schema": { "type": "string" } }, { "name": "timeStamp", "in": "query", "required": false, "description": "mestamp in UTC milliseconds. When provided, API computes any diff from provided timeStamp till latest.", "schema": { "type": "number" } }, { "name": "diffType", "in": "query", "required": false, "description": "Config Archive Diff Type (Processed/Unprocessed). Unprocessed is raw diff.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/configArchiveService/extractSanitizedFile": { "get": { "summary": "GET Download the sanitized configuration file\nGET op/configArchiveService/extractSanitizedFile", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileData": { "type": "string", "description": "File content." } } } } } } }, "parameters": [ { "name": "fileId", "in": "query", "required": true, "description": "RequiredfileId parameter from configuration version", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/configArchiveService/extractUnsanitizedFile": { "get": { "summary": "GET Download the unsanitized configuration file\nGET op/configArchiveService/extractUnsanitizedFile", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileData": { "type": "string", "description": "File content." } } } } } } }, "parameters": [ { "name": "fileId", "in": "query", "required": true, "description": "RequiredfileId parameter from configuration version", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/credentialProfilesManagement/credentialProfiles": { "delete": { "summary": "DELETE Delete credential profile\nDELETE op/credentialProfilesManagement/credentialProfiles", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "profileName": { "type": "string", "description": "RequiredThe name of credential profile to delete." } } } } } } } }, "get": { "summary": "GET Get credential profiles\nGET op/credentialProfilesManagement/credentialProfiles", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cliParameters": { "type": "object", "description": "The CLI parameters." }, "description": { "type": "string", "description": "The description of the credential profile." }, "httpParameters": { "type": "object", "description": "The http/https parameters." }, "profileName": { "type": "string", "description": "The name of the credential profile. This field is mandatory." }, "snmpParameters": { "type": "object", "description": "The SNMP parameters." } } } } } } } } }, "/webacs/api/v4/op/credentialProfilesManagement/deviceList": { "get": { "summary": "GET Get list of configured devices\nGET op/credentialProfilesManagement/deviceList", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIp": { "type": "string", "description": "The IP address or DNS name." }, "deviceName": { "type": "string", "description": "The device name." } } } } } } }, "parameters": [ { "name": "profileName", "in": "query", "required": true, "description": "RequiredThe name of credential profile to retrieve device list.", "schema": { "type": "string" } } ] }, "post": { "summary": "POST Create credential profile\nPOST op/credentialProfilesManagement/credentialProfiles", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cliParameters": { "type": "object", "description": "The CLI parameters." }, "description": { "type": "string", "description": "The description of the credential profile." }, "httpParameters": { "type": "object", "description": "The http/https parameters." }, "profileName": { "type": "string", "description": "The name of the credential profile. This field is mandatory." }, "snmpParameters": { "type": "object", "description": "The SNMP parameters." } } } } } } } }, "put": { "summary": "PUT Update credential profile\nPUT op/credentialProfilesManagement/credentialProfiles", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cliParameters": { "type": "object", "description": "The CLI parameters." }, "description": { "type": "string", "description": "The description of the credential profile." }, "httpParameters": { "type": "object", "description": "The http/https parameters." }, "profileName": { "type": "string", "description": "The name of the credential profile. This field is mandatory." }, "snmpParameters": { "type": "object", "description": "The SNMP parameters." } } } } } } } } }, "/webacs/api/v4/data/InventoryDetails": { "get": { "summary": "GET Inventory Details\nGET data/InventoryDetails", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cdpNeighbor": { "type": "array", "description": "This nested field provides information on the CDP neighbors for this device.", "items": { "type": "object" } }, "chassis": { "type": "array", "description": "This nested field provides a listing of the chassis associated with this device.", "items": { "type": "object" } }, "etherChannel": { "type": "array", "description": "This nested field provides information about the ether channels associated with this device.", "items": { "type": "object" } }, "ethernetInterface": { "type": "number", "description": "This nested field provides information on the ethernet interfaces associated with this device." }, "fan": { "type": "array", "description": "This nested field provides information about the fans associated with this device", "items": { "type": "object" } }, "ipInterface": { "type": "number", "description": "This nested field provides information about the ip interfaces associated with this device." }, "module": { "type": "array", "description": "This nested field provides a listing of the modules associated with this device", "items": { "type": "object" } }, "physicalPort": { "type": "array", "description": "This nested field provides information about the physical ports associated with this device.", "items": { "type": "object" } }, "powerSupply": { "type": "array", "description": "This nested field provides information about the power supplies associated with this device.", "items": { "type": "object" } }, "sensor": { "type": "array", "description": "This nested field provides information about the sensors associated with this device.", "items": { "type": "object" } }, "summary": { "type": "object", "description": "A nested field that provides an inventory summary" }, "udf": { "type": "array", "description": "This nested field provides the user defined fields for this device.", "items": { "type": "object" } }, "vlanInterface": { "type": "number", "description": "This nested field provides information about the vlan interfaces associated with this device." } } } } } } } } }, "/webacs/api/v4/data/MerakiAccessPoints": { "get": { "summary": "GET Meraki Access Points\nGET data/MerakiAccessPoints", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "clientCount": { "type": "number", "description": "The number of clients currently associated with the device." }, "contactedAt": { "type": "number", "description": "The last time the access point contacted the Cloud Controller." }, "dashboardAddress": { "type": "object", "description": "The Meraki dashboard address." }, "deviceName": { "type": "string", "description": "The name of the device." }, "deviceType": { "type": "string", "description": "The type of the device." }, "ipAddress": { "type": "object", "description": "The ip address of the device." }, "macAddress": { "type": "object", "description": "Device MAC address." }, "meshStatus": { "type": "string", "description": "Whether the AP is currently acting as a gateway or a repeater.\nAllowed values:\n\nGATEWAY\nREPEATER" }, "networkName": { "type": "string", "description": "The name of the network this device is in." }, "productFamily": { "type": "string", "description": "The product family of this device." }, "reachability": { "type": "string", "description": "The status of the device's connection to the Meraki Cloud.\nAllowed values:\n\nUNREACHABLE\nREACHABLE" }, "serialNumber": { "type": "string", "description": "Device serial number." } } } } } } } } }, "/webacs/api/v4/data/MerakiDevices": { "get": { "summary": "GET Meraki Devices\nGET data/MerakiDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "clientCount": { "type": "number", "description": "The number of clients currently associated with the device." }, "contactedAt": { "type": "number", "description": "The last time the device contacted the Cloud Controller." }, "dashboardAddress": { "type": "object", "description": "The Meraki dashboard address." }, "deviceName": { "type": "string", "description": "The name of the device." }, "deviceType": { "type": "string", "description": "The type of the device." }, "ipAddress": { "type": "object", "description": "The ip address of the device." }, "macAddress": { "type": "object", "description": "Device MAC address." }, "networkName": { "type": "string", "description": "The name of the network this device is in." }, "productFamily": { "type": "string", "description": "The product family of this device." }, "reachability": { "type": "string", "description": "The status of the device's connection to the Meraki Cloud.\nAllowed values:\n\nUNREACHABLE\nREACHABLE" }, "serialNumber": { "type": "string", "description": "Device serial number." } } } } } } } } }, "/webacs/api/v4/op/devices/exportDevices": { "get": { "summary": "GET Export Devices\nGET op/devices/exportDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": false, "description": "Management address of the device to be exported. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "required": false, "description": "The ids of the groups of the devices to be exported. A group logically organizes devices. A group could be a device type, a site or a user defined group", "schema": { "type": "string" } }, { "name": "groupPath", "in": "query", "required": false, "description": "The name of a group", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/devices/removalJob": { "post": { "summary": "POST Delete devices through job\nPOST op/devices/removalJob", "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": { "deleteAPs": { "type": "boolean", "description": "Delete access points associated to wireless controllers.\nWhen not provided or 'false', then associated access points will not be deleted and remain in \"unassociated\" state.\nNote, that thirdparty access points will be deleted regardless of the property value." }, "ipAddressList": { "type": "array", "description": "List of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/devices/syncDevices": { "post": { "summary": "POST Synchronize devices\nPOST op/devices/syncDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "description": "List of devices addresses to synchronize. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/devices/bulkImport": { "put": { "summary": "PUT Bulk Import\nPUT op/devices/bulkImport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobName": { "type": "string", "description": "The job name created by the bulk import operation. The job name can be referred to check the status of the job using job management services" }, "message": { "type": "string", "description": "A message returned from the bulk import operation" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "description": "A list of devices to be imported", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode": { "put": { "summary": "PUT Schedule AP Maintenance Mode\nPUT op/configure/ap/scheduleMaintenanceMode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "apIds": { "type": "number", "description": "List of unified AP IDs. Can be retrieved from the \"GET data/AccessPointDetails\" resource." }, "maintenanceMode": { "type": "boolean", "description": "If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false." } } } } } } }, "parameters": [ { "name": "scheduledTime", "in": "query", "required": false, "description": "The time when the job will be launched. If the time is not specified the job will be started immediately.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/configure/device/scheduleMaintenanceMode": { "put": { "summary": "PUT Schedule Maintenance Mode\nPUT op/configure/device/scheduleMaintenanceMode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIds": { "type": "number", "description": "List of device IDs. Can be retrieved with the response parameter 'id' from the \"GET data/Devices\" resource." }, "maintenanceMode": { "type": "boolean", "description": "If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false." }, "reason": { "type": "string", "description": "Reason for moving devices into the maintenance mode. Optional.\nThis attribute will be ignored if the attribute 'maintenanceMode' is false." } } } } } } }, "parameters": [ { "name": "scheduledTime", "in": "query", "required": false, "description": "The time when the job will be launched. If the time is not specified the job will be started immediately.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/configure/ap/maintenanceMode": { "put": { "summary": "PUT Set AP Maintenance Mode\nPUT op/configure/ap/maintenanceMode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Message with the result information" }, "results": { "type": "number", "description": "List of operation results" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "apIds": { "type": "array", "description": "List of unified AP IDs. Can be retrieved from the \"GET data/AccessPointDetails\" resource.", "items": { "type": "object" } }, "maintenanceMode": { "type": "boolean", "description": "If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false." } } } } } } } }, "/webacs/api/v4/op/configure/device/maintenanceMode": { "put": { "summary": "PUT Set Device Maintenance Mode\nPUT op/configure/device/maintenanceMode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Message with the result information" }, "results": { "type": "number", "description": "List of operation results" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIds": { "type": "array", "description": "List of device IDs. Can be retrieved with the response parameter 'id' from the \"GET data/Devices\" resource.", "items": { "type": "object" } }, "maintenanceMode": { "type": "boolean", "description": "If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false." }, "reason": { "type": "string", "description": "Reason for moving devices into the maintenance mode. Optional.\nThis attribute will be ignored if the attribute 'maintenanceMode' is false." } } } } } } } }, "/webacs/api/v4/op/groups/group": { "delete": { "summary": "DELETE Delete device or port group\nDELETE op/groups/group", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "number", "description": "RequiredId of the group. Either groupId or groupPath must be specified." }, "groupPath": { "type": "string", "description": "RequiredFull path and name of the group. Either groupId or groupPath must be specified." }, "groupType": { "type": "string", "description": "RequiredType of Group (DEVICE or INTERFACE)" } } } } } } } } }, "/webacs/api/v4/op/groups/groupRules": { "get": { "summary": "GET Device Group Rules\nGET op/groups/groupRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "array", "description": "List of group rules", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": true, "description": "RequiredId of the group. Either groupId or groupPath must be specified.", "schema": { "type": "number" } }, { "name": "groupPath", "in": "query", "required": true, "description": "RequiredFull path and name of the group. Either groupId or groupPath must be specified.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/groups/groupDevices": { "put": { "summary": "PUT Assign devices to a group\nPUT op/groups/groupDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIds": { "type": "number", "description": "List of device IDs" }, "deviceIps": { "type": "string", "description": "List of device IP addresses" } } } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": true, "description": "RequiredId of the group. Either groupId or groupPath must be specified.", "schema": { "type": "number" } }, { "name": "groupPath", "in": "query", "required": true, "description": "RequiredFull path and name of the group. Either groupId or groupPath must be specified.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/groups/groupInterfaces": { "put": { "summary": "PUT Create or update device or port group\nPUT op/groups/group", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of a group (human-readable). Optional. Max length of the description is 255 characters." }, "latitude": { "type": "number", "description": "Latitude of GPS location, measured in degrees. Latitude must range from -90 to 90. Optional. Could be specified only for LOCATION groups.\n\nNote that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified." }, "locationAddress": { "type": "string", "description": "Address of location. Optional. Could be specified only for LOCATION groups.\nNote that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified." }, "locationGroupType": { "type": "string", "description": "Type of location. Optional. Could be specified only for LOCATION groups.\n\nNote that Default and Campus groups can be created only under a group with Default location type, Building and Outdoor Area groups can be created only under a Campus group, and Floor Area groups can be created only under a Building group.\nWhen you are editing a location group, you can change the group type to Campus, if the group type is Default and the group does not have any subgroups. In all other cases it is not allowed to change the location type of the group.\nAllowed values:\n\nDEFAULT\nCAMPUS\nBUILDING\nFLOORAREA\nOUTDOORAREA" }, "longitude": { "type": "number", "description": "Longitude of GPS location, measured in degrees. Longitude must range from -180 to 180. Optional. Could be specified only for LOCATION groups.\nNote that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified." }, "name": { "type": "string", "description": "Name of a group. Required.\nThe group name can contain any characters except: '&<>\"/?\nThe maximum name length is 255 characters for user-defined groups and location groups with the default type. For location groups with a non-default type, the maximum name length is 40 characters." }, "path": { "type": "string", "description": "Path to the group (slash-separated, e.g. \"group/subgroup/sub_subgroup\") relative to the 'User Defined' or 'Location/All Locations' group." }, "type": { "type": "string", "description": "Type of a group. Required.\nAllowed values:\n\nLOCATION\nUSERDEFINED\nINTERFACEGROUP" } } } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": false, "description": "Group ID of group to update, if given. If not, new group will be created.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/groups/removeDevices": { "put": { "summary": "PUT Remove devices from a group\nPUT op/groups/removeDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIds": { "type": "number", "description": "List of device IDs" }, "deviceIps": { "type": "string", "description": "List of device IP addresses" } } } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": true, "description": "RequiredId of the group. Either groupId or groupPath must be specified.", "schema": { "type": "number" } }, { "name": "groupPath", "in": "query", "required": true, "description": "RequiredFull path and name of the group. Either groupId or groupPath must be specified.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/groups/removeInterfaces": { "put": { "summary": "PUT Replace set of group rules\nPUT op/groups/groupRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "array", "description": "List of group rules", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": true, "description": "RequiredId of the group. Either groupId or groupPath must be specified.", "schema": { "type": "number" } }, { "name": "groupPath", "in": "query", "required": true, "description": "RequiredFull path and name of the group. Either groupId or groupPath must be specified.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/data/GroupSpecification": { "get": { "summary": "GET Group Specification\nGET data/GroupSpecification", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the group" }, "groupName": { "type": "string", "description": "The name of the group" }, "groupPath": { "type": "string", "description": "The full hierarchy path of the group" }, "parentId": { "type": "number", "description": "The parent group id of the group. If it is -1, it is a root group. There are three root groups: User Defined, Device Type, Location" } } } } } } } } }, "/webacs/api/v4/op/groups/alarmSummary": { "get": { "summary": "GET Alarm Summary\nGET op/groups/alarmSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "nbrAlarmedAPs": { "type": "number", "description": "Number of access points with associated alarms of critical, major, minor, warning, and information severities." }, "nbrAlarmedClients": { "type": "number", "description": "Number of clients associated with APs with alarms of critical, major, minor, warning, and information severities." }, "nbrAlarmedDevices": { "type": "number", "description": "Number of Devices (excluding APs) with alarms of critical, major, minor, warning, and information severities associated." }, "nbrAlarmedSites": { "type": "number", "description": "Number of sites containing devices with associated alarms of critical, major, minor, warning, and information severities." }, "totalAlarms": { "type": "number", "description": "Total number of alarms of critical, major, minor, warning, and information severities." } } } } } } } } }, "/webacs/api/v4/op/groups/deviceGroups": { "get": { "summary": "GET Device Groups\nGET op/groups/deviceGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "clearedAlarms": { "type": "number", "description": "Total number of cleared alarms against members of the group." }, "criticalAlarms": { "type": "number", "description": "Total number of critical alarms against members of the group." }, "description": { "type": "string", "description": "The description of this group." }, "groupId": { "type": "number", "description": "The internal id of this group." }, "groupName": { "type": "string", "description": "The instance name of this group." }, "groupType": { "type": "string", "description": "Type of group defined by the application.\nAllowed values:\n\nNETWORK_DEVICE\nPORT" }, "informationAlarms": { "type": "number", "description": "Total number of information alarms against members of the group." }, "isExplicit": { "type": "boolean", "description": "Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group." }, "majorAlarms": { "type": "number", "description": "Total number of major alarms against members of the group." }, "membersCount": { "type": "number", "description": "Number of members statically or dynamically added to a group. Includes member counts of child groups for Device groups. Does not include member counts of child groups for User Defined groups. The members could be: ports (only for Port groups), non-AP devices, Autonomous, Unified and Thirdparty APs." }, "minorAlarms": { "type": "number", "description": "Total number of minor alarms against members of the group." }, "name": { "type": "string", "description": "The hierarchical name of the group." }, "unacknowledgedClearedAlarms": { "type": "number", "description": "Number of unacknowledged cleared alarms against members of the group." }, "unacknowledgedCriticalAlarms": { "type": "number", "description": "Number of unacknowledged critical alarms against members of the group." }, "unacknowledgedInformationAlarms": { "type": "number", "description": "Number of unacknowledged information alarms against members of the group." }, "unacknowledgedMajorAlarms": { "type": "number", "description": "Number of unacknowledged major alarms against members of the group." }, "unacknowledgedMinorAlarms": { "type": "number", "description": "Number of unacknowledged minor alarms against members of the group." }, "unacknowledgedWarningAlarms": { "type": "number", "description": "Number of unacknowledged warning alarms against members of the group." }, "warningAlarms": { "type": "number", "description": "Total number of warning alarms against members of the group." } } } } } } }, "parameters": [ { "name": "noAlarms", "in": "query", "required": false, "description": "If true, the alarms summary data won't be calculated and returned", "schema": { "type": "boolean" } }, { "name": "noMembersCount", "in": "query", "required": false, "description": "If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.", "schema": { "type": "boolean" } } ] } }, "/webacs/api/v4/op/groups/sites": { "get": { "summary": "GET Location Groups\nGET op/groups/sites", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "apCount": { "type": "number", "description": "The number of Access Points within the location." }, "clearedAlarms": { "type": "number", "description": "Total number of cleared alarms registered against devices within this location." }, "clientCount": { "type": "number", "description": "Number of clients connected to the location." }, "criticalAlarms": { "type": "number", "description": "Total number of critical alarms registered against devices within this location." }, "description": { "type": "string", "description": "The description of the location group." }, "deviceCount": { "type": "number", "description": "Total number of devices (non-APs)." }, "groupId": { "type": "number", "description": "The internal id of the location group." }, "groupName": { "type": "string", "description": "The name of the location group." }, "informationAlarms": { "type": "number", "description": "Total number of information alarms registered against devices within this location." }, "isExplicit": { "type": "boolean", "description": "Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group." }, "latitude": { "type": "number", "description": "Latitude of location, measured in degrees and ranges from -90 to 90." }, "locationAddress": { "type": "string", "description": "Address of location." }, "locationGroupType": { "type": "string", "description": "The type of location.\nAllowed values:\n\nDEFAULT\nCAMPUS\nBUILDING\nFLOORAREA\nOUTDOORAREA" }, "longitude": { "type": "number", "description": "Longitude of GPS location, measured in degrees and ranges from -180 to 180." }, "majorAlarms": { "type": "number", "description": "Total number of major alarms registered against devices within this location." }, "membersCount": { "type": "number", "description": "Number of members within a location group. Includes the members statically or dynamically added to the group and to the all child groups. The members could be: non-AP devices, Autonomous, Unified and Thirdparty APs." }, "minorAlarms": { "type": "number", "description": "Total number of minor alarms registered against devices within this location." }, "name": { "type": "string", "description": "The hierarchical name of the location." }, "siteType": { "type": "string", "description": "Deprecated: should use \"locationGroupType\" attribute.\nThe type of location: Campus, Building, Floor Area, Outdoor Area." }, "unacknowledgedClearedAlarms": { "type": "number", "description": "Number of unacknowledged cleared alarms registered against devices within this location." }, "unacknowledgedCriticalAlarms": { "type": "number", "description": "Number of unacknowledged critical alarms registered against devices within this location." }, "unacknowledgedInformationAlarms": { "type": "number", "description": "Number of unacknowledged information alarms registered against devices within this location." }, "unacknowledgedMajorAlarms": { "type": "number", "description": "Number of unacknowledged major alarms registered against devices within this location." }, "unacknowledgedMinorAlarms": { "type": "number", "description": "Number of unacknowledged minor alarms registered against devices within this location." }, "unacknowledgedWarningAlarms": { "type": "number", "description": "Number of unacknowledged warning alarms registered against devices within this location." }, "warningAlarms": { "type": "number", "description": "Total number of warning alarms registered against devices within this location." } } } } } } }, "parameters": [ { "name": "noAlarms", "in": "query", "required": false, "description": "If true, the alarms summary data won't be calculated and returned", "schema": { "type": "boolean" } }, { "name": "noMembersCount", "in": "query", "required": false, "description": "If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.", "schema": { "type": "boolean" } } ] } }, "/webacs/api/v4/op/groups/userDefinedGroups": { "get": { "summary": "GET User Defined Groups\nGET op/groups/userDefinedGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "clearedAlarms": { "type": "number", "description": "Total number of cleared alarms against members of the group." }, "criticalAlarms": { "type": "number", "description": "Total number of critical alarms against members of the group." }, "description": { "type": "string", "description": "The description of this group." }, "groupId": { "type": "number", "description": "The internal id of this group." }, "groupName": { "type": "string", "description": "The instance name of this group." }, "groupType": { "type": "string", "description": "Type of group defined by the application.\nAllowed values:\n\nNETWORK_DEVICE\nPORT" }, "informationAlarms": { "type": "number", "description": "Total number of information alarms against members of the group." }, "isExplicit": { "type": "boolean", "description": "Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group." }, "majorAlarms": { "type": "number", "description": "Total number of major alarms against members of the group." }, "membersCount": { "type": "number", "description": "Number of members statically or dynamically added to a group. Includes member counts of child groups for Device groups. Does not include member counts of child groups for User Defined groups. The members could be: ports (only for Port groups), non-AP devices, Autonomous, Unified and Thirdparty APs." }, "minorAlarms": { "type": "number", "description": "Total number of minor alarms against members of the group." }, "name": { "type": "string", "description": "The hierarchical name of the group." }, "unacknowledgedClearedAlarms": { "type": "number", "description": "Number of unacknowledged cleared alarms against members of the group." }, "unacknowledgedCriticalAlarms": { "type": "number", "description": "Number of unacknowledged critical alarms against members of the group." }, "unacknowledgedInformationAlarms": { "type": "number", "description": "Number of unacknowledged information alarms against members of the group." }, "unacknowledgedMajorAlarms": { "type": "number", "description": "Number of unacknowledged major alarms against members of the group." }, "unacknowledgedMinorAlarms": { "type": "number", "description": "Number of unacknowledged minor alarms against members of the group." }, "unacknowledgedWarningAlarms": { "type": "number", "description": "Number of unacknowledged warning alarms against members of the group." }, "warningAlarms": { "type": "number", "description": "Total number of warning alarms against members of the group." } } } } } } }, "parameters": [ { "name": "groupType", "in": "query", "required": false, "description": "An filter parameter with possible values: NETWORK_DEVICE (to return Network Device user defined groups), or PORT (to return Port user defined groups). By default, if this parameter not provided, it returns both Network Device groups and Port groups.", "schema": { "type": "string" } }, { "name": "noAlarms", "in": "query", "required": false, "description": "If true, the alarms summary data won't be calculated and returned", "schema": { "type": "boolean" } }, { "name": "noMembersCount", "in": "query", "required": false, "description": "If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.", "schema": { "type": "boolean" } } ] } }, "/webacs/api/v4/data/GuestUsers": { "get": { "summary": "GET Get guest users\nGET data/GuestUsers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "applyGuestUserTo": { "type": "object", "description": "Approach to choose a set of controllers for applying the guest user account.\nAllowed values:\n\nCONTROLLER_LIST\nINDOOR_AREA\nOUTDOOR_AREA\nCONFIG_GROUP" }, "building": { "type": "string", "description": "Name of a building for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA." }, "campus": { "type": "string", "description": "Name of a campus for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA." }, "configGroup": { "type": "string", "description": "Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP." }, "controllerId": { "type": "array", "description": "The list of controller IDs containing the guest user.", "items": { "type": "object" } }, "description": { "type": "string", "description": "Description of the guest user." }, "disclaimer": { "type": "string", "description": "Text with a disclaimer for a guest." }, "endTime": { "type": "number", "description": "An expiry time for the limited guest user. If time is not specified the user is not limited.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "floor": { "type": "string", "description": "Name of a floor for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA. If this field equals \"All Floors\" the guest account will apply to controllers on all floors." }, "lastModifiedTime": { "type": "number", "description": "The time when the guest user was created or modified in last time.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "outdoorArea": { "type": "string", "description": "Name of an outdoor area for which the guest user is configured. This field using only if applyGuestUserTo equals OUTDOOR_AREA." }, "password": { "type": "string", "description": "Password of the guest user. You should use \".case_sensitive=true\" if you want to filter by password." }, "profile": { "type": "string", "description": "Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value \"ANY PROFILE\" the guest account will apply to all controllers.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true&\nlayer3WebPolicyAuthenticationEnabled=true&\nlayer3WebPolicyOnMacFailureEnabled=true&.or_filter=true" }, "rebootController": { "type": "boolean", "description": "Indicates that a controller will be rebooted after applying the guest user." }, "saveConfigToFlash": { "type": "boolean", "description": "Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots." }, "status": { "type": "object", "description": "Current status of the guest account.\nAllowed values:\n\nACTIVE\nSCHEDULED\nNOT_ACTIVE\nEXPIRED" }, "userRole": { "type": "string", "description": "Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value \"default\" the guest account will apply to all controllers.\n\nYou can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller." }, "username": { "type": "string", "description": "Name of the guest user." } } } } } } } } }, "/webacs/api/v4/op/guestUser/guestUsersOnController": { "get": { "summary": "GET Get guest users from controller\nGET op/guestUser/guestUsersOnController", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "The name of a guest user." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredThe Id of WLAN controller to return guest users.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController": { "get": { "summary": "GET Get logged in guest users from controller\nGET op/guestUser/loggedInGuestUsersOnController", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "The name of a guest user." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredThe Id of WLAN controller to return logged in guest users.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/guestUser": { "post": { "summary": "POST Create guest user\nPOST op/guestUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "object", "description": "The operation type.\nAllowed values:\n\nCREATE\nUPDATE\nDELETE" }, "results": { "type": "array", "description": "The result of the operation on a certain WLAN controller.", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applyGuestUserTo": { "type": "object", "description": "Approach to choose a set of controllers for applying the guest user account.\nAllowed values:\n\nCONTROLLER_LIST\nINDOOR_AREA\nOUTDOOR_AREA\nCONFIG_GROUP" }, "configGroup": { "type": "string", "description": "Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP." }, "controllerId": { "type": "array", "description": "The list of controller IDs for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.", "items": { "type": "object" } }, "description": { "type": "string", "description": "Description of the guest user." }, "disclaimer": { "type": "string", "description": "Text with a disclaimer for a guest." }, "endTime": { "type": "object", "description": "An expiry time for the limited guest user. If time is not specified the user is not limited." }, "locationGroupId": { "type": "object", "description": "ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA." }, "password": { "type": "string", "description": "Password of the guest user." }, "profile": { "type": "string", "description": "Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value \"ANY PROFILE\" the guest account will apply to all controllers.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true&\nlayer3WebPolicyAuthenticationEnabled=true&\nlayer3WebPolicyOnMacFailureEnabled=true&.or_filter=true" }, "rebootController": { "type": "boolean", "description": "Indicates that a controller will be rebooted after applying the guest user." }, "saveConfigToFlash": { "type": "boolean", "description": "Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots." }, "userRole": { "type": "string", "description": "Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value \"default\" the guest account will apply to all controllers.\n\nYou can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller." }, "username": { "type": "string", "description": "Name of the guest user." } } } } } } } }, "/webacs/api/v4/op/guestUser/delete": { "put": { "summary": "PUT Update guest user\nPUT op/guestUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "object", "description": "The operation type.\nAllowed values:\n\nCREATE\nUPDATE\nDELETE" }, "results": { "type": "array", "description": "The result of the operation on a certain WLAN controller.", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applyGuestUserTo": { "type": "object", "description": "Approach to choose a set of controllers for applying the guest user account.\nAllowed values:\n\nCONTROLLER_LIST\nINDOOR_AREA\nOUTDOOR_AREA\nCONFIG_GROUP" }, "configGroup": { "type": "string", "description": "Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP." }, "controllerId": { "type": "array", "description": "The list of controller IDs for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.", "items": { "type": "object" } }, "description": { "type": "string", "description": "Description of the guest user." }, "disclaimer": { "type": "string", "description": "Text with a disclaimer for a guest." }, "endTime": { "type": "object", "description": "An expiry time for the limited guest user. If time is not specified the user is not limited." }, "locationGroupId": { "type": "object", "description": "ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA." }, "password": { "type": "string", "description": "Password of the guest user." }, "profile": { "type": "string", "description": "Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value \"ANY PROFILE\" the guest account will apply to all controllers.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true&\nlayer3WebPolicyAuthenticationEnabled=true&\nlayer3WebPolicyOnMacFailureEnabled=true&.or_filter=true" }, "rebootController": { "type": "boolean", "description": "Indicates that a controller will be rebooted after applying the guest user." }, "saveConfigToFlash": { "type": "boolean", "description": "Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots." }, "userRole": { "type": "string", "description": "Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value \"default\" the guest account will apply to all controllers.\n\nYou can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller." }, "username": { "type": "string", "description": "Name of the guest user." } } } } } } } }, "/webacs/api/v4/data/JobSummary": { "get": { "summary": "GET Job Summary\nGET data/JobSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "completionTime": { "type": "number", "description": "The time when the latest job run instance finishes" }, "description": { "type": "string", "description": "The job description." }, "duration": { "type": "number", "description": "The timespan of the latest run instance in seconds" }, "jobName": { "type": "string", "description": "The job name. The job name and job type should be unique." }, "jobStatus": { "type": "object", "description": "The job status\nAllowed values:\n\nSCHEDULED\nCOMPLETED\nSUSPENDED\nCANCELLED\nPENDINGAPPROVAL\nEXPIREDBEFOREAPPROVAL\nUNDEFINED" }, "jobType": { "type": "string", "description": "The job type" }, "lastStartTime": { "type": "number", "description": "The time when the latest job run instance starts" }, "nextRunTime": { "type": "number", "description": "The time when the next job run instance starts" }, "resultStatus": { "type": "object", "description": "The result of the latest job run instance\nAllowed values:\n\nUNKNOWN\nSUCCESS\nPARTIALSUCCESS\nFAILURE\nROLLBACKED\nCANCELFAILED\nCANCELLED\nPENDINGEXECUTION\nPAUSED\nPARTIALFAILURE" }, "runId": { "type": "number", "description": "The latest run instance id of the job" }, "runStatus": { "type": "object", "description": "The run status of the latest job run instance\nAllowed values:\n\nUNKNOWN\nCREATED\nRUNNING\nCOMPLETED\nABORTED\nINTERRUPTED\nCANCELLED\nPENDING_EXECUTION\nPAUSING\nPAUSED" }, "username": { "type": "string", "description": "Who creates the job. For system jobs the value is SYSTEM" } } } } } } } } }, "/webacs/api/v4/op/jobService/runhistory": { "get": { "summary": "GET Query Job Run History\nGET op/jobService/runhistory", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of a job" }, "jobId": { "type": "number", "description": "The id of a job to uniquely identify a job" }, "jobName": { "type": "string", "description": "The name of a job. Job name and job type together should be unique." }, "jobStatus": { "type": "object", "description": "The status of a job\nAllowed values:\n\nSCHEDULED\nCOMPLETED\nSUSPENDED\nCANCELLED\nPENDINGAPPROVAL\nEXPIREDBEFOREAPPROVAL\nUNDEFINED" }, "jobType": { "type": "string", "description": "The type of a job" }, "nextRunTime": { "type": "number", "description": "The time when the job will be trigger next time" }, "runInstances": { "type": "array", "description": "A list of run instances of the job", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "jobId", "in": "query", "required": false, "description": "A job id to uniquely identify a job", "schema": { "type": "string" } }, { "name": "jobType", "in": "query", "required": false, "description": "A job type", "schema": { "type": "string" } }, { "name": "jobName", "in": "query", "required": false, "description": "A job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs", "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": false, "description": "The time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/jobService/cancel": { "put": { "summary": "PUT Cancel A Job\nPUT op/jobService/cancel", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "failure": { "type": "array", "description": "A list of job ids that fail in the operation", "items": { "type": "object" } }, "message": { "type": "string", "description": "A system generated message" }, "operation": { "type": "string", "description": "The service name\nAllowed values:\n\nSUSPEND\nRESUME\nCANCEL\nCANCELRUNNING" }, "success": { "type": "array", "description": "A list of job ids that succeed in the operation", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "array", "description": "The id of a job on which the operation will be performed", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/jobService/cancelrunning": { "put": { "summary": "PUT Cancel A Job running instance\nPUT op/jobService/cancelrunning", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "failure": { "type": "array", "description": "A list of job ids that fail in the operation", "items": { "type": "object" } }, "message": { "type": "string", "description": "A system generated message" }, "operation": { "type": "string", "description": "The service name\nAllowed values:\n\nSUSPEND\nRESUME\nCANCEL\nCANCELRUNNING" }, "success": { "type": "array", "description": "A list of job ids that succeed in the operation", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "runId": { "type": "array", "description": "The id of a job run instance on which the operation will be performed", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/jobService/resume": { "put": { "summary": "PUT Resume A Job\nPUT op/jobService/resume", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "failure": { "type": "array", "description": "A list of job ids that fail in the operation", "items": { "type": "object" } }, "message": { "type": "string", "description": "A system generated message" }, "operation": { "type": "string", "description": "The service name\nAllowed values:\n\nSUSPEND\nRESUME\nCANCEL\nCANCELRUNNING" }, "success": { "type": "array", "description": "A list of job ids that succeed in the operation", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "array", "description": "The id of a job on which the operation will be performed", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/jobService/suspend": { "put": { "summary": "PUT Suspend A Job\nPUT op/jobService/suspend", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "failure": { "type": "array", "description": "A list of job ids that fail in the operation", "items": { "type": "object" } }, "message": { "type": "string", "description": "A system generated message" }, "operation": { "type": "string", "description": "The service name\nAllowed values:\n\nSUSPEND\nRESUME\nCANCEL\nCANCELRUNNING" }, "success": { "type": "array", "description": "A list of job ids that succeed in the operation", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "array", "description": "The id of a job on which the operation will be performed", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/data/MacFilterTemplates": { "get": { "summary": "GET MAC Filter Templates\nGET data/MacFilterTemplates", "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" }, "description": { "type": "string", "description": "The description of the MAC filter template." }, "deviceType": { "type": "string", "description": "The device type.\nAllowed values:\n\nCUWN\nCUWN_IOS_AND_UA" }, "interfaceName": { "type": "string", "description": "The name of the WLAN interface." }, "macAddress": { "type": "object", "description": "The MAC address." }, "path": { "type": "string", "description": "Full name of folder where the template is stored." }, "profileName": { "type": "string", "description": "The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true" }, "tags": { "type": "array", "description": "List of tags which are used for grouping templates.", "items": { "type": "object" } }, "templateName": { "type": "string", "description": "The name of the MAC filter template." } } } } } } } } }, "/webacs/api/v4/op/macFilter/macFilterTemplate": { "delete": { "summary": "DELETE Delete MAC Filter Template\nDELETE op/macFilter/macFilterTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "templateName": { "type": "string", "description": "RequiredThe name of the template to delete." } } } } } } } }, "post": { "summary": "POST Create MAC Filter Template\nPOST op/macFilter/macFilterTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the MAC filter template." }, "deviceType": { "type": "string", "description": "The device type.\nAllowed values:\n\nCUWN\nCUWN_IOS_AND_UA" }, "interfaceName": { "type": "string", "description": "The name of the WLAN interface." }, "macAddress": { "type": "object", "description": "The MAC address." }, "path": { "type": "string", "description": "Full name of folder where the template is stored." }, "profileName": { "type": "string", "description": "The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true" }, "templateName": { "type": "string", "description": "The name of the MAC filter template." } } } } } } } } }, "/webacs/api/v4/op/macFilter/deploy": { "put": { "summary": "PUT Update MAC Filter Template\nPUT op/macFilter/macFilterTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the MAC filter template." }, "interfaceName": { "type": "string", "description": "The name of the WLAN interface." }, "profileName": { "type": "string", "description": "The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.\n\nYou can use the following API for getting a list of profiles:\n/data/WlanProfiles?.full=true" }, "templateName": { "type": "string", "description": "The name of the MAC filter template." } } } } } } } } }, "/webacs/api/v4/op/info/coredumps": { "get": { "summary": "GET Core Dumps\nGET op/info/coredumps", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "coreDumpCount": { "type": "number", "description": "The number of core dumps present." } } } } } } } } }, "/webacs/api/v4/op/info/disk": { "get": { "summary": "GET Disk Usage and Capacity\nGET op/info/disk", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "availableCapacity": { "type": "number", "description": "Free/available capacity, in KB." }, "name": { "type": "string", "description": "The name of the volume." }, "usedCapacity": { "type": "number", "description": "Used capacity, in KB." }, "usedPercentage": { "type": "number", "description": "The percentage of the volume used, expressed in whole numbers where 100 is 100%." } } } } } } } } }, "/webacs/api/v4/op/info/license": { "get": { "summary": "GET Licenses\nGET op/info/license", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "daysToExpire": { "type": "number", "description": "The number of days until this license expires." }, "deviceCountRemaining": { "type": "number", "description": "The number of devices that may be added without exceeding the license." }, "deviceCountUsed": { "type": "number", "description": "The number of devices added under this license." }, "name": { "type": "string", "description": "The name of the feature for this license data." }, "status": { "type": "object", "description": "The licensing status of this feature.\nAllowed values:\n\nLICENSED\nNOT_LICENSED\nEXCEEDED" } } } } } } } } }, "/webacs/api/v4/op/info/uptime": { "get": { "summary": "GET Uptime\nGET op/info/uptime", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationUptime": { "type": "string", "description": "Uptime of this application." }, "defaultGateway": { "type": "string", "description": "The default gateway used by the server." }, "domainName": { "type": "string", "description": "The domain name of this server." }, "highAvailabilityEnabled": { "type": "boolean", "description": "Is high availability enabled on this server." }, "highAvailabilityPrimaryServerHostname": { "type": "string", "description": "The high availability primary server's hostname." }, "highAvailabilityPrimaryServerIp": { "type": "string", "description": "The high availability primary server's IP address." }, "highAvailabilityRole": { "type": "object", "description": "The role this server plays in the high availability group.\nAllowed values:\n\nUNKNOWN\nPRIMARY\nSECONDARY" }, "highAvailabilitySecondaryServerHostname": { "type": "string", "description": "The high availability secondary server's hostname." }, "highAvailabilitySecondaryServerIp": { "type": "string", "description": "The high availability secondary server's IP address." }, "highAvailabilityVirtualHostname": { "type": "string", "description": "High availability partners' virtual hostname" }, "highAvailabilityVirtualIp": { "type": "string", "description": "The high availabiliti partners' virtual IP address." }, "hostName": { "type": "string", "description": "The host name of this server." }, "serverTime": { "type": "number", "description": "Time as reported by the server." }, "serverUptime": { "type": "string", "description": "Uptime of the host server." }, "totalMemory": { "type": "number", "description": "The total amount of memory on the server in kilobytes." } } } } } } } } }, "/webacs/api/v4/op/info/version": { "get": { "summary": "GET Version\nGET op/info/version", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "The version number." } } } } } } } } }, "/webacs/api/v4/op/pnp/profile/{profileName}/instance/": { "delete": { "summary": "DELETE Delete All Profile Instances of a PnP Profile\nDELETE op/pnp/profile/{profileName}/instance/", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "string", "description": "This attribute contains error messages of the service" }, "status": { "type": "string", "description": "verall Status" } } } } } } }, "parameters": [ { "name": "profileName", "in": "path", "required": true, "description": "RequiredName of the profile in which the profile instance to be deleted", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pnp/profile/{pnpProfileFolder}/{profileName}": { "get": { "summary": "GET Read Pnp Profile\nGET op/pnp/profile/{pnpProfileFolder}/{profileName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "apicEmProfileOptions": { "type": "object", "description": "APIC Em profile options" }, "author": { "type": "string", "description": "Name of the user who created the profile" }, "bootStrapTemplateName": { "type": "string", "description": "Bootstrap template name of the profile" }, "configurationTemplateName": { "type": "string", "description": "Configuration template name" }, "credentialProfileName": { "type": "string", "description": "Credential Profile Name" }, "description": { "type": "string", "description": "Description of the pnp profile" }, "deviceType": { "type": "string", "description": "Device type" }, "imageLocation": { "type": "string", "description": "Location of the image" }, "imageName": { "type": "string", "description": "Image name" }, "nexusProfileDetails": { "type": "object", "description": "Nexus profile details" }, "postPnPTemplateName": { "type": "string", "description": "Post PNP Template name" }, "profileName": { "type": "string", "description": "Name of profile" }, "profileType": { "type": "string", "description": "Type of profile" } } } } } } }, "parameters": [ { "name": "pnpProfileFolder", "in": "path", "required": true, "description": "RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC", "schema": { "type": "string" } }, { "name": "profileName", "in": "path", "required": true, "description": "RequiredName of the profile for which details are got", "schema": { "type": "string" } } ] }, "post": { "summary": "POST Create Pnp Profile\nPOST op/pnp/profile/{pnpProfileFolder}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "apicEmProfileOptions": { "type": "object", "description": "Applicable only for APIC profiles" }, "bootStrapTemplateName": { "type": "string", "description": "field for Boot Strap Name; Either Bootstrap/Configuration/Image is mandatory" }, "configurationTemplateName": { "type": "string", "description": "Field for configuration Template name; Either Bootstrap/Configuration/Image is mandatory" }, "credentialProfileName": { "type": "string", "description": "Field for credential name; Optional" }, "description": { "type": "string", "description": "Description for the profile; Optional field" }, "deviceType": { "type": "string", "description": "Applicable only for CNS mode; Optional field" }, "imageLocation": { "type": "string", "description": "Field for image location" }, "imageName": { "type": "string", "description": "Field for Image Name;" }, "nexusProfileDetails": { "type": "object", "description": "Applicale only for Nexus POAP profiles" }, "postPnPTemplateName": { "type": "string", "description": "Field for postpnp template name; Optional field" }, "profileName": { "type": "string", "description": "field for pnp Profile Name; Mandatory field" } } } } } } }, "parameters": [ { "name": "pnpProfileFolder", "in": "path", "required": true, "description": "RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC", "schema": { "type": "string" } }, { "name": "profileName", "in": "path", "required": true, "description": "RequiredName of the profile for which details are got", "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE Delete Pnp Profile\nDELETE op/pnp/profile/{pnpProfileFolder}/{profileName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" } } } } } } }, "parameters": [ { "name": "pnpProfileFolder", "in": "path", "required": true, "description": "RequiredProfile Folder: Router/Switch/Wireless AP/Nexus POAP/Mobility Express WLC", "schema": { "type": "string" } }, { "name": "profileName", "in": "path", "required": true, "description": "Requiredprofile name of the profile to be deleted", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pnp/profile/{profileName}/instance/{instanceName}": { "delete": { "summary": "DELETE Delete Profile Instance of a PnP Profile\nDELETE op/pnp/profile/{profileName}/instance/{instanceName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "string", "description": "This attribute contains error messages of the service" }, "status": { "type": "string", "description": "verall Status" } } } } } } }, "parameters": [ { "name": "profileName", "in": "path", "required": true, "description": "RequiredName of the profile in which the profile instance to be deleted", "schema": { "type": "string" } }, { "name": "instanceName", "in": "path", "required": true, "description": "RequiredName of the profile instance to be deleted", "schema": { "type": "string" } } ] }, "get": { "summary": "GET Get Profile Instance of PnP Profile\nGET op/pnp/profile/{profileName}/instance/{instanceName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "profileInstances": { "type": "array", "description": "Profile Instances.", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "profileName", "in": "path", "required": true, "description": "RequiredThe profile name of the profile to be read", "schema": { "type": "string" } }, { "name": "instanceName", "in": "path", "required": true, "description": "RequiredThe profile instance name", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/rateService/rateLimits": { "get": { "summary": "GET Get Rate Limits\nGET op/rateService/rateLimits", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "limitPageSize": { "type": "number", "description": "This is the maximum size of a page that the user can request through .maxResults query parameter. Note that the value must be greater or equal to the limitUnpagedQuery attribute value." }, "limitUnpagedQuery": { "type": "number", "description": "This is the default size of a page returned when .maxResults query parameter is not specified. Note that the value must be lower or equal to the limitPageSize attribute value." }, "maxAllUserConcurrentQueries": { "type": "number", "description": "This is the number of concurrent requests allowed for all users. Use -1 to disable the limiting of all user concurrent requests." }, "maxConcurrentQueries": { "type": "number", "description": "This is the number of concurrent requests allowed for any given user." }, "perUserThreshold": { "type": "number", "description": "This is the number of requests for any given user that can be handled in windowsize ms. Use -1 to disable the limiting of per user requests." }, "totalRequestThreshold": { "type": "number", "description": "The number of total request that can be handled in windowsize ms. Use -1 to disable the limiting of total requests." }, "windowSegments": { "type": "number", "description": "This property is used internally to divide the window into segments. The number of segments determine the rate at which the window decrements the request counter. For example with 10 segments in a 1000 ms window, the count will be reduced every hundred ms, by the number of counts held in the oldest segment. (The count is increased immediately after receiving a new request).\nNote that windowSize/windowSegements must be a whole number." }, "windowSize": { "type": "number", "description": "Size of the sliding window used to count requests, in a milliseconds.\nNote that windowSize/windowSegements must be a whole number." } } } } } } } }, "put": { "summary": "PUT Update Rate Limits\nPUT op/rateService/rateLimits", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "limitPageSize": { "type": "number", "description": "This is the maximum size of a page that the user can request through .maxResults query parameter. Note that the value must be greater or equal to the limitUnpagedQuery attribute value." }, "limitUnpagedQuery": { "type": "number", "description": "This is the default size of a page returned when .maxResults query parameter is not specified. Note that the value must be lower or equal to the limitPageSize attribute value." }, "maxAllUserConcurrentQueries": { "type": "number", "description": "This is the number of concurrent requests allowed for all users. Use -1 to disable the limiting of all user concurrent requests." }, "maxConcurrentQueries": { "type": "number", "description": "This is the number of concurrent requests allowed for any given user." }, "perUserThreshold": { "type": "number", "description": "This is the number of requests for any given user that can be handled in windowsize ms. Use -1 to disable the limiting of per user requests." }, "totalRequestThreshold": { "type": "number", "description": "The number of total request that can be handled in windowsize ms. Use -1 to disable the limiting of total requests." }, "windowSegments": { "type": "number", "description": "This property is used internally to divide the window into segments. The number of segments determine the rate at which the window decrements the request counter. For example with 10 segments in a 1000 ms window, the count will be reduced every hundred ms, by the number of counts held in the oldest segment. (The count is increased immediately after receiving a new request).\nNote that windowSize/windowSegements must be a whole number." }, "windowSize": { "type": "number", "description": "Size of the sliding window used to count requests, in a milliseconds.\nNote that windowSize/windowSegements must be a whole number." } } } } } } } } }, "/webacs/api/v4/op/reportService/templates": { "get": { "summary": "GET Get Available Report Templates\nGET op/reportService/templates", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "reportTitle": { "type": "string", "description": "The title of the saved report template" }, "reportType": { "type": "string", "description": "This describes the type of the report represented by the report template. Examples include: Inventory, Device Health, Interface Summary, etc." }, "scheduled": { "type": "string", "description": "This field specifies if the saved report template's associated job schedule is Enabled, Disabled, or Expired." }, "virtualDomain": { "type": "string", "description": "The field specifies the associated virtual domain name of the saved report template." } } } } } } }, "parameters": [ { "name": "reportCategory", "in": "query", "required": false, "description": "An optional filter to specify the report category", "schema": { "type": "string" } }, { "name": "reportType", "in": "query", "required": false, "description": "An optional filter to specify the report type", "schema": { "type": "string" } }, { "name": "scheduled", "in": "query", "required": false, "description": "An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled", "schema": { "type": "string" } }, { "name": "virtualDomain", "in": "query", "required": false, "description": "An optional filter to specify the virtual domain name", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/reportService/getReport": { "get": { "summary": "GET Get a Report\nGET op/reportService/getReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childReports": { "type": "array", "description": "This is a collection of the nested child reports.", "items": { "type": "object" } }, "dataRows": { "type": "array", "description": "This is a collection representing the information obtained from the rows of a tabular report.", "items": { "type": "object" } }, "descriptorName": { "type": "string", "description": "The name of the report descriptor that defines the report template class of this report." }, "pageCount": { "type": "number", "description": "Total count of pages. Null for child reports." }, "pageIndex": { "type": "number", "description": "Page index of the current page. null for child reports." }, "reportDate": { "type": "string", "description": "The date and time when the report was generated." }, "reportName": { "type": "string", "description": "The name of the report." }, "reportTitle": { "type": "string", "description": "The name of the saved report template that was used to trigger this report." }, "reportUrl": { "type": "string", "description": "The URL that is used to retrieve the latest report generated for the specified reportTitle. It is useful to retrieve the report after an asynchronous run of report generation." } } } } } } }, "parameters": [ { "name": "reportTitle", "in": "query", "required": true, "description": "RequiredThe title of the saved report template that can be used to retrieve the latest report", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "required": false, "description": "The template's page number. The first page (when pageIndex equals zero) will be returned if page number is not specified.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/reportService/zipReport": { "get": { "summary": "GET Run a ZIP Report\nGET op/reportService/zipReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "reportTitle": { "type": "string", "description": "RequiredThe title of the report template to run." } } } } } } } } }, "/webacs/api/v4/op/update/platformInfo": {}, "/webacs/api/v4/op/update/retrieve": { "get": { "summary": "GET Information about updates\nGET op/update/retrieve", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ubfname": { "type": "string", "description": "The name of the UBF" }, "state": { "type": "string", "description": "The state of the update" } } } } } } } } }, "/webacs/api/v4/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}": { "get": { "summary": "GET All Border Routers\nGET op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all border routers from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all border routers to.", "schema": { "type": "number" } }, { "name": "siteName", "in": "path", "required": true, "description": "RequiredSpecifies the site name to get the all border routers for specified site.", "schema": { "type": "string" } }, { "name": "hierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the site name to get the all border routers for specified site hierarchy.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getAllIMEs/{srcSite}/{dstSite}/{startTime}/{endTime}": { "get": { "summary": "GET All IMEs\nGET op/pfrMonitoringExt/getAllIMEs/{srcSite}/{dstSite}/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all IMEs from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all IMEs to.", "schema": { "type": "number" } }, { "name": "srcSite", "in": "path", "required": true, "description": "RequiredSpecifies the source site to get the all IMEs.", "schema": { "type": "string" } }, { "name": "dstSite", "in": "path", "required": true, "description": "RequiredSpecifies the destination site to get the all IMEs.", "schema": { "type": "string" } }, { "name": "srcHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the source site hierarchy to get the all IMEs.", "schema": { "type": "string" } }, { "name": "destHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the destiantion site hierarchy to get the all IMEs.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getAllRCs/{srcSite}/{dstSite}/{startTime}/{endTime}": { "get": { "summary": "GET All RCs\nGET op/pfrMonitoringExt/getAllRCs/{srcSite}/{dstSite}/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all RCs from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all RCs to", "schema": { "type": "number" } }, { "name": "srcSite", "in": "path", "required": true, "description": "RequiredSpecifies the source site to get the all RCs .", "schema": { "type": "string" } }, { "name": "dstSite", "in": "path", "required": true, "description": "RequiredSpecifies the destination site to get the all RCs.", "schema": { "type": "string" } }, { "name": "srcHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the source site hierarchy to get the all RCs .", "schema": { "type": "string" } }, { "name": "destHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the destination site hierarchy to get the all RCs .", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime}": { "get": { "summary": "GET All TCAs\nGET op/pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all TCAs from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all TCAs to.", "schema": { "type": "number" } }, { "name": "srcSite", "in": "path", "required": true, "description": "RequiredSpecifies the source site to get the all TCAs .", "schema": { "type": "string" } }, { "name": "dstSite", "in": "path", "required": true, "description": "RequiredSpecifies the destination site to get the all TCAs .", "schema": { "type": "string" } }, { "name": "destHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the destination site hierarchy to get the all TCAs .", "schema": { "type": "string" } }, { "name": "srcHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the source site hierarchy to get the all TCAs .", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getAllWANInterfaces/{startTime}/{endTime}/{siteName}/{brIp}": { "get": { "summary": "GET All WANInterfaces\nGET op/pfrMonitoringExt/getAllWANInterfaces/{startTime}/{endTime}/{siteName}/{brIp}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all WAN interfaces from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the all WAN interfaces to.", "schema": { "type": "number" } }, { "name": "siteName", "in": "path", "required": true, "description": "RequiredSpecifies the site name to get the all WAN interfaces .", "schema": { "type": "string" } }, { "name": "brIp", "in": "path", "required": true, "description": "RequiredSpecifies the border router ip to get the all WAN interfaces .", "schema": { "type": "string" } }, { "name": "hierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the site hierarchy to get the all WAN interfaces .", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/applicationArtAnalysis": { "get": { "summary": "GET Application Art Analysis\nGET op/statisticsService/application/applicationArtAnalysis", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the time to start from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the time to check to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "The comma separated application IDs. Use to filter on a specific application or a list of applications. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "dataSourceId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "string" } }, { "name": "clientIp", "in": "query", "required": false, "description": "Values could be client or server. The default value is client", "schema": { "type": "string" } }, { "name": "networkAwareType", "in": "query", "required": false, "description": "Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/performance": { "get": { "summary": "GET Application Performance\nGET op/statisticsService/application/performance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application performance from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application performance to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "domainId", "in": "query", "required": false, "description": "Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/topNTraffics": { "get": { "summary": "GET Application Top N Traffics\nGET op/statisticsService/application/topNTraffics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the time to start from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the time to check to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "trafficDirection", "in": "query", "required": false, "description": "Traffic directions. The value could be All,In,Out. The default is All", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "string" } }, { "name": "dataSourceId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "deviceIp", "in": "query", "required": false, "description": "Device Ip address", "schema": { "type": "string" } }, { "name": "interfaceId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "interfaceIndex", "in": "query", "required": false, "description": "To filter by interfaceIndex, the deviceIp needs to be provided", "schema": { "type": "number" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "Values could be DESC/ASC, The default value is DESC", "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": false, "description": "The comma separated application IDs. Use to filter on a specific application or a list of applications. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": false, "description": "The default value is 15", "schema": { "type": "number" } }, { "name": "clientIp", "in": "query", "required": false, "description": "Client Ip address", "schema": { "type": "string" } }, { "name": "networkAwareType", "in": "query", "required": false, "description": "Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned", "schema": { "type": "string" } }, { "name": "dataType", "in": "query", "required": false, "description": "Values could be rate(bytes/second) or volume(bytes), The default value is volume", "schema": { "type": "string" } }, { "name": "nodeType", "in": "query", "required": false, "description": "Values could be client or server. The default value is client", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/topNApplicationsWithSites": { "get": { "summary": "GET Application Top N Volumes With Sites Statistics\nGET op/statisticsService/application/topNApplicationsWithSites", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application traffic from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application traffic to.", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "trafficDirection", "in": "query", "required": false, "description": "Traffic directions. The value could be All,In,Out. The default is All", "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "dataType", "in": "query", "required": false, "description": "Values could be rate(bytes/second) or volume(bytes), The default value is volume", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/trafficAnalysis": { "get": { "summary": "GET Application Traffic Analysis\nGET op/statisticsService/application/trafficAnalysis", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application traffic analysis from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application traffic analysis to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "type", "in": "query", "required": true, "description": "RequiredModify details of data returned. Set to 1 for simple details for dashlets, or 3 to include detailed statistics (mean/min/max/1st,2nd dev/etc.)", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "hostId", "in": "query", "required": false, "description": "Use to filter on a specific host. If not specified then statistics for all hosts will be returned.", "schema": { "type": "string" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/appVolume": { "get": { "summary": "GET Application Volume\nGET op/statisticsService/application/appVolume", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the time to start from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the time to check to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "trafficDirection", "in": "query", "required": false, "description": "Traffic directions. The value could be All, In, Out. The defaul is All", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "clientIp", "in": "query", "required": false, "description": "Client IP address", "schema": { "type": "string" } }, { "name": "deviceIp", "in": "query", "required": false, "description": "Device Ip address", "schema": { "type": "string" } }, { "name": "interfaceIndex", "in": "query", "required": false, "description": "To filter by interfaceIndex, the deviceIp needs to be provided", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": false, "description": "The default value is 15", "schema": { "type": "number" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "Values could be DESC/ASC, The default value is DESC", "schema": { "type": "string" } }, { "name": "networkAwareType", "in": "query", "required": false, "description": "Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned", "schema": { "type": "string" } }, { "name": "dataType", "in": "query", "required": false, "description": "Values could be rate(bytes/second) or volume(bytes), The default value is volume", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/numberOfUsers": { "get": { "summary": "GET Applications Number of Users\nGET op/statisticsService/application/numberOfUsers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application number of users from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application performance to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "hostId", "in": "query", "required": false, "description": "Use to filter on a specific host. If not specified then statistics for all hosts will be returned.", "schema": { "type": "string" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific CONNECTIONTYPE.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": false, "description": "Use to filter on a specifc USERID.", "schema": { "type": "string" } }, { "name": "macAddr", "in": "query", "required": false, "description": "Use to filter on a specifc MACADDR.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/cpuUtilSummary": { "get": { "summary": "GET CPU Utilization Summary\nGET op/statisticsService/device/cpuUtilSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "type", "in": "query", "required": false, "description": "An optional filter that specifies the response data format. Possible values: TABLE, PIECHART. By default, when not specified the response has pie chart type data.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "rangeString", "in": "query", "required": false, "description": "Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/cpuUtilTrend": { "get": { "summary": "GET CPU Utilization Trend\nGET op/statisticsService/device/cpuUtilTrend", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the device.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details).", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details).", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}": { "get": { "summary": "GET Client Distribution Data\nGET op/statisticsService/clients/distributions/{distribution}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "distribution", "in": "path", "required": true, "description": "RequiredThe distribution name for which the data need to be fetched.", "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": false, "description": "The device name or ip address to which the clients belong. Use all for all devices. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions. It cannot be used together with autoAp, site and siteType filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired.", "schema": { "type": "string" } }, { "name": "autoAp", "in": "query", "required": false, "description": "The autonomous AP name or ip address to which the clients belong. Use all for all autonomous APs. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions. It cannot be used together with device, site and siteType filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired.", "schema": { "type": "string" } }, { "name": "ssid", "in": "query", "required": false, "description": "The SSID to which the clients associate with. Use all for all SSIDs. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions.", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "The name of site to which the clients belong. Site examples : CampusA, CampusB/bldg1, CampusC/bldg2/floor2, CampusA/outdoorArea1, Unassigned. It is used for AP Client Counts, Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by SSID, Client Counts by Switch, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions. It cannot be used together with device and autoAp filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired.", "schema": { "type": "string" } }, { "name": "siteType", "in": "query", "required": false, "description": "The site type. Valid values : floor, outdoor, all. Default is all. It is used for AP Client Counts, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by SSID, Client Counts by Switch, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions.", "schema": { "type": "string" } }, { "name": "clientType", "in": "query", "required": false, "description": "The client type. Valid values : wireless, wired, all. Default is all. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Count Counts by Authentication Type distributions.", "schema": { "type": "string" } }, { "name": "clientState", "in": "query", "required": false, "description": "Client association and authentication state. Valid values : associated, authenticated, all. Default is all. It is used for Client Counts by Wireless/Wired distributions.", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "description": "Traffic direction. Valid values : upstream, downstream, all. Default is all. It is used for Client Traffic by Network distributions.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval nor the parameters startTime and endTime are provided. It is used for time series distributions.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the start time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the end time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions.", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "Specifies the sort order. Valid values : apName, mapLocation, or total for Client Counts by AP distribution; time for Client Counts by Posture Status, Client Counts by Wireless/Wired, Client Traffic by Network distributions; count for Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions; count, ssid for Client Counts by SSID distribution; count, name for Client Counts by Switch distribution.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/clients/distributions": { "get": { "summary": "GET Client Distribution Supported\nGET op/statisticsService/clients/distributions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/statisticsService/clusters": { "get": { "summary": "GET Cluster Details\nGET op/statisticsService/clusters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "children", "in": "query", "required": false, "description": "Parameter that needs to be set to true to fetch children of the Cluster. Children of a cluster are hypervisors that are part of it.", "schema": { "type": "boolean" } }, { "name": "Range", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "firstResult", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/clusters/metrics/{metric}": { "get": { "summary": "GET Cluster Metric Data\nGET op/statisticsService/clusters/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched", "schema": { "type": "string" } }, { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/clusters/metrics": { "get": { "summary": "GET Cluster Metrics Supported\nGET op/statisticsService/clusters/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}": { "get": { "summary": "GET DSCP App Usage\nGET op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the DSCP app usage from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the DSCP app usage to.", "schema": { "type": "number" } }, { "name": "srcSiteName", "in": "query", "required": false, "description": "PTIONAL Specifies the source site to get the DSCP app usage.", "schema": { "type": "string" } }, { "name": "dstSiteName", "in": "query", "required": false, "description": "PTIONAL Specifies the destination site to get the DSCP app usage.", "schema": { "type": "string" } }, { "name": "managedIpBR", "in": "query", "required": false, "description": "PTIONAL Specifies the managed ip to get the DSCP app usage.", "schema": { "type": "string" } }, { "name": "tunnelName", "in": "query", "required": false, "description": "PTIONAL Specifies the tunnel name to get the DSCP app usage.", "schema": { "type": "string" } }, { "name": "srcHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the source site hierarchy to get the DSCP app usage.", "schema": { "type": "string" } }, { "name": "destHierarchyPath", "in": "query", "required": false, "description": "PTIONAL Specifies the destination site hierarchy to get the DSCP app usage.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId}": { "get": { "summary": "GET DSCP App Usage For Live Topo\nGET op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the getDscpAppUsageForLiveTopo from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the getDscpAppUsageForLiveTopo to.", "schema": { "type": "number" } }, { "name": "srcSiteId", "in": "path", "required": true, "description": "RequiredSpecifies the source id to get the getDscpAppUsageForLiveTopo .", "schema": { "type": "number" } }, { "name": "dstSiteId", "in": "path", "required": true, "description": "RequiredSpecifies the destination id to get the getDscpAppUsageForLiveTopo .", "schema": { "type": "number" } }, { "name": "vrfIdList", "in": "query", "required": false, "description": "PTIONAL Specifies the Vrf id list to get the getDscpAppUsageForLiveTopo .", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getDSCPTimeVsUsageChart/{startTime}/{endTime}/{siteName}/{brIp}/{dscp}/{noOfPoints}": { "get": { "summary": "GET DSCP Time Vs Usage Chart\nGET op/pfrMonitoringExt/getDSCPTimeVsUsageChart/{startTime}/{endTime}/{siteName}/{brIp}/{dscp}/{noOfPoints}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "siteName", "in": "path", "required": true, "description": "RequiredsiteName", "schema": { "type": "string" } }, { "name": "brIp", "in": "path", "required": true, "description": "RequiredbrIp", "schema": { "type": "string" } }, { "name": "dscp", "in": "path", "required": true, "description": "Requireddscp", "schema": { "type": "number" } }, { "name": "noOfPoints", "in": "path", "required": true, "description": "RequirednoOfPoints", "schema": { "type": "number" } }, { "name": "interfaceName", "in": "query", "required": false, "description": "PTIONAL interfaceName", "schema": { "type": "string" } }, { "name": "hierarchyPath", "in": "query", "required": false, "description": "PTIONAL hierarchy path", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/datacenters": { "get": { "summary": "GET Datacenter Details\nGET op/statisticsService/datacenters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "children", "in": "query", "required": false, "description": "Parameter that needs to be set to true to fetch children of the Datacenter. Children of a Datacenter include clusters and hypervisors which are not part of any cluster", "schema": { "type": "boolean" } }, { "name": "firstResult", "in": "query", "required": false, "description": "PTIONAL: First result for pagination. Also look at maxResults", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "PTIONAL: maxResults for pagination. Also look at firstResult", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}": { "get": { "summary": "GET Datacenter Metric Data\nGET op/statisticsService/datacenters/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched", "schema": { "type": "string" } }, { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/datacenters/metrics": { "get": { "summary": "GET Datacenter Metrics Supported\nGET op/statisticsService/datacenters/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/device/availability": { "get": { "summary": "GET Device Availability\nGET op/statisticsService/device/availability", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the required device.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/device/availabilityMessage": { "get": { "summary": "GET Device Availability Message\nGET op/statisticsService/device/availabilityMessage", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the device.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/availabilitySummary": { "get": { "summary": "GET Device Availability Summary\nGET op/statisticsService/device/availabilitySummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "rangeString", "in": "query", "required": false, "description": "Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/downMessage": { "get": { "summary": "GET Device Down Message\nGET op/statisticsService/device/downMessage", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the device", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/healthInfo": { "get": { "summary": "GET Device Health Info\nGET op/statisticsService/device/healthInfo", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/devices/metrics/{metric}": { "get": { "summary": "GET Device Metric Data\nGET op/statisticsService/devices/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched.", "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": true, "description": "RequiredThe device IP or name for which the data need to be fetched.", "schema": { "type": "string" } }, { "name": "lineCard", "in": "query", "required": true, "description": "RequiredThe line card name for which the data need to be fetched. Required only for CPU Utilization metric.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the start time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the end time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/devices/metrics": { "get": { "summary": "GET Device Metrics Supported\nGET op/statisticsService/devices/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "device", "in": "query", "required": true, "description": "RequiredThe device IP or name for which the data need to be fetched.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the start time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the end time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/device/portSummary": { "get": { "summary": "GET Device Port Summary\nGET op/statisticsService/device/portSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the device.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "An filter parameter with possible values: SUMMARY (to return a summary of count of ports that are Up, Administratively down or Operationally down), or ALARMSEVERITY (to return the minimum Alarm severity of all the down ports). By default, if this parameter not provided, it returns the status summary of the ports.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/reachabilityStatus": { "get": { "summary": "GET Device Reachability Status\nGET op/statisticsService/device/reachabilityStatus", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "topN", "in": "query", "required": false, "description": "Indicates the number of devices to get. By default, when not specified returns all available results.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "A filter criteria that can take values such as ALL, REACHABLE, UNREACHABLE or PINGABLE.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/devices": { "get": { "summary": "GET Device Resource\nGET op/statisticsService/devices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "device", "in": "query", "required": false, "description": "PTIONAL: Natural key to identify the device. Could be Management Ip or DNS config name", "schema": { "type": "string" } }, { "name": "firstResult", "in": "query", "required": false, "description": "Defines the offset from the first result you want to fetch. Default is 0.", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "Defines maximum amount of hits to be returned. Default is 20.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/hosts": { "get": { "summary": "GET Host Details\nGET op/statisticsService/hosts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "children", "in": "query", "required": false, "description": "Parameter that needs to be set to true to fetch children of the Hypervisor. Children of a cluster are VMs that are part of it.", "schema": { "type": "boolean" } }, { "name": "Range", "in": "query", "required": false, "description": "Pagination range.", "schema": { "type": "string" } }, { "name": "firstResult", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/hosts/metrics/{metric}": { "get": { "summary": "GET Host Metric Data\nGET op/statisticsService/hosts/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched", "schema": { "type": "string" } }, { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/hosts/metrics": { "get": { "summary": "GET Host Metrics Supported\nGET op/statisticsService/hosts/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/availability": { "get": { "summary": "GET Interface Availability\nGET op/statisticsService/interface/availability", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the device availability from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the device availability to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to check the interface availability of.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to check availability of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/availMessage": { "get": { "summary": "GET Interface Availability Message\nGET op/statisticsService/interface/availMessage", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to check the interface available message of.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to get the available message of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/availabilitySummary": { "get": { "summary": "GET Interface Availability Summary\nGET op/statisticsService/interface/availabilitySummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the device availability summary from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the device availability summary to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "rangeString", "in": "query", "required": false, "description": "Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/details": { "get": { "summary": "GET Interface Details\nGET op/statisticsService/interface/details", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to check the interface details of.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to get details of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/discards": { "get": { "summary": "GET Interface Discards\nGET op/statisticsService/interface/discards", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface discards from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface discards to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to get the interface discards from.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to get discards of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/downMessage": { "get": { "summary": "GET Interface Down Message\nGET op/statisticsService/interface/downMessage", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to check the interface down message of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/errors": { "get": { "summary": "GET Interface Errors\nGET op/statisticsService/interface/errors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface errors from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface errors to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to get the interface errors from.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to get errors of.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interfaces/metrics/{metric}": { "get": { "summary": "GET Interface Metric Data\nGET op/statisticsService/interfaces/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched.", "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": true, "description": "RequiredThe IP address of the device to which the interface belongs.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredName of the interface for which the metric data need to be fetched.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the start time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the end time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } }, { "name": "isFullHierarchy", "in": "query", "required": false, "description": "Specifies full or short class hierarchy which is needed. Used in QOS Class Map and QOS Class Map Top Trend metrics. Default is false.", "schema": { "type": "boolean" } }, { "name": "direction", "in": "query", "required": false, "description": "Direction (1 - input, 2 - output). Used in QOS Class Map Top Trend metric. Default is 2.", "schema": { "type": "number" } }, { "name": "qosRateField", "in": "query", "required": false, "description": "e of dropPolicyToggle, prePolicyToggle, postPolicyToggle. Used in QOS Class Map Top Trend metric. Default is dropPolicyToggle.", "schema": { "type": "string" } }, { "name": "trafficDirection", "in": "query", "required": false, "description": "e of ALL, IN, OUT. Used in Top N Application and Top Application Traffic Overtime metrics. Default is ALL.", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "e of DESC, ASC. Used in Top N Application and Top Application Traffic Overtime metrics. Default is DESC.", "schema": { "type": "string" } }, { "name": "networkAwareType", "in": "query", "required": false, "description": "Network aware. Wireless: 1, Wired: 2, All: -1. Used in Top N Application and Top Application Traffic Overtime metrics. Default is -1.", "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": false, "description": "Comma separated application IDs. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all applications).", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Site ID. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all sites).", "schema": { "type": "string" } }, { "name": "dataType", "in": "query", "required": false, "description": "e of rate, volume. Used in Top N Application and Top Application Traffic Overtime metrics. Default is rate.", "schema": { "type": "string" } }, { "name": "dscp", "in": "query", "required": false, "description": "DSCP. Used in Top N Application metric.", "schema": { "type": "string" } }, { "name": "metricDataType", "in": "query", "required": false, "description": "e of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interfaces/metrics": { "get": { "summary": "GET Interface Metrics Supported\nGET op/statisticsService/interfaces/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "device", "in": "query", "required": true, "description": "RequiredThe IP address of the device to which the interface belongs.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredName of the interface for which the metric URLs need to be fetched.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": false, "description": "Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": false, "description": "Specifies the start time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "Specifies the end time in seconds. The timeInterval parameter overrides this parameter.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/interfaces": { "get": { "summary": "GET Interface Resource\nGET op/statisticsService/interfaces", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "device", "in": "query", "required": true, "description": "RequiredThe IP address or name of the device to which the interface belongs.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": false, "description": "The interface name whose details need to be fetched.", "schema": { "type": "string" } }, { "name": "firstResult", "in": "query", "required": false, "description": "Defines the offset from the first result you want to fetch. Default is 0.", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "Defines maximum amount of hits to be returned. Default is 20.", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "Comma-separated list of attribute names with their respective order.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/statusSummary": { "get": { "summary": "GET Interface Status Summary\nGET op/statisticsService/interface/statusSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface status summary from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface status summary to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "rangeString", "in": "query", "required": false, "description": "Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/utilSummary": { "get": { "summary": "GET Interface Utilization Summary\nGET op/statisticsService/interface/utilSummary", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "rangeString", "in": "query", "required": false, "description": "Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "utilType", "in": "query", "required": false, "description": "An optional parameter to filter based on the utilization type to get the Top N Interface utilization summary for. Possible Values: tx, rx. By default, when not specified, it defaults to a result that uses a combined average of tx and rx results.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/util": { "get": { "summary": "GET Interface Utilizations\nGET op/statisticsService/interface/util", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP address of the device to get the interface utilization from.", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "required": true, "description": "RequiredThe interface name to get utilization of.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "An optional parameter that specifies the requested utilization type. Possible values: percent, octets. By default, when not specified it return octets information.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/device-rest/DeviceLispMapSummary/{deviceIp}/{startTime}/{endTime}": { "get": { "summary": "GET Lisp Map Summary Trend\nGET op/device-rest/DeviceLispMapSummary/{deviceIp}/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "path", "required": true, "description": "RequiredSpecifies the deviceIp address to fetch the Lisp Map Cache size on the selected device.", "schema": { "type": "string" } }, { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the Lisp Map Cache size from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the end time in seconds to check the Lisp Map Cache size to.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/device/memoryUtilTrend": { "get": { "summary": "GET Memory Utilization Trend\nGET op/statisticsService/device/memoryUtilTrend", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "ipAddress", "in": "query", "required": true, "description": "RequiredThe IP Address of the device.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getOutStandingIMEsForSite/{startTime}/{endTime}/{srcSite}": { "get": { "summary": "GET OutStanding IMEs For Site\nGET op/pfrMonitoringExt/getOutStandingIMEsForSite/{startTime}/{endTime}/{srcSite}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "Requiredstarttime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "Requiredendtime in milliseconds", "schema": { "type": "number" } }, { "name": "srcSite", "in": "path", "required": true, "description": "Requiredsource site", "schema": { "type": "string" } }, { "name": "siteHierarchyPath", "in": "query", "required": false, "description": "PTIONAL siteHierarchy path", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}": { "get": { "summary": "GET Reachable UCI Devcies\nGET op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the UCI device reachable details from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the UCI device reachable details to.", "schema": { "type": "number" } }, { "name": "groupId", "in": "path", "required": true, "description": "RequiredSpecifies the group id to get the UCI device reachable details from specified group.", "schema": { "type": "string" } }, { "name": "maxrecords", "in": "path", "required": true, "description": "RequiredSpecifies the nubmer of records to fetch", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/refreshAppCache": {}, "/webacs/api/v4/op/statisticsService/resourceTypes": { "get": { "summary": "GET Resource Types Supported\nGET op/statisticsService/resourceTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "supportedResources": { "type": "array", "description": "List of supported resources", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/pfrMonitoringExt/getSiteAppHealth/{startTime}/{endTime}": { "get": { "summary": "GET Site App Health\nGET op/pfrMonitoringExt/getSiteAppHealth/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/system/health": { "get": { "summary": "GET System Health\nGET op/statisticsService/system/health", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the system health statistics from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the system health statistics to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": false, "description": "* REQUIRED Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/system/info": { "get": { "summary": "GET System Information\nGET op/statisticsService/system/info", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } } } }, "/webacs/api/v4/op/statisticsService/applications/appHealthCrossing": { "get": { "summary": "GET Threshold Violated Applications\nGET op/statisticsService/applications/appHealthCrossing", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": false, "description": "start time", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "end time", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": false, "description": "range", "schema": { "type": "number" } }, { "name": "siteId", "in": "query", "required": false, "description": "site id", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/topNHosts": { "get": { "summary": "GET Top N Application Hosts\nGET op/statisticsService/application/topNHosts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the top N hosts from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the top N hosts to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "domainId", "in": "query", "required": false, "description": "Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "trafficDir", "in": "query", "required": false, "description": "The direction of traffic to measure (All, In, Out). Defaults to All.", "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "required": false, "description": "A specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.", "schema": { "type": "string" } }, { "name": "interfaceName", "in": "query", "required": false, "description": "An interface name on the device given by ipAddress field.", "schema": { "type": "string" } }, { "name": "interfaceId", "in": "query", "required": false, "description": "A specific index of an interface . Required when pdsId=0 and interfaceName!=null.", "schema": { "type": "number" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "The sort order of the results (ASC/DESC). Defaults to DESC.", "schema": { "type": "string" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/applications/performance": { "get": { "summary": "GET Top N Applications\nGET op/statisticsService/applications/performance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "attribute", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application performance from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application performance to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "trafficDir", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "siteId", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "dscp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "hostId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "interfaceId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "interfaceIndex", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "userName", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "macAddr", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "nAwareValue", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "ssid", "in": "query", "required": false, "description": "Use to filter on a specifc SSID.", "schema": { "type": "string" } }, { "name": "domainId", "in": "query", "required": false, "description": "Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.", "schema": { "type": "string" } }, { "name": "dataType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "nodeType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "controllerId", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "apId", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "viewType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "siteMapId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "isFabric", "in": "query", "required": false, "description": "sFabric", "schema": { "type": "boolean" } } ] } }, "/webacs/api/v4/op/statisticsService/applications/overtime": { "get": { "summary": "GET Top N Applications Over Time\nGET op/statisticsService/applications/overtime", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application overtime from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the application overtime to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "trafficType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "interfaceName", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "interfaceIndex", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "rownum", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "hostId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "description": "RequiredSpecifies the siteId", "schema": { "type": "string" } }, { "name": "domainId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "dataType", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "isFabric", "in": "query", "required": true, "description": "RequiredSpecifies the isFabric", "schema": { "type": "boolean" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/topNClassMapQOS": { "get": { "summary": "GET Top N Class Map QOS\nGET op/statisticsService/interface/topNClassMapQOS", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of top interfaces to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "ifIndex", "in": "query", "required": true, "description": "RequiredThe ifIndex of the interface to be used in the query.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/topNCPU": { "get": { "summary": "GET Top N Device CPU Utilization\nGET op/statisticsService/device/topNCPU", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredIndicates the number of top devices to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/device-rest/TopNDeviceCache/ALL/{groupId}/{startTime}/{endTime}/{topn}": { "get": { "summary": "GET Top N Device Cache\nGET op/device-rest/TopNDeviceCache/ALL/{groupId}/{startTime}/{endTime}/{topn}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": true, "description": "RequiredSpecifies to filter the Lisp Map Cache size entries based on the Fabric Overlay groups. Default is 0.", "schema": { "type": "string" } }, { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the Lisp Map Cache size entries from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the end time in seconds to check the Lisp Map Cache size entries to.", "schema": { "type": "number" } }, { "name": "topn", "in": "path", "required": true, "description": "RequiredSpecifies to fetch the top n Lisp Map Cache size entries. Default is 10.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": true, "description": "Requiredspecifies Domain name. Default is root.", "schema": { "type": "string" } }, { "name": "dashlet", "in": "query", "required": true, "description": "RequiredSpecifies Dashlet id. Default is1.", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/device/topNMemory": { "get": { "summary": "GET Top N Device Memory Utilization\nGET op/statisticsService/device/topNMemory", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredIndicates the number of top devices to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/device/topNTemp": { "get": { "summary": "GET Top N Device Temperature\nGET op/statisticsService/device/topNTemp", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredRepresents the start time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredRepresents the end time of a time period in seconds. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredIndicates the number of top devices to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "description": "RequiredIndicates the temperature unit. Possible values: FH, C.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/topNErrors": { "get": { "summary": "GET Top N Interface Errors\nGET op/statisticsService/interface/topNErrors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of top interfaces to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "An optional type parameter to obtain the results as a special case for Top N WAN Interfaces, when provided the value: wantotal.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/topNUtil": { "get": { "summary": "GET Top N Interface Utilization\nGET op/statisticsService/interface/topNUtil", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of top interfaces to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } }, { "name": "utilType", "in": "query", "required": false, "description": "The utilization type to get the Top N Interface utilization summary for. Possible Values: tx, rx. By default, when not specified, it defaults to a result that uses a combined average of tx and rx results.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/topNWanIssues": { "get": { "summary": "GET Top N WAN Interface Issues\nGET op/statisticsService/interface/topNWanIssues", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of top WAN interfaces to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/interface/topNWanUtil": { "get": { "summary": "GET Top N WAN Interface Utilization\nGET op/statisticsService/interface/topNWanUtil", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the top N statistics. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of top WAN interfaces to get.", "schema": { "type": "number" } }, { "name": "source", "in": "query", "required": false, "description": "An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/{startTime}/{endTime}/{deviceIp}/{rownum}": { "get": { "summary": "GET TopNApplication Usage Over Time\nGET op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/{startTime}/{endTime}/{deviceIp}/{rownum}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "deviceIp", "in": "path", "required": true, "description": "RequireddeviceIps", "schema": { "type": "string" } }, { "name": "rownum", "in": "path", "required": true, "description": "Requiredrownum", "schema": { "type": "number" } }, { "name": "interfaceName", "in": "query", "required": false, "description": "PTIONAL interfaceName", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getTopNApplicationUsageOverTime/{startTime}/{endTime}/{deviceIp}/{rownum}": { "get": { "summary": "GET TopNApplication Usage Over Time PfR\nGET op/pfrMonitoringExt/getTopNApplicationUsageOverTime/{startTime}/{endTime}/{deviceIp}/{rownum}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "deviceIp", "in": "path", "required": true, "description": "PTIONAL deviceIp", "schema": { "type": "string" } }, { "name": "rownum", "in": "path", "required": true, "description": "PTIONAL rownum", "schema": { "type": "number" } }, { "name": "interfaceName", "in": "query", "required": false, "description": "PTIONAL intefraceName", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/applications/appCount": { "get": { "summary": "GET Total Application Count\nGET op/statisticsService/applications/appCount", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": false, "description": "", "schema": { "type": "number" } }, { "name": "siteId", "in": "query", "required": false, "description": "Site ID", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/device-rest/UnReachableUciDevice/{groupId}/{startTime}/{endTime}/{maxrecords}": { "get": { "summary": "GET Unreachable UCI Devcies\nGET op/device-rest/UnReachableUciDevice/{groupId}/{startTime}/{endTime}/{maxrecords}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the Unreachable UCI device details from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in seconds to check the Un reachable UCI device details to.", "schema": { "type": "number" } }, { "name": "maxrecords", "in": "path", "required": true, "description": "RequiredSpecifies the nubmer of records to fetch", "schema": { "type": "number" } }, { "name": "groupId", "in": "path", "required": true, "description": "RequiredSpecifies the group id to get the unreachable UCI device details from specified group.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/vms": { "get": { "summary": "GET VM Details\nGET op/statisticsService/vms", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resources": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "vm", "in": "query", "required": false, "description": "Pattern to match the VM name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "children", "in": "query", "required": false, "description": "Not Applicable for VMs", "schema": { "type": "boolean" } }, { "name": "Range", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "firstResult", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "maxResults", "in": "query", "required": false, "description": "TBD", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/vms/metrics/{metric}": { "get": { "summary": "GET VM Metric Data\nGET op/statisticsService/vms/metrics/{metric}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentDateTime": { "type": "string", "description": "Current timestamp" }, "description": { "type": "string", "description": "Metric description" }, "metricName": { "type": "string", "description": "Metric name" }, "metricRows": { "type": "array", "description": "Metric data list", "items": { "type": "object" } }, "resourceName": { "type": "string", "description": "Resource name" }, "xValueProperty": { "type": "object", "description": "Properties of X values" }, "yValueProperty": { "type": "array", "description": "Properties of Y values", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "RequiredThe metric name for which the data need to be fetched", "schema": { "type": "string" } }, { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "vm", "in": "query", "required": false, "description": "Pattern to match the VM name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/statisticsService/vms/metrics": { "get": { "summary": "GET VM Metrics Supported\nGET op/statisticsService/vms/metrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "string", "description": "Metrics info" }, "metrics": { "type": "array", "description": "Metric details list", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "datacenter", "in": "query", "required": false, "description": "Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.", "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "description": "Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "host", "in": "query", "required": false, "description": "Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "vm", "in": "query", "required": false, "description": "Pattern to match the VM name. If you do not specify any, all the Clusters are considered.", "schema": { "type": "string" } }, { "name": "timeInterval", "in": "query", "required": true, "description": "RequiredSpecifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeRateForLink/{startTime}/{endTime}/{brIpAddr}/{direction}": { "get": { "summary": "GET WAN Utilization Over TimeRate For Link\nGET op/pfrMonitoringExt/getWanUtilizationOverTimeRateForLink/{startTime}/{endTime}/{brIpAddr}/{direction}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the WanUtilizationOverTimeRateForLink from.", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredSpecifies the start time in milli seconds to get the WanUtilizationOverTimeRateForLink to", "schema": { "type": "number" } }, { "name": "brIpAddr", "in": "path", "required": true, "description": "RequiredSpecifies br ip address to get the WanUtilizationOverTimeRateForLink .", "schema": { "type": "string" } }, { "name": "direction", "in": "path", "required": true, "description": "RequiredSpecifies the direction to get the WanUtilizationOverTimeRateForLink .", "schema": { "type": "string" } }, { "name": "interfaceName", "in": "query", "required": true, "description": "RequiredSpecifies the interface name to get the WanUtilizationOverTimeRateForLink .", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/{startTime}/{endTime}/{brIpAddr}/{direction}": { "get": { "summary": "GET WanUtilization Over Time For Link\nGET op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/{startTime}/{endTime}/{brIpAddr}/{direction}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "brIpAddr", "in": "path", "required": true, "description": "RequiredbrIpAddr", "schema": { "type": "string" } }, { "name": "direction", "in": "path", "required": true, "description": "Requireddirection", "schema": { "type": "string" } }, { "name": "interfaceName", "in": "query", "required": true, "description": "RequiredinterfaceName", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/worstNHosts": { "get": { "summary": "GET Worst N Application Hosts\nGET op/statisticsService/application/worstNHosts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the worst N hosts from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the worst N hosts to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "domainId", "in": "query", "required": false, "description": "Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "attribute", "in": "query", "required": false, "description": "The attribute on which to measure worst N performing applications. Possible Values: transTime, svrRespTime, networkDelay.", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "required": false, "description": "The sort order of the results (ASC/DESC). Defaults to DESC for worst hosts first.", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": false, "description": "Use to filter on a specifc USERID.", "schema": { "type": "string" } }, { "name": "macAddr", "in": "query", "required": false, "description": "Use to filter on a specifc MACADDR.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/statisticsService/application/worstNSites": { "get": { "summary": "GET Worst N Application Locations\nGET op/statisticsService/application/worstNSites", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "childStatistics": { "type": "array", "description": "The set of nested StatisticsDTO objects.", "items": { "type": "object" } }, "statisticEntry": { "type": "array", "description": "The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.", "items": { "type": "object" } }, "statisticsName": { "type": "string", "description": "The Statistics operation type.\nAllowed values:\n\nDEVICE_TOPN_CPU_UTILIZATION\nDEVICE_TOPN_MEMORY_UTILIZATION\nDEVICE_TOPN_TEMPERATURE\nDEVICE_AVAILABILITY\nDEVICE_AVAILABILITY_SUMMARY\nDEVICE_CPU_UTILIZATION_TREND\nDEVICE_MEMORY_UTILIZATION_TREND\nDEVICE_HEALTH_INFO\nDEVICE_REACHABILITY_STATUS\nDEVICE_PORT_SUMMARY\nDEVICE_AVAILABILITY_MESSAGE\nDEVICE_DOWN_MESSAGE\nDEVICE_CPU_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY\nINTERFACE_DETAILS\nINTERFACE_OUT_ERRORS\nINTERFACE_DISCARDS\nINTERFACE_UTILIZATION\nINTERFACE_TOPN_UTILIZATION\nINTERFACE_TOPN_ERRORS\nINTERFACE_TOPN_WAN_UTILIZATION\nINTERFACE_UTILIZATION_SUMMARY\nINTERFACE_AVAILABILITY_SUMMARY\nINTERFACE_STATUS_SUMMARY\nINTERFACE_AVAILABILITY_MESSAGE\nINTERFACE_DOWN_MESSAGE\nINTERFACE_TOPN_WAN_ISSUES\nINTERFACE_CLASSMAP_QOS\nAPPLICATION_TOPN_WORST_HOSTS\nAPPLICATION_TOPN_WORST_SITES\nAPPLICATION_TOPN_HOSTS\nAPPLICATION_TOPN_APP_PERFORMANCE\nAPPLICATION_TOPN_TRAFFIC_ANALYSIS\nAPPLICATION_NUMBER_OF_USERS\nSYSTEM_INFO\nSYSTEM_HEALTH\nAPPLICATION_VOLUME\nAPPLICATION_ART_ANALYSIS\nAPPLICATION_TOPN_TRAFFICS\nAPPLICATION_TOPN_WITH_SITES" } } } } } } }, "parameters": [ { "name": "startTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the worst N sites from. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "endTime", "in": "query", "required": true, "description": "RequiredSpecifies the time to check the worst N sites to. (See 'range' for more details)", "schema": { "type": "number" } }, { "name": "range", "in": "query", "required": true, "description": "RequiredSpecifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.", "schema": { "type": "number" } }, { "name": "appId", "in": "query", "required": false, "description": "Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": false, "description": "Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.", "schema": { "type": "number" } }, { "name": "domainId", "in": "query", "required": false, "description": "Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.", "schema": { "type": "string" } }, { "name": "pdsId", "in": "query", "required": false, "description": "Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.", "schema": { "type": "string" } }, { "name": "attribute", "in": "query", "required": false, "description": "The attribute on which to measure worst N performing sites. Possible Values: transTime, svrRespTime, networkDelay.", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "required": true, "description": "RequiredThe number of results to return.", "schema": { "type": "number" } }, { "name": "nwAwareValue", "in": "query", "required": false, "description": "Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.", "schema": { "type": "string" } }, { "name": "ssidValue", "in": "query", "required": false, "description": "Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/{startTime}/{endTime}": { "post": { "summary": "POST DSCP vs All TCA\nPOST op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime}": { "post": { "summary": "POST DSCP vs UrTCA\nPOST op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/{startTime}/{endTime}": { "post": { "summary": "POST Max Delay Vs DSCP Chart Reports\nPOST op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "Requiredendtime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/{startTime}/{endTime}": { "post": { "summary": "POST Max Jitter Vs DSCP Chart Reports\nPOST op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/{startTime}/{endTime}": { "post": { "summary": "POST Max Packet Loss Vs DSCP Chart Reports\nPOST op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getPfrEventListViaPost/{startTime}/{endTime}": { "post": { "summary": "POST Pfr Event List\nPOST op/pfrMonitoringExt/getPfrEventListViaPost/{startTime}/{endTime}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}": { "post": { "summary": "POST Service Provider Usage Vs DSCP Chart\nPOST op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "dSCPs": { "type": "string", "description": "dscpList" }, "fromLGs": { "type": "string", "description": "" }, "lGRole": { "type": "string", "description": "cationGroupRole" }, "lGs": { "type": "string", "description": "cationGroupList" }, "pfREventMetricListDTO": { "type": "array", "description": "", "items": { "type": "object" } }, "pfREvents": { "type": "string", "description": "frEventList" }, "serviceProviders": { "type": "string", "description": "List of Service Provider" }, "toLGs": { "type": "string", "description": "LGList" }, "vrfs": { "type": "string", "description": "frVRFId" } } } } } } }, "parameters": [ { "name": "startTime", "in": "path", "required": true, "description": "RequiredstartTime in milliseconds", "schema": { "type": "number" } }, { "name": "endTime", "in": "path", "required": true, "description": "RequiredendTime in milliseconds", "schema": { "type": "number" } }, { "name": "topN", "in": "path", "required": true, "description": "RequiredtopN", "schema": { "type": "number" } } ] } }, "/webacs/api/v4/op/settings/servers/ftpServers/{serverName}": { "delete": { "summary": "DELETE WLAN FTP Server\nDELETE op/settings/servers/ftpServers/{serverName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "serverName": { "type": "string", "description": "" } } } } } } }, "parameters": [ { "name": "serverName", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/settings/notification/alarmCategories": { "get": { "summary": "GET Alarms notification settings\nGET op/settings/notification/alarmCategories", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmCategoriesSettings": { "type": "array", "description": "Array of notification settings per alarm category (at least one category is required)", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/settings/inventory/configArchiveBasic": { "get": { "summary": "GET Basic parameters for the configuration archive\nGET op/settings/inventory/configArchiveBasic", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventoryIntegration": { "type": "boolean", "description": "Do you want the application to archive configuration after Inventory Sync?" }, "inventoryTriggered": { "type": "boolean", "description": "Trigger inventory collection before config archive?" }, "maskAuthInfo": { "type": "boolean", "description": "Do you want to mask security content while exporting configuration to a file?" }, "noOfParallelThreads": { "type": "number", "description": "Thread pool count." }, "numberOfDays": { "type": "number", "description": "Maximum number of days for which configuration versions should be retained for each device. Turn off this property as well as \"Number of versions to retain\" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies." }, "numberOfVersions": { "type": "number", "description": "Maximum number of configuration versions to be retained for each device. Turn off this property as well as \"Number of days to retain\" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies." }, "outofboxArchiveIntegration": { "type": "boolean", "description": "Do you want the application to archive configuration out-of-box? Turn off this property to disable automatic configuration archive through all the flows. To control archive on inventory sync and change events etc, use individual settings by keeping this setting on. Turning on this setting alone means, archive on initial inventory will be enabled." }, "syslogHoldOffTimer": { "type": "number", "description": "Do you want the application to archive configuration after receiving configuration change events? Turn off (do not pass value) this property to stop processing configuration change events. The events that are already received and waiting for their hold off timer period, will still get processed immediately. Hold-off timer controls when the application should trigger archive, after the first indication of a configuration change event. Measurement unit is minute." }, "timeout": { "type": "number", "description": "Maximum time in milliseconds to wait while performing any configuration operation like fetch, archive and rollback." }, "viewUpdateTimeout": { "type": "number", "description": "Maximum time in minutes to wait before updating configuration archive summary data." } } } } } } } } }, "/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods": { "get": { "summary": "GET Configuration for Automatic Deletion Periods of Alarms\nGET op/settings/alarms/alarmDeletionPeriods", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "activeAndCleared": { "type": "number", "description": "Active and cleared alarms automatic deletion period (in days)" }, "allEvents": { "type": "number", "description": "All events automatic deletion period (in days)" }, "clearedNonSecurityAlarms": { "type": "number", "description": "Cleared non-security alarms automatic deletion period (in days)" }, "clearedSecurityAlarms": { "type": "number", "description": "Cleared security alarms automatic deletion period (in days)" } } } } } } } } }, "/webacs/api/v4/op/settings/logging/generalLoggingOptions": { "get": { "summary": "GET Current general logging options\nGET op/settings/logging/generalLoggingOptions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "logFileSettings": { "type": "object", "description": "Log files setting: maximum number of files, and maximun file size." }, "logMessageLevel": { "type": "string", "description": "Log message level: \"INFO\", \"ERROR\" or \"TRACE\".\nAllowed values:\n\nINFO\nERROR\nTRACE" }, "logModules": { "type": "array", "description": "An ordered list of log module names with attribute \"enabled\".", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/settings/data/pruneDataConfig/{tableName}": { "get": { "summary": "GET Data Pruning Configuration\nGET op/settings/data/pruneDataConfig/{tableName}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "age": { "type": "number", "description": "Specifies the maximum data retention period in hours for all records in the database." }, "ageAttribute": { "type": "string", "description": "Attribute used for age calculation." }, "maxRecords": { "type": "number", "description": "Specifies the maximum number of records to retain in a particular database table." }, "tableName": { "type": "string", "description": "Table name" } } } } } } }, "parameters": [ { "name": "tableName", "in": "path", "required": true, "description": "RequiredTable name", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}": { "get": { "summary": "GET Data Pruning Configuration for Category\nGET op/settings/data/pruneDataConfigsByGroup/{category}", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "pruneDataConfigs": { "type": "array", "description": "List of data pruning configurations.", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "category", "in": "path", "required": true, "description": "RequiredCategory name. Possible values are 'Optical Devices', 'Admin', 'Trend Data', 'RRM', 'Report', 'Statistics', 'Others'.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/settings/data/dataRetentionPeriods": { "get": { "summary": "GET Data Retention Periods\nGET op/settings/data/dataRetentionPeriods", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "auditRetainDaily": { "type": "number", "description": "Network Audit Data Retain Period" }, "deviceHealthRetainDaily": { "type": "number", "description": "Daily Device Health Data Retain Period" }, "deviceHealthRetainHourly": { "type": "number", "description": "Hourly Device Health Data Retain Period" }, "deviceHealthRetainWeekly": { "type": "number", "description": "Weekly Device Health Data Retain Period" }, "performanceRetainLong": { "type": "number", "description": "Short Term Performance Data Retain Period" }, "performanceRetainMedium": { "type": "number", "description": "Medium Term Performance Data Retain Period" }, "performanceRetainShort": { "type": "number", "description": "Short Term Performance Data Retain Period" }, "systemHealthRetainDaily": { "type": "number", "description": "Daily System Health Data Retain Period" }, "systemHealthRetainHourly": { "type": "number", "description": "Hourly System Health Data Retain Period" }, "systemHealthRetainWeekly": { "type": "number", "description": "Weekly System Health Data Retain Period" }, "trendRetainDaily": { "type": "number", "description": "Daily Aggregated Trend Data Retain Period" }, "trendRetainHourly": { "type": "number", "description": "Hourly Aggregated Trend Data Retain Period" }, "trendRetainWeekly": { "type": "number", "description": "Weekly Aggregated Trend Data Retain Period" } } } } } } } } }, "/webacs/api/v4/op/settings/servers/ftpServers": { "get": { "summary": "GET List of WLAN FTP Servers\nGET op/settings/servers/ftpServers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ipAddress": { "type": "string", "description": "IP address of the server." }, "name": { "type": "string", "description": "Name of the server." }, "serverType": { "type": "string", "description": "Type of the server.\nAllowed values:\n\nTFTP\nFTP\nALL\nSFTP" } } } } } } } } }, "/webacs/api/v4/op/settings/logging/logFileNames": { "get": { "summary": "GET Log file names\nGET op/settings/logging/logFileNames", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "description": "Logger category." }, "fileNames": { "type": "string", "description": "Names of files used by this logger category." } } } } } } } } }, "/webacs/api/v4/op/settings/notification/mailServer": { "get": { "summary": "GET Mail Server settings\nGET op/settings/notification/mailServer", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "applyToAlarms": { "type": "boolean", "description": "Indicates if this mail server settings should be applied to alarm categories (optional, default value will be \"false\")" }, "fromAddress": { "type": "string", "description": "Mail address that will be used to send mail notifications (required)" }, "globalSubject": { "type": "string", "description": "Subject that will be used in mail notifications (optional, default value will be empty string)" }, "primaryMailServerAddress": { "type": "string", "description": "Hostname/IP for Primary SMTP Server (required)" }, "primaryMailServerPassword": { "type": "string", "description": "Password for Primary SMTP Server (optional, default value will be empty string)" }, "primaryMailServerPort": { "type": "number", "description": "Port for Primary SMTP Server (required)" }, "primaryMailServerUserName": { "type": "string", "description": "Username for Primary SMTP Server (optional, default value will be empty string)" }, "secondaryMailServerAddress": { "type": "string", "description": "Hostname/IP for Secondary SMTP Server (optional, default value will be empty string)" }, "secondaryMailServerPassword": { "type": "string", "description": "Password for Secondary SMTP Server (optional, default value will be empty string)" }, "secondaryMailServerPort": { "type": "number", "description": "Port for Secondary SMTP Server (optional, default value will be 0)" }, "secondaryMailServerUserName": { "type": "string", "description": "Username for Secondary SMTP Server (optional, default value will be empty string)" }, "toAddress": { "type": "string", "description": "Comma separated list of mail notification recipients (required)" } } } } } } } } }, "/webacs/api/v4/op/settings/logging/snmpSettings": { "get": { "summary": "GET SNMP settings\nGET op/settings/logging/snmpSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "enableTrace": { "type": "boolean", "description": "Is traicing enabled." }, "logFileSettings": { "type": "object", "description": "The log file settings." }, "traceAllIps": { "type": "boolean", "description": "Are all ip addresses traced." }, "traceDisplayValues": { "type": "boolean", "description": "Is tracing display values." }, "tracedIPs": { "type": "string", "description": "The traced IP addresses." } } } } } } } } }, "/webacs/api/v4/op/settings/alarms/severityAutoClearConfig": { "get": { "summary": "GET Severity and Auto Clear Config\nGET op/settings/alarms/severityAutoClearConfig", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "description": "Nested subgroups.", "items": { "type": "object" } }, "items": { "type": "array", "description": "Configurations for alarms types.", "items": { "type": "object" } }, "name": { "type": "string", "description": "Name of group of alarms." } } } } } } } } }, "/webacs/api/v4/op/settings/logging/sysLogSettings": { "get": { "summary": "GET System log settings\nGET op/settings/logging/sysLogSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Is syslog enabled." }, "facility": { "type": "string", "description": "The log facility." }, "hostName": { "type": "string", "description": "The host name." } } } } } } } }, "post": { "summary": "POST Add WLAN FTP Server\nPOST op/settings/servers/ftpServers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ipAddress": { "type": "string", "description": "IP address of the server." }, "name": { "type": "string", "description": "Name of the server." }, "serverType": { "type": "string", "description": "Type of the server.\nAllowed values:\n\nTFTP\nFTP\nALL\nSFTP" } } } } } } } }, "put": { "summary": "PUT Update system log settings\nPUT op/settings/logging/sysLogSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Is syslog enabled." }, "facility": { "type": "string", "description": "The log facility." }, "hostName": { "type": "string", "description": "The host name." } } } } } } } } }, "/webacs/api/v4/data/UserDefinedFieldDefinition": { "get": { "summary": "GET User Defined Field Definition\nGET data/UserDefinedFieldDefinition", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the user defined field" }, "name": { "type": "string", "description": "The name of the user defined field. The name is case insensitive and should be unique" } } } } } } } } }, "/webacs/api/v4/op/udfService/deleteUserTagDefinition": { "put": { "summary": "PUT Delete User Defined Field Definition\nPUT op/udfService/deleteUserTagDefinition", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "description": "The name of the operation." }, "results": { "type": "array", "description": "List of operation results.", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "names": { "type": "array", "description": "Names of the User Defined Fields to delete.", "items": { "type": "string" } } } } } } } } }, "/webacs/api/v4/op/udfService/importUserTagDefinition": { "put": { "summary": "PUT Import User Defined Field Definition\nPUT op/udfService/importUserTagDefinition", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "description": "The name of the operation." }, "results": { "type": "array", "description": "List of operation results.", "items": { "type": "object" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "definitions": { "type": "array", "description": "A list of User Defined Field Definitions", "items": { "type": "object" } } } } } } } } }, "/webacs/api/v4/op/userManagement/users": { "delete": { "summary": "DELETE Delete user\nDELETE op/userManagement/users", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "RequiredThe name of the user to delete" } } } } } } } } }, "/webacs/api/v4/op/userManagement/userGroups": { "get": { "summary": "GET Get users\nGET op/userManagement/users", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Lock status of the user. True if the user is not locked" }, "name": { "type": "string", "description": "The name of the user" }, "userGroups": { "type": "string", "description": "Groups the user is a member of" }, "virtualDomains": { "type": "string", "description": "Virtual domains the user is a member of" }, "wirelessUser": { "type": "boolean", "description": "Indicates if the user is a wireless user. If 'true' then user will see only wireless specific navigation menu items.\nNot supported for root, Lobby Ambassador and mDNS Policy Admin users." } } } } } } } }, "post": { "summary": "POST Create user\nPOST op/userManagement/users", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the user." }, "password": { "type": "string", "description": "The password of the user." }, "userGroups": { "type": "string", "description": "Groups the user is a member of." }, "virtualDomains": { "type": "string", "description": "Virtual domains the user is a member of." }, "wirelessUser": { "type": "boolean", "description": "Indicates if the user is a wireless user. If 'true' then user will see only wireless specific navigation menu items.\nNot supported for root, Lobby Ambassador and mDNS Policy Admin users." } } } } } } } }, "put": { "summary": "PUT Update user\nPUT op/userManagement/users", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the user.\nNote that the name is used to identify the user to be edited and can not be changed." }, "password": { "type": "string", "description": "The password that will replace the current user password. Must be provided if you are changing the current password." }, "userGroups": { "type": "string", "description": "Groups the user is a member of" }, "virtualDomains": { "type": "string", "description": "Virtual domains the user is a member of" }, "wirelessUser": { "type": "boolean", "description": "Indicates if the user is a wireless user. If 'true' then user will see only wireless specific navigation menu items.\nNot supported for root, Lobby Ambassador and mDNS Policy Admin users." } } } } } } } } }, "/webacs/api/v4/op/nfv/getBridges": { "get": { "summary": "GET Get Bridges\nGET op/nfv/getBridges", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the bridge." }, "port": { "type": "array", "description": "List of ports assigned to the bridge", "items": { "type": "object" } }, "stp": { "type": "boolean", "description": "Enable / disable spanning tree protocol." } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/nfv/getDeployments": { "get": { "summary": "GET Get Deployments\nGET op/nfv/getDeployments", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service." }, "networks": { "type": "array", "description": "Networks DTO.", "items": { "type": "object" } }, "version": { "type": "string", "description": "Version of the service." }, "vmgroup": { "type": "array", "description": "VmGroup DTO.", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/nfv/deviceDetails": { "get": { "summary": "GET Get Device Details\nGET op/nfv/deviceDetails", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cimcIp": { "type": "string", "description": "" }, "compileTime": { "type": "string", "description": "" }, "cpu": { "type": "string", "description": "" }, "diskSize": { "type": "string", "description": "" }, "kernelVersion": { "type": "string", "description": "" }, "libVirVersion": { "type": "string", "description": "" }, "manufacturer": { "type": "string", "description": "" }, "memory": { "type": "string", "description": "" }, "ovsVersion": { "type": "string", "description": "" }, "pid": { "type": "string", "description": "" }, "portDetails": { "type": "array", "description": "", "items": { "type": "object" } }, "qemuVersion": { "type": "string", "description": "" }, "sn": { "type": "string", "description": "" }, "switchPorts": { "type": "number", "description": "" }, "uuid": { "type": "string", "description": "" }, "version": { "type": "string", "description": "" } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/nfv/getOvsBridges": { "get": { "summary": "GET Get OVS Bridges\nGET op/nfv/getOvsBridges", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminstate": { "type": "boolean", "description": "Specifies whether the admin state is up or down. Set to true for up and false for down. If down, the network does not forward packets." }, "akeyname": { "type": "string", "description": "Name of the network to be created. The name will be appended with the deployment id during actual creation during deployment to maintain uniqueness. These are given before vm_group so that ESC can create the network before actually deploying any VMs on the network in one pass." }, "bridge": { "type": "string", "description": "Attach this network to a bridge." }, "mirror": { "type": "boolean", "description": "Mirror traffic to this network from other network." }, "mirrorsrc": { "type": "string", "description": "Mirror traffic from a specific source." }, "providernetworktype": { "type": "string", "description": "Specifies the physical mechanism by which the virtual network is implemented." }, "providerphysicalnetwork": { "type": "string", "description": "Specifies the name of the physical network over which the virtual network is implemented." }, "providersegmentationid": { "type": "number", "description": "ID or tunnel ID of the underlying physical network." }, "routerexternal": { "type": "boolean", "description": "Indicates whether this netework is externally accessible." }, "shared": { "type": "boolean", "description": "Whether the network is shared among other tenants." }, "sriov": { "type": "string", "description": "Attach this network using SR-IOV." }, "subnet": { "type": "array", "description": "Subnet DTO.", "items": { "type": "object" } }, "trunk": { "type": "boolean", "description": "Set to trunk mode." }, "vlan": { "type": "array", "description": "The list of vLANs for this network.", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/nfv/getServices": { "get": { "summary": "GET Get Services\nGET op/nfv/getServices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "images": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "deviceIp", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/nfv/addBridge": { "post": { "summary": "POST Add Bridge\nPOST op/nfv/addBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "description": "Bridges DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/op/virtual/addDevice": { "post": { "summary": "POST Add Device\nPOST op/virtual/addDevice", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ip": { "type": "string", "description": "The IP address." }, "password": { "type": "string", "description": "The password." }, "port": { "type": "integer", "description": "The port number." }, "protocol": { "type": "string", "description": "The device protocol." }, "username": { "type": "string", "description": "The username." } } } } } } } }, "/webacs/api/v4/op/nfv/createOvsBridge": { "post": { "summary": "POST Create OVS Bridge\nPOST op/nfv/createOvsBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "networks": { "type": "array", "description": "Networks DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/op/nfv/deleteBridge": { "post": { "summary": "POST Delete Bridge\nPOST op/nfv/deleteBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "description": "Bridges DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/op/nfv/deleteOvsBridge": { "post": { "summary": "POST Delete OVS Bridge\nPOST op/nfv/deleteOvsBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "networks": { "type": "array", "description": "Networks DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/op/nfv/deploy": { "post": { "summary": "POST Deploy Service\nPOST op/nfv/deploy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configuration": { "type": "array", "description": "Configuration DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "The server DTO." }, "serviceType": { "type": "string", "description": "e.g. Thirdparty, CSR, ASAv, vWLC, vNAM" }, "servicedefinition": { "type": "object", "description": "ServiceDefinition DTO." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } } }, "/webacs/api/v4/op/nfv/register": { "post": { "summary": "POST Register Service\nPOST op/nfv/register", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "server": { "type": "object", "description": "The NfVOS server." }, "servicedefinition": { "type": "object", "description": "List of services." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } } }, "/webacs/api/v4/op/nfv/undeploy": { "post": { "summary": "POST Un-Deploy Service\nPOST op/nfv/undeploy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configuration": { "type": "array", "description": "Configuration DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "The server DTO." }, "serviceType": { "type": "string", "description": "e.g. Thirdparty, CSR, ASAv, vWLC, vNAM" }, "servicedefinition": { "type": "object", "description": "ServiceDefinition DTO." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } } }, "/webacs/api/v4/op/nfv/unregister": { "post": { "summary": "POST Un-Register Service\nPOST op/nfv/unregister", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "server": { "type": "object", "description": "The NfVOS server." }, "servicedefinition": { "type": "object", "description": "List of services." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } } }, "/webacs/api/v4/op/nfv/updateBridge": { "put": { "summary": "PUT Update Bridge\nPUT op/nfv/updateBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "description": "Bridges DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/op/nfv/updateOvsBridge": { "put": { "summary": "PUT Update OVS Bridge\nPUT op/nfv/updateOvsBridge", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentStage": { "type": "string", "description": "" }, "eventTime": { "type": "string", "description": "" }, "payload": { "type": "string", "description": "" }, "statusCode": { "type": "number", "description": "The response status code." }, "statusMessage": { "type": "string", "description": "The response message." }, "transactionId": { "type": "string", "description": "The unique transaction id." } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "networks": { "type": "array", "description": "Networks DTO.", "items": { "type": "object" } }, "server": { "type": "object", "description": "Server DTO." }, "transactionId": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/data/VDAssociatedAccessPoints": { "get": { "summary": "GET Access Points associated with current Virtual Domain\nGET data/VDAssociatedAccessPoints", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "controllerIp": { "type": "string", "description": "Registered Controller IP Address" }, "ipAddress": { "type": "string", "description": "AP IP Address" }, "macAddress": { "type": "string", "description": "Base Radio MAC address" }, "mneId": { "type": "number", "description": "The network element ID" }, "model": { "type": "string", "description": "AP Model" }, "name": { "type": "string", "description": "AP Name" } } } } } } } } }, "/webacs/api/v4/data/VDAssociatedDynamicGroups": { "get": { "summary": "GET Dynamic Groups associated with current Virtual Domain\nGET data/VDAssociatedDynamicGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "hierarchyName": { "type": "string", "description": "Group hierarchical name" }, "name": { "type": "string", "description": "Group name" } } } } } } } } }, "/webacs/api/v4/data/VDAssociatedGroups": { "get": { "summary": "GET Groups associated with current Virtual Domain\nGET data/VDAssociatedGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "hierarchyName": { "type": "string", "description": "Dynamic Group hierarchical name" }, "name": { "type": "string", "description": "Dynamic Group name" } } } } } } } } }, "/webacs/api/v4/data/VDAssociatedDevices": { "get": { "summary": "GET Network Devices associated with current Virtual Domain\nGET data/VDAssociatedDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ipAddress": { "type": "string", "description": "The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available" }, "name": { "type": "string", "description": "Device name" }, "type": { "type": "string", "description": "The type of the device" } } } } } } } } }, "/webacs/api/v4/data/VDAssociatedSiteMaps": { "get": { "summary": "GET Site Maps associated with current Virtual Domain\nGET data/VDAssociatedSiteMaps", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "hierarchyName": { "type": "string", "description": "Site Map hierarchical name" }, "name": { "type": "string", "description": "Site Map name" }, "parentId": { "type": "number", "description": "Site Map parent Id" }, "type": { "type": "number", "description": "Site Map Type: 1 Campus, 2 Building, 4 Floor Area, 5 Outdoor Area" } } } } } } } } }, "/webacs/api/v4/data/VDAssociatedVirtualElements": { "get": { "summary": "GET Virtual Elements associated with current Virtual Domain\nGET data/VDAssociatedVirtualElements", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "clusterId": { "type": "number", "description": "Id of the cluster this Virtual Element belongs to" }, "clusterName": { "type": "string", "description": "Name of the cluster this Virtual Element belongs to" }, "datacenterId": { "type": "number", "description": "Id of the datacenter this Virtual Element belongs to" }, "datacenterName": { "type": "string", "description": "Name of the datacenter this Virtual Element belongs to" }, "discoverySource": { "type": "string", "description": "Virtual Element discovery source" }, "ipAddress": { "type": "string", "description": "Virtual Element IP address" }, "name": { "type": "string", "description": "Virtual Element name" }, "parentId": { "type": "number", "description": "Id of the parent Virtual Element" }, "type": { "type": "string", "description": "Virtual Element type (Datacenter, Cluster, Host)" } } } } } } } } }, "/webacs/api/v4/op/vd": { "delete": { "summary": "DELETE Delete Virtual Domain\nDELETE op/vd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "warning": { "type": "string", "description": "An error message in case if any error occurred" } } } } } } }, "parameters": [ { "name": "domainFQN", "in": "query", "required": true, "description": "RequiredFully qualified name of the virtual domain to be deleted", "schema": { "type": "string" } } ] }, "get": { "summary": "GET List Virtual Domains\nGET op/vd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the virtual domain" }, "domainFQN": { "type": "string", "description": "Fully qualified name of the virtual domain" }, "email": { "type": "string", "description": "Email address for sending alarms notifications" }, "name": { "type": "string", "description": "Name of the virtual domain" }, "timezone": { "type": "string", "description": "Time zone of the virtual domain" } } } } } } }, "parameters": [ { "name": "parentDomainName", "in": "query", "required": false, "description": "An optional parameter that can be used to specify fully qualified name of the parent domain", "schema": { "type": "string" } } ] }, "post": { "summary": "POST Create Virtual Domain\nPOST op/vd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "warning": { "type": "string", "description": "An error message in case if any error occurred" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accessPoints": { "type": "array", "description": "IDs of access points associated with the virtual domain. Optional.", "items": { "type": "object" } }, "description": { "type": "string", "description": "Description of the virtual domain. Optional." }, "devices": { "type": "array", "description": "IDs of devices associated with the virtual domain. Optional.", "items": { "type": "object" } }, "domainFQN": { "type": "string", "description": "Fully qualified name of the virtual domain" }, "dynamicGroups": { "type": "array", "description": "FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.", "items": { "type": "string" } }, "email": { "type": "string", "description": "Email address for sending alarms notifications. Optional." }, "groups": { "type": "array", "description": "FQNs of groups associated with the virtual domain. Optional.", "items": { "type": "string" } }, "siteMaps": { "type": "array", "description": "IDs of site maps associated with the virtual domain. Optional.", "items": { "type": "object" } }, "timezone": { "type": "string", "description": "Time zone of the virtual domain. Optional." }, "virtualElements": { "type": "array", "description": "IDs of virtual elements associated with the virtual domain. Optional.", "items": { "type": "object" } } } } } } } }, "put": { "summary": "PUT Update Virtual Domain\nPUT op/vd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "accessPointsAdded": { "type": "number", "description": "IDs of access points to be associated with the virtual domain. Optional." }, "accessPointsRemoved": { "type": "number", "description": "IDs of access points to be removed from the virtual domain. Optional." }, "description": { "type": "string", "description": "Description of the virtual domain. Optional." }, "devicesAdded": { "type": "number", "description": "IDs of devices to be associated with the virtual domain. Optional." }, "devicesRemoved": { "type": "number", "description": "IDs of devices to be removed from the virtual domain. Optional." }, "domainName": { "type": "string", "description": "Name of the virtual domain." }, "dynamicGroupsAdded": { "type": "string", "description": "FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional." }, "dynamicGroupsRemoved": { "type": "string", "description": "FQNs of groups that have to be removed from the virtual domain. Devices assigned to these groups will be removed from the virtual domain as well. Optional." }, "email": { "type": "string", "description": "Email address for sending alarms notifications. Optional." }, "groupsAdded": { "type": "string", "description": "FQNs of groups to be associated with the virtual domain. Optional." }, "groupsRemoved": { "type": "string", "description": "FQNs of groups to be removed from the virtual domain. Optional." }, "siteMapsAdded": { "type": "number", "description": "IDs of site maps to be associated with the virtual domain. Optional." }, "siteMapsRemoved": { "type": "number", "description": "IDs of site maps to be removed from the virtual domain. Optional." }, "timezone": { "type": "string", "description": "Time zone of the virtual domain. Optional." }, "virtualElementsAdded": { "type": "number", "description": "IDs of virtual elements to be associated with the virtual domain. Optional." }, "virtualElementsRemoved": { "type": "number", "description": "IDs of virtual elements to be removed with the virtual domain. Optional." } } } } } } }, "parameters": [ { "name": "domainFQN", "in": "query", "required": true, "description": "RequiredFully qualified name of the virtual domain to be edited", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/image/id": { "delete": { "summary": "DELETE Delete Image by id\nDELETE op/image/id", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "idNum": { "type": "string", "description": "" } } } } } } } } }, "/webacs/api/v4/op/image/list/id": { "get": { "summary": "GET List Image by id\nGET op/image/list/id", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "idNum", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/image/list": { "get": { "summary": "GET List Images\nGET op/image/list", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/image/list/family": { "get": { "summary": "GET List Images by family\nGET op/image/list/family", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "familyName", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/image/list/physical": { "get": { "summary": "GET List Physical Images\nGET op/image/list/physical", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/image/list/virtual": { "get": { "summary": "GET List Virtual Images\nGET op/image/list/virtual", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "", "items": { "type": "object" } } } } } } } } } }, "/webacs/api/v4/op/image/add": { "post": { "summary": "POST Add Image\nPOST op/image/add", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationType": { "type": "string", "description": "The type of application, e.g. router" }, "family": { "type": "string", "description": "The product family of this image e.g. vNAM" }, "imageType": { "type": "string", "description": "he type of image file, e.g. OVA" }, "imageURL": { "type": "string", "description": "http or ftp url for uploading the image file" }, "minDisk": { "type": "string", "description": "Minimum amount of disk space for intances of this image" }, "minMemory": { "type": "string", "description": "Minimum amount of memory for instances of this image" }, "minProcessors": { "type": "string", "description": "Minimum number of processors for instances of this image" }, "version": { "type": "string", "description": "The version number of this image file" } } } } } } } }, "/webacs/api/v4/op/image/deployConfigure": { "post": { "summary": "POST Deploy Configuration\nPOST op/image/deployConfigure", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobName": { "type": "string", "description": "" }, "jobScheduleStatus": { "type": "string", "description": "" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deployConfigs": { "type": "array", "description": "", "items": { "type": "object" } }, "imageConfigType": { "type": "string", "description": "" }, "imageFileName": { "type": "string", "description": "" }, "imageId": { "type": "string", "description": "" }, "powerOn": { "type": "boolean", "description": "" }, "server": { "type": "string", "description": "" }, "vmDeviceType": { "type": "string", "description": "" } } } } } } } }, "/webacs/api/v4/data/WlanProfiles": { "get": { "summary": "GET Wlan Profiles\nGET data/WlanProfiles", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "aaaAllowOverride": { "type": "boolean", "description": "Is allow AAA override enabled?" }, "aaaLdapPrimaryServer": { "type": "string", "description": "Primary LDAP server." }, "aaaLdapSecondaryServer": { "type": "string", "description": "Secondary LDAP server." }, "aaaLdapTertiaryServer": { "type": "string", "description": "Tertiary LDAP server." }, "aaaLocalEapAuthenticationEnabled": { "type": "boolean", "description": "Is local EAP authentication enabled?" }, "aaaLocalEapAuthenticationProfileName": { "type": "string", "description": "When aaaLocalEapAuthenticationEnabled is true, this defines the EAP profile that will be used." }, "aaaRadiusAccountingPrimaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the primary RADIUS accounting server." }, "aaaRadiusAccountingSecondaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the secondary RADIUS accounting server." }, "aaaRadiusAccountingServersEnabled": { "type": "boolean", "description": "Is RADIUS accounting enabled?" }, "aaaRadiusAccountingTertiaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the tertiary RADIUS accounting server." }, "aaaRadiusAuthenticationPrimaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the primary RADIUS authentication server." }, "aaaRadiusAuthenticationSecondaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the secondary RADIUS authentication server." }, "aaaRadiusAuthenticationServersEnabled": { "type": "boolean", "description": "Is RADIUS authentication enabled?" }, "aaaRadiusAuthenticationTertiaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the tertiary RADIUS authentication server." }, "aaaRadiusInterimUpdateEnabled": { "type": "boolean", "description": "Is RADIUS server accounting interim update enabled?" }, "aaaRadiusInterimUpdateInterval": { "type": "number", "description": "When aaaRadiusInterimUpdateEnabled is true, this determines the update interval. Measured in seconds." }, "adminStatus": { "type": "boolean", "description": "Is the WLAN administratively enabled?" }, "advancedAironetIeEnabled": { "type": "boolean", "description": "Is Aironet Information Elements (IEs) enabled for this WLAN?" }, "advancedClientExclusionEnabled": { "type": "boolean", "description": "Is automatic client exclusion enabled for this WLAN?" }, "advancedClientExclusionTimeout": { "type": "number", "description": "When advancedClientExclusionEnabled is true, this denotes the length of the timeout. A value of zero represents an infinite timeout. Measured in seconds." }, "advancedCoverageHoleDetectionEnabled": { "type": "boolean", "description": "Is Coverage Hole Detection enabled for this WLAN?" }, "advancedDhcpAddressAssignmentRequired": { "type": "boolean", "description": "Are all clients required to obtain an IP address from the DHCP server for this WLAN?" }, "advancedDhcpProfilingEnabled": { "type": "boolean", "description": "Should the wireless controller collect the DHCP attributes of clients on this WLAN?" }, "advancedDhcpServerIpAddress": { "type": "object", "description": "If this contains a valid address, an IPv4 DHCP server has been specified for this WLAN." }, "advancedDiagnosticChannelEnabled": { "type": "boolean", "description": "Is the diagnostic channel available for this WLAN?" }, "advancedDot11anDtimPeriod": { "type": "number", "description": "Denotes the Delivery Traffic Indication Map (DTIM) interval for 802.11a/n radios, during which broadcast and multicast frames will be transmitted. A value of one results in a broadcast after every beacon, two for every other beacon, and so on." }, "advancedDot11bgnDtimPeriod": { "type": "number", "description": "Denotes the Delivery Traffic Indication Map (DTIM) interval for 802.11b/g/n radios, during which broadcast and multicast frames will be transmitted. A value of one results in a broadcast after every beacon, two for every other beacon, and so on." }, "advancedFlexConnectCentralDhcpProcessingEnabled": { "type": "boolean", "description": "Are DHCP packets received by the access point sent to the controller then forwarded to the WLAN's corresponding VLAN?" }, "advancedFlexConnectLearnClientIpEnabled": { "type": "boolean", "description": "Is client IP address learning enabled?" }, "advancedFlexConnectLocalAuthEnabled": { "type": "boolean", "description": "Is local authentication enabled?" }, "advancedFlexConnectLocalSwitchingEnabled": { "type": "boolean", "description": "When true, access points will locally switch traffic, rather than forwarding to the wireless controller." }, "advancedFlexConnectNatPatEnabled": { "type": "boolean", "description": "Is Network Address Translation (NAT) and Port Address Translation (PAT) enabled?" }, "advancedFlexConnectOverrideDnsEnabled": { "type": "boolean", "description": "When true, clients are given the DNS server of the access point rather than of the WLAN's configured interface." }, "advancedFlexConnectReapCentralAssociation": { "type": "boolean", "description": "Is Reap Central Association enabled?" }, "advancedFlexConnectVlanCentralSwitchingEnabled": { "type": "boolean", "description": "Is VLAN based central switching enabled?" }, "advancedHttpProfilingEnabled": { "type": "boolean", "description": "Should the wireless controller collect the HTTP attributes of clients on this WLAN?" }, "advancedIpv6Enabled": { "type": "boolean", "description": "Is IPv6 enabled?" }, "advancedKtsCacEnabled": { "type": "boolean", "description": "Is CAC based on the Key Telephone System (KTS) enabled on this WLAN?" }, "advancedLoadBalancingBandSelectEnabled": { "type": "boolean", "description": "Is client band select enabled?" }, "advancedLoadBalancingEnabled": { "type": "boolean", "description": "Is client load balancing enabled?" }, "advancedMaximumClients": { "type": "number", "description": "Denotes the maximum number of clients. A value of zero means unlimited." }, "advancedMdnsProfileName": { "type": "string", "description": "When advancedMdnsSnoopingEnabled is true, this denotes the mDNS profile. Clients receive service advertisements only for the services associated with the profile." }, "advancedMdnsSnoopingEnabled": { "type": "boolean", "description": "Is mDNS snooping enabled?" }, "advancedMediaSessionSnoopingEnabled": { "type": "boolean", "description": "Should the access point snoop on Session Initiation Protocol (SIP) traffic, and report back to the controller the establishment termination and failure of voice calls?" }, "advancedMfpClientProtection": { "type": "string", "description": "Denotes whether client management frame protection (MFP) is enabled (optional), required, or disabled for this WLAN.\nAllowed values:\n\nDISABLED\nENABLED\nREQUIRED" }, "advancedMfpSignatureGenerationEnabled": { "type": "boolean", "description": "Do 802.11 management frames transmitted by the access point have a signature to verify authenticity?" }, "advancedMfpVersion": { "type": "number", "description": "Denotes the version of management frame protection (MFP)." }, "advancedOverrideInterfaceAclName": { "type": "string", "description": "Denotes an IPv4 ACL that overrides the ACL configured for the WLAN's interface." }, "advancedOverrideInterfaceIpv6AclName": { "type": "string", "description": "Denotes an IPv6 ACL that overrides the ACL configured for the WLAN's interface." }, "advancedPassiveClientEnabled": { "type": "boolean", "description": "Should the controller forward ARP requests out to the WLAN for passive clients?" }, "advancedPeerToPeerBlocking": { "type": "string", "description": "Denotes whether peer-to-peer blocking is disabled, enabled, or if the packets are forwarded to the next device.\nAllowed values:\n\nDISABLE\nDROP\nFORWARDUP" }, "advancedPmipMobilityType": { "type": "string", "description": "Denotes the Proxy Mobile IP (PMIP) type for this WLAN.\nAllowed values:\n\nNONE\nPMIP" }, "advancedPmipProfile": { "type": "string", "description": "Denotes the Proxy Mobile IP (PMIP) profile for this WLAN." }, "advancedPmipRealm": { "type": "string", "description": "Denotes the default realm of the Proxy Mobile IPv6 (PMIPv6) WLAN." }, "advancedScanDeferPriority0": { "type": "boolean", "description": "Is priority 0 for the channel scan enabled?" }, "advancedScanDeferPriority1": { "type": "boolean", "description": "Is priority 1 for the channel scan enabled?" }, "advancedScanDeferPriority2": { "type": "boolean", "description": "Is priority 2 for the channel scan enabled?" }, "advancedScanDeferPriority3": { "type": "boolean", "description": "Is priority 3 for the channel scan enabled?" }, "advancedScanDeferPriority4": { "type": "boolean", "description": "Is priority 4 for the channel scan enabled?" }, "advancedScanDeferPriority5": { "type": "boolean", "description": "Is priority 5 for the channel scan enabled?" }, "advancedScanDeferPriority6": { "type": "boolean", "description": "Is priority 6 for the channel scan enabled?" }, "advancedScanDeferPriority7": { "type": "boolean", "description": "Is priority 7 for the channel scan enabled?" }, "advancedScanDeferTime": { "type": "number", "description": "Denotes the channel scan defer time. Measured in milliseconds." }, "advancedSessionTimeout": { "type": "number", "description": "Denotes the maximum time for a client session before requiring reauthentication. Zero means no timeout. Measured in seconds." }, "advancedWifiDirectClientsPolicy": { "type": "string", "description": "Denotes the Wi-Fi Direct Clients Policy for this WLAN.\nAllowed values:\n\nDISABLED\nALLOWED\nNOTALLOWED\nXCONNECTNOTALLOW" }, "broadcastSsidEnabled": { "type": "boolean", "description": "Is SSID broadcasting enabled?" }, "ckipKeyIndex": { "type": "number", "description": "When ckipSecurityEnabled is true, this denotes the key index." }, "ckipKeyPermutationEnabled": { "type": "boolean", "description": "When ckipSecurityEnabled is true, this denotes whether key permutation is enabled." }, "ckipKeySize": { "type": "string", "description": "When ckipSecurityEnabled is true, this denotes the key size.\nAllowed values:\n\nNONE\nLEN40\nLEN104" }, "ckipMmhModeEnabled": { "type": "boolean", "description": "When ckipSecurityEnabled is true, this denotes whether multimodular mode hashing is enabled." }, "ckipSecurityEnabled": { "type": "boolean", "description": "Is CKIP layer 2 security enabled?" }, "controllerId": { "type": "number", "description": "The ID of the controller this WLAN is present on." }, "hotspot2Enable": { "type": "object", "description": "This attribute represents enablement of HotSpot 2.0." }, "hotspot2Operators": { "type": "array", "description": "These attributes represent HotSpot 2.0 operators.", "items": { "type": "object" } }, "hotspot2Ports": { "type": "array", "description": "These attributes represent HotSpot 2.0 port configurations.", "items": { "type": "object" } }, "hotspot2Wan": { "type": "object", "description": "These attributes represent HotSpot 2.0 operators." }, "hotspotCellularNetworks": { "type": "array", "description": "These attributes represent 802.11u cellular network parameters.", "items": { "type": "object" } }, "hotspotDomains": { "type": "array", "description": "These attributes represent 802.11u domains.", "items": { "type": "object" } }, "hotspotGeneral": { "type": "object", "description": "These attributes represent 802.11u general parameters." }, "hotspotOuiConfigs": { "type": "array", "description": "These attributes represent 802.11u OUIs.", "items": { "type": "object" } }, "hotspotRealms": { "type": "array", "description": "These attributes represent 802.11u realms.", "items": { "type": "object" } }, "hotspotServiceAdvertisement": { "type": "object", "description": "These attributes represent MSAP (Mobility Service Advertisement Protocol) parameters." }, "interfaceName": { "type": "string", "description": "Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group." }, "interfaceType": { "type": "number", "description": "Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group.\nAllowed values:\n\nINTERFACE\nINTERFACEGROUP" }, "ipAddress": { "type": "string", "description": "Management IP address of the WLAN controller." }, "isWiredLan": { "type": "boolean", "description": "Is this a wired LAN?" }, "lanType": { "type": "string", "description": "Denotes the LAN type.\nAllowed values:\n\nWIRELESS\nGUEST\nREMOTE" }, "layer2FastTransitionEnabled": { "type": "boolean", "description": "Is fast transition (FT) between access points enabled?" }, "layer2FastTransitionOverDsEnabled": { "type": "boolean", "description": "When layer2FastTransitionEnabled is true, the denotes whether fast transition over a distributed system is enabled." }, "layer2FastTransitionReassociationTimeout": { "type": "number", "description": "When layer2FastTransitionEnabled is true, this denotes the transition timeout. Measured in seconds." }, "layer2MacFilteringEnabled": { "type": "boolean", "description": "Is MAC filtering enabled?" }, "layer3GlobalWebAuthEnabled": { "type": "boolean", "description": "When a layer 3 web policy is true, this denotes whether the template uses global or template-defined Web Auth configuration." }, "layer3PreauthenticationAcl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the IPv4 ACL for traffic between the client and the wireless controller." }, "layer3PreauthenticationIpv6Acl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the IPv6 ACL for traffic between the client and the wireless controller." }, "layer3VpnPassthroughEnabled": { "type": "boolean", "description": "Is VPN passthrough enabled?" }, "layer3WebAuthFlexAcl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the the FlexConnect ACL for external web authentication in locally switched WLANs." }, "layer3WebAuthType": { "type": "string", "description": "When a layer 3 web policy is true and layer3GlobalWebAuth is false, this denotes the type of web authentication to be used.\nAllowed values:\n\nDEFAULT\nCUSTOMIZED\nEXTERNAL" }, "layer3WebPolicyAuthenticationEnabled": { "type": "boolean", "description": "Is the authentication web policy enabled?" }, "layer3WebPolicyConditionalRedirectEnabled": { "type": "boolean", "description": "Is the conditional redirect web policy enabled?" }, "layer3WebPolicyOnMacFailureEnabled": { "type": "boolean", "description": "Is the WebAuth on MAC failure web policy enabled?" }, "layer3WebPolicyPassthroughEnabled": { "type": "boolean", "description": "Is the passthrough web policy enabled?" }, "multicastVlanEnabled": { "type": "boolean", "description": "Is a multicast VLAN enabled?" }, "multicastVlanInterface": { "type": "string", "description": "When multicastVlanInterface is true, this denotes the multicast VLAN." }, "profileName": { "type": "string", "description": "Profile name of the WLAN." }, "qos7920Cac": { "type": "string", "description": "Denotes the Call Admission Control (CAC) configuration for Cisco 7920 phones.\nAllowed values:\n\nDISABLED\nCLIENTCAC\nAPCAC\nCLIENTANDAPCAC" }, "qosAvcProfileName": { "type": "string", "description": "Denotes the Application Visibility and Control (AVC) profile for this WLAN." }, "qosNbarVisibilityEnabled": { "type": "boolean", "description": "Is Network Based Application Recognition (NBAR) deep packet inspection enabled on this WLAN?" }, "qosNetflowMonitor": { "type": "string", "description": "Denotes the Netflow monitor configured for this WLAN." }, "qosPerSSidBurstRealTimeUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageRealTimeDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageRealTimeUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstRealTimeDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageRealTimeDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageRealTimeUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstRealTimeDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstRealTimeUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosProfile": { "type": "string", "description": "Denotes the QoS level for the WLAN.\nAllowed values:\n\nBRONZE\nSILVER\nGOLD\nPLATINUM" }, "qosWmmPolicy": { "type": "string", "description": "Denotes the state of the Wi-fi Multimedia (WMM) policy for this WLAN.\nAllowed values:\n\nDISABLED\nALLOWED\nREQUIRED" }, "radioPolicy": { "type": "string", "description": "Denotes the WLAN radio policy.\nAllowed values:\n\nALL\nONLY80211A\nONLY80211B\nONLY80211G\nONLY80211BG\nONLY80211AG\nONLY80211AB\nNONE\nREMOTELAN" }, "ssid": { "type": "string", "description": "SSID of the WLAN." }, "vpnPassThroughGatewayAddress": { "type": "object", "description": "When layer3VpnPassthroughEnabled is true, this denotes the IP address of the VPN gateway." }, "webAuthExternalUrl": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"External\", this denotes the URL of the authentication server." }, "webAuthLoginFailurePage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for authentication failures." }, "webAuthLoginPage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for authentication." }, "webAuthLogoutPage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for logout." }, "webPassthruEmailInputEnabled": { "type": "boolean", "description": "When layer3WebPolicyPassthroughEnabled is true, this denotes whether the client is prompted to enter an email address when connecting." }, "wepAllowSharedKeyAuthentication": { "type": "boolean", "description": "When wepSecurityEnabled is true, this denotes whether shared key authentication is enabled." }, "wepKeyIndex": { "type": "number", "description": "When wepSecurityEnabled is true, this denotes the key index." }, "wepKeySize": { "type": "string", "description": "When wepSecurityEnabled is true, this denotes whether shared key authentication is enabled.\nAllowed values:\n\nWEP104\nNONE\nWEP40\nWEP128\nAESOCB128\nWEP_40\nWEP_104" }, "wepSecurityEnabled": { "type": "boolean", "description": "Is WEP layer 2 security enabled?" }, "wlanId": { "type": "number", "description": "The WLAN ID for this WLAN." }, "wpa2Enabled": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether the WPA2 policy is enabled." }, "wpa2EncryptionProtocolAes": { "type": "boolean", "description": "When wpaSecurityEnabled and wpa2Enabled are true, this denotes whether AES encryption is supported for the WPA2 policy." }, "wpa2EncryptionProtocolTkip": { "type": "boolean", "description": "When wpaSecurityEnabled and wpa2Enabled are true, this denotes whether TKIP encryption is supported for the WPA2 policy." }, "wpaAuthenticationKeyManagement8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementCckm": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Cisco Centralized Key Management (CCKM) is enabled." }, "wpaAuthenticationKeyManagementFt8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Fast Transition (FT) 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementFtPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Fast Transition (FT) preshared key management is enabled." }, "wpaAuthenticationKeyManagementPmf8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Protected Management Frame (PMF) 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementPmfPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Protected Management Frame (PMF) preshared key management is enabled." }, "wpaAuthenticationKeyManagementPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether preshared key management is enabled." }, "wpaEnabled": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether the WPA1 policy is enabled." }, "wpaEncryptionProtocolAes": { "type": "boolean", "description": "When wpaSecurityEnabled and wpaEnabled are both true, this denotes whether AES encryption is supported for the WPA1 policy." }, "wpaEncryptionProtocolTkip": { "type": "boolean", "description": "When wpaSecurityEnabled and wpaEnabled are both true, this denotes whether TKIP encryption is supported for the WPA1 policy." }, "wpaPresharedKey": { "type": "string", "description": "When wpaSecurityEnabled is true, this contains preshared key in HEX or ASCII format." }, "wpaPresharedKeyFormat": { "type": "string", "description": "When wpaSecurityEnabled is true, this denotes preshared key format.\nAllowed values:\n\nDEFAULT\nHEX\nASCII" }, "wpaSecurityEnabled": { "type": "boolean", "description": "Is WPA layer 2 security enabled?" }, "x8021KeySize": { "type": "string", "description": "When x8021SecurityEnabled is true, this denotes the 802.1X key size.\nAllowed values:\n\nWEP104\nWEP40\nWEP128\nNONE\nWEP_40\nWEP_104" }, "x8021SecurityEnabled": { "type": "boolean", "description": "Is 802.1X layer 2 security enabled?" } } } } } } } } }, "/webacs/api/v4/data/WlanTemplates": { "get": { "summary": "GET Wlan Templates\nGET data/WlanTemplates", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "aaaAllowOverride": { "type": "boolean", "description": "Is allow AAA override enabled?" }, "aaaLdapPrimaryServer": { "type": "string", "description": "Primary LDAP server." }, "aaaLdapSecondaryServer": { "type": "string", "description": "Secondary LDAP server." }, "aaaLdapTertiaryServer": { "type": "string", "description": "Tertiary LDAP server." }, "aaaLocalEapAuthenticationEnabled": { "type": "boolean", "description": "Is local EAP authentication enabled?" }, "aaaLocalEapAuthenticationProfileName": { "type": "string", "description": "When aaaLocalEapAuthenticationEnabled is true, this defines the EAP profile that will be used." }, "aaaRadiusAccountingPrimaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the primary RADIUS accounting server." }, "aaaRadiusAccountingSecondaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the secondary RADIUS accounting server." }, "aaaRadiusAccountingServersEnabled": { "type": "boolean", "description": "Is RADIUS accounting enabled?" }, "aaaRadiusAccountingTertiaryServer": { "type": "string", "description": "When aaaRadiusAccountingServersEnabled is true, this is the tertiary RADIUS accounting server." }, "aaaRadiusAccountingWlcSpecificEnabled": { "type": "boolean", "description": "Is controller specific RADIUS accounting servers enabled?" }, "aaaRadiusAuthenticationPrimaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the primary RADIUS authentication server." }, "aaaRadiusAuthenticationSecondaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the secondary RADIUS authentication server." }, "aaaRadiusAuthenticationServersEnabled": { "type": "boolean", "description": "Is RADIUS authentication enabled?" }, "aaaRadiusAuthenticationTertiaryServer": { "type": "string", "description": "When aaaRadiusAuthenticationServersEnabled is true, this is the tertiary RADIUS authentication server." }, "aaaRadiusAuthenticationWlcSpecificEnabled": { "type": "boolean", "description": "Is controller specific RADIUS authentication servers enabled?" }, "aaaRadiusInterimUpdateEnabled": { "type": "boolean", "description": "Is RADIUS server accounting interim update enabled?" }, "aaaRadiusInterimUpdateInterval": { "type": "number", "description": "When aaaRadiusInterimUpdateEnabled is true, this determines the update interval. Measured in seconds." }, "adminStatus": { "type": "boolean", "description": "Is the WLAN administratively enabled?" }, "advancedAironetIeEnabled": { "type": "boolean", "description": "Is Aironet Information Elements (IEs) enabled for this WLAN?" }, "advancedClientExclusionEnabled": { "type": "boolean", "description": "Is automatic client exclusion enabled for this WLAN?" }, "advancedClientExclusionTimeout": { "type": "number", "description": "When advancedClientExclusionEnabled is true, this denotes the length of the timeout. A value of zero represents an infinite timeout. Measured in seconds." }, "advancedCoverageHoleDetectionEnabled": { "type": "boolean", "description": "Is Coverage Hole Detection enabled for this WLAN?" }, "advancedDhcpAddressAssignmentRequired": { "type": "boolean", "description": "Are all clients required to obtain an IP address from the DHCP server for this WLAN?" }, "advancedDhcpProfilingEnabled": { "type": "boolean", "description": "Should the wireless controller collect the DHCP attributes of clients on this WLAN?" }, "advancedDhcpServerIpAddress": { "type": "object", "description": "If this contains a valid address, an IPv4 DHCP server has been specified for this WLAN." }, "advancedDiagnosticChannelEnabled": { "type": "boolean", "description": "Is the diagnostic channel available for this WLAN?" }, "advancedDot11anDtimPeriod": { "type": "number", "description": "Denotes the Delivery Traffic Indication Map (DTIM) interval for 802.11a/n radios, during which broadcast and multicast frames will be transmitted. A value of one results in a broadcast after every beacon, two for every other beacon, and so on." }, "advancedDot11bgnDtimPeriod": { "type": "number", "description": "Denotes the Delivery Traffic Indication Map (DTIM) interval for 802.11b/g/n radios, during which broadcast and multicast frames will be transmitted. A value of one results in a broadcast after every beacon, two for every other beacon, and so on." }, "advancedFlexConnectCentralDhcpProcessingEnabled": { "type": "boolean", "description": "Are DHCP packets received by the access point sent to the controller then forwarded to the WLAN's corresponding VLAN?" }, "advancedFlexConnectLearnClientIpEnabled": { "type": "boolean", "description": "Is client IP address learning enabled?" }, "advancedFlexConnectLocalAuthEnabled": { "type": "boolean", "description": "Is local authentication enabled?" }, "advancedFlexConnectLocalSwitchingEnabled": { "type": "boolean", "description": "When true, access points will locally switch traffic, rather than forwarding to the wireless controller." }, "advancedFlexConnectNatPatEnabled": { "type": "boolean", "description": "Is Network Address Translation (NAT) and Port Address Translation (PAT) enabled?" }, "advancedFlexConnectOverrideDnsEnabled": { "type": "boolean", "description": "When true, clients are given the DNS server of the access point rather than of the WLAN's configured interface." }, "advancedFlexConnectReapCentralAssociation": { "type": "boolean", "description": "Is Reap Central Association enabled?" }, "advancedFlexConnectVlanCentralSwitchingEnabled": { "type": "boolean", "description": "Is VLAN based central switching enabled?" }, "advancedHttpProfilingEnabled": { "type": "boolean", "description": "Should the wireless controller collect the HTTP attributes of clients on this WLAN?" }, "advancedIpv6Enabled": { "type": "boolean", "description": "Is IPv6 enabled?" }, "advancedKtsCacEnabled": { "type": "boolean", "description": "Is CAC based on the Key Telephone System (KTS) enabled on this WLAN?" }, "advancedLoadBalancingBandSelectEnabled": { "type": "boolean", "description": "Is client band select enabled?" }, "advancedLoadBalancingEnabled": { "type": "boolean", "description": "Is client load balancing enabled?" }, "advancedMaximumClients": { "type": "number", "description": "Denotes the maximum number of clients. A value of zero means unlimited." }, "advancedMdnsProfileName": { "type": "string", "description": "When advancedMdnsSnoopingEnabled is true, this denotes the mDNS profile. Clients receive service advertisements only for the services associated with the profile." }, "advancedMdnsSnoopingEnabled": { "type": "boolean", "description": "Is mDNS snooping enabled?" }, "advancedMediaSessionSnoopingEnabled": { "type": "boolean", "description": "Should the access point snoop on Session Initiation Protocol (SIP) traffic, and report back to the controller the establishment termination and failure of voice calls?" }, "advancedMfpClientProtection": { "type": "string", "description": "Denotes whether client management frame protection (MFP) is enabled (optional), required, or disabled for this WLAN.\nAllowed values:\n\nDISABLED\nENABLED\nREQUIRED" }, "advancedMfpSignatureGenerationEnabled": { "type": "boolean", "description": "Do 802.11 management frames transmitted by the access point have a signature to verify authenticity?" }, "advancedMfpVersion": { "type": "number", "description": "Denotes the version of management frame protection (MFP)." }, "advancedOverrideInterfaceAclName": { "type": "string", "description": "Denotes an IPv4 ACL that overrides the ACL configured for the WLAN's interface." }, "advancedOverrideInterfaceIpv6AclName": { "type": "string", "description": "Denotes an IPv6 ACL that overrides the ACL configured for the WLAN's interface." }, "advancedPassiveClientEnabled": { "type": "boolean", "description": "Should the controller forward ARP requests out to the WLAN for passive clients?" }, "advancedPeerToPeerBlocking": { "type": "string", "description": "Denotes whether peer-to-peer blocking is disabled, enabled, or if the packets are forwarded to the next device.\nAllowed values:\n\nDISABLE\nDROP\nFORWARDUP" }, "advancedPmipMobilityType": { "type": "string", "description": "Denotes the Proxy Mobile IP (PMIP) type for this WLAN.\nAllowed values:\n\nNONE\nPMIP" }, "advancedPmipProfile": { "type": "string", "description": "Denotes the Proxy Mobile IP (PMIP) profile for this WLAN." }, "advancedPmipRealm": { "type": "string", "description": "Denotes the default realm of the Proxy Mobile IPv6 (PMIPv6) WLAN." }, "advancedScanDeferPriority0": { "type": "boolean", "description": "Is priority 0 for the channel scan enabled?" }, "advancedScanDeferPriority1": { "type": "boolean", "description": "Is priority 1 for the channel scan enabled?" }, "advancedScanDeferPriority2": { "type": "boolean", "description": "Is priority 2 for the channel scan enabled?" }, "advancedScanDeferPriority3": { "type": "boolean", "description": "Is priority 3 for the channel scan enabled?" }, "advancedScanDeferPriority4": { "type": "boolean", "description": "Is priority 4 for the channel scan enabled?" }, "advancedScanDeferPriority5": { "type": "boolean", "description": "Is priority 5 for the channel scan enabled?" }, "advancedScanDeferPriority6": { "type": "boolean", "description": "Is priority 6 for the channel scan enabled?" }, "advancedScanDeferPriority7": { "type": "boolean", "description": "Is priority 7 for the channel scan enabled?" }, "advancedScanDeferTime": { "type": "number", "description": "Denotes the channel scan defer time. Measured in milliseconds." }, "advancedSessionTimeout": { "type": "number", "description": "Denotes the maximum time for a client session before requiring reauthentication. Zero means no timeout. Measured in seconds." }, "advancedSessionTimeoutEnabled": { "type": "boolean", "description": "Is advancedSessionTimeout enabled?" }, "advancedWifiDirectClientsPolicy": { "type": "string", "description": "Denotes the Wi-Fi Direct Clients Policy for this WLAN.\nAllowed values:\n\nDISABLED\nALLOWED\nNOTALLOWED\nXCONNECTNOTALLOW" }, "broadcastSsidEnabled": { "type": "boolean", "description": "Is SSID broadcasting enabled?" }, "ckipKeyIndex": { "type": "number", "description": "When ckipSecurityEnabled is true, this denotes the key index." }, "ckipKeyPermutationEnabled": { "type": "boolean", "description": "When ckipSecurityEnabled is true, this denotes whether key permutation is enabled." }, "ckipKeySize": { "type": "string", "description": "When ckipSecurityEnabled is true, this denotes the key size.\nAllowed values:\n\nNONE\nLEN40\nLEN104" }, "ckipMmhModeEnabled": { "type": "boolean", "description": "When ckipSecurityEnabled is true, this denotes whether multimodular mode hashing is enabled." }, "ckipSecurityEnabled": { "type": "boolean", "description": "Is CKIP layer 2 security enabled?" }, "hotspot2Enable": { "type": "object", "description": "This attribute represents enablement of HotSpot 2.0." }, "hotspot2Operators": { "type": "array", "description": "These attributes represent HotSpot 2.0 operators.", "items": { "type": "object" } }, "hotspot2Ports": { "type": "array", "description": "These attributes represent HotSpot 2.0 port configurations.", "items": { "type": "object" } }, "hotspot2Wan": { "type": "object", "description": "These attributes represent HotSpot 2.0 WAN metrics configuration." }, "hotspotCellularNetworks": { "type": "array", "description": "These attributes represent 802.11u cellular network parameters.", "items": { "type": "object" } }, "hotspotDomains": { "type": "array", "description": "These attributes represent 802.11u domains.", "items": { "type": "object" } }, "hotspotGeneral": { "type": "object", "description": "These attributes represent 802.11u general parameters." }, "hotspotOuiTemplate": { "type": "array", "description": "These attributes represent 802.11u OUIs.", "items": { "type": "object" } }, "hotspotRealms": { "type": "array", "description": "These attributes represent 802.11u realms.", "items": { "type": "object" } }, "hotspotServiceAdvertisement": { "type": "object", "description": "These attributes represent MSAP (Mobility Service Advertisement Protocol) parameters." }, "interfaceName": { "type": "string", "description": "Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group." }, "interfaceType": { "type": "number", "description": "Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group.\nAllowed values:\n\nINTERFACE\nINTERFACEGROUP" }, "isWiredLan": { "type": "boolean", "description": "Is this a wired LAN?" }, "lanType": { "type": "string", "description": "Denotes the LAN type.\nAllowed values:\n\nWIRELESS\nGUEST\nREMOTE" }, "lastModified": { "type": "number", "description": "The time the template was last modified. Measured in milliseconds since the Unix epoch." }, "layer2FastTransitionEnabled": { "type": "boolean", "description": "Is fast transition (FT) between access points enabled?" }, "layer2FastTransitionOverDsEnabled": { "type": "boolean", "description": "When layer2FastTransitionEnabled is true, the denotes whether fast transition over a distributed system is enabled." }, "layer2FastTransitionReassociationTimeout": { "type": "number", "description": "When layer2FastTransitionEnabled is true, this denotes the transition timeout. Measured in seconds." }, "layer2MacFilteringEnabled": { "type": "boolean", "description": "Is MAC filtering enabled?" }, "layer3GlobalWebAuthEnabled": { "type": "boolean", "description": "When a layer 3 web policy is true, this denotes whether the template uses global or template-defined Web Auth configuration." }, "layer3PreauthenticationAcl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the IPv4 ACL for traffic between the client and the wireless controller." }, "layer3PreauthenticationIpv6Acl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the IPv6 ACL for traffic between the client and the wireless controller." }, "layer3VpnPassthroughEnabled": { "type": "boolean", "description": "Is VPN passthrough enabled?" }, "layer3WebAuthFlexAcl": { "type": "string", "description": "When a layer 3 web policy is true, this denotes the the FlexConnect ACL for external web authentication in locally switched WLANs." }, "layer3WebAuthType": { "type": "string", "description": "When a layer 3 web policy is true and layer3GlobalWebAuth is false, this denotes the type of web authentication to be used.\nAllowed values:\n\nDEFAULT\nCUSTOMIZED\nEXTERNAL" }, "layer3WebPolicyAuthenticationEnabled": { "type": "boolean", "description": "Is the authentication web policy enabled?" }, "layer3WebPolicyConditionalRedirectEnabled": { "type": "boolean", "description": "Is the conditional redirect web policy enabled?" }, "layer3WebPolicyOnMacFailureEnabled": { "type": "boolean", "description": "Is the WebAuth on MAC failure web policy enabled?" }, "layer3WebPolicyPassthroughEnabled": { "type": "boolean", "description": "Is the passthrough web policy enabled?" }, "multicastVlanEnabled": { "type": "boolean", "description": "Is a multicast VLAN enabled?" }, "multicastVlanInterface": { "type": "string", "description": "When multicastVlanInterface is true, this denotes the multicast VLAN." }, "profileName": { "type": "string", "description": "Profile name of the WLAN." }, "qos7920Cac": { "type": "string", "description": "Denotes the Call Admission Control (CAC) configuration for Cisco 7920 phones.\nAllowed values:\n\nDISABLED\nCLIENTCAC\nAPCAC\nCLIENTANDAPCAC" }, "qosAvcProfileName": { "type": "string", "description": "Denotes the Application Visibility and Control (AVC) profile for this WLAN." }, "qosNbarVisibilityEnabled": { "type": "boolean", "description": "Is Network Based Application Recognition (NBAR) deep packet inspection enabled on this WLAN?" }, "qosNetflowMonitor": { "type": "string", "description": "Denotes the Netflow monitor configured for this WLAN." }, "qosPerSSidBurstRealTimeUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageRealTimeDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageRealTimeUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidAverageUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstRealTimeDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream UDP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerSsidBurstUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream TCP traffic for the WLAN. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageRealTimeDownstreamRate": { "type": "number", "description": "Denotes the average data rate limit for downstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageRealTimeUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserAverageUpstreamRate": { "type": "number", "description": "Denotes the average data rate limit for upstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstRealTimeDownstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for downstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstRealTimeUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream UDP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosPerUserBurstUpstreamRate": { "type": "number", "description": "Denotes the peak data rate limit for upstream TCP traffic for a client. Zero means no restriction. Measured in Kbps." }, "qosProfile": { "type": "string", "description": "Denotes the QoS level for the WLAN.\nAllowed values:\n\nBRONZE\nSILVER\nGOLD\nPLATINUM" }, "qosWmmPolicy": { "type": "string", "description": "Denotes the state of the Wi-fi Multimedia (WMM) policy for this WLAN.\nAllowed values:\n\nDISABLED\nALLOWED\nREQUIRED" }, "radioPolicy": { "type": "string", "description": "Denotes the WLAN radio policy.\nAllowed values:\n\nALL\nONLY80211A\nONLY80211B\nONLY80211G\nONLY80211BG\nONLY80211AG\nONLY80211AB\nNONE\nREMOTELAN" }, "ssid": { "type": "string", "description": "SSID of the WLAN." }, "templateName": { "type": "string", "description": "The name of the WLAN template." }, "vpnPassThroughGatewayAddress": { "type": "object", "description": "When layer3VpnPassthroughEnabled is true, this denotes the IP address of the VPN gateway." }, "webAuthExternalUrl": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"External\", this denotes the URL of the authentication server." }, "webAuthLoginFailurePage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for authentication failures." }, "webAuthLoginPage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for authentication." }, "webAuthLogoutPage": { "type": "string", "description": "When a layer 3 web policy is enabled, layer3GlobalWebAuthEnabled is false, and layer3WebAuthType is set to \"Customized\", this denotes the page for logout." }, "webPassthruEmailInputEnabled": { "type": "boolean", "description": "When layer3WebPolicyPassthroughEnabled is true, this denotes whether the client is prompted to enter an email address when connecting." }, "wepAllowSharedKeyAuthentication": { "type": "boolean", "description": "When wepSecurityEnabled is true, this denotes whether shared key authentication is enabled." }, "wepKeyIndex": { "type": "number", "description": "When wepSecurityEnabled is true, this denotes the key index." }, "wepKeySize": { "type": "string", "description": "When wepSecurityEnabled is true, this denotes whether shared key authentication is enabled.\nAllowed values:\n\nWEP104\nNONE\nWEP40\nWEP128\nAESOCB128\nWEP_40\nWEP_104" }, "wepSecurityEnabled": { "type": "boolean", "description": "Is WEP layer 2 security enabled?" }, "wpa2Enabled": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether the WPA2 policy is enabled." }, "wpa2EncryptionProtocolAes": { "type": "boolean", "description": "When wpaSecurityEnabled and wpa2Enabled are true, this denotes whether AES encryption is supported for the WPA2 policy." }, "wpa2EncryptionProtocolTkip": { "type": "boolean", "description": "When wpaSecurityEnabled and wpa2Enabled are true, this denotes whether TKIP encryption is supported for the WPA2 policy." }, "wpaAuthenticationKeyManagement8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementCckm": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Cisco Centralized Key Management (CCKM) is enabled." }, "wpaAuthenticationKeyManagementFt8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Fast Transition (FT) 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementFtPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Fast Transition (FT) preshared key management is enabled." }, "wpaAuthenticationKeyManagementPmf8021x": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Protected Management Frame (PMF) 802.1X key management is enabled." }, "wpaAuthenticationKeyManagementPmfPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether Protected Management Frame (PMF) preshared key management is enabled." }, "wpaAuthenticationKeyManagementPsk": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether preshared key management is enabled." }, "wpaControllerSpecificPresharedKeyEnabled": { "type": "boolean", "description": "Is controller specific preshared key enabled?" }, "wpaEnabled": { "type": "boolean", "description": "When wpaSecurityEnabled is true, this denotes whether the WPA1 policy is enabled." }, "wpaEncryptionProtocolAes": { "type": "boolean", "description": "When wpaSecurityEnabled and wpaEnabled are both true, this denotes whether AES encryption is supported for the WPA1 policy." }, "wpaEncryptionProtocolTkip": { "type": "boolean", "description": "When wpaSecurityEnabled and wpaEnabled are both true, this denotes whether TKIP encryption is supported for the WPA1 policy." }, "wpaPresharedKey": { "type": "string", "description": "When wpaSecurityEnabled is true, this contains preshared key in HEX or ASCII format." }, "wpaPresharedKeyFormat": { "type": "string", "description": "When wpaSecurityEnabled is true, this denotes preshared key format.\nAllowed values:\n\nDEFAULT\nHEX\nASCII" }, "wpaSecurityEnabled": { "type": "boolean", "description": "Is WPA layer 2 security enabled?" }, "x8021KeySize": { "type": "string", "description": "When x8021SecurityEnabled is true, this denotes the 802.1X key size.\nAllowed values:\n\nWEP104\nWEP40\nWEP128\nNONE\nWEP_40\nWEP_104" }, "x8021SecurityEnabled": { "type": "boolean", "description": "Is 802.1X layer 2 security enabled?" } } } } } } } } }, "/webacs/api/v4/op/wlanProvisioning/apGroup": { "delete": { "summary": "DELETE Delete AP Group\nDELETE op/wlanProvisioning/apGroup", "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." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the AP group from. Either controllerId or controllerName must be specified.", "schema": { "type": "number" } }, { "name": "controllerName", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the AP group from. Either controllerId or controllerName must be specified.", "schema": { "type": "string" } }, { "name": "apGroupName", "in": "query", "required": true, "description": "RequiredIdentifies the AP group to be deleted.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/wlanProvisioning/interface": { "delete": { "summary": "DELETE Delete Interface\nDELETE op/wlanProvisioning/interface", "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." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the interface from. Either controllerId or controllerName must be specified.", "schema": { "type": "number" } }, { "name": "controllerName", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the interface from. Either controllerId or controllerName must be specified.", "schema": { "type": "string" } }, { "name": "interfaceName", "in": "query", "required": true, "description": "RequiredIdentifies the interface to remove from the controller.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/wlanProvisioning/interfaceGroup": { "delete": { "summary": "DELETE Delete Interface Group\nDELETE op/wlanProvisioning/interfaceGroup", "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." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the interface group from. Either controllerId or controllerName must be specified.", "schema": { "type": "number" } }, { "name": "controllerName", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the interface group from. Either controllerId or controllerName must be specified.", "schema": { "type": "string" } }, { "name": "interfaceGroupName", "in": "query", "required": true, "description": "RequiredIdentifies the interface group to remove from the controller.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/wlanProvisioning/wlanProfile": { "delete": { "summary": "DELETE Delete WLAN Profile\nDELETE op/wlanProvisioning/wlanProfile", "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." } } } } } } }, "parameters": [ { "name": "controllerId", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the WLAN profile from. Either controllerId or controllerName must be specified.", "schema": { "type": "number" } }, { "name": "controllerName", "in": "query", "required": true, "description": "RequiredIdentifies the controller to delete the WLAN profile from. Either controllerId or controllerName must be specified.", "schema": { "type": "string" } }, { "name": "wlanProfileName", "in": "query", "required": true, "description": "RequiredIdentifies the WLAN profile to delete.", "schema": { "type": "string" } } ] } }, "/webacs/api/v4/op/wlanProvisioning/wlanTemplate": { "delete": { "summary": "DELETE Delete Wlan Template\nDELETE op/wlanProvisioning/wlanTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "templateName": { "type": "string", "description": "RequiredThe name of the template to delete." } } } } } } } }, "post": { "summary": "POST Create Wlan Template\nPOST op/wlanProvisioning/wlanTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "description": "Is the WLAN administratively enabled?" }, "broadcastSsidEnabled": { "type": "boolean", "description": "Is SSID broadcasting enabled?" }, "interfaceName": { "type": "string", "description": "Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group." }, "interfaceType": { "type": "number", "description": "Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group.\nAllowed values:\n\nINTERFACE\nINTERFACEGROUP" }, "lanType": { "type": "string", "description": "Denotes the LAN type.\nAllowed values:\n\nWIRELESS\nGUEST\nREMOTE" }, "layer2Security": { "type": "object", "description": "Layer 2 Security configuration. Required.\nNo changes in layer 2 security will be made when is not provided." }, "profileName": { "type": "string", "description": "Profile name of the WLAN." }, "ssid": { "type": "string", "description": "SSID of the WLAN." }, "templateName": { "type": "string", "description": "The name of the WLAN template." } } } } } } } } }, "/webacs/api/v4/op/wlanProvisioning/deployTemplate": { "put": { "summary": "PUT Modify Wlan Template\nPUT op/wlanProvisioning/wlanTemplate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "description": "Is the WLAN administratively enabled?" }, "broadcastSsidEnabled": { "type": "boolean", "description": "Is SSID broadcasting enabled?" }, "interfaceName": { "type": "string", "description": "Denotes the interface, or interface group, for this WLAN. See interfaceType to determine if this is an interface or interface group." }, "interfaceType": { "type": "number", "description": "Denotes whether an interface or interface group is used for this interface. See interfaceName for the name of the interface or interface group.\nAllowed values:\n\nINTERFACE\nINTERFACEGROUP" }, "lanType": { "type": "string", "description": "Denotes the LAN type.\nAllowed values:\n\nWIRELESS\nGUEST\nREMOTE" }, "layer2Security": { "type": "object", "description": "Layer 2 Security configuration. Required.\nNo changes in layer 2 security will be made when is not provided." }, "profileName": { "type": "string", "description": "Profile name of the WLAN." }, "ssid": { "type": "string", "description": "SSID of the WLAN." }, "templateName": { "type": "string", "description": "The name of the WLAN template." } } } } } } } } }, "/webacs/api/v4/data/AutoApRadioDetails": { "get": { "summary": "GET Autonomous AP Radio Details\nGET data/AutoApRadioDetails", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "string", "description": "Administrative status of the radio interface\nAllowed values:\n\nUNKNOWN\nENABLE\nDISABLE" }, "antennaAzimAngle": { "type": "number", "description": "Displays the horizontal angle of the antenna" }, "antennaElevAngle": { "type": "number", "description": "Displays the elevation angle of the antenna." }, "antennaGain": { "type": "number", "description": "The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain." }, "antennaName": { "type": "string", "description": "Antenna name" }, "apIpAddress": { "type": "object", "description": "IP address of the access point" }, "apName": { "type": "string", "description": "Name of the access point" }, "baseRadioMac": { "type": "object", "description": "Base radio MAC address" }, "channelNumber": { "type": "string", "description": "Current operational channel number\nAllowed values:\n\nUNKNOWN\n_1\n_2\n_3\n_4\n_5\n_6\n_7\n_8\n_9\n_10\n_11\n_12\n_13\n_14\n_20\n_21\n_22\n_23\n_24\n_25\n_26\n_34\n_36\n_38\n_40\n_42\n_44\n_46\n_48\n_52\n_56\n_60\n_64\n_100\n_104\n_108\n_112\n_116\n_120\n_124\n_128\n_132\n_136\n_140\n_144\n_149\n_153\n_157\n_161\n_165\n_169\n_173" }, "clientCount": { "type": "number", "description": "Client count connected to the radio interface" }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "ifDescr": { "type": "string", "description": "SNMP ifDescr" }, "nativePowerUseStandard": { "type": "boolean", "description": "Native power use standard" }, "operBand": { "type": "string", "description": "802.11 operational band\nAllowed values:\n\nUNKNOWN\nBAND24GHZ\nBAND5GHZ" }, "operStatus": { "type": "string", "description": "erational status of the radio interface\nAllowed values:\n\nDOWN\nUP\nNOTASSOCIATED\nUNKNOWN" }, "phyType": { "type": "string", "description": "802.11 phy type\nAllowed values:\n\nUNKNOWN\nFHSS\nDSSS\nIRBASEBAND\nOFDM\nHRDSSS\nERP\nHT" }, "powerLevel": { "type": "number", "description": "Power level of the radio" }, "radioMac": { "type": "object", "description": "Radio MAC address" }, "radioRole": { "type": "string", "description": "Radio role\nAllowed values:\n\nUNKNOWN\nWGB\nBRIDGE\nCLIENT\nROOT\nREPEATER\nAPBRIDGE\nAPREPEATER\nIBSS\nNRBRIDGE\nAPBRBRIDGE\nSCANNER" }, "radioType": { "type": "string", "description": "Radio type\nAllowed values:\n\n802.11a\n802.11b/g\n802.11b/g/n\n802.11a/n\nUnknown" } } } } } } } } }, "/webacs/api/v4/data/ClientStats": { "get": { "summary": "GET Client Statistics\nGET data/ClientStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "bytesReceived": { "type": "number", "description": "Number of bytes received during the session" }, "bytesSent": { "type": "number", "description": "Number of bytes sent during the session" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "dataRate": { "type": "number", "description": "Reading data rate, measured in Mbps." }, "dataRetries": { "type": "number", "description": "Number data retries during the session" }, "macAddress": { "type": "object", "description": "Client MAC address" }, "packetsReceived": { "type": "number", "description": "Number packets received during the session" }, "packetsSent": { "type": "number", "description": "Number of packets sent during the session" }, "raPacketsDropped": { "type": "number", "description": "Number of IPv6 RA packets dropped during the session" }, "rssi": { "type": "number", "description": "The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm." }, "rtsRetries": { "type": "number", "description": "Number of RTS retries during the session" }, "rxBytesDropped": { "type": "number", "description": "Number of Rx bytes dropped during the session" }, "rxPacketsDropped": { "type": "number", "description": "Number of Rx packets dropped during the session" }, "snr": { "type": "number", "description": "Signal-to-noise ratio of the client session as detected by the access point with which the client is associated." }, "txBytesDropped": { "type": "number", "description": "Number of Tx bytes dropped during the session" }, "txPacketsDropped": { "type": "number", "description": "Number of Tx packets dropped during the session" } } } } } } } } }, "/webacs/api/v4/data/HistoricalClientStats": { "get": { "summary": "GET Historical Client Statistics\nGET data/HistoricalClientStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "bytesReceived": { "type": "number", "description": "Number of bytes received during the session" }, "bytesSent": { "type": "number", "description": "Number of bytes sent during the session" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished, measured in milliseconds since the Unix epoch." }, "dataRate": { "type": "number", "description": "Reading data rate, measured in Mbps." }, "dataRetries": { "type": "number", "description": "Number data retries during the session" }, "macAddress": { "type": "object", "description": "Client MAC address" }, "packetsReceived": { "type": "number", "description": "Number packets received during the session" }, "packetsSent": { "type": "number", "description": "Number of packets sent during the session" }, "raPacketsDropped": { "type": "number", "description": "Number of IPv6 RA packets dropped during the session" }, "rssi": { "type": "number", "description": "The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm." }, "rtsRetries": { "type": "number", "description": "Number of RTS retries during the session" }, "rxBytesDropped": { "type": "number", "description": "Number of Rx bytes dropped during the session" }, "rxPacketsDropped": { "type": "number", "description": "Number of Rx packets dropped during the session" }, "snr": { "type": "number", "description": "Signal-to-noise ratio of the client session as detected by the access point with which the client is associated." }, "txBytesDropped": { "type": "number", "description": "Number of Tx bytes dropped during the session" }, "txPacketsDropped": { "type": "number", "description": "Number of Tx packets dropped during the session" } } } } } } } } }, "/webacs/api/v4/data/HistoricalRFCounters": { "get": { "summary": "GET Historical Radio Interface 802.11 Counters in Last 24 Hours\nGET data/HistoricalRFCounters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ackFailureCount": { "type": "number", "description": "ACK failure count" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "failedCount": { "type": "number", "description": "Failed count" }, "fcsErrorCount": { "type": "number", "description": "FCS error count" }, "frameDuplicateCount": { "type": "number", "description": "Frame duplicate count" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "multipleRetryCount": { "type": "number", "description": "Multiple retry count" }, "retryCount": { "type": "number", "description": "Retry count" }, "rtsFailureCount": { "type": "number", "description": "RTS failure count" }, "rtsSuccessCount": { "type": "number", "description": "RTS success count" }, "rxFragmentCount": { "type": "number", "description": "Rx fragment count" }, "rxMulticastFrameCount": { "type": "number", "description": "Rx multicast frame count" }, "slotId": { "type": "number", "description": "Radio slot ID" }, "txFragmentCount": { "type": "number", "description": "Tx fragment count" }, "txFrameCount": { "type": "number", "description": "Tx frame count" }, "txMulticastFrameCount": { "type": "number", "description": "Tx multicast frame count" }, "wepUndecryptableCount": { "type": "number", "description": "WEP undecryptable count" } } } } } } } } }, "/webacs/api/v4/data/HistoricalRFLoadStats": { "get": { "summary": "GET Historical Radio Interface Load Statistics in Last 24 Hours\nGET data/HistoricalRFLoadStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channelUtilization": { "type": "number", "description": "Channel Utilization (%)" }, "clientCount": { "type": "number", "description": "Number of associated clients" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "poorCoverageClients": { "type": "number", "description": "Poor coverage clients" }, "rxUtilization": { "type": "number", "description": "Rx Utilization (%)" }, "slotId": { "type": "number", "description": "Slot ID of the radio" }, "txUtilization": { "type": "number", "description": "Tx Utilization (%)" } } } } } } } } }, "/webacs/api/v4/data/HistoricalRFStats": { "get": { "summary": "GET Historical Radio Interface Statistics in Last 24 Hours\nGET data/HistoricalRFStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channelNumber": { "type": "string", "description": "Channel number that the radio is operating on\nAllowed values:\n\nUNKNOWN\n_1\n_2\n_3\n_4\n_5\n_6\n_7\n_8\n_9\n_10\n_11\n_12\n_13\n_14\n_20\n_21\n_22\n_23\n_24\n_25\n_26\n_34\n_36\n_38\n_40\n_42\n_44\n_46\n_48\n_52\n_56\n_60\n_64\n_100\n_104\n_108\n_112\n_116\n_120\n_124\n_128\n_132\n_136\n_140\n_144\n_149\n_153\n_157\n_161\n_165\n_169\n_173" }, "clientCount": { "type": "number", "description": "Number of associated clients" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "coverageProfile": { "type": "string", "description": "Allowed values:\n\nFAILED\nPASSED" }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "interferenceProfile": { "type": "string", "description": "Interference profile\nAllowed values:\n\nFAILED\nPASSED" }, "loadProfile": { "type": "string", "description": "Load profile\nAllowed values:\n\nFAILED\nPASSED" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "noiseProfile": { "type": "string", "description": "Noise profile\nAllowed values:\n\nFAILED\nPASSED" }, "operStatus": { "type": "string", "description": "erational Status\nAllowed values:\n\nDOWN\nUP\nNOTASSOCIATED\nUNKNOWN" }, "powerLevel": { "type": "number", "description": "wer level of the radio" }, "slotId": { "type": "number", "description": "Slot ID of the radio" } } } } } } } } }, "/webacs/api/v4/data/HistoricalWLCCPUUtilizations": { "get": { "summary": "GET Historical Wireless Lan Controller CPU Utilizations\nGET data/HistoricalWLCCPUUtilizations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "averageCPUUtilization": { "type": "number", "description": "The average utilization of all CPUs in the controller" }, "collectionTime": { "type": "number", "description": "The time on the server when the collection was performed, as milliseconds from the Unix epoch" }, "cpuUtilization": { "type": "array", "description": "Detailed utilization information per each controller CPU", "items": { "type": "object" } }, "ipAddress": { "type": "object", "description": "WLAN controller IP address" }, "name": { "type": "string", "description": "WLAN controller name" } } } } } } } } }, "/webacs/api/v4/data/HistoricalWLCMemUtilizations": { "get": { "summary": "GET Historical Wireless Lan Controller Memory Utilizations\nGET data/HistoricalWLCMemUtilizations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionTime": { "type": "number", "description": "The time on the server when the collection was performed, as milliseconds from the Unix epoch" }, "ipAddress": { "type": "object", "description": "WLAN controller IP address" }, "memoryFree": { "type": "number", "description": "The total amount of free memory in all controller memory pools" }, "memoryPoolUtilization": { "type": "array", "description": "Detailed utilization information per each controller memory pool", "items": { "type": "object" } }, "memoryTotal": { "type": "number", "description": "The total amount of memory in all controller memory pools" }, "memoryUsed": { "type": "number", "description": "The total amount of used memory in all controller memory pools" }, "memoryUtilization": { "type": "number", "description": "Common memory utilization for all controller memory pools" }, "name": { "type": "string", "description": "WLAN controller name" } } } } } } } } }, "/webacs/api/v4/data/RadioDetails": { "get": { "summary": "GET Lightweight AP Radio Details\nGET data/RadioDetails", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "string", "description": "Administrative status of the radio interface\nAllowed values:\n\nUNKNOWN\nENABLE\nDISABLE" }, "alarmStatus": { "type": "string", "description": "Allowed values:\n\nCRITICAL\nMAJOR\nMINOR\nWARNING\nCLEARED\nINFORMATION" }, "antennaAzimAngle": { "type": "number", "description": "Displays the horizontal angle of the antenna" }, "antennaDiversity": { "type": "string", "description": "Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.\nAllowed values:\n\nCONNECTOR_A\nCONNECTOR_B\nENABLED\nNOT_APPLICABLE" }, "antennaElevAngle": { "type": "number", "description": "Displays the elevation angle of the antenna." }, "antennaGain": { "type": "number", "description": "The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain." }, "antennaMode": { "type": "string", "description": "Displays the antenna mode such as Omni, Directional, or NA (non-applicable).\nAllowed values:\n\nSECTOR_A\nSECTOR_B\nOMNI\nNOTAPPLICABLE" }, "antennaName": { "type": "string", "description": "Antenna name" }, "antennaType": { "type": "string", "description": "Antenna type\nAllowed values:\n\nINTERNAL\nEXTERNAL\nCIRCULAR\nLINEAR\nNOT_APPLICABLE" }, "apIpAddress": { "type": "object", "description": "IP address of the access point" }, "apName": { "type": "string", "description": "Name of the access point" }, "baseRadioMac": { "type": "object", "description": "Base radio MAC address" }, "channelControl": { "type": "string", "description": "Radio channel control\nAllowed values:\n\nAUTOMATIC\nCUSTOM" }, "channelNumber": { "type": "string", "description": "Current operational channel number\nAllowed values:\n\nUNKNOWN\n_1\n_2\n_3\n_4\n_5\n_6\n_7\n_8\n_9\n_10\n_11\n_12\n_13\n_14\n_20\n_21\n_22\n_23\n_24\n_25\n_26\n_34\n_36\n_38\n_40\n_42\n_44\n_46\n_48\n_52\n_56\n_60\n_64\n_100\n_104\n_108\n_112\n_116\n_120\n_124\n_128\n_132\n_136\n_140\n_144\n_149\n_153\n_157\n_161\n_165\n_169\n_173" }, "channelWidth": { "type": "string", "description": "Channel width\nAllowed values:\n\n5 MHz\n10 MHz\n20 MHz\n40 MHz\nBelow 40 MHz\nAbove 40 MHz\n80 MHz\n160 MHz\nNOTAPPLICABLE" }, "cleanAirCapable": { "type": "boolean", "description": "Capability of clean air feature." }, "cleanAirSensorStatus": { "type": "object", "description": "Clean air sensor status\nAllowed values:\n\nUP\nDOWN\nNOTAPPLICABLE" }, "cleanAirStatus": { "type": "boolean", "description": "Clean air enablement status." }, "clientCount": { "type": "number", "description": "Client count connected to the radio interface" }, "controllerIpAddress": { "type": "object", "description": "Registered controller IP address for CAPWAP AP only" }, "dot11nCapable": { "type": "boolean", "description": "802.11n capability" }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "operStatus": { "type": "string", "description": "erational status of the radio interface\nAllowed values:\n\nDOWN\nUP\nNOTASSOCIATED\nUNKNOWN" }, "port": { "type": "number", "description": "Controller port number" }, "powerLevel": { "type": "number", "description": "Power level of the radio" }, "radioBand": { "type": "string", "description": "Radio band of the radio interface\nAllowed values:\n\n2.4 GHz\n5 GHz\nUnknown" }, "radioRole": { "type": "string", "description": "Radio role\nAllowed values:\n\nSHUTDOWN\nUPDOWNLINK\nUPLINK\nDOWNLINK\nACCESS\nUPLINKACCESS\nDOWNLINKACCESS\nUPDOWNLINKACCESS\nNOTAPPLICABLE" }, "radioType": { "type": "string", "description": "Radio type ot the interface\nAllowed values:\n\n802.11a\n802.11a/n\n802.11ac\n802.11a/n/ac\n802.11b/g\n802.11b/g/n\nUnknown" }, "slotId": { "type": "number", "description": "Slot ID of the radio in the AP" }, "txPowerControl": { "type": "string", "description": "Tranmission power control\nAllowed values:\n\nAUTOMATIC\nCUSTOM" }, "txPowerOutput": { "type": "number", "description": "The txPower currently being used to transmit data, in dBm" } } } } } } } } }, "/webacs/api/v4/data/RFCounters": { "get": { "summary": "GET Radio Interface 802.11 Counters\nGET data/RFCounters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ackFailureCount": { "type": "number", "description": "ACK failure count" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "failedCount": { "type": "number", "description": "Failed count" }, "fcsErrorCount": { "type": "number", "description": "FCS error count" }, "frameDuplicateCount": { "type": "number", "description": "Frame duplicate count" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "multipleRetryCount": { "type": "number", "description": "Multiple retry count" }, "retryCount": { "type": "number", "description": "Retry count" }, "rtsFailureCount": { "type": "number", "description": "RTS failure count" }, "rtsSuccessCount": { "type": "number", "description": "RTS success count" }, "rxFragmentCount": { "type": "number", "description": "Rx fragment count" }, "rxMulticastFrameCount": { "type": "number", "description": "Rx multicast frame count" }, "slotId": { "type": "number", "description": "Radio slot ID" }, "txFragmentCount": { "type": "number", "description": "Tx fragment count" }, "txFrameCount": { "type": "number", "description": "Tx frame count" }, "txMulticastFrameCount": { "type": "number", "description": "Tx multicast frame count" }, "wepUndecryptableCount": { "type": "number", "description": "WEP undecryptable count" } } } } } } } } }, "/webacs/api/v4/data/RFLoadStats": { "get": { "summary": "GET Radio Interface Load Statistics\nGET data/RFLoadStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channelUtilization": { "type": "number", "description": "Channel Utilization (%)" }, "clientCount": { "type": "number", "description": "Number of associated clients" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "poorCoverageClients": { "type": "number", "description": "Poor coverage clients" }, "rxUtilization": { "type": "number", "description": "Rx Utilization (%)" }, "slotId": { "type": "number", "description": "Slot ID of the radio" }, "txUtilization": { "type": "number", "description": "Tx Utilization (%)" } } } } } } } } }, "/webacs/api/v4/data/RFStats": { "get": { "summary": "GET Radio Interface Statistics\nGET data/RFStats", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channelNumber": { "type": "string", "description": "Channel number that the radio is operating on\nAllowed values:\n\nUNKNOWN\n_1\n_2\n_3\n_4\n_5\n_6\n_7\n_8\n_9\n_10\n_11\n_12\n_13\n_14\n_20\n_21\n_22\n_23\n_24\n_25\n_26\n_34\n_36\n_38\n_40\n_42\n_44\n_46\n_48\n_52\n_56\n_60\n_64\n_100\n_104\n_108\n_112\n_116\n_120\n_124\n_128\n_132\n_136\n_140\n_144\n_149\n_153\n_157\n_161\n_165\n_169\n_173" }, "clientCount": { "type": "number", "description": "Number of associated clients" }, "collectionTime": { "type": "number", "description": "The time collection of this record was finished.\n\nNote: The date has an incorrect UTC offset. Please see the FAQ for details." }, "coverageProfile": { "type": "string", "description": "Allowed values:\n\nFAILED\nPASSED" }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "interferenceProfile": { "type": "string", "description": "Interference profile\nAllowed values:\n\nFAILED\nPASSED" }, "loadProfile": { "type": "string", "description": "Load profile\nAllowed values:\n\nFAILED\nPASSED" }, "macAddress": { "type": "object", "description": "Base radio MAC address" }, "noiseProfile": { "type": "string", "description": "Noise profile\nAllowed values:\n\nFAILED\nPASSED" }, "operStatus": { "type": "string", "description": "erational Status\nAllowed values:\n\nDOWN\nUP\nNOTASSOCIATED\nUNKNOWN" }, "powerLevel": { "type": "number", "description": "wer level of the radio" }, "slotId": { "type": "number", "description": "Slot ID of the radio" }, "txPowerOutput": { "type": "number", "description": "The txPower currently being used to transmit data, in dBm" } } } } } } } } }, "/webacs/api/v4/data/Radios": { "get": { "summary": "GET Radio Summary\nGET data/Radios", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "string", "description": "Administrative status of the radio interface\nAllowed values:\n\nUNKNOWN\nENABLE\nDISABLE" }, "apIpAddress": { "type": "object", "description": "IP address of the access point" }, "apName": { "type": "string", "description": "Name of the access point" }, "apType": { "type": "number", "description": "Type of access point\nAllowed values:\n\nCAPWAP\nAUTONOMOUS" }, "baseRadioMac": { "type": "object", "description": "Base radio MAC address" }, "channelNumber": { "type": "string", "description": "Current operational channel number\nAllowed values:\n\nUNKNOWN\n_1\n_2\n_3\n_4\n_5\n_6\n_7\n_8\n_9\n_10\n_11\n_12\n_13\n_14\n_20\n_21\n_22\n_23\n_24\n_25\n_26\n_34\n_36\n_38\n_40\n_42\n_44\n_46\n_48\n_52\n_56\n_60\n_64\n_100\n_104\n_108\n_112\n_116\n_120\n_124\n_128\n_132\n_136\n_140\n_144\n_149\n_153\n_157\n_161\n_165\n_169\n_173" }, "clientCount": { "type": "number", "description": "Client count connected to the radio interface" }, "controllerIpAddress": { "type": "object", "description": "Registered controller IP address for CAPWAP AP only" }, "ethernetMac": { "type": "object", "description": "MAC address of the ethernet interface on the AP" }, "operStatus": { "type": "string", "description": "erational status of the radio interface\nAllowed values:\n\nDOWN\nUP\nNOTASSOCIATED\nUNKNOWN" }, "powerLevel": { "type": "number", "description": "Power level of the radio" }, "radioType": { "type": "string", "description": "Radio type ot the interface\nAllowed values:\n\n802.11a\n802.11a/n\n802.11ac\n802.11a/n/ac\n802.11b/g\n802.11b/g/n\nUnknown" } } } } } } } } }, "/webacs/api/v4/data/ThirdpartyAccessPoints": { "get": { "summary": "GET Third Party Access Point Summary\nGET data/ThirdpartyAccessPoints", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "string", "description": "AP Admin Status\nAllowed values:\n\nUNKNOWN\nENABLE\nDISABLE" }, "clientCount": { "type": "number", "description": "Total Client Count" }, "clientCount24GHz": { "type": "number", "description": "Client Count on 2.4GHz Band" }, "clientCount5GHz": { "type": "number", "description": "Client Count on 5GHZ Band" }, "controllerIpAddress": { "type": "string", "description": "Registered Third Party Controller IP address" }, "controllerName": { "type": "string", "description": "Registered Third Party Controller name" }, "ethernetMac": { "type": "string", "description": "AP Ethernet MAC Address" }, "ipAddress": { "type": "string", "description": "AP IP Address" }, "location": { "type": "string", "description": "AP SNMP Location" }, "macAddress": { "type": "string", "description": "AP MAC Address" }, "model": { "type": "string", "description": "AP Model" }, "name": { "type": "string", "description": "AP Name" }, "operationalStatus": { "type": "string", "description": "AP Operational Status\nAllowed values:\n\nREGISTERED\nNOTREGISTERED\nDOWNLOADING" }, "serialNumber": { "type": "string", "description": "AP Serial Number" }, "softwareVersion": { "type": "string", "description": "AP Software Version" }, "status": { "type": "string", "description": "AP Alarm Status\nAllowed values:\n\nCRITICAL\nMAJOR\nMINOR\nWARNING\nCLEARED\nINFORMATION" } } } } } } } } }, "/webacs/api/v4/data/AccessPoints": { "get": { "summary": "GET Wireless Access Point Summary\nGET data/AccessPoints", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "adminStatus": { "type": "string", "description": "AP Admin Status\nAllowed values:\n\nUNKNOWN\nENABLE\nDISABLE" }, "bootVersion": { "type": "string", "description": "AP Boot Version" }, "clientCount": { "type": "number", "description": "Total Client Count" }, "clientCount24GHz": { "type": "number", "description": "Client Count on 2.4GHz Band" }, "clientCount5GHz": { "type": "number", "description": "Client Count on 5GHZ Band" }, "controllerIpAddress": { "type": "string", "description": "Registered Controller IP Address" }, "controllerName": { "type": "string", "description": "Registered Controller Name" }, "countryCode": { "type": "string", "description": "Identifies the country in which the AP is operating. This value is the 3 letter country code." }, "ethernetMac": { "type": "object", "description": "AP Ethernet MAC Address" }, "hreapEnabled": { "type": "boolean", "description": "Displays whether OfficeExtend is enabled." }, "ipAddress": { "type": "object", "description": "AP IP Address" }, "location": { "type": "string", "description": "AP SNMP Location" }, "lwappUpTime": { "type": "number", "description": "LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller." }, "macAddress": { "type": "object", "description": "AP MAC Address" }, "model": { "type": "string", "description": "AP Model" }, "name": { "type": "string", "description": "AP Name" }, "serialNumber": { "type": "string", "description": "AP Serial Number" }, "softwareVersion": { "type": "string", "description": "AP Software Version" }, "status": { "type": "string", "description": "AP Alarm Status\nAllowed values:\n\nCRITICAL\nMAJOR\nMINOR\nWARNING\nCLEARED\nINFORMATION" }, "type": { "type": "string", "description": "AP Type" }, "upTime": { "type": "number", "description": "AP Up Time in hundredths of a second" } } } } } } } } }, "/webacs/api/v4/data/WLCCPUUtilizations": { "get": { "summary": "GET Wireless Lan Controller CPU Utlizations\nGET data/WLCCPUUtilizations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "averageCPUUtilization": { "type": "number", "description": "The average utilization of all CPUs in the controller" }, "collectionTime": { "type": "number", "description": "The time on the server when the collection was performed, as milliseconds from the Unix epoch" }, "cpuUtilization": { "type": "array", "description": "Detailed utilization information per each controller CPU", "items": { "type": "object" } }, "ipAddress": { "type": "object", "description": "WLAN controller IP address" }, "name": { "type": "string", "description": "WLAN controller name" } } } } } } } } }, "/webacs/api/v4/data/WLCMemoryUtilizations": { "get": { "summary": "GET Wireless Lan Controller Memory Utilizations\nGET data/WLCMemoryUtilizations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionTime": { "type": "number", "description": "The time on the server when the collection was performed, as milliseconds from the Unix epoch" }, "ipAddress": { "type": "object", "description": "WLAN controller IP address" }, "memoryFree": { "type": "number", "description": "The total amount of free memory in all controller memory pools" }, "memoryPoolUtilization": { "type": "array", "description": "Detailed utilization information per each controller memory pool", "items": { "type": "object" } }, "memoryTotal": { "type": "number", "description": "The total amount of memory in all controller memory pools" }, "memoryUsed": { "type": "number", "description": "The total amount of used memory in all controller memory pools" }, "memoryUtilization": { "type": "number", "description": "Common memory utilization for all controller memory pools" }, "name": { "type": "string", "description": "WLAN controller name" } } } } } } } } }, "/webacs/api/v4/data/WlanControllers": { "get": { "summary": "GET Wireless Lan Controller Summary\nGET data/WlanControllers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmStatus": { "type": "string", "description": "Alarm status\nAllowed values:\n\nCRITICAL\nMAJOR\nMINOR\nWARNING\nCLEARED\nINFORMATION" }, "apCount": { "type": "number", "description": "Number of access points associated with the controller" }, "auditStatus": { "type": "string", "description": "Audit status\nAllowed values:\n\nNA\nMISMATCH\nIDENTICAL\nUNREACHABLE" }, "autoRefresh": { "type": "boolean", "description": "Auto refresh state" }, "clientCount": { "type": "number", "description": "Number of clients associated with the controller" }, "contact": { "type": "string", "description": "System contact" }, "ipAddress": { "type": "string", "description": "Management IP address of the WLAN controller" }, "lastBackup": { "type": "number", "description": "The latest backup time. Null if no backup were taken" }, "location": { "type": "string", "description": "Device location set in MIB2" }, "mobilityGroupName": { "type": "string", "description": "Mobility group name" }, "name": { "type": "string", "description": "Device name" }, "reachabilityStatus": { "type": "boolean", "description": "SNMP reachability" }, "rfGroupName": { "type": "string", "description": "RF group name" }, "softwareVersion": { "type": "string", "description": "Software version running on the controller" }, "type": { "type": "string", "description": "Device type" } } } } } } } } } }, "components": { "schemas": {} } }