{ "id": "@itentialopensource/adapter-velocloud", "type": "Adapter", "export": "Velocloud", "title": "Velocloud", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "postLoginoperatorLogin", "summary": "Authentication for an operator user", "description": "", "input": [ { "name": "authorization", "type": "object", "info": "", "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": "/postLoginoperatorLogin" }, "task": true }, { "name": "postLoginenterpriseLogin", "summary": "Authentication for non-operator users", "description": "", "input": [ { "name": "authorization", "type": "object", "info": "", "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": "/postLoginenterpriseLogin" }, "task": true }, { "name": "postLogout", "summary": "Deactivate a given authorization cookie", "description": "", "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 meta-data on any other API call", "description": "", "input": [ { "name": "apiPath", "type": "string", "info": "the path to another api method, starting after /rest/", "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": "postConfigurationcloneEnterpriseTemplate", "summary": "Clone the default enterprise configuration profile", "description": "Creates a new enterprise configuration from the VCO enterprise default configuration. On success, returns an object 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": "", "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": "/postConfigurationcloneEnterpriseTemplate" }, "task": true }, { "name": "postConfigurationdeleteConfiguration", "summary": "Delete a configuration profile", "description": "Delete an existing configuration profile. On success, returns an object indicating the number of rows deleted.\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_PROFILE`, or\n\n`DELETE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationdeleteConfiguration" }, "task": true }, { "name": "postConfigurationgetConfiguration", "summary": "Get a configuration profile", "description": "Get a configuration profile, optionally with module detail.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationgetConfiguration" }, "task": true }, { "name": "postConfigurationgetRoutableApplications", "summary": "List applications that are first packet routable", "description": "List the applications that are first packet routable. If called from the operator context, an enterprise ID may optionally be specified to filter the result set. Additionally, an edge ID may be specified to get the map for a specific edge.\n\nPrivileges required:\n\n`VIEW_FLOW_STATS` `undefined`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationgetRoutableApplications" }, "task": true }, { "name": "postDisasterRecoveryconfigureActiveForReplication", "summary": "Designate a standby VCO for disaster recovery replication", "description": "Configure the current VCO to be active and the specified VCO to be standby for VCO disaster recovery replication. Required attributes are 1) standbyList, a single-entry array containing the standbyAddress and standbyUuid, 2) drVCOUser, a VCO super user available on both the active and standby VCOs, and 3) drVCOPassword, the password of drVCOUser on the standby VCO (unless the autoConfigStandby option is specified as false). The call sets up the active VCO to allow replication from the standby and then (unless autoConfigStandby is false) makes a transitionToStandby API call to the specified standby, expected to have been previously placed in STANDBY_CANDIDATE state via prepareForStandby. After this call, the active and standby VCOs should be polled via getReplicationStatus until they both reach STANDBY_RUNNING drState (or a configuration error is reported). (Note: the drVCOPassword is not persisted.)\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoveryconfigureActiveForReplication" }, "task": true }, { "name": "postDisasterRecoverydemoteActive", "summary": "Demote current server from active to zombie", "description": "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 the standby server, the operator can force demotion of the active using the optional parameter force passed with value of true; in this case, the operator must ensure the standby server has already been successfully promoted.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoverydemoteActive" }, "task": true }, { "name": "postDisasterRecoverygetReplicationBlob", "summary": "Get the blob needed to configure VCO replication on the standby", "description": "Get from the active VCO the blob needed to configure VCO replication on the standby. Only used 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": "", "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": "/postDisasterRecoverygetReplicationBlob" }, "task": true }, { "name": "postDisasterRecoverygetReplicationStatus", "summary": "Get VCO disaster recovery status", "description": "Get VCO disaster recovery replication status, optionally with client contact, state transition history, and storage information. No input parameters are required. Can optionally specify 1 or more of the following with parameters: clientContact,clientCount,stateHistory,storageInfo.\n\nPrivileges required:\n\n`READ` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoverygetReplicationStatus" }, "task": true }, { "name": "postDisasterRecoveryprepareForStandby", "summary": "Prepare current VCO to be configured as a standby system", "description": "Transition current VCO to quiesced state, ready to be configured as a standby system. No input parameters are required. After this call, VCO will be restarted in standby mode; caller should subsequently poll getReplicationStatus until drState is STANDBY_CANDIDATE. This is the first step to configuring VCO Disaster Recovery.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoveryprepareForStandby" }, "task": true }, { "name": "postDisasterRecoverypromoteStandbyToActive", "summary": "Promote the current server to take over as the single standalone VCO", "description": "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. If the standby server is in the drState STANDBY_RUNNING, meaning that it has detected no problems in replicating from the active server, the operator can force promotion of the standby using the optional parameter force passed with value of true; in this case, the standby server will call demoteActive/force on the active. The operator should, if possible, ensure the formerly active server is demoted by running demoteServer directly on that server if the standby server was unable to do so successfully.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoverypromoteStandbyToActive" }, "task": true }, { "name": "postDisasterRecoveryremoveStandby", "summary": "Unconfigure VCO disaster recovery on the current server", "description": "Unconfigure VCO disaster recovery on the current server. Also, make a best-effort call to removeStandby on the paired DR server. No input parameters are required.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoveryremoveStandby" }, "task": true }, { "name": "postDisasterRecoverytransitionToStandby", "summary": "Configure current VCO to transition to standby in disaster recovery active/standby pair.", "description": "Configure current VCO to transition to standby in disaster recovery active/standby pair. Requires parameter activeAccessFromStandby, which contains the data needed to configure standby. This data is produced by configureActiveForReplication, which by default, automatically calls transitionToStandby; an explicit call is only needed, with a blob obtained from getReplicationBlob, if configureActiveForReplication is called with autoConfigStandby set false.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postDisasterRecoverytransitionToStandby" }, "task": true }, { "name": "postEdgedeleteEdge", "summary": "Delete an edge", "description": "Delete an edge by id.\n\nPrivileges required:\n\n`DELETE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgedeleteEdge" }, "task": true }, { "name": "postEdgedeleteEdgeBgpNeighborRecords", "summary": "Delete edge BGP neighbor records", "description": "Deletes BGP record(s) matching the given record keys (neighborIp) on the edges with the given IDs, if they exist.\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgedeleteEdgeBgpNeighborRecords" }, "task": true }, { "name": "postEdgesetEdgeEnterpriseConfiguration", "summary": "Apply an enterprise configuration to an Edge", "description": "Set an edge's enterprise configuration, overriding the enterprise default for an edge.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgesetEdgeEnterpriseConfiguration" }, "task": true }, { "name": "postEdgesetEdgeHandOffGateways", "summary": "Set an edge's on-premise hand off gateways", "description": "Set an edge's on-premise hand off gateways. A primary and secondary gateway are defined, primary is required, secondary is optional. All existing edge-gateway hand off relationships are moved and are replaced by the the specified primary and secondary gateways.\n\nPrivileges required:\n\n`UPDATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgesetEdgeHandOffGateways" }, "task": true }, { "name": "postEdgesetEdgeOperatorConfiguration", "summary": "Apply an operator configuration to an Edge", "description": "Set an Edge's operator configuration. 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": "", "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": "/postEdgesetEdgeOperatorConfiguration" }, "task": true }, { "name": "postEnterprisedeleteEnterprise", "summary": "Delete an enterprise", "description": "Delete the enterprise specified by the given id parameter. enterpriseId is also a valid alias for id.\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisedeleteEnterprise" }, "task": true }, { "name": "postEnterprisedeleteEnterpriseGatewayRecords", "summary": "Delete enterprise gateway record(s)", "description": "Delete the enterprise gateway record(s) matching the given gateway id(s) and neighbor IP addresses.\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisedeleteEnterpriseGatewayRecords" }, "task": true }, { "name": "postEnterprisedeleteEnterpriseNetworkAllocation", "summary": "Delete an enterprise network allocation", "description": "Delete an enterprise network allocation, by id.\n\nPrivileges required:\n\n`DELETE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisedeleteEnterpriseNetworkAllocation" }, "task": true }, { "name": "postEnterprisedeleteEnterpriseService", "summary": "Delete an enterprise service", "description": "Delete an enterprise service, by id.\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisedeleteEnterpriseService" }, "task": true }, { "name": "postEnterprisegetEnterpriseAddresses", "summary": "Get enterprise IP address information", "description": "Retrieve the public IP address information for the management and control entities associated with this enterprise, including Orchestrator(s), Gateway(s), and datacenter(s).\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseAddresses" }, "task": true }, { "name": "postEnterprisegetEnterpriseAlertConfigurations", "summary": "Get the enterprise alert configuration", "description": "Get the alert configurations associated with an enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseAlertConfigurations" }, "task": true }, { "name": "postEnterprisegetEnterpriseAlerts", "summary": "Get a list of the alerts triggered for the enterprise", "description": "Get a list of past alerts triggered for the enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseAlerts" }, "task": true }, { "name": "postEnterprisegetEnterpriseAllAlertsRecipients", "summary": "List recipients currently receiving ALL enterprise alerts", "description": "List the recipients currently configured to receive all alerts for an enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseAllAlertsRecipients" }, "task": true }, { "name": "postEnterprisegetEnterpriseConfigurations", "summary": "Get enterprise configuration profiles", "description": "Retrieve a list of configuration profiles existing on an enterprise, with optional edge and/or module detail.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseConfigurations" }, "task": true }, { "name": "postEnterprisegetEnterpriseNetworkAllocations", "summary": "Get all network allocation objects defined on an enterprise", "description": "Retrieve a list of all of the network allocations defined onthe given enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseNetworkAllocations" }, "task": true }, { "name": "postEnterprisegetEnterpriseRouteConfiguration", "summary": "Get route advertisement and routing preferences policy", "description": "Get enterprise route advertisement, routing peferences and OSPF, BGP advertisement policy as configured in the Overlay Flow Control table.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseRouteConfiguration" }, "task": true }, { "name": "postEnterprisegetEnterpriseRouteTable", "summary": "Get the enterprise route table", "description": "Get 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": "", "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": "/postEnterprisegetEnterpriseRouteTable" }, "task": true }, { "name": "postEnterprisegetEnterpriseServices", "summary": "Get enterprise network service detail", "description": "Get the network service JSON objects defined for an enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseServices" }, "task": true }, { "name": "postEnterpriseinsertEnterpriseService", "summary": "Insert a new enterprise service", "description": "Insert a new enterprise service.\n\nPrivileges required:\n\n`CREATE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertEnterpriseService" }, "task": true }, { "name": "postEnterpriseinsertOrUpdateEnterpriseAlertConfigurations", "summary": "Insert, update, or delete enterprise alert configurations", "description": "Insert, update, or delete enterprise alert configurations. Returns the array of alert configurations submitted, with ids added for the entries that have been successfully inserted. If an entry is not successfully inserted or updated, an `error` property is included in the .\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertOrUpdateEnterpriseAlertConfigurations" }, "task": true }, { "name": "postEnterprisesetEnterpriseAllAlertsRecipients", "summary": "Set the recipients who should receive all alerts for an enterprise", "description": "Set the recipients who should receive all alerts for an enterprise.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_ALERT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisesetEnterpriseAllAlertsRecipients" }, "task": true }, { "name": "postEnterpriseupdateEnterpriseRoute", "summary": "Update an enterprise route", "description": "Update an 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": "", "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": "/postEnterpriseupdateEnterpriseRoute" }, "task": true }, { "name": "postEnterpriseupdateEnterpriseRouteConfiguration", "summary": "Update enterprise routing configuration", "description": "Update enterprise routing configuration, by configuration id or logicalId.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseupdateEnterpriseRouteConfiguration" }, "task": true }, { "name": "postEnterpriseupdateEnterpriseService", "summary": "Update an enterprise service", "description": "Update the enterprise service with the given id according to the settings specified by the _update field.\n\nPrivileges required:\n\n`UPDATE` `NETWORK_SERVICE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseupdateEnterpriseService" }, "task": true }, { "name": "postEnterpriseProxydeleteEnterpriseProxyUser", "summary": "Delete an enterprise proxy admin user", "description": "Delete an enterprise proxy user by id or username. Note that `enterpriseProxyId` is a required parameter when invoking this method as an operator or partner user.\n\nPrivileges required:\n\n`DELETE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxydeleteEnterpriseProxyUser" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyEdgeInventory", "summary": "Get a list of all partner enterprises and edge inventory associated with each enterprise", "description": "Get partner enterprises and their edge inventory.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxygetEnterpriseProxyEdgeInventory" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyEnterprises", "summary": "Get a list of all partner enterprises", "description": "Get all partner enterprises, optionally including all edges or edge counts.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxygetEnterpriseProxyEnterprises" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyGatewayPools", "summary": "Get list of gateway pools", "description": "Get list of gateway pools associated with an enterprise proxy, optionally with lists of gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxygetEnterpriseProxyGatewayPools" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyOperatorProfiles", "summary": "Get the operator profiles associated with a partner", "description": "Get the operator profiles associated with a proxy (MSP), as assigned by the operator.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxygetEnterpriseProxyOperatorProfiles" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyUser", "summary": "Get an enterprise proxy user", "description": "Get an 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": "", "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": "/postEnterpriseProxygetEnterpriseProxyUser" }, "task": true }, { "name": "postEnterpriseProxyinsertEnterpriseProxyUser", "summary": "Create a new partner admin user", "description": "Create a new partner admin user\n\nPrivileges required:\n\n`CREATE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxyinsertEnterpriseProxyUser" }, "task": true }, { "name": "postEnterpriseProxyupdateEnterpriseProxyUser", "summary": "Update an enterprise proxy admin user", "description": "Update an enterprise proxy admin user\n\nPrivileges required:\n\n`UPDATE` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxyupdateEnterpriseProxyUser" }, "task": true }, { "name": "postEnterpriseUserdeleteEnterpriseUser", "summary": "Delete an enterprise user.", "description": "Delete an enterprise user by id or username. Note that `enterpriseId` is a required parameter when invoking this method as an operator or partner user.\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseUserdeleteEnterpriseUser" }, "task": true }, { "name": "postEnterpriseUsergetEnterpriseUser", "summary": "Get an enterprise user", "description": "Get an enterprise user by id or username.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseUsergetEnterpriseUser" }, "task": true }, { "name": "postEnterpriseUserupdateEnterpriseUser", "summary": "Update an enterprise user", "description": "Update an enterprise user provided an object `id` or other identifying attributes, and an `_update` object with the names and values of columns to be updated.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_USER`, or\n\n`UPDATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseUserupdateEnterpriseUser" }, "task": true }, { "name": "postMetricsgetEdgeAppLinkMetrics", "summary": "Get flow metric aggregate data by link", "description": "Fetch flow metric summaries for the given time interval by link. On success, this method returns an array of flow data where each entry corresponds to a link on the given 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": "", "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": "/postMetricsgetEdgeAppLinkMetrics" }, "task": true }, { "name": "postMetricsgetEdgeAppLinkSeries", "summary": "Get flow metric time series data by link", "description": "Fetch flow metric time series for the given time interval by link. On success, this method returns an array of flow data where each entry corresponds to a link on the given 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": "", "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": "/postMetricsgetEdgeAppLinkSeries" }, "task": true }, { "name": "postMetricsgetEdgeAppMetrics", "summary": "Get flow metric aggregate data by application", "description": "Fetch flow metric summaries for the given time interval by application. On success, this method returns an array of flow data where each entry corresponds to a single application. 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": "", "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": "/postMetricsgetEdgeAppMetrics" }, "task": true }, { "name": "postMetricsgetEdgeAppSeries", "summary": "Get flow metric time series data by application", "description": "Fetch flow metric time series for the given time interval by application. On success, this method returns an array of flow data where each entry corresponds to a single application. 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": "", "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": "/postMetricsgetEdgeAppSeries" }, "task": true }, { "name": "postMetricsgetEdgeCategoryMetrics", "summary": "Get flow metric aggregate data by application category", "description": "Fetch flow metric summaries for the given time interval by application category. On success, this method returns an array of flow data where each entry corresponds to a category of application traffic that has traversed the given 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": "", "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": "/postMetricsgetEdgeCategoryMetrics" }, "task": true }, { "name": "postMetricsgetEdgeCategorySeries", "summary": "Get flow metric time series data by application category", "description": "Fetch flow metric time series for the given time interval by application category. On success, this method returns an array of flow data where each entry corresponds to a category of application traffic that has traversed the given 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": "", "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": "/postMetricsgetEdgeCategorySeries" }, "task": true }, { "name": "postMetricsgetEdgeDestMetrics", "summary": "Get flow metric aggregate data by destination", "description": "Fetch flow metric summaries for the given time interval by destination. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeDestMetrics" }, "task": true }, { "name": "postMetricsgetEdgeDestSeries", "summary": "Get flow metric time series data by destination", "description": "Fetch flow metric time series for the given time interval by destination. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeDestSeries" }, "task": true }, { "name": "postMetricsgetEdgeDeviceMetrics", "summary": "Get flow metric aggregate data by client device", "description": "Fetch flow metric summaries for the given time interval by client device. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeDeviceMetrics" }, "task": true }, { "name": "postMetricsgetEdgeDeviceSeries", "summary": "Get flow metric time series data by client device", "description": "Fetch flow metric time series for the given time interval by client device. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeDeviceSeries" }, "task": true }, { "name": "postMetricsgetEdgeLinkMetrics", "summary": "Get advanced flow metric aggregate data by link", "description": "Fetch advanced flow metric summaries for the given time interval by link. On success, this method returns an array of flow data where each entry corresponds to a link on the given 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`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMetricsgetEdgeLinkMetrics" }, "task": true }, { "name": "postMetricsgetEdgeLinkSeries", "summary": "Get advanced flow metric time series data by link", "description": "Fetch advanced flow metric time series for the given time interval by link. On success, this method returns an array of flow data where each entry corresponds to a link on the given 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`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMetricsgetEdgeLinkSeries" }, "task": true }, { "name": "postMetricsgetEdgeOsMetrics", "summary": "Get flow metric aggregate data by client OS", "description": "Fetch flow metric summaries for the given time interval by client OS. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeOsMetrics" }, "task": true }, { "name": "postMetricsgetEdgeOsSeries", "summary": "Get flow metric time series data by client OS", "description": "Fetch flow metric time series for the given time interval by client OS. On success, this method returns an array of flow data where 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": "", "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": "/postMetricsgetEdgeOsSeries" }, "task": true }, { "name": "postMetricsgetEdgeSegmentMetrics", "summary": "Get flow metric aggregate data by segment Id", "description": "Fetch flow metric summaries for the given 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 given 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": "", "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": "/postMetricsgetEdgeSegmentMetrics" }, "task": true }, { "name": "postMetricsgetEdgeSegmentSeries", "summary": "Get flow metric time series data by segment id", "description": "Fetch flow metric time series for the given time interval by segment id. On success, this method returns an array of flow data where each entry corresponds to a segment id of traffic that has traversed the given 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": "", "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": "/postMetricsgetEdgeSegmentSeries" }, "task": true }, { "name": "postMonitoringgetAggregateEdgeLinkMetrics", "summary": "Get aggregated edge link metrics across enterprises", "description": "Get aggregate edge link metrics across enterprises. On success, returns an array of network utilization metrics, one per link.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMonitoringgetAggregateEdgeLinkMetrics" }, "task": true }, { "name": "postMonitoringgetAggregateEnterpriseEvents", "summary": "Fetch all enterprise events", "description": "Fetch all events across all enterprises in a paginated list. When called in the MSP/Partner context, only enterprises managed by the MSP are queried.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMonitoringgetAggregateEnterpriseEvents" }, "task": true }, { "name": "postMonitoringgetAggregates", "summary": "Get aggregate enterprise and edge information", "description": "Retrieve 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`) which gives edge counts per enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMonitoringgetAggregates" }, "task": true }, { "name": "postMonitoringgetEnterpriseBgpPeerStatus", "summary": "Get gateway BGP peer status for all enterprise gateways", "description": "Returns an array where 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": "", "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": "/postMonitoringgetEnterpriseBgpPeerStatus" }, "task": true }, { "name": "postMonitoringgetEnterpriseEdgeBgpPeerStatus", "summary": "Get edge BGP peer status for all enterprise edges", "description": "Returns an array where 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": "", "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": "/postMonitoringgetEnterpriseEdgeBgpPeerStatus" }, "task": true }, { "name": "postMonitoringgetEnterpriseEdgeLinkStatus", "summary": "Get edge and link status data", "description": "Get current edge and edge-link status for all enterprise edges.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postMonitoringgetEnterpriseEdgeLinkStatus" }, "task": true }, { "name": "postMonitoringgetEnterpriseEdgeNvsTunnelStatus", "summary": "Get gateway BGP peer status for all enterprise gateways", "description": "Returns an array where 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": "", "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": "/postMonitoringgetEnterpriseEdgeNvsTunnelStatus" }, "task": true }, { "name": "postNetworkgetNetworkConfigurations", "summary": "Get operator configuration profiles", "description": "Get the configuration profiles associated with an operator's network, optionally including the modules associated with each profile. Templates are not returned from this call.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkgetNetworkConfigurations" }, "task": true }, { "name": "postNetworkgetNetworkEnterprises", "summary": "Get a list of the enterprises on a network", "description": "Get the enterprises existing on a network, optionally including all edges or edge counts. The `edgeConfigUpdate` \"with\" option may also be passed to check whether application of configuration updates to edges is enabled for each enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkgetNetworkEnterprises" }, "task": true }, { "name": "postNetworkgetNetworkGatewayPools", "summary": "Get list of gateway pools", "description": "Get list of gateway pools associated with a network, optionally with the gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkgetNetworkGatewayPools" }, "task": true }, { "name": "postNetworkgetNetworkOperatorUsers", "summary": "Get list of operator users for a network", "description": "Get a list of all of the operator users associated with a network\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkgetNetworkOperatorUsers" }, "task": true }, { "name": "postOperatorUserdeleteOperatorUser", "summary": "Delete an operator user", "description": "Delete an operator user object by `id` or `username`.\n\nPrivileges required:\n\n`DELETE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postOperatorUserdeleteOperatorUser" }, "task": true }, { "name": "postOperatorUsergetOperatorUser", "summary": "Get an operator user", "description": "Get an operator user object by `id` or `username`.\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postOperatorUsergetOperatorUser" }, "task": true }, { "name": "postOperatorUserinsertOperatorUser", "summary": "Insert an operator user", "description": "Insert an operator user and associate with an operator's network.\n\nPrivileges required:\n\n`CREATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postOperatorUserinsertOperatorUser" }, "task": true }, { "name": "postOperatorUserupdateOperatorUser", "summary": "Update an operator user", "description": "Update an operator user provided an object `id` or `username`, and an `_update` object containing the names and values, of columns to be updated.\n\nPrivileges required:\n\n`UPDATE` `OPERATOR_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postOperatorUserupdateOperatorUser" }, "task": true }, { "name": "postRolecreateRoleCustomization", "summary": "Create a role customization", "description": "Create a role customization given a roleId and an array of privilegeIds.\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postRolecreateRoleCustomization" }, "task": true }, { "name": "postRoledeleteRoleCustomization", "summary": "Delete a role customization", "description": "Delete a role customization, given a role customization name or forRoleId.\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postRoledeleteRoleCustomization" }, "task": true }, { "name": "postRolegetUserTypeRoles", "summary": "Get the roles defined for a user type", "description": "Return the defined roles for a specified user type.\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": "", "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": "/postRolegetUserTypeRoles" }, "task": true }, { "name": "postVcoInventoryassociateEdge", "summary": "Return inventory items available at this VCO", "description": "Assigns an edge in the inventory to an 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 an Enterprise edge only if it is in a PENDING/REACTIVATION_PENDING state.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postVcoInventoryassociateEdge" }, "task": true }, { "name": "postVcoInventorygetInventoryItems", "summary": "Return inventory items available at this VCO", "description": "Retrieve all the inventory information available with this VCO. This method does not have required parameters. The optional parameters are \nenterpriseId - Return inventory items belonging to that enterprise. If the caller context is an enterprise, this value will be taken from token itself.\nmodifiedSince - Used to retrieve inventory items that have been modified in the last modifiedSince hours.\nwith - an array containing the string \"edge\" to get details about details about the provisioned edge if any.\n\nPrivileges required:\n\n`READ` `INVENTORY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postVcoInventorygetInventoryItems" }, "task": true }, { "name": "postConfigurationcloneConfiguration", "summary": "Clone a configuration profile", "description": "Clones an existing configuration by configurationId. Accepts an enterpriseId or networkId to associate the new config with an enterprise or network. Select modules may also be specified. On success, returns an object 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": "", "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": "/postConfigurationcloneConfiguration" }, "task": true }, { "name": "postConfigurationgetConfigurationModules", "summary": "List the modules that compose a configuration profile", "description": "Retrieve a list of the configuration modules that compose the given configuration profile.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationgetConfigurationModules" }, "task": true }, { "name": "postConfigurationinsertConfigurationModule", "summary": "Insert a new configuration module", "description": "Insert a new configuration module into the given configuration profile.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationinsertConfigurationModule" }, "task": true }, { "name": "postConfigurationupdateConfigurationModule", "summary": "Update a configuration module", "description": "Update an existing configuration module with the data. module data contained in the _update object.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postConfigurationupdateConfigurationModule" }, "task": true }, { "name": "postEdgeedgeCancelReactivation", "summary": "Cancel a pending edge reactivation request", "description": "Cancel a pending reactivation edge reactivation request.\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgeedgeCancelReactivation" }, "task": true }, { "name": "postEdgeedgeProvision", "summary": "Provision an edge", "description": "Provision an edge prior to activation.\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgeedgeProvision" }, "task": true }, { "name": "postEdgeedgeRequestReactivation", "summary": "Reactivate an edge", "description": "Update activation state for an edge to REACTIVATION_PENDING.\n\nPrivileges required:\n\n`CREATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgeedgeRequestReactivation" }, "task": true }, { "name": "postEdgegetEdge", "summary": "Get edge", "description": "Get VELOCLOUD_EDGE object, with optional link, site, enterprise, or configuration information. Query by object id, deviceId, activationKey or logicalId. All four values are unique so are sufficient to identify a single edge in the database.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgegetEdge" }, "task": true }, { "name": "postEdgegetEdgeConfigurationStack", "summary": "Get an edge's configuration stack", "description": "Retrieve an edge's complete configuration profile, with all modules included.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`READ` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgegetEdgeConfigurationStack" }, "task": true }, { "name": "postEdgeupdateEdgeAdminPassword", "summary": "Update edge's local UI authentication credentials", "description": "Request an update to the edge's local UI authentication credentials. On success, returns a JSON object with the ID of the action queued, status for 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": "", "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": "/postEdgeupdateEdgeAdminPassword" }, "task": true }, { "name": "postEdgeupdateEdgeAttributes", "summary": "Update edge attributes", "description": "Update basic edge attributes, including edge name, description, site information, or serial number.\n\nPrivileges required:\n\n`UPDATE` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEdgeupdateEdgeAttributes" }, "task": true }, { "name": "postEdgeupdateEdgeCredentialsByConfiguration", "summary": "Update edge UI credentials by configuration id", "description": "Request an update to the edge-local UI authentication credentials for all edges belonging to a 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": "", "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": "/postEdgeupdateEdgeCredentialsByConfiguration" }, "task": true }, { "name": "postEnterprisegetEnterprise", "summary": "Get enterprise", "description": "Retrieve enterprise data, with optional proxy (partner) detail.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterprise" }, "task": true }, { "name": "postEnterprisegetEnterpriseCapabilities", "summary": "Get enterprise capabilities", "description": "Retrieve a list of the enterprise capabilities currently enabled/disabled on an enterprise (e.g. BGP, COS mapping, PKI, etc.)\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseCapabilities" }, "task": true }, { "name": "postEnterprisegetEnterpriseEdges", "summary": "Get edges associated with an enterprise", "description": "Get the edges associated with an enterprise, with optional location and link detail.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseEdges" }, "task": true }, { "name": "postEnterprisegetEnterpriseGatewayHandoff", "summary": "Get enterprise gateway handoff configuration", "description": "Get enterprise gateway handoff configuration.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseGatewayHandoff" }, "task": true }, { "name": "postEnterprisegetEnterpriseNetworkAllocation", "summary": "Get an enterprise network allocation", "description": "Retrieve a network allocation object by id.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseNetworkAllocation" }, "task": true }, { "name": "postEnterprisegetEnterpriseProperty", "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": "", "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": "/postEnterprisegetEnterpriseProperty" }, "task": true }, { "name": "postEnterpriseinsertEnterprise", "summary": "Insert a new enterprise", "description": "Insert an enterprise, owned by the operator or an MSP.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertEnterprise" }, "task": true }, { "name": "postEnterpriseinsertEnterpriseNetworkAllocation", "summary": "Insert an enterprise network allocation", "description": "Insert a new enterprise network allocation.\n\nPrivileges required:\n\n`CREATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertEnterpriseNetworkAllocation" }, "task": true }, { "name": "postEnterpriseinsertOrUpdateEnterpriseCapability", "summary": "Insert or update an enterprise capability", "description": "Insert or update an enterprise capability.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertOrUpdateEnterpriseCapability" }, "task": true }, { "name": "postEnterpriseinsertOrUpdateEnterpriseGatewayHandoff", "summary": "Insert or update an enterprise gateway handoff configuration", "description": "Insert or update an enterprise gateway handoff configuration.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertOrUpdateEnterpriseGatewayHandoff" }, "task": true }, { "name": "postEnterpriseinsertOrUpdateEnterpriseProperty", "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`READ` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertOrUpdateEnterpriseProperty" }, "task": true }, { "name": "postEnterpriseupdateEnterprise", "summary": "Update an enterprise", "description": "Update an enterprise provided an object id or name, and an _update object with the names and values of columns to be updated.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseupdateEnterprise" }, "task": true }, { "name": "postEnterpriseupdateEnterpriseNetworkAllocation", "summary": "Update an enterprise network allocation", "description": "Update an enterprise network allocation, provided an object id and an _update object with the names and values of columns to be updated.\n\nPrivileges required:\n\n`UPDATE` `NETWORK_ALLOCATION`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseupdateEnterpriseNetworkAllocation" }, "task": true }, { "name": "postEnterpriseupdateEnterpriseSecurityPolicy", "summary": "Update enterprise security policy", "description": "Update enterprise security policy in accordance with to the passed ipsec settings.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseupdateEnterpriseSecurityPolicy" }, "task": true }, { "name": "postEnterprisegetEnterpriseUsers", "summary": "Get list of enterprise users by enterprise id", "description": "undefined\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterprisegetEnterpriseUsers" }, "task": true }, { "name": "postEnterpriseinsertEnterpriseUser", "summary": "Insert an enterprise user", "description": "Insert an enterprise user.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseinsertEnterpriseUser" }, "task": true }, { "name": "postEnterpriseProxygetEnterpriseProxyUsers", "summary": "Get all enterprise proxy admin users", "description": "undefined\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `PROXY_USER`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEnterpriseProxygetEnterpriseProxyUsers" }, "task": true }, { "name": "postEnterpriseProxyinsertEnterpriseProxyEnterprise", "summary": "Insert a new enterprise owned by an MSP", "description": "Insert an enterprise owned by an MSP. Whereas the `insertEnterprise` method will create an enterprise in the global or network context with no MSP association, this method will create 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": "", "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": "/postEnterpriseProxyinsertEnterpriseProxyEnterprise" }, "task": true }, { "name": "postEventgetEnterpriseEvents", "summary": "Fetch edge events", "description": "Fetch edge events in an enterprise or edge context, returns an array of filters and sorted edge events.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_EVENT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEventgetEnterpriseEvents" }, "task": true }, { "name": "postEventgetOperatorEvents", "summary": "Fetch operator events", "description": "Fetch Operator Events by network ID (optional, if not specified will be taken for the callers security context). Optionally, a filter object can be used to limit the number of events returned. Additionally, a time interval can be specified with an interval object. If no end date is given, it will default to the current date. Gateway ID can be supplied to filter events to those from a specific gateway.\n\nPrivileges required:\n\n`READ` `OPERATOR_EVENT`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postEventgetOperatorEvents" }, "task": true }, { "name": "postFirewallgetEnterpriseFirewallLogs", "summary": "Get enterprise firewall logs", "description": "Retrieve enterprise firewall logs.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FIREWALL_LOGS` `undefined`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postFirewallgetEnterpriseFirewallLogs" }, "task": true }, { "name": "postGatewaydeleteGateway", "summary": "Delete a gateway", "description": "Delete a gateway by id.\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postGatewaydeleteGateway" }, "task": true }, { "name": "postGatewaygatewayProvision", "summary": "Provision a gateway", "description": "Provision a gateway into an operator network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postGatewaygatewayProvision" }, "task": true }, { "name": "postGatewayupdateGatewayAttributes", "summary": "Update gateway attributes", "description": "Update gateway attributes (name, ipAddress, on-premise parametrization and description) and associated site attributes\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postGatewayupdateGatewayAttributes" }, "task": true }, { "name": "postLinkQualityEventgetLinkQualityEvents", "summary": "Get link quality data", "description": "Returns link quality scores per link for a particular edge within a time interval. Rolls up link quality events to provide an aggregate score for the edge. Returns an empty array if no link quality events are available in the given timeframe.\n\nPrivileges required:\n\n`READ` `EDGE`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postLinkQualityEventgetLinkQualityEvents" }, "task": true }, { "name": "postNetworkdeleteNetworkGatewayPool", "summary": "Delete a gateway pool", "description": "Delete a gateway pool, and it's component gateways, by pool id.\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkdeleteNetworkGatewayPool" }, "task": true }, { "name": "postNetworkgetNetworkGateways", "summary": "Get list of gateways", "description": "Get list of gateways associated with a network.\n\nPrivileges required:\n\n`READ` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkgetNetworkGateways" }, "task": true }, { "name": "postNetworkinsertNetworkGatewayPool", "summary": "Insert a gateway pool", "description": "Insert a gateway pool, associated with a network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkinsertNetworkGatewayPool" }, "task": true }, { "name": "postNetworkupdateNetworkGatwayPoolAttributes", "summary": "Update gateway pool attributes", "description": "Update the configurable attributes of a Gateway Pool. Configurarable attributes are `name`, `description`, and `handOffType`.\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postNetworkupdateNetworkGatwayPoolAttributes" }, "task": true }, { "name": "postRolesetEnterpriseDelegatedToEnterpriseProxy", "summary": "Grant enterprise access to an enterprise proxy", "description": "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": "", "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": "/postRolesetEnterpriseDelegatedToEnterpriseProxy" }, "task": true }, { "name": "postRolesetEnterpriseDelegatedToOperator", "summary": "Grant enterprise access to the network operator", "description": "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": "", "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": "/postRolesetEnterpriseDelegatedToOperator" }, "task": true }, { "name": "postRolesetEnterpriseProxyDelegatedToOperator", "summary": "Grant enterprise proxy access to the network operator", "description": "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": "", "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": "/postRolesetEnterpriseProxyDelegatedToOperator" }, "task": true }, { "name": "postRolesetEnterpriseUserManagementDelegatedToOperator", "summary": "Grant enterprise user access to the network operator", "description": "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": "", "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": "/postRolesetEnterpriseUserManagementDelegatedToOperator" }, "task": true }, { "name": "postSystemPropertygetSystemProperties", "summary": "Get all system properties", "description": "Get a list of all configured system properties.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postSystemPropertygetSystemProperties" }, "task": true }, { "name": "postSystemPropertygetSystemProperty", "summary": "Get system property", "description": "Get a system property by object id or other attribute.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postSystemPropertygetSystemProperty" }, "task": true }, { "name": "postSystemPropertyinsertOrUpdateSystemProperty", "summary": "Insert or update a system property", "description": "Insert a system property. If property with the given name already exists, the property will be updated.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postSystemPropertyinsertOrUpdateSystemProperty" }, "task": true }, { "name": "postSystemPropertyinsertSystemProperty", "summary": "Insert a system property", "description": "Insert a new system property.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postSystemPropertyinsertSystemProperty" }, "task": true }, { "name": "postSystemPropertyupdateSystemProperty", "summary": "Update a system property", "description": "Update an existing system property, provided an object `id` or other identifying attributes\n\nPrivileges required:\n\n`UPDATE` `SYSTEM_PROPERTY`", "input": [ { "name": "body", "type": "object", "info": "", "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": "/postSystemPropertyupdateSystemProperty" }, "task": true } ] }