{ "id": "@itentialopensource/adapter-velocloud_orchestrator", "type": "Adapter", "export": "VelocloudOrchestrator", "title": "VelocloudOrchestrator", "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" } } ], "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": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "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 Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform 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": "loginOperatorLogin", "summary": "Authenticate operator user", "description": "Authenticates an operator user and, upon successful login, returns a velocloud.session cookie. Pass this session cookie in the authentication header in subsequent VCO calls.\n If you are using an HTTP client (e.g. Postman) that is configured to automatically follow HTTP redirects, a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie can then be used to make VCO API calls.\n Note that session cookies expire aft...(description truncated)", "input": [ { "name": "authorization", "type": "object", "info": ": object", "required": true, "schema": { "title": "authorization", "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": "/loginOperatorLogin" }, "task": true }, { "name": "loginEnterpriseLogin", "summary": "Authenticate enterprise or partner (MSP) user", "description": "Authenticates an enterprise or partner (MSP) user and, upon successful login, returns a velocloud.session cookie. Pass this session cookie in the authentication header in subsequent VCO calls.\n If you are using an HTTP client (e.g. Postman) that is configured to automatically follow HTTP redirects, a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie can then be used to make VCO API calls.\n Note that session ...(description truncated)", "input": [ { "name": "authorization", "type": "object", "info": ": object", "required": true, "schema": { "title": "authorization", "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": "/loginEnterpriseLogin" }, "task": true }, { "name": "postLogout", "summary": "Logout and invalidate authorization session cookie", "description": "Logs out the VCO API user and invalidates the session cookie.", "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": "/postLogout" }, "task": true }, { "name": "postMetaApiPath", "summary": "Get Swagger specification for any VCO API call", "description": "Gets the Swagger specification for any VCO API call.", "input": [ { "name": "apiPath", "type": "string", "info": "the path to another api method, starting after /rest/: string", "required": true, "schema": { "title": "apiPath", "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": "/postMetaApiPath" }, "task": true }, { "name": "configurationCloneEnterpriseTemplate", "summary": "Clone default enterprise configuration profile", "description": "Creates a new enterprise configuration from the enterprise default configuration. On success, returns the `id` of the newly created configuration object.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationCloneEnterpriseTemplate" }, "task": true }, { "name": "configurationDeleteConfiguration", "summary": "Delete configuration profile", "description": "Deletes the specified configuration profile (by `id`). On success, returns an object indicating the number of objects (rows) deleted (1 or 0).\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_PROFILE`, or\n\n`DELETE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationDeleteConfiguration" }, "task": true }, { "name": "configurationGetConfiguration", "summary": "Get configuration profile", "description": "Gets the specified configuration profile, optionally with module details.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationGetConfiguration" }, "task": true }, { "name": "configurationGetIdentifiableApplications", "summary": "Get the applications that are identifiable through DPI.", "description": "Gets all applications that are identifiable through DPI. If called from an operator or MSP context, then `enterpriseId` is required.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationGetIdentifiableApplications" }, "task": true }, { "name": "configurationGetRoutableApplications", "summary": "Get first packet routable applications", "description": "Gets all applications that are first packet routable. If called from an operator or MSP context, then `enterpriseId` is required.Optionally, specify `edgeId` to get the map for a specific Edge.\n\nPrivileges required:\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationGetRoutableApplications" }, "task": true }, { "name": "disasterRecoveryConfigureActiveForReplication", "summary": "Configure current VCO for disaster recovery", "description": "Configures the current Orchestrator to be active and the specified Orchestrator to be standby for Orchestrator disaster recovery replication. Required attributes: 1) `standbyList`, a single-entry array containing the `standbyAddress` and `standbyUuid`, 2) `drVCOUser`, a Orchestrator super user available on both the active and standby VCOs, and 3) `drVCOPassword`, the password of `drVCOUser` on the standby Orchestrator (unless the `autoConfigStandby` option is specified as `false`). The call sets...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryConfigureActiveForReplication" }, "task": true }, { "name": "disasterRecoveryDemoteActive", "summary": "Demote current VCO from active to zombie", "description": "Demotes the current VCO from active to zombie. No input parameters are required. The active server is expected to be in the `drState` `FAILURE_GET_STANDBY_STATUS` or `FAILURE_MYSQL_ACTIVE_STATUS`, meaning that DR protection had been engaged (with the last successful replication status observed at `lastDRProtectedTime`) but that active failed a health check since that time. If the active server is in the `drState` `STANDBY_RUNNING`, meaning that it has detected no problems in interacting with th...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryDemoteActive" }, "task": true }, { "name": "disasterRecoveryGetReplicationBlob", "summary": "Get blob needed to configure VCO replication on standby", "description": "Gets from the active Orchestrator the blob needed to configure replication on the standby. Used only when `configureActiveForReplication` was called with `autoConfigStandby` set to `false` [`true` by default].\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryGetReplicationBlob" }, "task": true }, { "name": "disasterRecoveryGetReplicationStatus", "summary": "Get disaster recovery status", "description": "Gets the disaster recovery replication status, optionally with client contact, state transition history, and storage information. No input parameters are required. Can optionally specify one or more of the following `with` parameters: `clientContact`, `clientCount`, `stateHistory`, and `storageInfo`.\n\nPrivileges required:\n\n`READ` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryGetReplicationStatus" }, "task": true }, { "name": "disasterRecoveryPrepareForStandby", "summary": "Designate current VCO as DR standby candidate", "description": "Transitions the current Orchestrator to a quiesced state, ready to be configured as a standby system. No input parameters are required. After this call, the Orchestrator will be restarted in standby mode. The caller should subsequently poll `getReplicationStatus` until `drState` is `STANDBY_CANDIDATE`. This is the first step in configuring Orchestrator disaster recovery.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryPrepareForStandby" }, "task": true }, { "name": "disasterRecoveryPromoteStandbyToActive", "summary": "Promote standby VCO to active", "description": "Promotes the current server to take over as the single standalone VCO. The current server is expected to be a standby in the `drState` `FAILURE_MYSQL_STANDBY_STATUS`, meaning that DR protection had been engaged (with the last successful replication status observed at `lastDRProtectedTime`), but that standby has been unable to replicate since that time.\n If the standby server is in the `drState` `STANDBY_RUNNING`, meaning that it has detected no problems in replicating from the active server, th...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryPromoteStandbyToActive" }, "task": true }, { "name": "disasterRecoveryRemoveStandby", "summary": "Remove VCO disaster recovery on current server", "description": "Removes disaster recovery on the current server. In addition, makes a best-effort call to `removeStandby` on the paired disaster recovery server. No input parameters are required.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryRemoveStandby" }, "task": true }, { "name": "disasterRecoveryTransitionToStandby", "summary": "Transition VCO to standby", "description": "Configures the current Orchestrator to transition to standby in a disaster recovery active/standby pair. Requires the `activeAccessFromStandby` parameter that contains the data needed to configure standby. This data is produced by `configureActiveForReplication`, which by default automatically calls `transitionToStandby`; an explicit call is needed (with a blob obtained from `getReplicationBlob`), only if `configureActiveForReplication` is called with `autoConfigStandby` set to `false`.\n\nPrivile...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/disasterRecoveryTransitionToStandby" }, "task": true }, { "name": "edgeDeleteEdge", "summary": "Delete Edge", "description": "Deletes the specified Edge(s) (by `id` or an array of `ids`).\n\nPrivileges required:\n\n`DELETE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeDeleteEdge" }, "task": true }, { "name": "edgeDeleteEdgeBgpNeighborRecords", "summary": "Delete Edge BGP neighbor records", "description": "Deletes BGP record(s) matching the specified record keys (`neighborIp`) on the Edges with the specified `edgeId`s, if they exist.\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeDeleteEdgeBgpNeighborRecords" }, "task": true }, { "name": "edgeSetEdgeEnterpriseConfiguration", "summary": "Apply configuration profile to Edge", "description": "Sets the enterprise configuration for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeSetEdgeEnterpriseConfiguration" }, "task": true }, { "name": "edgeSetEdgeHandOffGateways", "summary": "Set Edge on premise hand-off gateway(s)", "description": "Sets the on-premise hand off gateways for the specified Edge (by `edgeId`). A primary and secondary gateway are defined. The primary is required, the secondary is optional. Moves all existing Edge-gateway hand-off relationships and replaces them with the specified primary and secondary gateways.\n\nPrivileges required:\n\n`UPDATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeSetEdgeHandOffGateways" }, "task": true }, { "name": "edgeSetEdgeOperatorConfiguration", "summary": "Apply operator profile to Edge", "description": "Sets the operator configuration for the specified Edge (by `edgeId`). This overrides any enterprise-assigned operator configuration and the network default operator configuration.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeSetEdgeOperatorConfiguration" }, "task": true }, { "name": "enterpriseDeleteEnterprise", "summary": "Delete enterprise", "description": "Deletes the specified enterprise (by `id` or `enterpriseId`).\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDeleteEnterprise" }, "task": true }, { "name": "enterpriseDeleteEnterpriseGatewayRecords", "summary": "Delete gateway BGP neighbor record(s) for enterprise", "description": "Deletes the enterprise gateway BGP neighbor record(s) matching the specified gateway id(s) (`gatewayId`) and neighbor IP addresses (`neighborIp`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDeleteEnterpriseGatewayRecords" }, "task": true }, { "name": "enterpriseDeleteEnterpriseNetworkAllocation", "summary": "Delete enterprise network allocation", "description": "Deletes the specified enterprise network allocation (by `id`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDeleteEnterpriseNetworkAllocation" }, "task": true }, { "name": "enterpriseDeleteEnterpriseNetworkSegment", "summary": "Delete an enterprise network segment", "description": "Delete an enterprise network segment, by id.\n\nPrivileges required:\n\n`DELETE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDeleteEnterpriseNetworkSegment" }, "task": true }, { "name": "enterpriseDeleteEnterpriseService", "summary": "Delete enterprise network service", "description": "Deletes the specified enterprise network service (by `id`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDeleteEnterpriseService" }, "task": true }, { "name": "enterpriseGetEnterpriseAddresses", "summary": "Get enterprise IP address(es)", "description": "Gets all public IP address information for the management and control entities associated with the specified enterprise, including Orchestrator(s), Gateway(s), and datacenter(s).\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseAddresses" }, "task": true }, { "name": "enterpriseGetEnterpriseAlertConfigurations", "summary": "Get enterprise alert configuration(s)", "description": "Gets all alert configuration(s) for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseAlertConfigurations" }, "task": true }, { "name": "enterpriseGetEnterpriseAlerts", "summary": "Get triggered enterprise alerts", "description": "Gets past triggered alerts for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseAlerts" }, "task": true }, { "name": "enterpriseGetEnterpriseAllAlertRecipients", "summary": "Get recipients receiving all enterprise alerts", "description": "Gets all recipients configured to receive all alerts for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseAllAlertRecipients" }, "task": true }, { "name": "enterpriseGetEnterpriseConfigurations", "summary": "Get enterprise configuration profiles", "description": "Gets all configuration profiles, with optional Edge and/or module details, for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseConfigurations" }, "task": true }, { "name": "enterpriseGetEnterpriseNetworkAllocations", "summary": "Get enterprise network allocations", "description": "Gets all network allocations for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseNetworkAllocations" }, "task": true }, { "name": "enterpriseGetEnterpriseNetworkSegments", "summary": "Get all network segment objects defined on an enterprise", "description": "Retrieve a list of all of the network segments defined forthe given enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseNetworkSegments" }, "task": true }, { "name": "enterpriseGetEnterpriseRouteConfiguration", "summary": "Get enterprise global routing preferences", "description": "Gets all global routing preferences for the specified enterprise, incuding enterprise route advertisement, routing preferences, OSPF, and BGP advertisement policy.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseRouteConfiguration" }, "task": true }, { "name": "enterpriseGetEnterpriseRouteTable", "summary": "Get enterprise route table", "description": "Gets the composite enterprise route table, optionally scoped by profile(s). The returned routes include static routes, directly connected routes, and learned routes.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseRouteTable" }, "task": true }, { "name": "enterpriseGetEnterpriseServices", "summary": "Get enterprise network services", "description": "Gets all network service JSON objects defined for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseServices" }, "task": true }, { "name": "enterpriseInsertEnterpriseService", "summary": "Create enterprise service", "description": "Creates a new enterprise service for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertEnterpriseService" }, "task": true }, { "name": "enterpriseInsertOrUpdateEnterpriseAlertConfigurations", "summary": "Create, update, or delete enterprise alert configurations", "description": "Creates, updates, or deletes alert configurations for the specified enterprise. Returns the array of alert configurations submitted, with ids added for the entries that have been successfully created. If an entry is not successfully created or updated, an `error` property is included in the response.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertOrUpdateEnterpriseAlertConfigurations" }, "task": true }, { "name": "enterpriseSetEnterpriseAllAlertRecipients", "summary": "Specify recipients for all enterprise alerts", "description": "Specifies the recipients who should receive all alerts for the specified enterprise.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseSetEnterpriseAllAlertRecipients" }, "task": true }, { "name": "enterpriseSetEnterpriseOperatorConfiguration", "summary": "Apply operator profile to given enterprise", "description": "Sets the operator configuration for the specified enterprise (by `enterpriseId`). This overrides any network-assigned operator configuration and the network default operator configuration.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseSetEnterpriseOperatorConfiguration" }, "task": true }, { "name": "enterpriseUpdateEnterpriseRoute", "summary": "Update preferred VPN exits for a route", "description": "Updates the specified enterprise route, set advertisement, and cost values. Required parameters include the original route, as returned by `enterprise/getEnterpriseRouteTable`, and the updated route with modified advertisement and route preference ordering.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseRoute" }, "task": true }, { "name": "enterpriseUpdateEnterpriseRouteConfiguration", "summary": "Update enterprise global routing preferences", "description": "Updates the specified enterprise global routing preferences as specified by configuration `id` or logicalId.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseRouteConfiguration" }, "task": true }, { "name": "enterpriseUpdateEnterpriseService", "summary": "Update enterprise network service", "description": "Updates the enterprise service for the specified enterprise (by `id` or `enterpriseId`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseService" }, "task": true }, { "name": "enterpriseProxyDeleteEnterpriseProxyUser", "summary": "Delete partner admin user", "description": "Deletes the specified enterprise proxy user (by `id` or `username`). Note: `enterpriseProxyId` is a required parameter when invoking this method as an operator or as a partner user.\n\nPrivileges required:\n\n`DELETE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyDeleteEnterpriseProxyUser" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyEdgeInventory", "summary": "Get partner enterprises and associated Edge inventory", "description": "Gets all partner enterprises and their associated Edge inventory.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyEdgeInventory" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyEnterprises", "summary": "Get partner enterprises", "description": "Gets all partner enterprises. Optionally includes all Edges or Edge counts.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyEnterprises" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyGatewayPools", "summary": "Get gateway pools", "description": "Gets all gateway pools associated with the specified enterprise proxy. Optionally includes all gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyGatewayPools" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyOperatorProfiles", "summary": "Get partner operator profiles", "description": "Gets all operator profiles associated with the specified partner (MSP), as assigned by the operator.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyOperatorProfiles" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyUser", "summary": "Get enterprise proxy user", "description": "Gets the specified enterprise proxy user (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `PROXY_USER`\n\n`READ` `PROXY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyUser" }, "task": true }, { "name": "enterpriseProxyInsertEnterpriseProxyUser", "summary": "Create partner admin user", "description": "Creates a new partner admin user.\n\nPrivileges required:\n\n`CREATE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyInsertEnterpriseProxyUser" }, "task": true }, { "name": "enterpriseProxyUpdateEnterpriseProxyUser", "summary": "Update enterprise proxy admin user", "description": "Updates the specified enterprise proxy admin user (by object `id` or other identifying attribute). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyUpdateEnterpriseProxyUser" }, "task": true }, { "name": "enterpriseUserDeleteEnterpriseUser", "summary": "Delete enterprise user", "description": "Deletes the specified enterprise user (by `id` or `username`). Note: `enterpriseId` is a required parameter when invoking this method as an operator or as a partner user.\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUserDeleteEnterpriseUser" }, "task": true }, { "name": "enterpriseUserGetEnterpriseUser", "summary": "Get enterprise user", "description": "Gets the specified enterprise user (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUserGetEnterpriseUser" }, "task": true }, { "name": "enterpriseUserUpdateEnterpriseUser", "summary": "Update enterprise user", "description": "Updates the specified enterprise user (by object `id` or other identifying attribute). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_USER`, or\n\n`UPDATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUserUpdateEnterpriseUser" }, "task": true }, { "name": "metricsGetEdgeAppLinkMetrics", "summary": "Get flow metric aggregate data", "description": "Gets flow metric summaries for the specified time interval by link. On success, this method returns an array of flow data in which each entry corresponds to a link on the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeAppLinkMetrics" }, "task": true }, { "name": "metricsGetEdgeAppLinkSeries", "summary": "Get flow metric time series data", "description": "Gets flow metric time series data for the specified time interval by link. On success, this method returns an array of flow data in which each entry corresponds to a link on the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeAppLinkSeries" }, "task": true }, { "name": "metricsGetEdgeAppMetrics", "summary": "Get flow metric aggregate data by application", "description": "Gets flow metric summaries for the specified Edge over the specified time interval by application. On success, this method returns an array of flow data in which each entry corresponds to a single application.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeAppMetrics" }, "task": true }, { "name": "metricsGetEdgeAppSeries", "summary": "Get flow metric time series data by application", "description": "Gets flow metric time series data for the specified time interval by application. On success, this method returns an array of flow data in which each entry corresponds to a single application.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeAppSeries" }, "task": true }, { "name": "metricsGetEdgeCategoryMetrics", "summary": "Get flow metric aggregate data by application category", "description": "Gets flow metric summaries for the specified time interval by application category. On success, this method returns an array of flow data in which each entry corresponds to a category of application traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeCategoryMetrics" }, "task": true }, { "name": "metricsGetEdgeCategorySeries", "summary": "Get flow metric time series data by application category", "description": "Gets flow metric time series data for the specified time interval by application category. On success, this method returns an array of flow data in which each entry corresponds to a category of application traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeCategorySeries" }, "task": true }, { "name": "metricsGetEdgeDestMetrics", "summary": "Get flow metric aggregate data by destination", "description": "Gets flow metric summaries for the specified time interval by destination. On success, this method returns an array of flow data in which each entry corresponds to a distinct traffic destination. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeDestMetrics" }, "task": true }, { "name": "metricsGetEdgeDestSeries", "summary": "Get flow metric time series data by destination", "description": "Gets flow metric time series data for the specified time interval by destination. On success, this method returns an array of flow data in which each entry corresponds to a distinct traffic destination. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeDestSeries" }, "task": true }, { "name": "metricsGetEdgeDeviceMetrics", "summary": "Get flow metric aggregate data by client device", "description": "Gets flow metric summaries for the specified time interval by client device. On success, this method returns an array of flow data in which each entry corresponds to a distinct device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeDeviceMetrics" }, "task": true }, { "name": "metricsGetEdgeDeviceSeries", "summary": "Get flow metric time series data by client device", "description": "Gets flow metric time series data for the specified time interval by client device. On success, this method returns an array of flow data in which each entry corresponds to a distinct device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeDeviceSeries" }, "task": true }, { "name": "metricsGetEdgeLinkMetrics", "summary": "Get summary link metrics for an Edge", "description": "Fetches summary transport metrics by link for the specified Edge over the specified time interval. On success, this method returns an array where each entry corresponds to a WAN link for which the Edge reported some activity over the time period covered by the request interval.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeLinkMetrics" }, "task": true }, { "name": "metricsGetEdgeLinkSeries", "summary": "Get link metric time series data for an Edge", "description": "Fetches link/transport metric time series data for WAN links belonging to the specified Edge over the specified interval. On success, this method returns an array where each entry corresponds to a link on the specified Edge.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeLinkSeries" }, "task": true }, { "name": "metricsGetEdgeOsMetrics", "summary": "Get flow metric aggregate data by client OS", "description": "Gets flow metric summaries for the specified time interval by client OS. On success, this method returns an array of flow data in which each entry corresponds to a distinct OS on a client device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeOsMetrics" }, "task": true }, { "name": "metricsGetEdgeOsSeries", "summary": "Get flow metric time series data by client OS", "description": "Gets flow metric time series data for the specified time interval by client OS. On success, this method returns an array of flow data in which each entry corresponds to a distinct OS on a client device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeOsSeries" }, "task": true }, { "name": "metricsGetEdgeSegmentMetrics", "summary": "Get flow metric aggregate data by segment Id", "description": "Gets flow metric summaries for the specified time interval by segment id. On success, this method returns an array of flow data where each entry corresponds to a segment id traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeSegmentMetrics" }, "task": true }, { "name": "metricsGetEdgeSegmentSeries", "summary": "Get flow metric time series data by segment id", "description": "Gets flow metric time series data for the specified time interval by segment id. On success, this method returns an array of flow data in which each entry corresponds to a segment id of traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeSegmentSeries" }, "task": true }, { "name": "metricsGetEdgeStatusMetrics", "summary": "Get Edge healthStats metrics for an interval", "description": "Fetch healthStats metric summaries for the given edge, time interval and list of metrics. On success, this method returns anhealthsStats object with min, max and average values of requested metrics\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeStatusMetrics" }, "task": true }, { "name": "metricsGetEdgeStatusSeries", "summary": "Get Edge healthStats time series for an interval", "description": "Fetch healthStats time series for the given edge, time interval and list of metrics. On success, this method returns anarray of healthsStats series of requested metrics\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetEdgeStatusSeries" }, "task": true }, { "name": "metricsGetGatewayStatusMetrics", "summary": "Get Gateway health metric summaries for an interval", "description": "Fetch health metric summaries given a target gateway, time interval and list of metrics. On success, this method returns an object containing min, max and average values of requested metrics\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetGatewayStatusMetrics" }, "task": true }, { "name": "metricsGetGatewayStatusSeries", "summary": "Get Gateway health metric time series for an interval", "description": "Fetch health metric time series given a target gateway, time interval and list of metrics. On success, this method returns an array of time series, one per metric.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/metricsGetGatewayStatusSeries" }, "task": true }, { "name": "monitoringGetAggregateEdgeLinkMetrics", "summary": "Get aggregate Edge link metrics across enterprises", "description": "Gets aggregate link/transport metrics for all active Edge WAN links (across all Edges available for the specified Enterprises) over the specified interval. A link is considered to be active if an Edge has reported any activity for it in the last 24 hours. On success, this method returns an array of network utilization metrics where each element corresponds to a link.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetAggregateEdgeLinkMetrics" }, "task": true }, { "name": "monitoringGetAggregateEnterpriseEvents", "summary": "Get events across all enterprises", "description": "Gets events across all enterprises in a paginated list. When called in the MSP/Partner context, queries only enterprises managed by the MSP.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetAggregateEnterpriseEvents" }, "task": true }, { "name": "monitoringGetAggregates", "summary": "Get aggregate enterprise and Edge information", "description": "Gets a comprehensive listing of all enterprises and Edges on a network. Returns an object containing an aggregate `edgeCount`, a list (`enterprises`) containing enterprise objects, and a map (`edges`) that provides Edge counts per enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetAggregates" }, "task": true }, { "name": "monitoringGetEnterpriseBgpPeerStatus", "summary": "Get gateway BGP peer status for all enterprise gateways", "description": "Gets the gateway BGP peer status for all enterprise gateways. Returns an array in which each entry corresponds to a gateway and contains an associated set of BGP peers with state records.\n\nPrivileges required:\n\n`READ` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetEnterpriseBgpPeerStatus" }, "task": true }, { "name": "monitoringGetEnterpriseEdgeBgpPeerStatus", "summary": "Get Edge BGP peer status for all enterprise Edges", "description": "Gets the Edge BGP peer status for all enterprise Edges. Returns an array in which each entry corresponds to an Edge and contains an associated set of BGP peers and state records.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetEnterpriseEdgeBgpPeerStatus" }, "task": true }, { "name": "monitoringGetEnterpriseEdgeClusterStatus", "summary": "Get Edge Cluster status", "description": "Get edge`s utilization data by clusters\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetEnterpriseEdgeClusterStatus" }, "task": true }, { "name": "monitoringGetEnterpriseEdgeLinkStatus", "summary": "Get Edge and link status data", "description": "Gets the current Edge and Edge-link status for all enterprises. edges.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/monitoringGetEnterpriseEdgeLinkStatus" }, "task": true }, { "name": "networkGetNetworkConfigurations", "summary": "Get operator configuration profiles", "description": "Gets all operator configuration profiles associated with an operator's network. Optionally includes the modules associated with each profile. This call does not return templates.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkGetNetworkConfigurations" }, "task": true }, { "name": "networkGetNetworkEnterprises", "summary": "Get enterprises on network", "description": "Gets all enterprises existing on a network, optionally including all Edges or Edge counts. The `edgeConfigUpdate` \"with\" option may also be passed to check whether the application of configuration updates to Edges is enabled for each enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkGetNetworkEnterprises" }, "task": true }, { "name": "networkGetNetworkGatewayPools", "summary": "Get gateway pools on network", "description": "Gets all gateway pools associated with the specified network. Optionally includes the gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkGetNetworkGatewayPools" }, "task": true }, { "name": "networkGetNetworkOperatorUsers", "summary": "Get operator users for network", "description": "Gets all operator users associated with the specified network.\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkGetNetworkOperatorUsers" }, "task": true }, { "name": "operatorUserDeleteOperatorUser", "summary": "Delete operator user", "description": "Deletes the specified operator user (by `id` or `username`).\n\nPrivileges required:\n\n`DELETE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/operatorUserDeleteOperatorUser" }, "task": true }, { "name": "operatorUserGetOperatorUser", "summary": "Get operator user", "description": "Gets the specified operator user object (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/operatorUserGetOperatorUser" }, "task": true }, { "name": "operatorUserInsertOperatorUser", "summary": "Create operator user", "description": "Creates an operator user and associates it with the operator's network.\n\nPrivileges required:\n\n`CREATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/operatorUserInsertOperatorUser" }, "task": true }, { "name": "operatorUserUpdateOperatorUser", "summary": "Update operator user", "description": "Updates the specified operator user (by object `id` or `username`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/operatorUserUpdateOperatorUser" }, "task": true }, { "name": "roleCreateRoleCustomization", "summary": "Create role customization", "description": "Creates a role customization specified by `roleId` and an array of `privilegeIds`.\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleCreateRoleCustomization" }, "task": true }, { "name": "roleDeleteRoleCustomization", "summary": "Delete role customization", "description": "Deletes the specified role customization (by `name` or `forRoleId`).\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleDeleteRoleCustomization" }, "task": true }, { "name": "roleGetUserTypeRoles", "summary": "Get roles per user type", "description": "Gets all roles defined for the specified `userType`.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_USER`, or\n\n`READ` `PROXY_USER`, or\n\n`READ` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleGetUserTypeRoles" }, "task": true }, { "name": "vcoDiagnosticsGetVcoDbDiagnostics", "summary": "Get VCO Database Diagnostics", "description": "Gets the diagnostic information of the VCO database.\n\nPrivileges required:\n\n`READ` `VCO_DIAGNOSTICS`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/vcoDiagnosticsGetVcoDbDiagnostics" }, "task": true }, { "name": "vcoInventoryAssociateEdge", "summary": "Assign Edge to enterprise", "description": "Assigns an Edge in the inventory to the specified enterprise. To perform the action, the Edge should already be in a `STAGING` state. The assignment can be done at an enterprise level, without selecting a destination Edge profile. In such a case, the inventory Edge is assigned to a staging profile within the enterprise. Optionally, a profile or destination Edge can be assigned to this inventory Edge. The Edge in the inventory can be assigned to any profile. The inventory Edge can be assigned to ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/vcoInventoryAssociateEdge" }, "task": true }, { "name": "vcoInventoryGetInventoryItems", "summary": "Get available VCO inventory items", "description": "Gets all of the inventory information available with this VCO. This method does not have required parameters. The optional parameters are\n`enterpriseId` - Returns inventory items belonging to the specified enterprise. If the caller context is an enterprise, then this value will be taken from the token itself.\n`modifiedSince` - Returns inventory items that have been modified in the last `modifiedSince` hours.\n`with` - Array containing the string \"edge\" to get details about the provisioned Edge, ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/vcoInventoryGetInventoryItems" }, "task": true }, { "name": "vpnGenerateVpnGatewayConfiguration", "summary": "Provision a non-SD-WAN VPN site", "description": "Provision a non-SD-WAN site (e.g. a data center or cloud service PoP) and generate VPN configuration.\n\nPrivileges required:\n\n`CREATE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/vpnGenerateVpnGatewayConfiguration" }, "task": true }, { "name": "setClientDeviceHostName", "summary": "Set hostname for client device", "description": "Sets the `hostName` for client device\n\nPrivileges required:\n\n`UPDATE` `CLIENT_DEVICE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/setClientDeviceHostName" }, "task": true }, { "name": "configurationCloneAndConvertConfiguration", "summary": "Create new segment-based profile from existing network-based profile", "description": "Clones and converts the specified network configuration (by `configurationId`). Accepts an `enterpriseId` or `networkId` to associate the new configuration with an enterprise or network. On success, returns the ID of the newly created configuration object.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationCloneAndConvertConfiguration" }, "task": true }, { "name": "configurationCloneConfiguration", "summary": "Clone configuration profile", "description": "Clones the specified configuration (by `configurationId`) and all associated configuration modules. Accepts an `enterpriseId` or `networkId` to associate the new configuration with an enterprise or network. Select modules may also be specified. On success, returns the `id` of the newly created configuration object.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationCloneConfiguration" }, "task": true }, { "name": "configurationGetConfigurationModules", "summary": "Get configuration profile modules", "description": "Gets all configuration modules for the specified configuration profile.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationGetConfigurationModules" }, "task": true }, { "name": "configurationInsertConfigurationModule", "summary": "Create configuration module", "description": "Creates a new configuration module for the specified configuration profile.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationInsertConfigurationModule" }, "task": true }, { "name": "configurationUpdateConfiguration", "summary": "Update configuration profile", "description": "Updates the specified configuration profile record according to the attribute:value mappings specified in the `_update` object.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationUpdateConfiguration" }, "task": true }, { "name": "configurationUpdateConfigurationModule", "summary": "Update configuration module", "description": "Updates the specified configuration module. Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). For most use cases, configuration module `data` should be the only module attribute that it is necessary to update. This method does not support partial updates on specific sub-sections of the `data` object.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/configurationUpdateConfigurationModule" }, "task": true }, { "name": "edgeEdgeCancelReactivation", "summary": "Cancel pending Edge reactivation request", "description": "Cancels a pending Edge reactivation request for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeEdgeCancelReactivation" }, "task": true }, { "name": "edgeEdgeProvision", "summary": "Provision Edge", "description": "Provisions an Edge before activation.\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeEdgeProvision" }, "task": true }, { "name": "edgeEdgeRequestReactivation", "summary": "Prepare Edge for reactivation", "description": "Updates the activation state of the specified Edge to `REACTIVATION_PENDING`.\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeEdgeRequestReactivation" }, "task": true }, { "name": "edgeGetClientVisibilityMode", "summary": "Get an edge's client visibility mode", "description": "Retrieve an edge's client visibility mode.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeGetClientVisibilityMode" }, "task": true }, { "name": "edgeGetEdge", "summary": "Get Edge", "description": "Gets the specified Edge with optional link, site, configuration, certificate, orenterprise details. Supports queries by Edge `id`, `deviceId`, `activationKey`, and `logicalId`.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeGetEdge" }, "task": true }, { "name": "edgeGetEdgeActivationEmail", "summary": "Get Edge Activation E-mail", "description": "Gets edge activation e-mail.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeGetEdgeActivationEmail" }, "task": true }, { "name": "edgeGetEdgeConfigurationModules", "summary": "Get edge configuration modules", "description": "Gets edge composite configuration modules for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeGetEdgeConfigurationModules" }, "task": true }, { "name": "edgeGetEdgeConfigurationStack", "summary": "Get Edge configuration stack", "description": "Gets the complete configuration profile (including all modules) of the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeGetEdgeConfigurationStack" }, "task": true }, { "name": "edgeSendEdgeActivationEmail", "summary": "Get Edge", "description": "Send edge activation e-mail.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeSendEdgeActivationEmail" }, "task": true }, { "name": "edgeUpdateEdgeAdminPassword", "summary": "Update Edge local UI authentication credentials", "description": "Requests an update to the Edge's local UI authentication credentials. On success, returns a JSON object with the ID of the action queued, the status of which can be queried using the `edgeAction/getEdgeAction` API.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_KEYS`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeUpdateEdgeAdminPassword" }, "task": true }, { "name": "edgeUpdateEdgeAttributes", "summary": "Update Edge attributes", "description": "Updates basic attributes (including Edge name, description, site information, and serial number) for the specified Edge. Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeUpdateEdgeAttributes" }, "task": true }, { "name": "edgeUpdateEdgeCredentialsByConfiguration", "summary": "Update Edge local UI credentials by configuration profile", "description": "Requests an update to the Edge-local UI authentication credentials for all Edges belonging to the specified configuration profile. On success, returns a JSON object containing a list of each of the action IDs queued.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_KEYS`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/edgeUpdateEdgeCredentialsByConfiguration" }, "task": true }, { "name": "enterpriseDecodeEnterpriseKey", "summary": "Decrypt an enterprise key", "description": "Decrypt an enterprise key\n\nPrivileges required:\n\n`READ` `ENTERPRISE_KEYS`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseDecodeEnterpriseKey" }, "task": true }, { "name": "enterpriseEncodeEnterpriseKey", "summary": "Encrypt an enterprise key", "description": "Encrypt an enterprise key\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_KEYS`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseEncodeEnterpriseKey" }, "task": true }, { "name": "enterpriseGetEnterprise", "summary": "Get enterprise", "description": "Gets data for the specified enterprise with optional proxy (partner) detail.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterprise" }, "task": true }, { "name": "enterpriseGetEnterpriseCapabilities", "summary": "Get enterprise capabilities", "description": "Gets all enterprise capabilities (e.g. BGP, COS mapping, PKI, etc.) currently enabled/disabled for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseCapabilities" }, "task": true }, { "name": "enterpriseGetEnterpriseEdges", "summary": "Get enterprise Edges", "description": "Gets all Edges associated with the specified enterprise, including optional site, link, and configuration details.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseEdges" }, "task": true }, { "name": "enterpriseGetEnterpriseGatewayHandoff", "summary": "Get enterprise gateway handoff configuration", "description": "Gets the gateway handoff configuration for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseGatewayHandoff" }, "task": true }, { "name": "enterpriseGetEnterpriseMaximumSegments", "summary": "Get enterprise maximum segment", "description": "Gets maximum segments for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseMaximumSegments" }, "task": true }, { "name": "enterpriseGetEnterpriseNetworkAllocation", "summary": "Get enterprise network allocation", "description": "Gets the specified network allocation object (by `id`) for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseNetworkAllocation" }, "task": true }, { "name": "enterpriseGetEnterpriseProperty", "summary": "Get enterprise property", "description": "Get a enterprise property by object id or other attribute.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseProperty" }, "task": true }, { "name": "enterpriseInsertEnterprise", "summary": "Create enterprise", "description": "Creates a new enterprise, which is owned by the operator.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertEnterprise" }, "task": true }, { "name": "enterpriseInsertEnterpriseNetworkAllocation", "summary": "Create enterprise network allocation", "description": "Creates a new network allocation for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertEnterpriseNetworkAllocation" }, "task": true }, { "name": "enterpriseInsertEnterpriseNetworkSegment", "summary": "Create enterprise network segment", "description": "Creates a new network segment for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertEnterpriseNetworkSegment" }, "task": true }, { "name": "enterpriseInsertOrUpdateEnterpriseCapability", "summary": "Create or update enterprise capability", "description": "Creates or updates the specified capability (`name`, `value`) for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertOrUpdateEnterpriseCapability" }, "task": true }, { "name": "enterpriseInsertOrUpdateEnterpriseGatewayHandoff", "summary": "Create or update enterprise gateway handoff configuration", "description": "Creates or updates a gateway handoff configuration for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`\n\n`UPDATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertOrUpdateEnterpriseGatewayHandoff" }, "task": true }, { "name": "enterpriseInsertOrUpdateEnterpriseProperty", "summary": "Insert or update an enterprise property", "description": "Insert a enterprise property. If property with the given name already exists, the property will be updated.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertOrUpdateEnterpriseProperty" }, "task": true }, { "name": "enterpriseSetEnterpriseMaximumSegments", "summary": "Set enterprise maximum segments", "description": "Set maximum segments for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseSetEnterpriseMaximumSegments" }, "task": true }, { "name": "enterpriseUpdateEnterprise", "summary": "Update enterprise", "description": "Updates the specified enterprise (by `enterpriseId` or `name`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterprise" }, "task": true }, { "name": "enterpriseUpdateEnterpriseNetworkAllocation", "summary": "Update enterprise network allocation", "description": "Updates the specified enterprise network allocation (by `id`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseNetworkAllocation" }, "task": true }, { "name": "enterpriseUpdateEnterpriseNetworkSegment", "summary": "Update an enterprise network segment", "description": "Update an enterprise network segment.\n\nPrivileges required:\n\n`UPDATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseNetworkSegment" }, "task": true }, { "name": "enterpriseUpdateEnterpriseSecurityPolicy", "summary": "Update enterprise security policy", "description": "Updates the security policy for the specified enterprise (by `enterpriseId`) using the passed in `ipsec` settings.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseUpdateEnterpriseSecurityPolicy" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyProperty", "summary": "Get enterprise proxy property", "description": "Get a enterprise proxy property by object id or other attribute.\n\nPrivileges required:\n\n`READ` `PROXY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyProperty" }, "task": true }, { "name": "enterpriseGetEnterpriseUsers", "summary": "Get enterprise users", "description": "Gets all enterprise users for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseGetEnterpriseUsers" }, "task": true }, { "name": "enterpriseInsertEnterpriseUser", "summary": "Create enterprise user", "description": "Creates a new enterprise user.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseInsertEnterpriseUser" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyUsers", "summary": "Get enterprise proxy admin users", "description": "Gets all proxy admin users for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyUsers" }, "task": true }, { "name": "enterpriseProxyGetEnterpriseProxyGateways", "summary": "Get gateways for enterprise proxy", "description": "Gets all gateways associated with the specified enterprise proxy.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyGetEnterpriseProxyGateways" }, "task": true }, { "name": "enterpriseProxyInsertEnterpriseProxyEnterprise", "summary": "Create enterprise owned by MSP", "description": "Creates a new enterprise owned by an MSP. Whereas the `insertEnterprise` method creates an enterprise in the global or network context with no MSP association, this method creates one owned by an MSP, as determined by the credentials of the caller.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyInsertEnterpriseProxyEnterprise" }, "task": true }, { "name": "enterpriseProxyInsertOrUpdateEnterpriseProxyProperty", "summary": "Insert or update an enterprise proxy (MSP) property", "description": "Insert a enterprise proxy property. If property with the given name already exists, the property will be updated.\n\nPrivileges required:\n\n`UPDATE` `PROXY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/enterpriseProxyInsertOrUpdateEnterpriseProxyProperty" }, "task": true }, { "name": "eventGetEnterpriseEvents", "summary": "Get Edge events", "description": "Gets Edge events in an enterprise or Edge context. Returns an array of Edge events sorted by `eventTime`..\n\nPrivileges required:\n\n`READ` `ENTERPRISE_EVENT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/eventGetEnterpriseEvents" }, "task": true }, { "name": "eventGetOperatorEvents", "summary": "Get operator events", "description": "Gets operator events by network ID (optional). If not specified, will be taken for the caller's security context. Optionally, use a filter object to limit the number of events returned. Additionally, specify a time interval with an interval object. If no end date is specified, then the default is the current date. Specify a `gatewayId` to filter events for the specified gateway.\n\nPrivileges required:\n\n`READ` `OPERATOR_EVENT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/eventGetOperatorEvents" }, "task": true }, { "name": "eventGetProxyEvents", "summary": "Fetch Partner events", "description": "Fetch Partner Events by enterprise ID. Optionally, a filter object to specify search criteria and limit on number of records. A time interval could be specified with an interval object. If no end date is given, it will default to the current date. Enterprise ID can be supplied to filter events to those of a specific enterprises.\n\nPrivileges required:\n\n`READ` `PROXY_EVENT`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/eventGetProxyEvents" }, "task": true }, { "name": "firewallGetEnterpriseFirewallLogs", "summary": "Get enterprise firewall logs", "description": "Gets firewall logs for the specified enterprise.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FIREWALL_LOGS` `undefined`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/firewallGetEnterpriseFirewallLogs" }, "task": true }, { "name": "gatewayDeleteGateway", "summary": "Delete a gateway", "description": "Delete a gateway by id.\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/gatewayDeleteGateway" }, "task": true }, { "name": "gatewayGatewayProvision", "summary": "Provision gateway", "description": "Provisions a gateway into the specified operator network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/gatewayGatewayProvision" }, "task": true }, { "name": "gatewayGetGatewayEdgeAssignments", "summary": "Get edge assignments for a gateway", "description": "Get edge assignments for a gateway\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/gatewayGetGatewayEdgeAssignments" }, "task": true }, { "name": "gatewayUpdateGatewayAttributes", "summary": "Update gateway attributes", "description": "Updates gateway attributes (`name`, `ipAddress`, on-premise parametrization, and `description`) and associated site attributes for the specified gateway (by `id`).\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/gatewayUpdateGatewayAttributes" }, "task": true }, { "name": "linkQualityEventGetLinkQualityEvents", "summary": "Get link quality (QoE) scores for an Edge", "description": "Fetch per-link and overall Quality of Experience scores for the specified Edge over the specified time interval. For each link, this method reports an aggregate `totalScore`, a `score` breakdown by traffic type, a `timeseries` composed of samples for which pre- and post-enhancement link states are recorded by traffic type, and quality state `distribution`s by traffic type. It also summarizes effective overall link quality scores across all links in the same format on the `overallLinkQuality` pro...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/linkQualityEventGetLinkQualityEvents" }, "task": true }, { "name": "networkDeleteNetworkGatewayPool", "summary": "Delete gateway pool", "description": "Deletes the specified gateway pool (by `id`).\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkDeleteNetworkGatewayPool" }, "task": true }, { "name": "networkGetNetworkGateways", "summary": "Get gateways on network", "description": "Gets all gateways associated with the specified network.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkGetNetworkGateways" }, "task": true }, { "name": "networkInsertNetworkGatewayPool", "summary": "Create gateway pool", "description": "Creates a gateway pool for the specified network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkInsertNetworkGatewayPool" }, "task": true }, { "name": "networkUpdateNetworkGatewayPoolAttributes", "summary": "Update gateway pool attributes", "description": "Updates the configurable attributes (`name`, `description`, and `handOffType`) of the specified gateway pool (by `id` or `gatewayPoolId`).\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/networkUpdateNetworkGatewayPoolAttributes" }, "task": true }, { "name": "roleSetEnterpriseDelegatedToEnterpriseProxy", "summary": "Grant enterprise access to partner", "description": "Grants enterprise access to the specified enterprise proxy (partner). When an enterprise is delegated to a proxy, proxy users are granted access to view, configure, and troubleshoot Edges owned by the enterprise. As a security consideration, proxy Support users cannot view personally identifiable information.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleSetEnterpriseDelegatedToEnterpriseProxy" }, "task": true }, { "name": "roleSetEnterpriseDelegatedToOperator", "summary": "Grant enterprise access to network operator", "description": "Grants enterprise access to the network operator. When an enterprise is delegated to the operator, operator users are permitted to view, configure, and troubleshoot Edges owned by the enterprise. As a security consideration, operator users cannot view personally identifiable information.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleSetEnterpriseDelegatedToOperator" }, "task": true }, { "name": "roleSetEnterpriseProxyDelegatedToOperator", "summary": "Grant enterprise proxy access to network operator", "description": "Grants enterprise proxy access to the network operator. When an enterprise proxy is delegated to the operator, operator users are granted access to view, configure and troubleshoot objects owned by the proxy.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROXY_DELEGATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleSetEnterpriseProxyDelegatedToOperator" }, "task": true }, { "name": "roleSetEnterpriseUserManagementDelegatedToOperator", "summary": "Grant enterprise user access to network operator", "description": "Grants enterprise user access to the specified network operator. When enterprise user management is delegated to the operator, operator users are granted enterprise-level user management capabilities (user creation, password resets, etc.).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/roleSetEnterpriseUserManagementDelegatedToOperator" }, "task": true }, { "name": "systemPropertyGetSystemProperties", "summary": "Get all system properties", "description": "Gets all configured system properties.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/systemPropertyGetSystemProperties" }, "task": true }, { "name": "systemPropertyGetSystemProperty", "summary": "Get system property", "description": "Gets the specified system property. Specify by object `id` or `name`.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/systemPropertyGetSystemProperty" }, "task": true }, { "name": "systemPropertyInsertOrUpdateSystemProperty", "summary": "Create or update system property", "description": "Creates the specified system property. If the system property with the specified `name` already exists, then the API call updates it.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/systemPropertyInsertOrUpdateSystemProperty" }, "task": true }, { "name": "systemPropertyInsertSystemProperty", "summary": "Create system property", "description": "Creates a new system property with the specified `name`, `value`, and optionally other attributes.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/systemPropertyInsertSystemProperty" }, "task": true }, { "name": "systemPropertyUpdateSystemProperty", "summary": "Update system property", "description": "Updates the specified system property (by object `id` or `name`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "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": "/systemPropertyUpdateSystemProperty" }, "task": true } ], "views": [] }