@itentialopensource/adapter-cisco_prime

{ "id": "@itentialopensource/adapter-cisco_prime", "type": "Adapter", "export": "CiscoPrime", "title": "Cisco_prime", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "deleteWebacsApiV4OpAaaTacacsPlusServer", "summary": "DELETE Delete Server\nDELETE op/aaa/tacacsPlusServer", "description": "DELETE Delete Server\nDELETE op/aaa/tacacsPlusServer", "input": [ { "name": "serverIp", "type": "string", "info": "IP address of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.: string", "required": false, "schema": { "title": "serverIp", "type": "string" } }, { "name": "serverHostName", "type": "string", "info": "Host name of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.: string", "required": false, "schema": { "title": "serverHostName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteWebacsApiV4OpAaaTacacsPlusServer" }, "task": true }, { "name": "getWebacsApiV4OpAaaTacacsPlusServer", "summary": "GET List Servers\nGET op/aaa/tacacsPlusServer", "description": "GET List Servers\nGET op/aaa/tacacsPlusServer", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getWebacsApiV4OpAaaTacacsPlusServer" }, "task": true }, { "name": "postWebacsApiV4OpAaaTacacsPlusServer", "summary": "POST Add Server\nPOST op/aaa/tacacsPlusServer", "description": "POST Add Server\nPOST op/aaa/tacacsPlusServer", "input": [ { "name": "body", "type": "object", "info": ": {\"authenticationType\": \"object\", \"localInterfaceIp\": \"object\", \"numberOfTries\": \"object\", \"port\": \"object\", \"retransmitTimeout\": \"object\", \"secretKey\": \"string\", \"secretKeyType\": \"object\", \"serverHostName\": \"string\", \"serverIp\": \"object\"}", "required": false, "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." } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWebacsApiV4OpAaaTacacsPlusServer" }, "task": true }, { "name": "putWebacsApiV4OpAaaTacacsPlusServer", "summary": "PUT Update Server\nPUT op/aaa/tacacsPlusServer", "description": "PUT Update Server\nPUT op/aaa/tacacsPlusServer", "input": [ { "name": "body", "type": "object", "info": ": {\"authenticationType\": \"object\", \"localInterfaceIp\": \"object\", \"numberOfTries\": \"object\", \"port\": \"object\", \"retransmitTimeout\": \"object\", \"secretKey\": \"string\", \"secretKeyType\": \"object\", \"serverHostName\": \"string\", \"serverIp\": \"object\"}", "required": false, "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." } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWebacsApiV4OpAaaTacacsPlusServer" }, "task": true }, { "name": "getWebacsApiV4DataApOnboardingProfile", "summary": "GET Get AP onboarding profiles\nGET data/ApOnboardingProfile", "description": "GET Get AP onboarding profiles\nGET data/ApOnboardingProfile", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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." } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getWebacsApiV4DataApOnboardingProfile" }, "task": true }, { "name": "deleteWebacsApiV4OpApOnboardingProfile", "summary": "DELETE Delete AP onboarding profiles\nDELETE op/apOnboarding/profile", "description": "DELETE Delete AP onboarding profiles\nDELETE op/apOnboarding/profile", "input": [ { "name": "body", "type": "object", "info": ": {\"profileIds\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "profileIds": { "type": "array", "description": "Profile IDs", "items": { "type": "object" } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteWebacsApiV4OpApOnboardingProfile" }, "task": true }, { "name": "postWebacsApiV4OpApOnboardingProfile", "summary": "POST Create AP onboarding profiles\nPOST op/apOnboarding/profile", "description": "POST Create AP onboarding profiles\nPOST op/apOnboarding/profile", "input": [ { "name": "overrideOption", "type": "boolean", "info": "verride existing profiles: boolean", "required": false, "schema": { "title": "overrideOption", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "profiles": { "type": "array", "description": "AP Onboarding Profiles", "items": { "type": "object" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWebacsApiV4OpApOnboardingProfile" }, "task": true }, { "name": "putWebacsApiV4OpApOnboardingProfile", "summary": "PUT Modify AP onboarding profile\nPUT op/apOnboarding/profile", "description": "PUT Modify AP onboarding profile\nPUT op/apOnboarding/profile", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/putWebacsApiV4OpApOnboardingProfile" }, "task": true }, { "name": "getWebacsApiV4DataApiHealthRecords", "summary": "GET API Health Record\nGET data/ApiHealthRecords", "description": "GET API Health Record\nGET data/ApiHealthRecords", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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." } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getWebacsApiV4DataApiHealthRecords" }, "task": true }, { "name": "getWebacsApiV4DataApiResponseTimeSummary", "summary": "GET API Response Time Summary\nGET data/ApiResponseTimeSummary", "description": "GET API Response Time Summary\nGET data/ApiResponseTimeSummary", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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." } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getWebacsApiV4DataApiResponseTimeSummary" }, "task": true }, { "name": "getWebacsApiV4OpApiHealthCallsPerClient", "summary": "GET API Calls Per Client\nGET op/apiHealth/callsPerClient", "description": "GET API Calls Per Client\nGET op/apiHealth/callsPerClient", "input": [ { "name": "service", "type": "string", "info": "The service path. If unspecified, data will be returned for all services.: string", "required": false, "schema": { "title": "service", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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." } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWebacsApiV4OpApiHealthCallsPerClient" }, "task": true }, { "name": "getWebacsApiV4OpApiHealthRequestCountTrend", "summary": "GET API Request Count Trend\nGET op/apiHealth/requestCountTrend", "description": "GET API Request Count Trend\nGET op/apiHealth/requestCountTrend", "input": [ { "name": "service", "type": "string", "info": "The service path. If unspecified, data will be returned for all services.: string", "required": false, "schema":