{ "id": "@itentialopensource/adapter-kentik", "type": "Adapter", "export": "Kentik", "title": "Kentik", "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": "listASGroups", "summary": "ListASGroups", "description": "Returns list of configured AS groups.", "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": "/listASGroups" }, "task": true }, { "name": "createASGroup", "summary": "CreateASGroup", "description": "Create configuration for a new AS group. Returns the newly created configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"asGroup\": {\"id\": \"string\", \"name\": \"string\", \"asn\": \"array\", \"createdDate\": \"string\", \"updatedDate\": \"string\"}}", "required": true, "schema": { "title": "CreateASGroupRequest", "required": [ "asGroup" ], "type": "object", "properties": { "asGroup": { "title": "ASGroupConcise", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected unique name" }, "asn": { "type": "array", "items": { "type": "string" }, "description": "List of ASNs" }, "createdDate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "updatedDate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createASGroup" }, "task": true }, { "name": "updateASGroup", "summary": "UpdateASGroup", "description": "Replaces configuration of a AS group with attributes in the request. Returns the updated configuration.", "input": [ { "name": "asGroupId", "type": "string", "info": "System generated unique identifier: string", "required": true, "schema": { "title": "asGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"asGroup\": {\"id\": \"string\", \"name\": \"string\", \"asn\": \"array\", \"createdDate\": \"string\", \"updatedDate\": \"string\"}}", "required": true, "schema": { "title": "UpdateASGroupRequest", "required": [ "asGroup" ], "type": "object", "properties": { "asGroup": { "title": "ASGroupConcise", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected unique name" }, "asn": { "type": "array", "items": { "type": "string" }, "description": "List of ASNs" }, "createdDate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "updatedDate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateASGroup" }, "task": true }, { "name": "getASGroup", "summary": "GetASGroup", "description": "Returns configuration of a AS group specified by ID.", "input": [ { "name": "asGroupId", "type": "string", "info": "ID of the requested AS group: string", "required": true, "schema": { "title": "asGroupId", "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": "/getASGroup" }, "task": true }, { "name": "deleteASGroup", "summary": "DeleteASGroup", "description": "Deletes configuration of a AS group with specific ID.", "input": [ { "name": "asGroupId", "type": "string", "info": "ID of the AS group to be deleted: string", "required": true, "schema": { "title": "asGroupId", "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": "/deleteASGroup" }, "task": true }, { "name": "listMonitors", "summary": "ListMonitors", "description": "Returns list of all BGP monitors present in the account.", "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": "/listMonitors" }, "task": true }, { "name": "createMonitor", "summary": "CreateMonitor", "description": "Creates new BGP Monitor and if successful returns its configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"monitor\": {\"id\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [BGP_MONITOR_STATUS_UNSPECIFIED, BGP_MONITOR_STATUS_ACTIVE, BGP_MONITOR_STATUS_PAUSED, BGP_MONITOR_STATUS_DELETED]\", \"settings\": {\"allowedAsns\": \"array\", \"targets\": [{\"afi\": \"Must be one of [AFI_UNSPECIFIED, AFI_IP4, AFI_IP6]\", \"safi\": \"Must be one of [SAFI_UNSPECIFIED, SAFI_UNICAST, SAFI_MPLS, SAFI_L3VPN]\", \"prefix\": \"string\"}], \"checkRpki\": \"boolean\", \"includeCoveredPrefixes\": \"boolean\", \"healthSettings\": {\"reachabilityWarning\": 123, \"reachabilityCritical\": 123}, \"notificationChannels\": \"array\", \"notes\": \"string\", \"allowedUpstreams\": \"array\"}, \"cdate\": \"string\", \"edate\": \"string\", \"createdBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"lastUpdatedBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"labels\": \"array\"}}", "required": true, "schema": { "title": "CreateMonitorRequest", "required": [ "monitor" ], "type": "object", "properties": { "monitor": { "title": "BgpMonitor", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected name of the monitor" }, "status": { "title": "BgpMonitorStatus", "enum": [ "BGP_MONITOR_STATUS_UNSPECIFIED", "BGP_MONITOR_STATUS_ACTIVE", "BGP_MONITOR_STATUS_PAUSED", "BGP_MONITOR_STATUS_DELETED" ], "type": "string", "description": "- BGP_MONITOR_STATUS_UNSPECIFIED: Invalid value.\n - BGP_MONITOR_STATUS_ACTIVE: Monitor is active.\n - BGP_MONITOR_STATUS_PAUSED: Monitor is paused.\n - BGP_MONITOR_STATUS_DELETED: Monitor is deleted. Not user settable" }, "settings": { "title": "BgpMonitorSettings", "required": [ "targets" ], "type": "object", "properties": { "allowedAsns": { "type": "array", "items": { "type": "integer" }, "description": "List of ASNs that are valid originators of monitored prefixes" }, "targets": { "type": "array", "items": { "title": "Nlri", "required": [ "afi", "safi", "prefix" ], "type": "object", "properties": { "afi": { "title": "Afi", "enum": [ "AFI_UNSPECIFIED", "AFI_IP4", "AFI_IP6" ], "type": "string" }, "safi": { "title": "Safi", "enum": [ "SAFI_UNSPECIFIED", "SAFI_UNICAST", "SAFI_MPLS", "SAFI_L3VPN" ], "type": "string" }, "prefix": { "type": "string", "description": "Actual prefix data (format depends on AFI)" } } }, "description": "List of prefixes to monitor" }, "checkRpki": { "type": "boolean", "description": "Enable verification of validity of advertisements of monitored prefixes with respect to RPKI" }, "includeCoveredPrefixes": { "type": "boolean", "description": "Include advertised subnets (sub-prefixes) of monitored prefixes" }, "healthSettings": { "title": "BgpHealthSettings", "type": "object", "properties": { "reachabilityWarning": { "type": "number", "description": "Threshold (in percents) for triggering warning level alert" }, "reachabilityCritical": { "type": "number", "description": "Threshold (in percents) for triggering critical level alert" } } }, "notificationChannels": { "type": "array", "items": { "type": "string" }, "description": "List of IDs of notification channels for delivery of alerts" }, "notes": { "type": "string", "description": "Free form notes documenting the monitor" }, "allowedUpstreams": { "type": "array", "items": { "type": "integer" }, "description": "List of ASNs that are expected to propagate monitored prefixes" } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true }, "createdBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "lastUpdatedBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "labels": { "type": "array", "items": { "type": "string" }, "description": "" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMonitor" }, "task": true }, { "name": "getMonitor", "summary": "GetMonitor", "description": "Returns configuration of existing BGP monitor with specific ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the BGP monitor to be retrieved: string", "required": true, "schema": { "title": "id", "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": "/getMonitor" }, "task": true }, { "name": "deleteMonitor", "summary": "DeleteMonitor", "description": "Delete BGP monitor with with specific ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the BGP monitor to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteMonitor" }, "task": true }, { "name": "updateMonitor", "summary": "UpdateMonitor", "description": "Updates configuration of BGP monitor with specific ID and returns updated configuration.", "input": [ { "name": "id", "type": "string", "info": "System generated unique identifier: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"monitor\": {\"id\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [BGP_MONITOR_STATUS_UNSPECIFIED, BGP_MONITOR_STATUS_ACTIVE, BGP_MONITOR_STATUS_PAUSED, BGP_MONITOR_STATUS_DELETED]\", \"settings\": {\"allowedAsns\": \"array\", \"targets\": [{\"afi\": \"Must be one of [AFI_UNSPECIFIED, AFI_IP4, AFI_IP6]\", \"safi\": \"Must be one of [SAFI_UNSPECIFIED, SAFI_UNICAST, SAFI_MPLS, SAFI_L3VPN]\", \"prefix\": \"string\"}], \"checkRpki\": \"boolean\", \"includeCoveredPrefixes\": \"boolean\", \"healthSettings\": {\"reachabilityWarning\": 123, \"reachabilityCritical\": 123}, \"notificationChannels\": \"array\", \"notes\": \"string\", \"allowedUpstreams\": \"array\"}, \"cdate\": \"string\", \"edate\": \"string\", \"createdBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"lastUpdatedBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"labels\": \"array\"}}", "required": true, "schema": { "title": "UpdateMonitorRequest", "required": [ "monitor" ], "type": "object", "properties": { "monitor": { "title": "BgpMonitor", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected name of the monitor" }, "status": { "title": "BgpMonitorStatus", "enum": [ "BGP_MONITOR_STATUS_UNSPECIFIED", "BGP_MONITOR_STATUS_ACTIVE", "BGP_MONITOR_STATUS_PAUSED", "BGP_MONITOR_STATUS_DELETED" ], "type": "string", "description": "- BGP_MONITOR_STATUS_UNSPECIFIED: Invalid value.\n - BGP_MONITOR_STATUS_ACTIVE: Monitor is active.\n - BGP_MONITOR_STATUS_PAUSED: Monitor is paused.\n - BGP_MONITOR_STATUS_DELETED: Monitor is deleted. Not user settable" }, "settings": { "title": "BgpMonitorSettings", "required": [ "targets" ], "type": "object", "properties": { "allowedAsns": { "type": "array", "items": { "type": "integer" }, "description": "List of ASNs that are valid originators of monitored prefixes" }, "targets": { "type": "array", "items": { "title": "Nlri", "required": [ "afi", "safi", "prefix" ], "type": "object", "properties": { "afi": { "title": "Afi", "enum": [ "AFI_UNSPECIFIED", "AFI_IP4", "AFI_IP6" ], "type": "string" }, "safi": { "title": "Safi", "enum": [ "SAFI_UNSPECIFIED", "SAFI_UNICAST", "SAFI_MPLS", "SAFI_L3VPN" ], "type": "string" }, "prefix": { "type": "string", "description": "Actual prefix data (format depends on AFI)" } } }, "description": "List of prefixes to monitor" }, "checkRpki": { "type": "boolean", "description": "Enable verification of validity of advertisements of monitored prefixes with respect to RPKI" }, "includeCoveredPrefixes": { "type": "boolean", "description": "Include advertised subnets (sub-prefixes) of monitored prefixes" }, "healthSettings": { "title": "BgpHealthSettings", "type": "object", "properties": { "reachabilityWarning": { "type": "number", "description": "Threshold (in percents) for triggering warning level alert" }, "reachabilityCritical": { "type": "number", "description": "Threshold (in percents) for triggering critical level alert" } } }, "notificationChannels": { "type": "array", "items": { "type": "string" }, "description": "List of IDs of notification channels for delivery of alerts" }, "notes": { "type": "string", "description": "Free form notes documenting the monitor" }, "allowedUpstreams": { "type": "array", "items": { "type": "integer" }, "description": "List of ASNs that are expected to propagate monitored prefixes" } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true }, "createdBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "lastUpdatedBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "labels": { "type": "array", "items": { "type": "string" }, "description": "" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMonitor" }, "task": true }, { "name": "setMonitorStatus", "summary": "SetMonitorStatus", "description": "Sets administrative status of BGP monitor with specific ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the BGP monitor whose status is to be modified: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"id\": \"string\", \"status\": \"Must be one of [BGP_MONITOR_STATUS_UNSPECIFIED, BGP_MONITOR_STATUS_ACTIVE, BGP_MONITOR_STATUS_PAUSED, BGP_MONITOR_STATUS_DELETED]\"}", "required": true, "schema": { "title": "SetMonitorStatusRequest", "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the BGP monitor whose status is to be modified" }, "status": { "title": "BgpMonitorStatus", "enum": [ "BGP_MONITOR_STATUS_UNSPECIFIED", "BGP_MONITOR_STATUS_ACTIVE", "BGP_MONITOR_STATUS_PAUSED", "BGP_MONITOR_STATUS_DELETED" ], "type": "string", "description": "- BGP_MONITOR_STATUS_UNSPECIFIED: Invalid value.\n - BGP_MONITOR_STATUS_ACTIVE: Monitor is active.\n - BGP_MONITOR_STATUS_PAUSED: Monitor is paused.\n - BGP_MONITOR_STATUS_DELETED: Monitor is deleted. Not user settable" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setMonitorStatus" }, "task": true }, { "name": "getMetricsForTarget", "summary": "GetMetricsForTarget", "description": "Retrieve metric data for single BGP prefix and time interval.", "input": [ { "name": "body", "type": "object", "info": ": {\"startTime\": \"string\", \"endTime\": \"string\", \"target\": {\"afi\": \"Must be one of [AFI_UNSPECIFIED, AFI_IP4, AFI_IP6]\", \"safi\": \"Must be one of [SAFI_UNSPECIFIED, SAFI_UNICAST, SAFI_MPLS, SAFI_L3VPN]\", \"prefix\": \"string\"}, \"includeCovered\": \"boolean\", \"metrics\": \"array\"}", "required": true, "schema": { "title": "GetMetricsForTargetRequest", "required": [ "startTime", "endTime", "target", "metrics" ], "type": "object", "properties": { "startTime": { "type": "string", "description": "UTC timestamp of the beginning of queried interval" }, "endTime": { "type": "string", "description": "UTC timestamp of the end of queried interval" }, "target": { "title": "Nlri", "required": [ "afi", "safi", "prefix" ], "type": "object", "properties": { "afi": { "title": "Afi", "enum": [ "AFI_UNSPECIFIED", "AFI_IP4", "AFI_IP6" ], "type": "string" }, "safi": { "title": "Safi", "enum": [ "SAFI_UNSPECIFIED", "SAFI_UNICAST", "SAFI_MPLS", "SAFI_L3VPN" ], "type": "string" }, "prefix": { "type": "string", "description": "Actual prefix data (format depends on AFI)" } } }, "includeCovered": { "type": "boolean", "description": "Return metrics for subnets (sub-prefixes) of the target prefix (default: false)" }, "metrics": { "type": "array", "items": { "title": "BgpMetricType", "enum": [ "BGP_METRIC_TYPE_UNSPECIFIED", "BGP_METRIC_TYPE_REACHABILITY", "BGP_METRIC_TYPE_PATH_CHANGES" ], "type": "string", "description": "- BGP_METRIC_TYPE_UNSPECIFIED: Invalid value.\n - BGP_METRIC_TYPE_REACHABILITY: Reachability metric in percents\n - BGP_METRIC_TYPE_PATH_CHANGES: Number of path changes over time interval" }, "description": "List of one or more BGP metric types to return" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getMetricsForTarget" }, "task": true }, { "name": "getRoutesForTarget", "summary": "GetRoutesForTarget", "description": "Retrieve snapshot of route information for single BGP prefix at specific time.", "input": [ { "name": "body", "type": "object", "info": ": {\"time\": \"string\", \"target\": {\"afi\": \"Must be one of [AFI_UNSPECIFIED, AFI_IP4, AFI_IP6]\", \"safi\": \"Must be one of [SAFI_UNSPECIFIED, SAFI_UNICAST, SAFI_MPLS, SAFI_L3VPN]\", \"prefix\": \"string\"}, \"includeCovered\": \"boolean\", \"checkRpki\": \"boolean\"}", "required": true, "schema": { "title": "GetRoutesForTargetRequest", "required": [ "time", "target" ], "type": "object", "properties": { "time": { "type": "string", "description": "Reference UTC time for the route information snapshot" }, "target": { "title": "Nlri", "required": [ "afi", "safi", "prefix" ], "type": "object", "properties": { "afi": { "title": "Afi", "enum": [ "AFI_UNSPECIFIED", "AFI_IP4", "AFI_IP6" ], "type": "string" }, "safi": { "title": "Safi", "enum": [ "SAFI_UNSPECIFIED", "SAFI_UNICAST", "SAFI_MPLS", "SAFI_L3VPN" ], "type": "string" }, "prefix": { "type": "string", "description": "Actual prefix data (format depends on AFI)" } } }, "includeCovered": { "type": "boolean", "description": "Return routes for subnets (sub-prefixes) of the target prefix (default: false)" }, "checkRpki": { "type": "boolean", "description": "Return information about validity of prefix advertisements with respect to RPKI (default: false)" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRoutesForTarget" }, "task": true }, { "name": "listCapacityPlans", "summary": "ListCapacityPlans", "description": "Returns list of capacity plans.", "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": "/listCapacityPlans" }, "task": true }, { "name": "listCapacitySummaries", "summary": "ListCapacitySummaries", "description": "Returns list of capacity summaries.", "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": "/listCapacitySummaries" }, "task": true }, { "name": "getCapacityPlan", "summary": "GetCapacityPlan", "description": "Returns capacity plan specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the requested capacity plan: string", "required": true, "schema": { "title": "id", "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": "/getCapacityPlan" }, "task": true }, { "name": "getCapacitySummary", "summary": "GetCapacitySummary", "description": "Returns capacity plan summary specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the requested capacity plan summary: string", "required": true, "schema": { "title": "id", "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": "/getCapacitySummary" }, "task": true }, { "name": "listCloudExports", "summary": "ListCloudExports", "description": "Returns a list of all cloud exports in the account.", "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": "/listCloudExports" }, "task": true }, { "name": "createCloudExport", "summary": "CreateCloudExport", "description": "Create new cloud export based on configuration in the request.", "input": [ { "name": "body", "type": "object", "info": ": {\"export\": {\"id\": \"string\", \"type\": \"Must be one of [CLOUD_EXPORT_TYPE_UNSPECIFIED, CLOUD_EXPORT_TYPE_KENTIK_MANAGED, CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED]\", \"enabled\": \"boolean\", \"name\": \"string\", \"description\": \"string\", \"planId\": \"string\", \"cloudProvider\": \"Must be one of [CLOUD_PROVIDER_UNSPECIFIED, CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_AZURE, CLOUD_PROVIDER_GCE, CLOUD_PROVIDER_IBM]\", \"aws\": {\"bucket\": \"string\", \"iamRoleArn\": \"string\", \"region\": \"string\", \"deleteAfterRead\": \"boolean\", \"metadataOnly\": \"boolean\"}, \"azure\": {\"location\": \"string\", \"resourceGroup\": \"string\", \"storageAccount\": \"string\", \"subscriptionId\": \"string\", \"securityPrincipalEnabled\": \"boolean\"}, \"gce\": {\"project\": \"string\", \"subscription\": \"string\"}, \"ibm\": {\"bucket\": \"string\"}, \"currentStatus\": {\"status\": \"string\", \"errorMessage\": \"string\", \"flowFound\": \"boolean\", \"apiAccess\": \"boolean\", \"storageAccountAccess\": \"boolean\"}, \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "CreateCloudExportRequest", "type": "object", "properties": { "export": { "title": "CloudExport", "required": [ "enabled", "name", "planId", "cloudProvider" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the instance", "readOnly": true }, "type": { "title": "CloudExportType", "enum": [ "CLOUD_EXPORT_TYPE_UNSPECIFIED", "CLOUD_EXPORT_TYPE_KENTIK_MANAGED", "CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED" ], "type": "string", "description": "- CLOUD_EXPORT_TYPE_UNSPECIFIED: Invalid value.\n - CLOUD_EXPORT_TYPE_KENTIK_MANAGED: Cloud export process is managed by Kentik\n - CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED: Cloud export process is managed by customer" }, "enabled": { "type": "boolean", "description": "Attribute controlling whether the instance is active" }, "name": { "type": "string", "description": "User selected name of the instance" }, "description": { "type": "string", "description": "Description of the instance" }, "planId": { "type": "string", "description": "Identifier of the billing plan for the instance" }, "cloudProvider": { "title": "CloudProvider", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "CLOUD_PROVIDER_AWS", "CLOUD_PROVIDER_AZURE", "CLOUD_PROVIDER_GCE", "CLOUD_PROVIDER_IBM" ], "type": "string", "description": "- CLOUD_PROVIDER_UNSPECIFIED: Invalid value.\n - CLOUD_PROVIDER_AWS: Amazon Web Services\n - CLOUD_PROVIDER_AZURE: Microsoft Azure\n - CLOUD_PROVIDER_GCE: Google Cloud\n - CLOUD_PROVIDER_IBM: IBM Cloud" }, "aws": { "title": "AwsProperties", "required": [ "iamRoleArn", "region" ], "type": "object", "properties": { "bucket": { "type": "string", "description": "Name of S3 bucket from which flow logs are to be exported." }, "iamRoleArn": { "type": "string", "description": "ARN of the IAM role granted access to the S3 bucket and describe API end-points." }, "region": { "type": "string", "description": "Name of AWS region from which to export flow logs." }, "deleteAfterRead": { "type": "boolean", "description": "Delete from logs from the S3 bucket after export (default false)." }, "metadataOnly": { "type": "boolean", "description": "Import only metadata without any flows (default false)." } } }, "azure": { "title": "AzureProperties", "required": [ "location", "resourceGroup", "storageAccount", "subscriptionId" ], "type": "object", "properties": { "location": { "type": "string", "description": "Azure region/location from which to export flow logs." }, "resourceGroup": { "type": "string", "description": "Resource group containing the NSG generating flow logs." }, "storageAccount": { "type": "string", "description": "Storage account from which flow logs are to be extracted." }, "subscriptionId": { "type": "string", "description": "ID of Azure account from which flows logs are to be exported." }, "securityPrincipalEnabled": { "type": "boolean", "description": "Indication whether security principal for the Kentik flow export application has been authorized." } } }, "gce": { "title": "GceProperties", "required": [ "project", "subscription" ], "type": "object", "properties": { "project": { "type": "string", "description": "Name of the project from which to export flow logs." }, "subscription": { "type": "string", "description": "GCP Pub/Sub subscription providing flow logs." } } }, "ibm": { "title": "IbmProperties", "type": "object", "properties": { "bucket": { "type": "string", "description": "Storage bucket from which flow logs are to be extracted." } } }, "currentStatus": { "title": "CloudExportStatus", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the export task.", "readOnly": true }, "errorMessage": { "type": "string", "description": "Text of the last error message (empty if status is OK).", "readOnly": true }, "flowFound": { "type": "boolean", "description": "Indication whether any flow data were exported.", "readOnly": true }, "apiAccess": { "type": "boolean", "description": "Indication whether the export process is able to access cloud API.", "readOnly": true }, "storageAccountAccess": { "type": "boolean", "description": "Indication whether the export process is able to access storage account containing flow logs.", "readOnly": true } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCloudExport" }, "task": true }, { "name": "updateCloudExport", "summary": "UpdateCloudExport", "description": "Replace complete configuration of a cloud export with data in the request.", "input": [ { "name": "exportId", "type": "string", "info": "Unique identifier of the instance: string", "required": true, "schema": { "title": "exportId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"export\": {\"id\": \"string\", \"type\": \"Must be one of [CLOUD_EXPORT_TYPE_UNSPECIFIED, CLOUD_EXPORT_TYPE_KENTIK_MANAGED, CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED]\", \"enabled\": \"boolean\", \"name\": \"string\", \"description\": \"string\", \"planId\": \"string\", \"cloudProvider\": \"Must be one of [CLOUD_PROVIDER_UNSPECIFIED, CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_AZURE, CLOUD_PROVIDER_GCE, CLOUD_PROVIDER_IBM]\", \"aws\": {\"bucket\": \"string\", \"iamRoleArn\": \"string\", \"region\": \"string\", \"deleteAfterRead\": \"boolean\", \"metadataOnly\": \"boolean\"}, \"azure\": {\"location\": \"string\", \"resourceGroup\": \"string\", \"storageAccount\": \"string\", \"subscriptionId\": \"string\", \"securityPrincipalEnabled\": \"boolean\"}, \"gce\": {\"project\": \"string\", \"subscription\": \"string\"}, \"ibm\": {\"bucket\": \"string\"}, \"currentStatus\": {\"status\": \"string\", \"errorMessage\": \"string\", \"flowFound\": \"boolean\", \"apiAccess\": \"boolean\", \"storageAccountAccess\": \"boolean\"}, \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "UpdateCloudExportRequest", "type": "object", "properties": { "export": { "title": "CloudExport", "required": [ "enabled", "name", "planId", "cloudProvider" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the instance", "readOnly": true }, "type": { "title": "CloudExportType", "enum": [ "CLOUD_EXPORT_TYPE_UNSPECIFIED", "CLOUD_EXPORT_TYPE_KENTIK_MANAGED", "CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED" ], "type": "string", "description": "- CLOUD_EXPORT_TYPE_UNSPECIFIED: Invalid value.\n - CLOUD_EXPORT_TYPE_KENTIK_MANAGED: Cloud export process is managed by Kentik\n - CLOUD_EXPORT_TYPE_CUSTOMER_MANAGED: Cloud export process is managed by customer" }, "enabled": { "type": "boolean", "description": "Attribute controlling whether the instance is active" }, "name": { "type": "string", "description": "User selected name of the instance" }, "description": { "type": "string", "description": "Description of the instance" }, "planId": { "type": "string", "description": "Identifier of the billing plan for the instance" }, "cloudProvider": { "title": "CloudProvider", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "CLOUD_PROVIDER_AWS", "CLOUD_PROVIDER_AZURE", "CLOUD_PROVIDER_GCE", "CLOUD_PROVIDER_IBM" ], "type": "string", "description": "- CLOUD_PROVIDER_UNSPECIFIED: Invalid value.\n - CLOUD_PROVIDER_AWS: Amazon Web Services\n - CLOUD_PROVIDER_AZURE: Microsoft Azure\n - CLOUD_PROVIDER_GCE: Google Cloud\n - CLOUD_PROVIDER_IBM: IBM Cloud" }, "aws": { "title": "AwsProperties", "required": [ "iamRoleArn", "region" ], "type": "object", "properties": { "bucket": { "type": "string", "description": "Name of S3 bucket from which flow logs are to be exported." }, "iamRoleArn": { "type": "string", "description": "ARN of the IAM role granted access to the S3 bucket and describe API end-points." }, "region": { "type": "string", "description": "Name of AWS region from which to export flow logs." }, "deleteAfterRead": { "type": "boolean", "description": "Delete from logs from the S3 bucket after export (default false)." }, "metadataOnly": { "type": "boolean", "description": "Import only metadata without any flows (default false)." } } }, "azure": { "title": "AzureProperties", "required": [ "location", "resourceGroup", "storageAccount", "subscriptionId" ], "type": "object", "properties": { "location": { "type": "string", "description": "Azure region/location from which to export flow logs." }, "resourceGroup": { "type": "string", "description": "Resource group containing the NSG generating flow logs." }, "storageAccount": { "type": "string", "description": "Storage account from which flow logs are to be extracted." }, "subscriptionId": { "type": "string", "description": "ID of Azure account from which flows logs are to be exported." }, "securityPrincipalEnabled": { "type": "boolean", "description": "Indication whether security principal for the Kentik flow export application has been authorized." } } }, "gce": { "title": "GceProperties", "required": [ "project", "subscription" ], "type": "object", "properties": { "project": { "type": "string", "description": "Name of the project from which to export flow logs." }, "subscription": { "type": "string", "description": "GCP Pub/Sub subscription providing flow logs." } } }, "ibm": { "title": "IbmProperties", "type": "object", "properties": { "bucket": { "type": "string", "description": "Storage bucket from which flow logs are to be extracted." } } }, "currentStatus": { "title": "CloudExportStatus", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the export task.", "readOnly": true }, "errorMessage": { "type": "string", "description": "Text of the last error message (empty if status is OK).", "readOnly": true }, "flowFound": { "type": "boolean", "description": "Indication whether any flow data were exported.", "readOnly": true }, "apiAccess": { "type": "boolean", "description": "Indication whether the export process is able to access cloud API.", "readOnly": true }, "storageAccountAccess": { "type": "boolean", "description": "Indication whether the export process is able to access storage account containing flow logs.", "readOnly": true } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateCloudExport" }, "task": true }, { "name": "getCloudExport", "summary": "GetCloudExport", "description": "Returns configuration and status of cloud export with specified ID.", "input": [ { "name": "exportId", "type": "string", "info": "ID of the cloud export to be retrieved.: string", "required": true, "schema": { "title": "exportId", "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": "/getCloudExport" }, "task": true }, { "name": "deleteCloudExport", "summary": "DeleteCloudExport", "description": "Delete cloud export with specified ID.", "input": [ { "name": "exportId", "type": "string", "info": "ID of the cloud export to be deleted.: string", "required": true, "schema": { "title": "exportId", "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": "/deleteCloudExport" }, "task": true }, { "name": "listInterface", "summary": "ListInterface", "description": "Return list of interfaces matches search critera.", "input": [ { "name": "filtersText", "type": "string", "info": "Search text match in interface description and alias.: string", "required": false, "schema": { "title": "filtersText", "type": "string" } }, { "name": "filtersDeviceIds", "type": "array", "info": "Search by device ID.: array", "required": false, "schema": { "title": "filtersDeviceIds", "type": "array" } }, { "name": "filtersConnectivityTypes", "type": "array", "info": "Search by type of interface connectivity.: array", "required": false, "schema": { "title": "filtersConnectivityTypes", "type": "array" } }, { "name": "filtersNetworkBoundaries", "type": "array", "info": "Search by type of network boundary.: array", "required": false, "schema": { "title": "filtersNetworkBoundaries", "type": "array" } }, { "name": "filtersProviders", "type": "array", "info": "Search by provider.: array", "required": false, "schema": { "title": "filtersProviders", "type": "array" } }, { "name": "filtersSnmpSpeeds", "type": "array", "info": "SNMP speed in Mbps.: array", "required": false, "schema": { "title": "filtersSnmpSpeeds", "type": "array" } }, { "name": "filtersIpTypes", "type": "array", "info": "Search by ip address.: array", "required": false, "schema": { "title": "filtersIpTypes", "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": "/listInterface" }, "task": true }, { "name": "interfaceCreate", "summary": "InterfaceCreate", "description": "Create a interface from request. returns created.", "input": [ { "name": "body", "type": "object", "info": ": {\"interface\": {\"id\": \"string\", \"deviceId\": \"string\", \"snmpId\": \"string\", \"snmpSpeed\": 123, \"snmpType\": 123, \"snmpAlias\": \"string\", \"interfaceIp\": \"string\", \"interfaceDescription\": \"string\", \"cdate\": \"string\", \"edate\": \"string\", \"interfaceIpNetmask\": \"string\", \"connectivityType\": \"Must be one of [CONNECTIVITY_TYPE_UNSPECIFIED, CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT, CONNECTIVITY_TYPE_AVAILABLE, CONNECTIVITY_TYPE_BACKBONE, CONNECTIVITY_TYPE_CLOUD_INTERCONNECT, CONNECTIVITY_TYPE_CUSTOMER, CONNECTIVITY_TYPE_DATACENTER_FABRIC, CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT, CONNECTIVITY_TYPE_EMBEDDED_CACHE, CONNECTIVITY_TYPE_FREE_PNI, CONNECTIVITY_TYPE_HOST, CONNECTIVITY_TYPE_IX, CONNECTIVITY_TYPE_OTHER, CONNECTIVITY_TYPE_PAID_PNI, CONNECTIVITY_TYPE_RESERVED, CONNECTIVITY_TYPE_TRANSIT, CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT]\", \"networkBoundary\": \"Must be one of [NETWORK_BOUNDARY_UNSPECIFIED, NETWORK_BOUNDARY_AUTO, NETWORK_BOUNDARY_INTERNAL, NETWORK_BOUNDARY_EXTERNAL, NETWORK_BOUNDARY_NONE]\", \"topNexthopAsns\": \"array\", \"provider\": \"string\"}}", "required": true, "schema": { "title": "v202108alpha1CreateInterfaceRequest", "type": "object", "properties": { "interface": { "title": "v202108alpha1Interface", "type": "object", "properties": { "id": { "type": "string", "description": "ID of interface." }, "deviceId": { "type": "string", "description": "ID of device with this interface." }, "snmpId": { "type": "string", "description": "SNMP ID." }, "snmpSpeed": { "type": "integer", "description": "Network speed in Mbps." }, "snmpType": { "type": "integer", "description": "Snmp Type." }, "snmpAlias": { "type": "string", "description": "Interface alias." }, "interfaceIp": { "type": "string", "description": "IP of interface." }, "interfaceDescription": { "type": "string", "description": "Readable string description of interface." }, "cdate": { "type": "string", "description": "Create timestamp." }, "edate": { "type": "string", "description": "Update Timestamp." }, "interfaceIpNetmask": { "type": "string", "description": "Subnet mask." }, "connectivityType": { "title": "v202108alpha1ConnectivityType", "enum": [ "CONNECTIVITY_TYPE_UNSPECIFIED", "CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT", "CONNECTIVITY_TYPE_AVAILABLE", "CONNECTIVITY_TYPE_BACKBONE", "CONNECTIVITY_TYPE_CLOUD_INTERCONNECT", "CONNECTIVITY_TYPE_CUSTOMER", "CONNECTIVITY_TYPE_DATACENTER_FABRIC", "CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT", "CONNECTIVITY_TYPE_EMBEDDED_CACHE", "CONNECTIVITY_TYPE_FREE_PNI", "CONNECTIVITY_TYPE_HOST", "CONNECTIVITY_TYPE_IX", "CONNECTIVITY_TYPE_OTHER", "CONNECTIVITY_TYPE_PAID_PNI", "CONNECTIVITY_TYPE_RESERVED", "CONNECTIVITY_TYPE_TRANSIT", "CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT" ], "type": "string" }, "networkBoundary": { "title": "v202108alpha1NetworkBoundary", "enum": [ "NETWORK_BOUNDARY_UNSPECIFIED", "NETWORK_BOUNDARY_AUTO", "NETWORK_BOUNDARY_INTERNAL", "NETWORK_BOUNDARY_EXTERNAL", "NETWORK_BOUNDARY_NONE" ], "type": "string" }, "topNexthopAsns": { "type": "array", "items": { "type": "integer" }, "description": "Top asn hops." }, "provider": { "type": "string", "description": "Network provider." } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interfaceCreate" }, "task": true }, { "name": "interfaceGet", "summary": "InterfaceGet", "description": "Returns information about a interface specified with ID.", "input": [ { "name": "id", "type": "string", "info": "ID of interface.: string", "required": true, "schema": { "title": "id", "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": "/interfaceGet" }, "task": true }, { "name": "interfaceDelete", "summary": "InterfaceDelete", "description": "Deletes the interface specified with id.", "input": [ { "name": "id", "type": "string", "info": "ID of interface.: string", "required": true, "schema": { "title": "id", "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": "/interfaceDelete" }, "task": true }, { "name": "interfaceUpdate", "summary": "InterfaceUpdate", "description": "Replaces the entire interface attributes specified with id.", "input": [ { "name": "id", "type": "string", "info": "ID of interface.: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"interface\": {\"id\": \"string\", \"deviceId\": \"string\", \"snmpId\": \"string\", \"snmpSpeed\": 123, \"snmpType\": 123, \"snmpAlias\": \"string\", \"interfaceIp\": \"string\", \"interfaceDescription\": \"string\", \"cdate\": \"string\", \"edate\": \"string\", \"interfaceIpNetmask\": \"string\", \"connectivityType\": \"Must be one of [CONNECTIVITY_TYPE_UNSPECIFIED, CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT, CONNECTIVITY_TYPE_AVAILABLE, CONNECTIVITY_TYPE_BACKBONE, CONNECTIVITY_TYPE_CLOUD_INTERCONNECT, CONNECTIVITY_TYPE_CUSTOMER, CONNECTIVITY_TYPE_DATACENTER_FABRIC, CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT, CONNECTIVITY_TYPE_EMBEDDED_CACHE, CONNECTIVITY_TYPE_FREE_PNI, CONNECTIVITY_TYPE_HOST, CONNECTIVITY_TYPE_IX, CONNECTIVITY_TYPE_OTHER, CONNECTIVITY_TYPE_PAID_PNI, CONNECTIVITY_TYPE_RESERVED, CONNECTIVITY_TYPE_TRANSIT, CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT]\", \"networkBoundary\": \"Must be one of [NETWORK_BOUNDARY_UNSPECIFIED, NETWORK_BOUNDARY_AUTO, NETWORK_BOUNDARY_INTERNAL, NETWORK_BOUNDARY_EXTERNAL, NETWORK_BOUNDARY_NONE]\", \"topNexthopAsns\": \"array\", \"provider\": \"string\"}}", "required": true, "schema": { "title": "v202108alpha1UpdateInterfaceRequest", "type": "object", "properties": { "interface": { "title": "v202108alpha1Interface", "type": "object", "properties": { "id": { "type": "string", "description": "ID of interface." }, "deviceId": { "type": "string", "description": "ID of device with this interface." }, "snmpId": { "type": "string", "description": "SNMP ID." }, "snmpSpeed": { "type": "integer", "description": "Network speed in Mbps." }, "snmpType": { "type": "integer", "description": "Snmp Type." }, "snmpAlias": { "type": "string", "description": "Interface alias." }, "interfaceIp": { "type": "string", "description": "IP of interface." }, "interfaceDescription": { "type": "string", "description": "Readable string description of interface." }, "cdate": { "type": "string", "description": "Create timestamp." }, "edate": { "type": "string", "description": "Update Timestamp." }, "interfaceIpNetmask": { "type": "string", "description": "Subnet mask." }, "connectivityType": { "title": "v202108alpha1ConnectivityType", "enum": [ "CONNECTIVITY_TYPE_UNSPECIFIED", "CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT", "CONNECTIVITY_TYPE_AVAILABLE", "CONNECTIVITY_TYPE_BACKBONE", "CONNECTIVITY_TYPE_CLOUD_INTERCONNECT", "CONNECTIVITY_TYPE_CUSTOMER", "CONNECTIVITY_TYPE_DATACENTER_FABRIC", "CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT", "CONNECTIVITY_TYPE_EMBEDDED_CACHE", "CONNECTIVITY_TYPE_FREE_PNI", "CONNECTIVITY_TYPE_HOST", "CONNECTIVITY_TYPE_IX", "CONNECTIVITY_TYPE_OTHER", "CONNECTIVITY_TYPE_PAID_PNI", "CONNECTIVITY_TYPE_RESERVED", "CONNECTIVITY_TYPE_TRANSIT", "CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT" ], "type": "string" }, "networkBoundary": { "title": "v202108alpha1NetworkBoundary", "enum": [ "NETWORK_BOUNDARY_UNSPECIFIED", "NETWORK_BOUNDARY_AUTO", "NETWORK_BOUNDARY_INTERNAL", "NETWORK_BOUNDARY_EXTERNAL", "NETWORK_BOUNDARY_NONE" ], "type": "string" }, "topNexthopAsns": { "type": "array", "items": { "type": "integer" }, "description": "Top asn hops." }, "provider": { "type": "string", "description": "Network provider." } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/interfaceUpdate" }, "task": true }, { "name": "manualClassify", "summary": "ManualClassify", "description": "Manually set interface(s) classification.", "input": [ { "name": "body", "type": "object", "info": ": {\"interfaceIds\": \"array\", \"connectivityType\": \"Must be one of [CONNECTIVITY_TYPE_UNSPECIFIED, CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT, CONNECTIVITY_TYPE_AVAILABLE, CONNECTIVITY_TYPE_BACKBONE, CONNECTIVITY_TYPE_CLOUD_INTERCONNECT, CONNECTIVITY_TYPE_CUSTOMER, CONNECTIVITY_TYPE_DATACENTER_FABRIC, CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT, CONNECTIVITY_TYPE_EMBEDDED_CACHE, CONNECTIVITY_TYPE_FREE_PNI, CONNECTIVITY_TYPE_HOST, CONNECTIVITY_TYPE_IX, CONNECTIVITY_TYPE_OTHER, CONNECTIVITY_TYPE_PAID_PNI, CONNECTIVITY_TYPE_RESERVED, CONNECTIVITY_TYPE_TRANSIT, CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT]\", \"networkBoundary\": \"Must be one of [NETWORK_BOUNDARY_UNSPECIFIED, NETWORK_BOUNDARY_AUTO, NETWORK_BOUNDARY_INTERNAL, NETWORK_BOUNDARY_EXTERNAL, NETWORK_BOUNDARY_NONE]\", \"provider\": \"string\"}", "required": true, "schema": { "title": "v202108alpha1ManualClassifyRequest", "type": "object", "properties": { "interfaceIds": { "type": "array", "items": { "type": "string" }, "description": "Interface ids to set the properties." }, "connectivityType": { "title": "v202108alpha1ConnectivityType", "enum": [ "CONNECTIVITY_TYPE_UNSPECIFIED", "CONNECTIVITY_TYPE_AGGREGATION_INTERCONNECT", "CONNECTIVITY_TYPE_AVAILABLE", "CONNECTIVITY_TYPE_BACKBONE", "CONNECTIVITY_TYPE_CLOUD_INTERCONNECT", "CONNECTIVITY_TYPE_CUSTOMER", "CONNECTIVITY_TYPE_DATACENTER_FABRIC", "CONNECTIVITY_TYPE_DATACENTER_INTERCONNECT", "CONNECTIVITY_TYPE_EMBEDDED_CACHE", "CONNECTIVITY_TYPE_FREE_PNI", "CONNECTIVITY_TYPE_HOST", "CONNECTIVITY_TYPE_IX", "CONNECTIVITY_TYPE_OTHER", "CONNECTIVITY_TYPE_PAID_PNI", "CONNECTIVITY_TYPE_RESERVED", "CONNECTIVITY_TYPE_TRANSIT", "CONNECTIVITY_TYPE_VIRTUAL_CROSS_CONNECT" ], "type": "string" }, "networkBoundary": { "title": "v202108alpha1NetworkBoundary", "enum": [ "NETWORK_BOUNDARY_UNSPECIFIED", "NETWORK_BOUNDARY_AUTO", "NETWORK_BOUNDARY_INTERNAL", "NETWORK_BOUNDARY_EXTERNAL", "NETWORK_BOUNDARY_NONE" ], "type": "string" }, "provider": { "type": "string", "description": "Network provider." } }, "description": "Set connection type, network boundary, and provider of interface id(s) specified.", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/manualClassify" }, "task": true }, { "name": "getASNDetails", "summary": "GetASNDetails", "description": "Returns metadata and list of customers, providers, and peers for an Autonomous System.", "input": [ { "name": "marketId", "type": "string", "info": "Unique Geo Market identifier (as provided by the ListMarkets RPC): string", "required": true, "schema": { "title": "marketId", "type": "string" } }, { "name": "asn", "type": "string", "info": "Autonomous System Number (ASN): string", "required": true, "schema": { "title": "asn", "type": "string" } }, { "name": "type", "type": "string", "info": "Type of the requested ASN ('all', 'customer', 'provider', 'peer'). Defaults to 'all'.: string", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"marketId\": \"string\", \"asn\": \"string\", \"ip\": \"string\", \"type\": \"string\", \"mutualProvider\": \"string\", \"mutualCustomer\": \"string\", \"singlehomedCustomer\": \"string\"}", "required": true, "schema": { "title": "GetASNDetailsRequest", "required": [ "marketId", "asn" ], "type": "object", "properties": { "marketId": { "type": "string", "description": "Unique Geo Market identifier (as provided by the ListMarkets RPC)" }, "asn": { "type": "string", "description": "Autonomous System Number (ASN)" }, "ip": { "type": "string", "description": "IP Address Family ('v4' or 'v6'). Defaults to 'v4'." }, "type": { "type": "string", "description": "Type of the requested ASN ('all', 'customer', 'provider', 'peer'). Defaults to 'all'." }, "mutualProvider": { "type": "string", "description": "Filter by mutual provider ('all', 'only', 'exclude'). Defaults to 'all'." }, "mutualCustomer": { "type": "string", "description": "Filter by mutual customer ('all', 'only', 'exclude'). Defaults to 'all'." }, "singlehomedCustomer": { "type": "string", "description": "Filter by singlehomed customer ('all', 'only', 'exclude'). Defaults to 'all'." } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getASNDetails" }, "task": true }, { "name": "getRankings", "summary": "GetRankings", "description": "Returns list of KMI rankings.", "input": [ { "name": "marketId", "type": "string", "info": "Unique Geo Market identifier (as provided by the ListMarkets RPC): string", "required": true, "schema": { "title": "marketId", "type": "string" } }, { "name": "rankType", "type": "string", "info": "Type of the requested ranking ('customer_base', 'customer_base_retail', 'customer_base_wholesome', 'customer_base_backbone', 'customer_growth', 'peering_base'). Defaults ...(description truncated): string", "required": true, "schema": { "title": "rankType", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"marketId\": \"string\", \"rankType\": \"string\", \"ip\": \"string\", \"limit\": 123}", "required": true, "schema": { "title": "GetRankingsRequest", "required": [ "marketId" ], "type": "object", "properties": { "marketId": { "type": "string", "description": "Unique Geo Market identifier (as provided by the ListMarkets RPC)" }, "rankType": { "type": "string", "description": "Type of the requested ranking ('customer_base', 'customer_base_retail', 'customer_base_wholesome', 'customer_base_backbone', 'customer_growth', 'peering_base'). Defaults to 'customer_base'." }, "ip": { "type": "string", "description": "IP Address Family ('v4' or 'v6') of requested ranking. Defaults to 'v4'." }, "limit": { "type": "integer", "description": "Maximum number of entries returned. (Default: 600)." } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRankings" }, "task": true }, { "name": "listMarkets", "summary": "ListMarkets", "description": "Returns list of geo markets for KMI.", "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": "/listMarkets" }, "task": true }, { "name": "listLabels", "summary": "ListLabels", "description": "Returns list of all labels configured in the account.", "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": "/listLabels" }, "task": true }, { "name": "createLabel", "summary": "CreateLabel", "description": "Creates a new label based on data in the request.", "input": [ { "name": "body", "type": "object", "info": ": {\"label\": {\"id\": \"string\", \"name\": \"string\", \"description\": \"string\", \"color\": \"string\", \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "CreateLabelRequest", "required": [ "label" ], "type": "object", "properties": { "label": { "title": "Label", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique system assigned identifier of the label", "readOnly": true }, "name": { "type": "string", "description": "Label text visible in listing of configuration of objects to which it has been applied" }, "description": { "type": "string", "description": "Optional description of the label, visible only in API responses" }, "color": { "type": "string", "description": "[Hexadecimal code of the color](https://www.color-hex.com/) of the label text background in the portal" }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLabel" }, "task": true }, { "name": "deleteLabel", "summary": "DeleteLabel", "description": "Deletes label with specified with id.", "input": [ { "name": "id", "type": "string", "info": "ID of the label to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteLabel" }, "task": true }, { "name": "updateLabel", "summary": "UpdateLabel", "description": "Updates configuration of a label.", "input": [ { "name": "id", "type": "string", "info": "Unique system assigned identifier of the label: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"label\": {\"id\": \"string\", \"name\": \"string\", \"description\": \"string\", \"color\": \"string\", \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "UpdateLabelRequest", "required": [ "label" ], "type": "object", "properties": { "label": { "title": "Label", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique system assigned identifier of the label", "readOnly": true }, "name": { "type": "string", "description": "Label text visible in listing of configuration of objects to which it has been applied" }, "description": { "type": "string", "description": "Optional description of the label, visible only in API responses" }, "color": { "type": "string", "description": "[Hexadecimal code of the color](https://www.color-hex.com/) of the label text background in the portal" }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateLabel" }, "task": true }, { "name": "packageList", "summary": "PackageList", "description": "Returns a list of MKP packages.", "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": "/packageList" }, "task": true }, { "name": "packageCreate", "summary": "PackageCreate", "description": "Create package from request. returns created package.", "input": [ { "name": "body", "type": "object", "info": ": {\"package\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}}", "required": true, "schema": { "title": "v202102alpha1CreatePackageRequest", "type": "object", "properties": { "package": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packageCreate" }, "task": true }, { "name": "packageGet", "summary": "PackageGet", "description": "Returns information about package specified with ID.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "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": "/packageGet" }, "task": true }, { "name": "packageDelete", "summary": "PackageDelete", "description": "Deletes the package specified with id.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "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": "/packageDelete" }, "task": true }, { "name": "packageUpdate", "summary": "PackageUpdate", "description": "Replaces the entire package attributes specified with id.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"package\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}}", "required": true, "schema": { "title": "v202102alpha1UpdatePackageRequest", "type": "object", "properties": { "package": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packageUpdate" }, "task": true }, { "name": "packagePatch", "summary": "PackagePatch", "description": "Partially Updates the attributes of package specified with id and mask fields.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"package\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}, \"mask\": \"string\"}", "required": true, "schema": { "title": "v202102alpha1PatchPackageRequest", "type": "object", "properties": { "package": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } }, "mask": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/packagePatch" }, "task": true }, { "name": "tenantList", "summary": "TenantList", "description": "Returns a list of MKP tenants.", "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": "/tenantList" }, "task": true }, { "name": "tenantCreate", "summary": "TenantCreate", "description": "Create tenant from request. returns created tenant.", "input": [ { "name": "body", "type": "object", "info": ": {\"tenant\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"type\": \"string\", \"enabled\": \"boolean\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"asn\": \"string\", \"cidr\": \"string\", \"customDimensions\": [{\"dimension\": \"string\", \"populator\": \"string\"}], \"devices\": {\"allDevices\": \"boolean\", \"deviceTypes\": \"array\", \"deviceLabels\": \"array\", \"deviceSites\": \"array\", \"deviceName\": \"array\"}, \"filters\": {\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": [{\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": \"array\", \"metric\": \"array\"}], \"metric\": \"array\"}, \"interfaceName\": \"string\", \"snmpAlias\": \"string\", \"packages\": [{\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}], \"users\": [{\"id\": \"string\", \"companyId\": \"string\", \"userEmail\": \"string\", \"userName\": \"string\", \"userFullName\": \"string\", \"userGroupId\": \"string\", \"lastLogin\": \"string\", \"permissionOverrides\": \"boolean\", \"role\": \"string\", \"userLevel\": 123}], \"templateId\": 123}}", "required": true, "schema": { "title": "v202102alpha1CreateTenantRequest", "type": "object", "properties": { "tenant": { "title": "v202102alpha1Tenant", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "asn": { "type": "string" }, "cidr": { "type": "string" }, "customDimensions": { "type": "array", "items": { "title": "v202102alpha1CustomDimension", "type": "object", "properties": { "dimension": { "type": "string" }, "populator": { "type": "string" } } }, "description": "" }, "devices": { "title": "v202102alpha1Device", "type": "object", "properties": { "allDevices": { "type": "boolean" }, "deviceTypes": { "type": "array", "items": { "type": "string" }, "description": "" }, "deviceLabels": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceSites": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceName": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "filters": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "type": "object" }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "interfaceName": { "type": "string" }, "snmpAlias": { "type": "string" }, "packages": { "type": "array", "items": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } }, "description": "" }, "users": { "type": "array", "items": { "title": "v202102alpha1User", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "userEmail": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "userGroupId": { "type": "string" }, "lastLogin": { "type": "string" }, "permissionOverrides": { "type": "boolean" }, "role": { "type": "string" }, "userLevel": { "type": "integer" } } }, "description": "" }, "templateId": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/tenantCreate" }, "task": true }, { "name": "tenantGet", "summary": "TenantGet", "description": "Returns information about package specified with ID.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "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": "/tenantGet" }, "task": true }, { "name": "tenantDelete", "summary": "TenantDelete", "description": "Deletes the tenant specified with id.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "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": "/tenantDelete" }, "task": true }, { "name": "tenantUpdate", "summary": "TenantUpdate", "description": "Replaces the entire tenant attributes specified with id.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"tenant\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"type\": \"string\", \"enabled\": \"boolean\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"asn\": \"string\", \"cidr\": \"string\", \"customDimensions\": [{\"dimension\": \"string\", \"populator\": \"string\"}], \"devices\": {\"allDevices\": \"boolean\", \"deviceTypes\": \"array\", \"deviceLabels\": \"array\", \"deviceSites\": \"array\", \"deviceName\": \"array\"}, \"filters\": {\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": [{\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": \"array\", \"metric\": \"array\"}], \"metric\": \"array\"}, \"interfaceName\": \"string\", \"snmpAlias\": \"string\", \"packages\": [{\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}], \"users\": [{\"id\": \"string\", \"companyId\": \"string\", \"userEmail\": \"string\", \"userName\": \"string\", \"userFullName\": \"string\", \"userGroupId\": \"string\", \"lastLogin\": \"string\", \"permissionOverrides\": \"boolean\", \"role\": \"string\", \"userLevel\": 123}], \"templateId\": 123}}", "required": true, "schema": { "title": "v202102alpha1UpdateTenantRequest", "type": "object", "properties": { "tenant": { "title": "v202102alpha1Tenant", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "asn": { "type": "string" }, "cidr": { "type": "string" }, "customDimensions": { "type": "array", "items": { "title": "v202102alpha1CustomDimension", "type": "object", "properties": { "dimension": { "type": "string" }, "populator": { "type": "string" } } }, "description": "" }, "devices": { "title": "v202102alpha1Device", "type": "object", "properties": { "allDevices": { "type": "boolean" }, "deviceTypes": { "type": "array", "items": { "type": "string" }, "description": "" }, "deviceLabels": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceSites": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceName": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "filters": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "type": "object" }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "interfaceName": { "type": "string" }, "snmpAlias": { "type": "string" }, "packages": { "type": "array", "items": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } }, "description": "" }, "users": { "type": "array", "items": { "title": "v202102alpha1User", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "userEmail": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "userGroupId": { "type": "string" }, "lastLogin": { "type": "string" }, "permissionOverrides": { "type": "boolean" }, "role": { "type": "string" }, "userLevel": { "type": "integer" } } }, "description": "" }, "templateId": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/tenantUpdate" }, "task": true }, { "name": "tenantPatch", "summary": "TenantPatch", "description": "Partially Updates the attributes of tenant specified with id and mask fields.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"tenant\": {\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"type\": \"string\", \"enabled\": \"boolean\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"asn\": \"string\", \"cidr\": \"string\", \"customDimensions\": [{\"dimension\": \"string\", \"populator\": \"string\"}], \"devices\": {\"allDevices\": \"boolean\", \"deviceTypes\": \"array\", \"deviceLabels\": \"array\", \"deviceSites\": \"array\", \"deviceName\": \"array\"}, \"filters\": {\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": [{\"name\": \"string\", \"named\": \"boolean\", \"connector\": \"string\", \"not\": \"boolean\", \"autoAdded\": \"string\", \"savedFilters\": \"array\", \"filters\": [{\"filterField\": \"string\", \"operator\": \"string\", \"filterValue\": \"string\"}], \"filterGroups\": \"array\", \"metric\": \"array\"}], \"metric\": \"array\"}, \"interfaceName\": \"string\", \"snmpAlias\": \"string\", \"packages\": [{\"id\": \"string\", \"companyId\": \"string\", \"name\": \"string\", \"description\": \"string\", \"icon\": \"string\", \"color\": \"string\", \"alerts\": [{\"saved\": \"boolean\", \"policyId\": \"string\", \"thresholds\": [{\"id\": \"string\", \"activate\": {\"times\": 123, \"operator\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": 123, \"gracePeriod\": 123}, \"severity\": \"string\", \"conditions\": [{\"type\": \"string\", \"value\": 123, \"metric\": \"string\", \"operator\": \"string\", \"valueType\": \"string\", \"valueSelect\": \"string\"}], \"mitigations\": [{\"id\": \"string\", \"status\": \"string\", \"companyId\": \"string\", \"pairingId\": \"string\", \"thresholdId\": \"string\", \"isMethodOverridable\": \"boolean\", \"mitigationApplyType\": \"string\", \"mitigationClearType\": \"string\", \"mitigationApplyTimer\": 123, \"mitigationClearTimer\": 123, \"isPlatformOverridable\": \"boolean\", \"cdate\": \"string\", \"edate\": \"string\"}], \"notificationChannels\": [{\"id\": \"string\"}], \"thresholdAckRequired\": \"boolean\", \"enableTenantNotifications\": \"boolean\", \"receiveLandlordNotifications\": \"boolean\"}], \"primaryMetric\": \"string\", \"secondaryMetrics\": \"array\", \"isTemplate\": \"boolean\", \"subpolicyId\": \"string\"}], \"assets\": {\"reports\": [{\"id\": \"string\", \"type\": \"string\"}], \"defaultReport\": {\"id\": \"string\", \"type\": \"string\"}}, \"isDefault\": \"boolean\", \"tenants\": [{\"id\": \"string\", \"pivotTemplateId\": \"string\", \"pivotUserGroupId\": \"string\"}]}], \"users\": [{\"id\": \"string\", \"companyId\": \"string\", \"userEmail\": \"string\", \"userName\": \"string\", \"userFullName\": \"string\", \"userGroupId\": \"string\", \"lastLogin\": \"string\", \"permissionOverrides\": \"boolean\", \"role\": \"string\", \"userLevel\": 123}], \"templateId\": 123}, \"mask\": \"string\"}", "required": true, "schema": { "title": "v202102alpha1PatchTenantRequest", "type": "object", "properties": { "tenant": { "title": "v202102alpha1Tenant", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "asn": { "type": "string" }, "cidr": { "type": "string" }, "customDimensions": { "type": "array", "items": { "title": "v202102alpha1CustomDimension", "type": "object", "properties": { "dimension": { "type": "string" }, "populator": { "type": "string" } } }, "description": "" }, "devices": { "title": "v202102alpha1Device", "type": "object", "properties": { "allDevices": { "type": "boolean" }, "deviceTypes": { "type": "array", "items": { "type": "string" }, "description": "" }, "deviceLabels": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceSites": { "type": "array", "items": { "type": "integer" }, "description": "" }, "deviceName": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "filters": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "title": "v202102alpha1Filter", "type": "object", "properties": { "name": { "type": "string" }, "named": { "type": "boolean" }, "connector": { "type": "string" }, "not": { "type": "boolean" }, "autoAdded": { "type": "string" }, "savedFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "filters": { "type": "array", "items": { "title": "v202102alpha1FilterField", "type": "object", "properties": { "filterField": { "type": "string" }, "operator": { "type": "string" }, "filterValue": { "type": "string" } } }, "description": "" }, "filterGroups": { "type": "array", "items": { "type": "object" }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" }, "metric": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "interfaceName": { "type": "string" }, "snmpAlias": { "type": "string" }, "packages": { "type": "array", "items": { "title": "PackageTemplatedefinition", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "alerts": { "type": "array", "items": { "title": "AlertPolicy", "type": "object", "properties": { "saved": { "type": "boolean" }, "policyId": { "type": "string" }, "thresholds": { "type": "array", "items": { "title": "AlertThreshold", "type": "object", "properties": { "id": { "type": "string" }, "activate": { "title": "v202102alpha1Activate", "type": "object", "properties": { "times": { "type": "integer" }, "operator": { "type": "string" }, "timeUnit": { "type": "string" }, "timeWindow": { "type": "integer" }, "gracePeriod": { "type": "integer" } } }, "severity": { "type": "string" }, "conditions": { "type": "array", "items": { "title": "v202102alpha1Condition", "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "integer" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "valueType": { "type": "string" }, "valueSelect": { "type": "string" } } }, "description": "" }, "mitigations": { "type": "array", "items": { "title": "v202102alpha1Mitigation", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "companyId": { "type": "string" }, "pairingId": { "type": "string" }, "thresholdId": { "type": "string" }, "isMethodOverridable": { "type": "boolean" }, "mitigationApplyType": { "type": "string" }, "mitigationClearType": { "type": "string" }, "mitigationApplyTimer": { "type": "integer" }, "mitigationClearTimer": { "type": "integer" }, "isPlatformOverridable": { "type": "boolean" }, "cdate": { "type": "string" }, "edate": { "type": "string" } } }, "description": "" }, "notificationChannels": { "type": "array", "items": { "title": "v202102alpha1NotificationChannel", "type": "object", "properties": { "id": { "type": "string" } } }, "description": "" }, "thresholdAckRequired": { "type": "boolean" }, "enableTenantNotifications": { "type": "boolean" }, "receiveLandlordNotifications": { "type": "boolean" } } }, "description": "" }, "primaryMetric": { "type": "string" }, "secondaryMetrics": { "type": "array", "items": { "type": "string" }, "description": "" }, "isTemplate": { "type": "boolean" }, "subpolicyId": { "type": "string" } } }, "description": "" }, "assets": { "title": "v202102alpha1Asset", "type": "object", "properties": { "reports": { "type": "array", "items": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } }, "description": "" }, "defaultReport": { "title": "AssetReport", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } } }, "isDefault": { "type": "boolean" }, "tenants": { "type": "array", "items": { "title": "TenantsreferencingthisPackagetemplate", "type": "object", "properties": { "id": { "type": "string" }, "pivotTemplateId": { "type": "string" }, "pivotUserGroupId": { "type": "string" } } }, "description": "" } } }, "description": "" }, "users": { "type": "array", "items": { "title": "v202102alpha1User", "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string" }, "userEmail": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "userGroupId": { "type": "string" }, "lastLogin": { "type": "string" }, "permissionOverrides": { "type": "boolean" }, "role": { "type": "string" }, "userLevel": { "type": "integer" } } }, "description": "" }, "templateId": { "type": "integer" } } }, "mask": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/tenantPatch" }, "task": true }, { "name": "networkClassGet", "summary": "NetworkClassGet", "description": "Returns information about a network classification for the company.", "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": "/networkClassGet" }, "task": true }, { "name": "networkClassUpdate", "summary": "NetworkClassUpdate", "description": "Replaces the entire network classification attributes for the company.", "input": [ { "name": "body", "type": "object", "info": ": {\"networkClass\": {\"internalAsns\": \"array\", \"internalIps\": \"array\", \"usePrivateAsns\": \"boolean\", \"usePrivateSubnets\": \"boolean\", \"cloudSubnets\": [{\"type\": \"Must be one of [CLOUD_TYPE_UNSPECIFIED, CLOUD_TYPE_AWS, CLOUD_TYPE_AZURE, CLOUD_TYPE_GCE, CLOUD_TYPE_IBM]\", \"subnets\": \"array\"}]}}", "required": true, "schema": { "title": "v202109alpha1UpdateNetworkClassRequest", "type": "object", "properties": { "networkClass": { "title": "v202109alpha1NetworkClass", "type": "object", "properties": { "internalAsns": { "type": "array", "items": { "type": "string" }, "description": "" }, "internalIps": { "type": "array", "items": { "type": "string" }, "description": "" }, "usePrivateAsns": { "type": "boolean" }, "usePrivateSubnets": { "type": "boolean" }, "cloudSubnets": { "type": "array", "items": { "title": "v202109alpha1CloudSubnet", "type": "object", "properties": { "type": { "title": "v202109alpha1CloudType", "enum": [ "CLOUD_TYPE_UNSPECIFIED", "CLOUD_TYPE_AWS", "CLOUD_TYPE_AZURE", "CLOUD_TYPE_GCE", "CLOUD_TYPE_IBM" ], "type": "string" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "Cloud provider and subnet info." } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/networkClassUpdate" }, "task": true }, { "name": "listNotificationChannels", "summary": "ListNotificationChannels", "description": "Returns list of all configured notification channels.", "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": "/listNotificationChannels" }, "task": true }, { "name": "searchNotificationChannels", "summary": "SearchNotificationChannels", "description": "Returns list of all notification channels matching request criteria. Match criteria are treated as a logical AND, i.e. all provided criteria must match in order for an entry to be included in the response.", "input": [ { "name": "body", "type": "object", "info": ": {\"namePattern\": \"string\", \"types\": \"array\", \"includeDisabled\": \"boolean\"}", "required": true, "schema": { "title": "SearchNotificationChannelsRequest", "type": "object", "properties": { "namePattern": { "type": "string", "description": "Regular expression pattern for matching the name attribute of channels. Empty string matches any name, otherwise the regular expression must consume all characters in the channel name." }, "types": { "type": "array", "items": { "title": "ChannelType", "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "CHANNEL_TYPE_XMATTERS", "CHANNEL_TYPE_SLACK", "CHANNEL_TYPE_SERVICENOW", "CHANNEL_TYPE_SYSLOG", "CHANNEL_TYPE_OPSGENIE", "CHANNEL_TYPE_CUSTOM_WEBHOOK", "CHANNEL_TYPE_SPLUNK", "CHANNEL_TYPE_MSTEAMS", "CHANNEL_TYPE_JSON", "CHANNEL_TYPE_EMAIL", "CHANNEL_TYPE_VICTOROPS", "CHANNEL_TYPE_PAGERDUTY" ], "type": "string", "description": "- CHANNEL_TYPE_UNSPECIFIED: Invalid value.\n - CHANNEL_TYPE_XMATTERS: XMATTERS platform\n - CHANNEL_TYPE_SLACK: Slack channel\n - CHANNEL_TYPE_SERVICENOW: ServiceNow platform\n - CHANNEL_TYPE_SYSLOG: Syslog server\n - CHANNEL_TYPE_OPSGENIE: Atlassian Opsgenie\n - CHANNEL_TYPE_CUSTOM_WEBHOOK: Custom REST webhook\n - CHANNEL_TYPE_SPLUNK: Splunk platform\n - CHANNEL_TYPE_MSTEAMS: Microsoft Teams channel\n - CHANNEL_TYPE_JSON: webhook with JSON payload\n - CHANNEL_TYPE_EMAIL: E-mail\n - CHANNEL_TYPE_VICTOROPS: Splunk On-Call (formerly VictorOps)\n - CHANNEL_TYPE_PAGERDUTY: Pagerduty platform" }, "description": "List of ChannelType enum values to match. Empty list matches any channel type." }, "includeDisabled": { "type": "boolean", "description": "Include disabled channels in results.", "default": false } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchNotificationChannels" }, "task": true }, { "name": "getNotificationChannel", "summary": "GetNotificationChannel", "description": "Returns information about a notification channel with specific ID.", "input": [ { "name": "id", "type": "string", "info": "Request channel ID.: string", "required": true, "schema": { "title": "id", "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": "/getNotificationChannel" }, "task": true }, { "name": "listSiteMarkets", "summary": "ListSiteMarkets", "description": "Returns list of configured site markets.", "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": "/listSiteMarkets" }, "task": true }, { "name": "createSiteMarket", "summary": "CreateSiteMarket", "description": "Create configuration for a new site market. Returns the newly created configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"siteMarket\": {\"id\": \"string\", \"name\": \"string\", \"description\": \"string\", \"numberOfSites\": 123, \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "CreateSiteMarketRequest", "required": [ "siteMarket" ], "type": "object", "properties": { "siteMarket": { "title": "SiteMarket", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected unique name" }, "description": { "type": "string", "description": "Free-form description" }, "numberOfSites": { "type": "integer", "description": "Number of sites in this market", "readOnly": true }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSiteMarket" }, "task": true }, { "name": "getSiteMarket", "summary": "GetSiteMarket", "description": "Returns configuration of a site market specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the requested site market: string", "required": true, "schema": { "title": "id", "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": "/getSiteMarket" }, "task": true }, { "name": "deleteSiteMarket", "summary": "DeleteSiteMarket", "description": "Deletes configuration of a site market with specific ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the site market to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteSiteMarket" }, "task": true }, { "name": "updateSiteMarket", "summary": "UpdateSiteMarket", "description": "Replaces configuration of a site market with attributes in the request. Returns the updated configuration.", "input": [ { "name": "id", "type": "string", "info": "System generated unique identifier: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteMarket\": {\"id\": \"string\", \"name\": \"string\", \"description\": \"string\", \"numberOfSites\": 123, \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "UpdateSiteMarketRequest", "required": [ "siteMarket" ], "type": "object", "properties": { "siteMarket": { "title": "SiteMarket", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "name": { "type": "string", "description": "User selected unique name" }, "description": { "type": "string", "description": "Free-form description" }, "numberOfSites": { "type": "integer", "description": "Number of sites in this market", "readOnly": true }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSiteMarket" }, "task": true }, { "name": "listSites", "summary": "ListSites", "description": "Returns list of configured sites.", "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": "/listSites" }, "task": true }, { "name": "createSite", "summary": "CreateSite", "description": "Create configuration for a new site. Returns the newly created configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"site\": {\"id\": \"string\", \"title\": \"string\", \"lat\": 123, \"lon\": 123, \"postalAddress\": {\"address\": \"string\", \"city\": \"string\", \"region\": \"string\", \"postalCode\": \"string\", \"country\": \"string\"}, \"type\": \"Must be one of [SITE_TYPE_UNSPECIFIED, SITE_TYPE_DATA_CENTER, SITE_TYPE_CLOUD, SITE_TYPE_BRANCH, SITE_TYPE_CONNECTIVITY, SITE_TYPE_CUSTOMER, SITE_TYPE_OTHER]\", \"addressClassification\": {\"infrastructureNetworks\": \"array\", \"userAccessNetworks\": \"array\", \"otherNetworks\": \"array\"}, \"architecture\": [{\"layers\": [{\"name\": \"string\", \"deviceIds\": \"array\"}]}], \"siteMarket\": \"string\"}}", "required": true, "schema": { "title": "CreateSiteRequest", "required": [ "site" ], "type": "object", "properties": { "site": { "title": "Site", "required": [ "title", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "title": { "type": "string", "description": "User selected title/name" }, "lat": { "type": "number", "description": "Latitude (signed decimal degrees)" }, "lon": { "type": "number", "description": "Longitude (signed decimal degrees)" }, "postalAddress": { "title": "PostalAddress", "required": [ "address", "city", "country" ], "type": "object", "properties": { "address": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City (full name)" }, "region": { "type": "string", "description": "Geographical region" }, "postalCode": { "type": "string", "description": "Country specific postal code" }, "country": { "type": "string", "description": "Country (full name or country code)" } } }, "type": { "title": "SiteType", "enum": [ "SITE_TYPE_UNSPECIFIED", "SITE_TYPE_DATA_CENTER", "SITE_TYPE_CLOUD", "SITE_TYPE_BRANCH", "SITE_TYPE_CONNECTIVITY", "SITE_TYPE_CUSTOMER", "SITE_TYPE_OTHER" ], "type": "string", "description": "- SITE_TYPE_UNSPECIFIED: Invalid value.\n - SITE_TYPE_DATA_CENTER: Data center site type.\n - SITE_TYPE_CLOUD: Cloud site type.\n - SITE_TYPE_BRANCH: Branch office site type.\n - SITE_TYPE_CONNECTIVITY: Connectivity/PoP site type.\n - SITE_TYPE_CUSTOMER: Customer/partner site type.\n - SITE_TYPE_OTHER: Other site type." }, "addressClassification": { "title": "SiteIpAddressClassification", "type": "object", "properties": { "infrastructureNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in infrastructure networks" }, "userAccessNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in access networks" }, "otherNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in other networks" } } }, "architecture": { "type": "array", "items": { "title": "LayerSet", "type": "object", "properties": { "layers": { "type": "array", "items": { "title": "Layer", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the network layer" }, "deviceIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of devices that are deemed to be part of the network layer" } } }, "description": "List of parallel network layers" } } }, "description": "Logical network topology/architecture" }, "siteMarket": { "type": "string", "description": "Name of the Site Market this sire belongs to" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSite" }, "task": true }, { "name": "getSite", "summary": "GetSite", "description": "Returns configuration of a site specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the requested site: string", "required": true, "schema": { "title": "id", "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": "/getSite" }, "task": true }, { "name": "deleteSite", "summary": "DeleteSite", "description": "Deletes configuration of a site with specific ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the site to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteSite" }, "task": true }, { "name": "updateSite", "summary": "UpdateSite", "description": "Replaces configuration of a site with attributes in the request. Returns the updated configuration.", "input": [ { "name": "id", "type": "string", "info": "System generated unique identifier: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"site\": {\"id\": \"string\", \"title\": \"string\", \"lat\": 123, \"lon\": 123, \"postalAddress\": {\"address\": \"string\", \"city\": \"string\", \"region\": \"string\", \"postalCode\": \"string\", \"country\": \"string\"}, \"type\": \"Must be one of [SITE_TYPE_UNSPECIFIED, SITE_TYPE_DATA_CENTER, SITE_TYPE_CLOUD, SITE_TYPE_BRANCH, SITE_TYPE_CONNECTIVITY, SITE_TYPE_CUSTOMER, SITE_TYPE_OTHER]\", \"addressClassification\": {\"infrastructureNetworks\": \"array\", \"userAccessNetworks\": \"array\", \"otherNetworks\": \"array\"}, \"architecture\": [{\"layers\": [{\"name\": \"string\", \"deviceIds\": \"array\"}]}], \"siteMarket\": \"string\"}}", "required": true, "schema": { "title": "UpdateSiteRequest", "required": [ "site" ], "type": "object", "properties": { "site": { "title": "Site", "required": [ "title", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "title": { "type": "string", "description": "User selected title/name" }, "lat": { "type": "number", "description": "Latitude (signed decimal degrees)" }, "lon": { "type": "number", "description": "Longitude (signed decimal degrees)" }, "postalAddress": { "title": "PostalAddress", "required": [ "address", "city", "country" ], "type": "object", "properties": { "address": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City (full name)" }, "region": { "type": "string", "description": "Geographical region" }, "postalCode": { "type": "string", "description": "Country specific postal code" }, "country": { "type": "string", "description": "Country (full name or country code)" } } }, "type": { "title": "SiteType", "enum": [ "SITE_TYPE_UNSPECIFIED", "SITE_TYPE_DATA_CENTER", "SITE_TYPE_CLOUD", "SITE_TYPE_BRANCH", "SITE_TYPE_CONNECTIVITY", "SITE_TYPE_CUSTOMER", "SITE_TYPE_OTHER" ], "type": "string", "description": "- SITE_TYPE_UNSPECIFIED: Invalid value.\n - SITE_TYPE_DATA_CENTER: Data center site type.\n - SITE_TYPE_CLOUD: Cloud site type.\n - SITE_TYPE_BRANCH: Branch office site type.\n - SITE_TYPE_CONNECTIVITY: Connectivity/PoP site type.\n - SITE_TYPE_CUSTOMER: Customer/partner site type.\n - SITE_TYPE_OTHER: Other site type." }, "addressClassification": { "title": "SiteIpAddressClassification", "type": "object", "properties": { "infrastructureNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in infrastructure networks" }, "userAccessNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in access networks" }, "otherNetworks": { "type": "array", "items": { "type": "string" }, "description": "List of IP address prefixes (in standard CIDR notation) used in other networks" } } }, "architecture": { "type": "array", "items": { "title": "LayerSet", "type": "object", "properties": { "layers": { "type": "array", "items": { "title": "Layer", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the network layer" }, "deviceIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of devices that are deemed to be part of the network layer" } } }, "description": "List of parallel network layers" } } }, "description": "Logical network topology/architecture" }, "siteMarket": { "type": "string", "description": "Name of the Site Market this sire belongs to" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSite" }, "task": true }, { "name": "getResultsForTests", "summary": "GetResultsForTests", "description": "Returns probe results for a set of tests for specified period of time.", "input": [ { "name": "body", "type": "object", "info": ": {\"ids\": \"array\", \"startTime\": \"string\", \"endTime\": \"string\", \"agentIds\": \"array\", \"targets\": \"array\", \"aggregate\": \"boolean\"}", "required": true, "schema": { "title": "GetResultsForTestsRequest", "required": [ "ids", "startTime", "endTime" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of test IDs for which to retrieve results" }, "startTime": { "type": "string", "description": "Timestamp of the oldest results to include in results" }, "endTime": { "type": "string", "description": "Timestamp of the newest results to include in results" }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "List of agent IDs from which to return results" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "List of targets (test dependent) for which to retrieve results" }, "aggregate": { "type": "boolean", "description": "If true, retrieve result aggregated across the requested time period, else return complete time series" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getResultsForTests" }, "task": true }, { "name": "getTraceForTest", "summary": "GetTraceForTest", "description": "Get network trace data for a specific synthetic test. The test must have traceroute task configured.", "input": [ { "name": "body", "type": "object", "info": ": {\"id\": \"string\", \"startTime\": \"string\", \"endTime\": \"string\", \"agentIds\": \"array\", \"targetIps\": \"array\"}", "required": true, "schema": { "title": "GetTraceForTestRequest", "required": [ "startTime", "endTime" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of test for which to retrieve network path trace data" }, "startTime": { "type": "string", "description": "Timestamp of the oldest results to include in results" }, "endTime": { "type": "string", "description": "Timestamp of the newest results to include in results" }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "List of agent IDs from which to return results" }, "targetIps": { "type": "array", "items": { "type": "string" }, "description": "List of target IP addresses for which to retrieve results" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTraceForTest" }, "task": true }, { "name": "listAgents", "summary": "ListAgents", "description": "Returns list of all synthetic agents available in the account.", "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": "/listAgents" }, "task": true }, { "name": "updateAgent", "summary": "UpdateAgent", "description": "Update configuration of a synthetic agent.", "input": [ { "name": "agentId", "type": "string", "info": "Unique identifier of the agent: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"agent\": {\"id\": \"string\", \"siteName\": \"string\", \"status\": \"Must be one of [AGENT_STATUS_UNSPECIFIED, AGENT_STATUS_OK, AGENT_STATUS_WAIT, AGENT_STATUS_DELETED]\", \"alias\": \"string\", \"type\": \"string\", \"os\": \"string\", \"ip\": \"string\", \"lat\": 123, \"long\": 123, \"lastAuthed\": \"string\", \"family\": \"Must be one of [IP_FAMILY_UNSPECIFIED, IP_FAMILY_V4, IP_FAMILY_V6, IP_FAMILY_DUAL]\", \"asn\": 123, \"siteId\": \"string\", \"version\": \"string\", \"city\": \"string\", \"region\": \"string\", \"country\": \"string\", \"testIds\": \"array\", \"localIp\": \"string\", \"cloudRegion\": \"string\", \"cloudProvider\": \"string\", \"agentImpl\": \"Must be one of [IMPLEMENT_TYPE_UNSPECIFIED, IMPLEMENT_TYPE_RUST, IMPLEMENT_TYPE_NODE, IMPLEMENT_TYPE_NETWORK]\", \"labels\": \"array\", \"metadata\": {\"privateIpv4Addresses\": [{\"value\": \"string\"}], \"publicIpv4Addresses\": [{\"value\": \"string\"}], \"privateIpv6Addresses\": [{\"value\": \"string\"}], \"publicIpv6Addresses\": [{\"value\": \"string\"}]}}}", "required": true, "schema": { "title": "UpdateAgentRequest", "type": "object", "properties": { "agent": { "title": "Agent", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the agent", "readOnly": true }, "siteName": { "type": "string", "description": "Name of the site where agent is located" }, "status": { "title": "AgentStatus", "enum": [ "AGENT_STATUS_UNSPECIFIED", "AGENT_STATUS_OK", "AGENT_STATUS_WAIT", "AGENT_STATUS_DELETED" ], "type": "string", "description": "- AGENT_STATUS_UNSPECIFIED: Invalid value.\n - AGENT_STATUS_OK: Agent is ready to accept tests\n - AGENT_STATUS_WAIT: Agent is waiting for authorization\n - AGENT_STATUS_DELETED: Agent was deleted - not user settable" }, "alias": { "type": "string", "description": "User selected descriptive name of the agent" }, "type": { "type": "string", "description": "Type of agent (global | private)", "readOnly": true }, "os": { "type": "string", "description": "OS version of server/VM hosting the agent", "readOnly": true }, "ip": { "type": "string", "description": "Public IP address of the agent (auto-detected)", "readOnly": true }, "lat": { "type": "number", "description": "Latitude of agent's location (signed decimal degrees)" }, "long": { "type": "number", "description": "Longitude of agent's location (signed decimal degrees)" }, "lastAuthed": { "type": "string", "description": "Timestamp of the last authorization", "readOnly": true }, "family": { "title": "IPFamily", "enum": [ "IP_FAMILY_UNSPECIFIED", "IP_FAMILY_V4", "IP_FAMILY_V6", "IP_FAMILY_DUAL" ], "type": "string", "description": "- IP_FAMILY_UNSPECIFIED: Invalid value.\n - IP_FAMILY_V4: IPv4 only\n - IP_FAMILY_V6: IPv6 only\n - IP_FAMILY_DUAL: IPv4 and IPv6 supported" }, "asn": { "type": "integer", "description": "ASN of the AS owning agent's public address" }, "siteId": { "type": "string", "description": "ID of the site hosting the agent (if configured in Kentik)" }, "version": { "type": "string", "description": "Software version of the agent", "readOnly": true }, "city": { "type": "string", "description": "City where the agent is located" }, "region": { "type": "string", "description": "Geographical region of agent's location" }, "country": { "type": "string", "description": "Country of agent's location" }, "testIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of user's test running on the agent", "readOnly": true }, "localIp": { "type": "string", "description": "Internal IP address of the agent" }, "cloudRegion": { "type": "string", "description": "Cloud region (if any) hosting the agent" }, "cloudProvider": { "type": "string", "description": "Cloud provider (if any) hosting the agent" }, "agentImpl": { "title": "ImplementType", "enum": [ "IMPLEMENT_TYPE_UNSPECIFIED", "IMPLEMENT_TYPE_RUST", "IMPLEMENT_TYPE_NODE", "IMPLEMENT_TYPE_NETWORK" ], "type": "string", "description": "- IMPLEMENT_TYPE_RUST: ksynth, a.k.a network agent (implemented in Rust) capable of running all tasks except for page-load and transaction\n - IMPLEMENT_TYPE_NODE: ksynth-agent, a.k.a. app agent (implemented in NodeJS) with Chromium enabled capable of running all tasks\n - IMPLEMENT_TYPE_NETWORK: ksynth-agent, a.k.a. app agent with Chromium disabled, capable of running all tasks except for page-load and transaction" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "List of names of labels associated with the agent" }, "metadata": { "title": "AgentMetadata", "type": "object", "properties": { "privateIpv4Addresses": { "type": "array", "items": { "title": "AgentMetadataIpValue", "type": "object", "properties": { "value": { "type": "string" } } }, "description": "List of private IPv4 addresses" }, "publicIpv4Addresses": { "type": "array", "items": { "title": "AgentMetadataIpValue", "type": "object", "properties": { "value": { "type": "string" } } }, "description": "List of public IPv4 addresses", "readOnly": true }, "privateIpv6Addresses": { "type": "array", "items": { "title": "AgentMetadataIpValue", "type": "object", "properties": { "value": { "type": "string" } } }, "description": "List of private IPv6 addresses" }, "publicIpv6Addresses": { "type": "array", "items": { "title": "AgentMetadataIpValue", "type": "object", "properties": { "value": { "type": "string" } } }, "description": "List of public IPv6 addresses", "readOnly": true } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAgent" }, "task": true }, { "name": "getAgent", "summary": "GetAgent", "description": "Returns information about the requested synthetic agent.", "input": [ { "name": "agentId", "type": "string", "info": "ID of the requested agent: string", "required": true, "schema": { "title": "agentId", "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": "/getAgent" }, "task": true }, { "name": "deleteAgent", "summary": "DeleteAgent", "description": "Deletes the requested agent. The deleted agent is removed from configuration of all tests.", "input": [ { "name": "agentId", "type": "string", "info": "ID of the agent to be deleted: string", "required": true, "schema": { "title": "agentId", "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": "/deleteAgent" }, "task": true }, { "name": "listTests", "summary": "ListTests", "description": "Returns a list of all configured active and paused synthetic tests.", "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": "/listTests" }, "task": true }, { "name": "createTest", "summary": "CreateTest", "description": "Create synthetic test based on configuration provided in the request.", "input": [ { "name": "body", "type": "object", "info": ": {\"test\": {\"id\": \"string\", \"name\": \"string\", \"type\": \"string\", \"status\": \"Must be one of [TEST_STATUS_UNSPECIFIED, TEST_STATUS_ACTIVE, TEST_STATUS_PAUSED, TEST_STATUS_DELETED, TEST_STATUS_PREVIEW]\", \"settings\": {\"hostname\": {\"target\": \"string\"}, \"ip\": {\"targets\": \"array\"}, \"agent\": {\"target\": \"string\", \"useLocalIp\": \"boolean\"}, \"flow\": {\"target\": \"string\", \"targetRefreshIntervalMillis\": 123, \"maxProviders\": 123, \"maxIpTargets\": 123, \"type\": \"string\", \"inetDirection\": \"string\", \"direction\": \"string\"}, \"dns\": {\"target\": \"string\", \"timeout\": 123, \"recordType\": \"Must be one of [DNS_RECORD_UNSPECIFIED, DNS_RECORD_A, DNS_RECORD_AAAA, DNS_RECORD_CNAME, DNS_RECORD_DNAME, DNS_RECORD_NS, DNS_RECORD_MX, DNS_RECORD_PTR, DNS_RECORD_SOA]\", \"servers\": \"array\", \"port\": 123}, \"url\": {\"target\": \"string\", \"timeout\": 123, \"method\": \"string\", \"headers\": \"object\", \"body\": \"string\", \"ignoreTlsErrors\": \"boolean\"}, \"networkGrid\": {\"targets\": \"array\"}, \"pageLoad\": {\"target\": \"string\", \"timeout\": 123, \"headers\": \"object\", \"ignoreTlsErrors\": \"boolean\", \"cssSelectors\": \"object\"}, \"dnsGrid\": {\"target\": \"string\", \"timeout\": 123, \"recordType\": \"Must be one of [DNS_RECORD_UNSPECIFIED, DNS_RECORD_A, DNS_RECORD_AAAA, DNS_RECORD_CNAME, DNS_RECORD_DNAME, DNS_RECORD_NS, DNS_RECORD_MX, DNS_RECORD_PTR, DNS_RECORD_SOA]\", \"servers\": \"array\", \"port\": 123}, \"networkMesh\": {\"useLocalIp\": \"boolean\"}, \"agentIds\": \"array\", \"tasks\": \"array\", \"healthSettings\": {\"latencyCritical\": 123, \"latencyWarning\": 123, \"packetLossCritical\": 123, \"packetLossWarning\": 123, \"jitterCritical\": 123, \"jitterWarning\": 123, \"httpLatencyCritical\": 123, \"httpLatencyWarning\": 123, \"httpValidCodes\": \"array\", \"dnsValidCodes\": \"array\", \"latencyCriticalStddev\": 123, \"latencyWarningStddev\": 123, \"jitterCriticalStddev\": 123, \"jitterWarningStddev\": 123, \"httpLatencyCriticalStddev\": 123, \"httpLatencyWarningStddev\": 123, \"unhealthySubtestThreshold\": 123, \"activation\": {\"gracePeriod\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": \"string\", \"times\": \"string\"}, \"certExpiryWarning\": 123, \"certExpiryCritical\": 123, \"dnsValidIps\": \"string\"}, \"ping\": {\"count\": 123, \"protocol\": \"string\", \"port\": 123, \"timeout\": 123, \"delay\": 123, \"dscp\": 123}, \"trace\": {\"count\": 123, \"protocol\": \"string\", \"port\": 123, \"timeout\": 123, \"limit\": 123, \"delay\": 123, \"dscp\": 123}, \"period\": 123, \"family\": \"Must be one of [IP_FAMILY_UNSPECIFIED, IP_FAMILY_V4, IP_FAMILY_V6, IP_FAMILY_DUAL]\", \"notificationChannels\": \"array\", \"notes\": \"string\"}, \"cdate\": \"string\", \"edate\": \"string\", \"createdBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"lastUpdatedBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"labels\": \"array\"}}", "required": true, "schema": { "title": "CreateTestRequest", "required": [ "test" ], "type": "object", "properties": { "test": { "title": "Test", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the test", "readOnly": true }, "name": { "type": "string", "description": "User selected name of the test" }, "type": { "type": "string", "description": "Type of the test" }, "status": { "title": "TestStatus", "enum": [ "TEST_STATUS_UNSPECIFIED", "TEST_STATUS_ACTIVE", "TEST_STATUS_PAUSED", "TEST_STATUS_DELETED", "TEST_STATUS_PREVIEW" ], "type": "string", "description": "- TEST_STATUS_UNSPECIFIED: Invalid value.\n - TEST_STATUS_ACTIVE: Test is active.\n - TEST_STATUS_PAUSED: Test is paused.\n - TEST_STATUS_DELETED: Test is deleted. Not user settable.\n - TEST_STATUS_PREVIEW: Test is preview" }, "settings": { "title": "TestSettings", "type": "object", "properties": { "hostname": { "title": "HostnameTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name of the target host" } } }, "ip": { "title": "IpTest", "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of targets" } } }, "agent": { "title": "AgentTest", "type": "object", "properties": { "target": { "type": "string", "description": "ID of the target agent" }, "useLocalIp": { "type": "boolean", "description": "Boolean value indicating whether to use local (private) IP address of the target agent" } } }, "flow": { "title": "FlowTest", "type": "object", "properties": { "target": { "type": "string", "description": "Target ASN, CDN, Country, Region of City for autonomous test (type of value depends on flow test sub-type)" }, "targetRefreshIntervalMillis": { "type": "integer", "description": "Period (in milliseconds) for refreshing list of targets based on available flow data" }, "maxProviders": { "type": "integer", "description": "Maximum number of IP providers to track autonomously" }, "maxIpTargets": { "type": "integer", "description": "Maximum number of target IP addresses to select based flow data query" }, "type": { "type": "string", "description": "Autonomous test sub-type (asn | cdn | country | region | city)" }, "inetDirection": { "type": "string", "description": "Selection of address from flow data (src = source address in inbound flows | dst = destination addresses in outbound flows)" }, "direction": { "type": "string", "description": "Direction of flows to match target attribute for extraction of target addresses (src | dst)" } } }, "dns": { "title": "DnsTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name to query" }, "timeout": { "type": "integer", "description": "--- Deprecated: value is ignored. ---" }, "recordType": { "title": "DNSRecord", "enum": [ "DNS_RECORD_UNSPECIFIED", "DNS_RECORD_A", "DNS_RECORD_AAAA", "DNS_RECORD_CNAME", "DNS_RECORD_DNAME", "DNS_RECORD_NS", "DNS_RECORD_MX", "DNS_RECORD_PTR", "DNS_RECORD_SOA" ], "type": "string", "description": "- DNS_RECORD_UNSPECIFIED: Invalid value\n - DNS_RECORD_A: name to IPv4 address(es) mapping\n - DNS_RECORD_AAAA: name to IPv6 address(es) mapping\n - DNS_RECORD_CNAME: alternative resource name\n - DNS_RECORD_DNAME: alternative resource set name\n - DNS_RECORD_NS: domain to name server mapping\n - DNS_RECORD_MX: SMTP mail server record\n - DNS_RECORD_PTR: IPv4/6 address to name mapping\n - DNS_RECORD_SOA: domain meta-data" }, "servers": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of DNS servers" }, "port": { "type": "integer", "description": "Target DNS server port" } } }, "url": { "title": "UrlTest", "type": "object", "properties": { "target": { "type": "string", "description": "HTTP or HTTPS URL to request" }, "timeout": { "type": "integer", "description": "HTTP transaction timeout (in milliseconds)" }, "method": { "type": "string", "description": "HTTP method to use (GET | HEAD | PATCH | POST | PUT)" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of HTTP header values keyed by header names" }, "body": { "type": "string", "description": "HTTP request body" }, "ignoreTlsErrors": { "type": "boolean", "description": "Boolean indicating whether to ignore TLS certificate verification errors" } } }, "networkGrid": { "title": "IpTest", "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of targets" } } }, "pageLoad": { "title": "PageLoadTest", "type": "object", "properties": { "target": { "type": "string", "description": "HTTP or HTTPS URL to request" }, "timeout": { "type": "integer", "description": "HTTP transaction timeout (in milliseconds)" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of HTTP header values keyed by header names" }, "ignoreTlsErrors": { "type": "boolean", "description": "Boolean indicating whether to ignore TLS certificate verification errors" }, "cssSelectors": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of CSS selector values keyed by selector name" } } }, "dnsGrid": { "title": "DnsTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name to query" }, "timeout": { "type": "integer", "description": "--- Deprecated: value is ignored. ---" }, "recordType": { "title": "DNSRecord", "enum": [ "DNS_RECORD_UNSPECIFIED", "DNS_RECORD_A", "DNS_RECORD_AAAA", "DNS_RECORD_CNAME", "DNS_RECORD_DNAME", "DNS_RECORD_NS", "DNS_RECORD_MX", "DNS_RECORD_PTR", "DNS_RECORD_SOA" ], "type": "string", "description": "- DNS_RECORD_UNSPECIFIED: Invalid value\n - DNS_RECORD_A: name to IPv4 address(es) mapping\n - DNS_RECORD_AAAA: name to IPv6 address(es) mapping\n - DNS_RECORD_CNAME: alternative resource name\n - DNS_RECORD_DNAME: alternative resource set name\n - DNS_RECORD_NS: domain to name server mapping\n - DNS_RECORD_MX: SMTP mail server record\n - DNS_RECORD_PTR: IPv4/6 address to name mapping\n - DNS_RECORD_SOA: domain meta-data" }, "servers": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of DNS servers" }, "port": { "type": "integer", "description": "Target DNS server port" } } }, "networkMesh": { "title": "NetworkMeshTest", "type": "object", "properties": { "useLocalIp": { "type": "boolean", "description": "Boolean value indicating whether to use local (private) IP address of the target agents" } } }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of agents assigned to run tasks on behalf of the test" }, "tasks": { "type": "array", "items": { "type": "string" }, "description": "List of task names to run for the test" }, "healthSettings": { "title": "HealthSettings", "type": "object", "properties": { "latencyCritical": { "type": "number", "description": "Threshold for ping or DNS response latency (in microseconds) to trigger critical alarm" }, "latencyWarning": { "type": "number", "description": "Threshold for ping or DNS response latency (in microseconds) to trigger warning alarm" }, "packetLossCritical": { "type": "number", "description": "Threshold for ping packet loss (in %) to trigger critical alarm" }, "packetLossWarning": { "type": "number", "description": "Threshold for ping packet loss (in %) to trigger warning alarm" }, "jitterCritical": { "type": "number", "description": "Threshold for ping jitter (in microseconds) to trigger critical alarm" }, "jitterWarning": { "type": "number", "description": "Threshold for ping jitter (in microseconds) to trigger critical alarm" }, "httpLatencyCritical": { "type": "number", "description": "Threshold for HTTP response latency (in microseconds) to trigger critical alarm" }, "httpLatencyWarning": { "type": "number", "description": "Threshold for HTTP response latency (in microseconds) to trigger warning alarm" }, "httpValidCodes": { "type": "array", "items": { "type": "integer" }, "description": "List of HTTP status codes indicating healthy state" }, "dnsValidCodes": { "type": "array", "items": { "type": "integer" }, "description": "List of DNS status codes indicating healthy state" }, "latencyCriticalStddev": { "type": "number", "description": "Threshold for standard deviation (in microseconds) of ping or DNS response latency to trigger critical alarm" }, "latencyWarningStddev": { "type": "number", "description": "Threshold for standard deviation (in microseconds) of ping or DNS response latency to trigger warning alarm" }, "jitterCriticalStddev": { "type": "number", "description": "Threshold for standard deviation of ping jitter (in microseconds) to trigger critical alarm" }, "jitterWarningStddev": { "type": "number", "description": "Threshold for standard deviation of ping jitter (in microseconds) to trigger warning alarm" }, "httpLatencyCriticalStddev": { "type": "number", "description": "Threshold for standard deviation of HTTP response latency (in microseconds) to trigger critical alarm" }, "httpLatencyWarningStddev": { "type": "number", "description": "Threshold for standard deviation of HTTP response latency (in microseconds) to trigger warning alarm" }, "unhealthySubtestThreshold": { "type": "integer", "description": "Number of tasks (across all agents) that must report unhealthy status in order for alarm to be triggered" }, "activation": { "title": "ActivationSettings", "type": "object", "properties": { "gracePeriod": { "type": "string", "description": "Period of healthy status in minutes within the time window not cancelling alarm activation" }, "timeUnit": { "type": "string", "description": "Time unit for specifying time window (m | h)" }, "timeWindow": { "type": "string", "description": "Time window for evaluating of test for alarm activation" }, "times": { "type": "string", "description": "Number of occurrences of unhealthy test status within the time window triggering alarm activation" } } }, "certExpiryWarning": { "type": "integer", "description": "Threshold for remaining validity of TLS certificate (in days) to trigger warning alarm" }, "certExpiryCritical": { "type": "integer", "description": "Threshold for remaining validity of TLS certificate (in days) to trigger critical alarm" }, "dnsValidIps": { "type": "string", "description": "Comma separated list of IP addresses expected to be received in response to DNS A or AAAA query" } } }, "ping": { "title": "TestPingSettings", "type": "object", "properties": { "count": { "type": "integer", "description": "Number of probe packets to send in one iteration" }, "protocol": { "type": "string", "description": "Transport protocol to use (icmp | tcp)" }, "port": { "type": "integer", "description": "Target port for TCP probes (ignored for ICMP)" }, "timeout": { "type": "integer", "description": "Timeout in milliseconds for execution of the task" }, "delay": { "type": "number", "description": "Inter-probe delay in milliseconds" }, "dscp": { "type": "integer", "description": "DSCP code to be set in IP header of probe packets" } } }, "trace": { "title": "TestTraceSettings", "type": "object", "properties": { "count": { "type": "integer", "description": "Number of probe packets to send in one iteration" }, "protocol": { "type": "string", "description": "Transport protocol to use (icmp | tcp | udp)" }, "port": { "type": "integer", "description": "Target port for TCP or UDP probes (ignored for ICMP)" }, "timeout": { "type": "integer", "description": "Timeout in milliseconds for execution of the task" }, "limit": { "type": "integer", "description": "Maximum number of hops to probe (i.e. maximum TTL)" }, "delay": { "type": "number", "description": "Inter-probe delay in milliseconds" }, "dscp": { "type": "integer", "description": "DSCP code to be set in IP header of probe packets" } } }, "period": { "type": "integer", "description": "Test evaluation period (in seconds)" }, "family": { "title": "IPFamily", "enum": [ "IP_FAMILY_UNSPECIFIED", "IP_FAMILY_V4", "IP_FAMILY_V6", "IP_FAMILY_DUAL" ], "type": "string", "description": "- IP_FAMILY_UNSPECIFIED: Invalid value.\n - IP_FAMILY_V4: IPv4 only\n - IP_FAMILY_V6: IPv6 only\n - IP_FAMILY_DUAL: IPv4 and IPv6 supported" }, "notificationChannels": { "type": "array", "items": { "type": "string" }, "description": "List of IDs of notification channels for alarms triggered by the test" }, "notes": { "type": "string", "description": "Add a note or comment for this test" } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true }, "createdBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "lastUpdatedBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Set of labels associated with the test" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTest" }, "task": true }, { "name": "getTest", "summary": "GetTest", "description": "Returns configuration and status for the requested synthetic test.", "input": [ { "name": "id", "type": "string", "info": "ID of requested test: string", "required": true, "schema": { "title": "id", "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": "/getTest" }, "task": true }, { "name": "deleteTest", "summary": "DeleteTest", "description": "Deletes the synthetics test. All accumulated results for the test cease to be accessible.", "input": [ { "name": "id", "type": "string", "info": "ID of the test to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteTest" }, "task": true }, { "name": "updateTest", "summary": "UpdateTest", "description": "Updates configuration of a synthetic test.", "input": [ { "name": "id", "type": "string", "info": "Unique ID of the test: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"test\": {\"id\": \"string\", \"name\": \"string\", \"type\": \"string\", \"status\": \"Must be one of [TEST_STATUS_UNSPECIFIED, TEST_STATUS_ACTIVE, TEST_STATUS_PAUSED, TEST_STATUS_DELETED, TEST_STATUS_PREVIEW]\", \"settings\": {\"hostname\": {\"target\": \"string\"}, \"ip\": {\"targets\": \"array\"}, \"agent\": {\"target\": \"string\", \"useLocalIp\": \"boolean\"}, \"flow\": {\"target\": \"string\", \"targetRefreshIntervalMillis\": 123, \"maxProviders\": 123, \"maxIpTargets\": 123, \"type\": \"string\", \"inetDirection\": \"string\", \"direction\": \"string\"}, \"dns\": {\"target\": \"string\", \"timeout\": 123, \"recordType\": \"Must be one of [DNS_RECORD_UNSPECIFIED, DNS_RECORD_A, DNS_RECORD_AAAA, DNS_RECORD_CNAME, DNS_RECORD_DNAME, DNS_RECORD_NS, DNS_RECORD_MX, DNS_RECORD_PTR, DNS_RECORD_SOA]\", \"servers\": \"array\", \"port\": 123}, \"url\": {\"target\": \"string\", \"timeout\": 123, \"method\": \"string\", \"headers\": \"object\", \"body\": \"string\", \"ignoreTlsErrors\": \"boolean\"}, \"networkGrid\": {\"targets\": \"array\"}, \"pageLoad\": {\"target\": \"string\", \"timeout\": 123, \"headers\": \"object\", \"ignoreTlsErrors\": \"boolean\", \"cssSelectors\": \"object\"}, \"dnsGrid\": {\"target\": \"string\", \"timeout\": 123, \"recordType\": \"Must be one of [DNS_RECORD_UNSPECIFIED, DNS_RECORD_A, DNS_RECORD_AAAA, DNS_RECORD_CNAME, DNS_RECORD_DNAME, DNS_RECORD_NS, DNS_RECORD_MX, DNS_RECORD_PTR, DNS_RECORD_SOA]\", \"servers\": \"array\", \"port\": 123}, \"networkMesh\": {\"useLocalIp\": \"boolean\"}, \"agentIds\": \"array\", \"tasks\": \"array\", \"healthSettings\": {\"latencyCritical\": 123, \"latencyWarning\": 123, \"packetLossCritical\": 123, \"packetLossWarning\": 123, \"jitterCritical\": 123, \"jitterWarning\": 123, \"httpLatencyCritical\": 123, \"httpLatencyWarning\": 123, \"httpValidCodes\": \"array\", \"dnsValidCodes\": \"array\", \"latencyCriticalStddev\": 123, \"latencyWarningStddev\": 123, \"jitterCriticalStddev\": 123, \"jitterWarningStddev\": 123, \"httpLatencyCriticalStddev\": 123, \"httpLatencyWarningStddev\": 123, \"unhealthySubtestThreshold\": 123, \"activation\": {\"gracePeriod\": \"string\", \"timeUnit\": \"string\", \"timeWindow\": \"string\", \"times\": \"string\"}, \"certExpiryWarning\": 123, \"certExpiryCritical\": 123, \"dnsValidIps\": \"string\"}, \"ping\": {\"count\": 123, \"protocol\": \"string\", \"port\": 123, \"timeout\": 123, \"delay\": 123, \"dscp\": 123}, \"trace\": {\"count\": 123, \"protocol\": \"string\", \"port\": 123, \"timeout\": 123, \"limit\": 123, \"delay\": 123, \"dscp\": 123}, \"period\": 123, \"family\": \"Must be one of [IP_FAMILY_UNSPECIFIED, IP_FAMILY_V4, IP_FAMILY_V6, IP_FAMILY_DUAL]\", \"notificationChannels\": \"array\", \"notes\": \"string\"}, \"cdate\": \"string\", \"edate\": \"string\", \"createdBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"lastUpdatedBy\": {\"id\": \"string\", \"email\": \"string\", \"fullName\": \"string\"}, \"labels\": \"array\"}}", "required": true, "schema": { "title": "UpdateTestRequest", "type": "object", "properties": { "test": { "title": "Test", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the test", "readOnly": true }, "name": { "type": "string", "description": "User selected name of the test" }, "type": { "type": "string", "description": "Type of the test" }, "status": { "title": "TestStatus", "enum": [ "TEST_STATUS_UNSPECIFIED", "TEST_STATUS_ACTIVE", "TEST_STATUS_PAUSED", "TEST_STATUS_DELETED", "TEST_STATUS_PREVIEW" ], "type": "string", "description": "- TEST_STATUS_UNSPECIFIED: Invalid value.\n - TEST_STATUS_ACTIVE: Test is active.\n - TEST_STATUS_PAUSED: Test is paused.\n - TEST_STATUS_DELETED: Test is deleted. Not user settable.\n - TEST_STATUS_PREVIEW: Test is preview" }, "settings": { "title": "TestSettings", "type": "object", "properties": { "hostname": { "title": "HostnameTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name of the target host" } } }, "ip": { "title": "IpTest", "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of targets" } } }, "agent": { "title": "AgentTest", "type": "object", "properties": { "target": { "type": "string", "description": "ID of the target agent" }, "useLocalIp": { "type": "boolean", "description": "Boolean value indicating whether to use local (private) IP address of the target agent" } } }, "flow": { "title": "FlowTest", "type": "object", "properties": { "target": { "type": "string", "description": "Target ASN, CDN, Country, Region of City for autonomous test (type of value depends on flow test sub-type)" }, "targetRefreshIntervalMillis": { "type": "integer", "description": "Period (in milliseconds) for refreshing list of targets based on available flow data" }, "maxProviders": { "type": "integer", "description": "Maximum number of IP providers to track autonomously" }, "maxIpTargets": { "type": "integer", "description": "Maximum number of target IP addresses to select based flow data query" }, "type": { "type": "string", "description": "Autonomous test sub-type (asn | cdn | country | region | city)" }, "inetDirection": { "type": "string", "description": "Selection of address from flow data (src = source address in inbound flows | dst = destination addresses in outbound flows)" }, "direction": { "type": "string", "description": "Direction of flows to match target attribute for extraction of target addresses (src | dst)" } } }, "dns": { "title": "DnsTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name to query" }, "timeout": { "type": "integer", "description": "--- Deprecated: value is ignored. ---" }, "recordType": { "title": "DNSRecord", "enum": [ "DNS_RECORD_UNSPECIFIED", "DNS_RECORD_A", "DNS_RECORD_AAAA", "DNS_RECORD_CNAME", "DNS_RECORD_DNAME", "DNS_RECORD_NS", "DNS_RECORD_MX", "DNS_RECORD_PTR", "DNS_RECORD_SOA" ], "type": "string", "description": "- DNS_RECORD_UNSPECIFIED: Invalid value\n - DNS_RECORD_A: name to IPv4 address(es) mapping\n - DNS_RECORD_AAAA: name to IPv6 address(es) mapping\n - DNS_RECORD_CNAME: alternative resource name\n - DNS_RECORD_DNAME: alternative resource set name\n - DNS_RECORD_NS: domain to name server mapping\n - DNS_RECORD_MX: SMTP mail server record\n - DNS_RECORD_PTR: IPv4/6 address to name mapping\n - DNS_RECORD_SOA: domain meta-data" }, "servers": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of DNS servers" }, "port": { "type": "integer", "description": "Target DNS server port" } } }, "url": { "title": "UrlTest", "type": "object", "properties": { "target": { "type": "string", "description": "HTTP or HTTPS URL to request" }, "timeout": { "type": "integer", "description": "HTTP transaction timeout (in milliseconds)" }, "method": { "type": "string", "description": "HTTP method to use (GET | HEAD | PATCH | POST | PUT)" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of HTTP header values keyed by header names" }, "body": { "type": "string", "description": "HTTP request body" }, "ignoreTlsErrors": { "type": "boolean", "description": "Boolean indicating whether to ignore TLS certificate verification errors" } } }, "networkGrid": { "title": "IpTest", "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of targets" } } }, "pageLoad": { "title": "PageLoadTest", "type": "object", "properties": { "target": { "type": "string", "description": "HTTP or HTTPS URL to request" }, "timeout": { "type": "integer", "description": "HTTP transaction timeout (in milliseconds)" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of HTTP header values keyed by header names" }, "ignoreTlsErrors": { "type": "boolean", "description": "Boolean indicating whether to ignore TLS certificate verification errors" }, "cssSelectors": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of CSS selector values keyed by selector name" } } }, "dnsGrid": { "title": "DnsTest", "type": "object", "properties": { "target": { "type": "string", "description": "Fully qualified DNS name to query" }, "timeout": { "type": "integer", "description": "--- Deprecated: value is ignored. ---" }, "recordType": { "title": "DNSRecord", "enum": [ "DNS_RECORD_UNSPECIFIED", "DNS_RECORD_A", "DNS_RECORD_AAAA", "DNS_RECORD_CNAME", "DNS_RECORD_DNAME", "DNS_RECORD_NS", "DNS_RECORD_MX", "DNS_RECORD_PTR", "DNS_RECORD_SOA" ], "type": "string", "description": "- DNS_RECORD_UNSPECIFIED: Invalid value\n - DNS_RECORD_A: name to IPv4 address(es) mapping\n - DNS_RECORD_AAAA: name to IPv6 address(es) mapping\n - DNS_RECORD_CNAME: alternative resource name\n - DNS_RECORD_DNAME: alternative resource set name\n - DNS_RECORD_NS: domain to name server mapping\n - DNS_RECORD_MX: SMTP mail server record\n - DNS_RECORD_PTR: IPv4/6 address to name mapping\n - DNS_RECORD_SOA: domain meta-data" }, "servers": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses of DNS servers" }, "port": { "type": "integer", "description": "Target DNS server port" } } }, "networkMesh": { "title": "NetworkMeshTest", "type": "object", "properties": { "useLocalIp": { "type": "boolean", "description": "Boolean value indicating whether to use local (private) IP address of the target agents" } } }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of agents assigned to run tasks on behalf of the test" }, "tasks": { "type": "array", "items": { "type": "string" }, "description": "List of task names to run for the test" }, "healthSettings": { "title": "HealthSettings", "type": "object", "properties": { "latencyCritical": { "type": "number", "description": "Threshold for ping or DNS response latency (in microseconds) to trigger critical alarm" }, "latencyWarning": { "type": "number", "description": "Threshold for ping or DNS response latency (in microseconds) to trigger warning alarm" }, "packetLossCritical": { "type": "number", "description": "Threshold for ping packet loss (in %) to trigger critical alarm" }, "packetLossWarning": { "type": "number", "description": "Threshold for ping packet loss (in %) to trigger warning alarm" }, "jitterCritical": { "type": "number", "description": "Threshold for ping jitter (in microseconds) to trigger critical alarm" }, "jitterWarning": { "type": "number", "description": "Threshold for ping jitter (in microseconds) to trigger critical alarm" }, "httpLatencyCritical": { "type": "number", "description": "Threshold for HTTP response latency (in microseconds) to trigger critical alarm" }, "httpLatencyWarning": { "type": "number", "description": "Threshold for HTTP response latency (in microseconds) to trigger warning alarm" }, "httpValidCodes": { "type": "array", "items": { "type": "integer" }, "description": "List of HTTP status codes indicating healthy state" }, "dnsValidCodes": { "type": "array", "items": { "type": "integer" }, "description": "List of DNS status codes indicating healthy state" }, "latencyCriticalStddev": { "type": "number", "description": "Threshold for standard deviation (in microseconds) of ping or DNS response latency to trigger critical alarm" }, "latencyWarningStddev": { "type": "number", "description": "Threshold for standard deviation (in microseconds) of ping or DNS response latency to trigger warning alarm" }, "jitterCriticalStddev": { "type": "number", "description": "Threshold for standard deviation of ping jitter (in microseconds) to trigger critical alarm" }, "jitterWarningStddev": { "type": "number", "description": "Threshold for standard deviation of ping jitter (in microseconds) to trigger warning alarm" }, "httpLatencyCriticalStddev": { "type": "number", "description": "Threshold for standard deviation of HTTP response latency (in microseconds) to trigger critical alarm" }, "httpLatencyWarningStddev": { "type": "number", "description": "Threshold for standard deviation of HTTP response latency (in microseconds) to trigger warning alarm" }, "unhealthySubtestThreshold": { "type": "integer", "description": "Number of tasks (across all agents) that must report unhealthy status in order for alarm to be triggered" }, "activation": { "title": "ActivationSettings", "type": "object", "properties": { "gracePeriod": { "type": "string", "description": "Period of healthy status in minutes within the time window not cancelling alarm activation" }, "timeUnit": { "type": "string", "description": "Time unit for specifying time window (m | h)" }, "timeWindow": { "type": "string", "description": "Time window for evaluating of test for alarm activation" }, "times": { "type": "string", "description": "Number of occurrences of unhealthy test status within the time window triggering alarm activation" } } }, "certExpiryWarning": { "type": "integer", "description": "Threshold for remaining validity of TLS certificate (in days) to trigger warning alarm" }, "certExpiryCritical": { "type": "integer", "description": "Threshold for remaining validity of TLS certificate (in days) to trigger critical alarm" }, "dnsValidIps": { "type": "string", "description": "Comma separated list of IP addresses expected to be received in response to DNS A or AAAA query" } } }, "ping": { "title": "TestPingSettings", "type": "object", "properties": { "count": { "type": "integer", "description": "Number of probe packets to send in one iteration" }, "protocol": { "type": "string", "description": "Transport protocol to use (icmp | tcp)" }, "port": { "type": "integer", "description": "Target port for TCP probes (ignored for ICMP)" }, "timeout": { "type": "integer", "description": "Timeout in milliseconds for execution of the task" }, "delay": { "type": "number", "description": "Inter-probe delay in milliseconds" }, "dscp": { "type": "integer", "description": "DSCP code to be set in IP header of probe packets" } } }, "trace": { "title": "TestTraceSettings", "type": "object", "properties": { "count": { "type": "integer", "description": "Number of probe packets to send in one iteration" }, "protocol": { "type": "string", "description": "Transport protocol to use (icmp | tcp | udp)" }, "port": { "type": "integer", "description": "Target port for TCP or UDP probes (ignored for ICMP)" }, "timeout": { "type": "integer", "description": "Timeout in milliseconds for execution of the task" }, "limit": { "type": "integer", "description": "Maximum number of hops to probe (i.e. maximum TTL)" }, "delay": { "type": "number", "description": "Inter-probe delay in milliseconds" }, "dscp": { "type": "integer", "description": "DSCP code to be set in IP header of probe packets" } } }, "period": { "type": "integer", "description": "Test evaluation period (in seconds)" }, "family": { "title": "IPFamily", "enum": [ "IP_FAMILY_UNSPECIFIED", "IP_FAMILY_V4", "IP_FAMILY_V6", "IP_FAMILY_DUAL" ], "type": "string", "description": "- IP_FAMILY_UNSPECIFIED: Invalid value.\n - IP_FAMILY_V4: IPv4 only\n - IP_FAMILY_V6: IPv6 only\n - IP_FAMILY_DUAL: IPv4 and IPv6 supported" }, "notificationChannels": { "type": "array", "items": { "type": "string" }, "description": "List of IDs of notification channels for alarms triggered by the test" }, "notes": { "type": "string", "description": "Add a note or comment for this test" } } }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true }, "createdBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "lastUpdatedBy": { "title": "UserInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique system generated ID", "readOnly": true }, "email": { "type": "string", "description": "E-mail address of the user", "readOnly": true }, "fullName": { "type": "string", "description": "Full name of the user", "readOnly": true } } }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Set of labels associated with the test" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTest" }, "task": true }, { "name": "setTestStatus", "summary": "SetTestStatus", "description": "Update status of a synthetic test", "input": [ { "name": "id", "type": "string", "info": "ID of the test which status is to be modified: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"id\": \"string\", \"status\": \"Must be one of [TEST_STATUS_UNSPECIFIED, TEST_STATUS_ACTIVE, TEST_STATUS_PAUSED, TEST_STATUS_DELETED, TEST_STATUS_PREVIEW]\"}", "required": true, "schema": { "title": "SetTestStatusRequest", "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the test which status is to be modified" }, "status": { "title": "TestStatus", "enum": [ "TEST_STATUS_UNSPECIFIED", "TEST_STATUS_ACTIVE", "TEST_STATUS_PAUSED", "TEST_STATUS_DELETED", "TEST_STATUS_PREVIEW" ], "type": "string", "description": "- TEST_STATUS_UNSPECIFIED: Invalid value.\n - TEST_STATUS_ACTIVE: Test is active.\n - TEST_STATUS_PAUSED: Test is paused.\n - TEST_STATUS_DELETED: Test is deleted. Not user settable.\n - TEST_STATUS_PREVIEW: Test is preview" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTestStatus" }, "task": true }, { "name": "listUsers", "summary": "ListUsers", "description": "Returns a list of all user accounts in the company.", "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": "/listUsers" }, "task": true }, { "name": "createUser", "summary": "CreateUser", "description": "Creates new user account based on attributes in the request. Returns attributes of the newly created account.", "input": [ { "name": "body", "type": "object", "info": ": {\"user\": {\"id\": \"string\", \"userEmail\": \"string\", \"userFullName\": \"string\", \"role\": \"Must be one of [ROLE_UNSPECIFIED, ROLE_MEMBER, ROLE_ADMINISTRATOR, ROLE_SUPER_ADMINISTRATOR]\", \"permissions\": [{\"capability\": \"string\", \"allowed\": \"boolean\"}], \"filter\": \"string\", \"lastLogin\": \"string\", \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "CreateUserRequest", "required": [ "user" ], "type": "object", "properties": { "user": { "title": "User", "required": [ "userEmail", "userFullName", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "userEmail": { "type": "string", "description": "User e-mail address (serves also as username)" }, "userFullName": { "type": "string", "description": "Full name" }, "role": { "title": "Role", "enum": [ "ROLE_UNSPECIFIED", "ROLE_MEMBER", "ROLE_ADMINISTRATOR", "ROLE_SUPER_ADMINISTRATOR" ], "type": "string", "description": "- ROLE_UNSPECIFIED: Invalid value.\n - ROLE_MEMBER: Member\n - ROLE_ADMINISTRATOR: Administrator\n - ROLE_SUPER_ADMINISTRATOR: Super-administrator" }, "permissions": { "type": "array", "items": { "title": "PermissionEntry", "required": [ "capability", "allowed" ], "type": "object", "properties": { "capability": { "type": "string", "description": "String identifying capability that is granted of denied" }, "allowed": { "type": "boolean", "description": "Flag indicating whether operation is allowed" } } }, "description": "Optional list of permissions granted to the user" }, "filter": { "type": "string", "description": "Optional JSON string defining filter for objects visible to the user" }, "lastLogin": { "type": "string", "description": "UTC Timestamp of user's last login session", "readOnly": true }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createUser" }, "task": true }, { "name": "getUser", "summary": "GetUser", "description": "Returns attributes of a user account specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the requested user: string", "required": true, "schema": { "title": "id", "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": "/getUser" }, "task": true }, { "name": "deleteUser", "summary": "DeleteUser", "description": "Deletes user account specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the the user account to be deleted: string", "required": true, "schema": { "title": "id", "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": "/deleteUser" }, "task": true }, { "name": "updateUser", "summary": "UpdateUser", "description": "Replaces all attributes of a user account specified by ID with attributes in the request. Returns updated attributes.", "input": [ { "name": "id", "type": "string", "info": "System generated unique identifier: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"user\": {\"id\": \"string\", \"userEmail\": \"string\", \"userFullName\": \"string\", \"role\": \"Must be one of [ROLE_UNSPECIFIED, ROLE_MEMBER, ROLE_ADMINISTRATOR, ROLE_SUPER_ADMINISTRATOR]\", \"permissions\": [{\"capability\": \"string\", \"allowed\": \"boolean\"}], \"filter\": \"string\", \"lastLogin\": \"string\", \"cdate\": \"string\", \"edate\": \"string\"}}", "required": true, "schema": { "title": "UpdateUserRequest", "required": [ "user" ], "type": "object", "properties": { "user": { "title": "User", "required": [ "userEmail", "userFullName", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "System generated unique identifier", "readOnly": true }, "userEmail": { "type": "string", "description": "User e-mail address (serves also as username)" }, "userFullName": { "type": "string", "description": "Full name" }, "role": { "title": "Role", "enum": [ "ROLE_UNSPECIFIED", "ROLE_MEMBER", "ROLE_ADMINISTRATOR", "ROLE_SUPER_ADMINISTRATOR" ], "type": "string", "description": "- ROLE_UNSPECIFIED: Invalid value.\n - ROLE_MEMBER: Member\n - ROLE_ADMINISTRATOR: Administrator\n - ROLE_SUPER_ADMINISTRATOR: Super-administrator" }, "permissions": { "type": "array", "items": { "title": "PermissionEntry", "required": [ "capability", "allowed" ], "type": "object", "properties": { "capability": { "type": "string", "description": "String identifying capability that is granted of denied" }, "allowed": { "type": "boolean", "description": "Flag indicating whether operation is allowed" } } }, "description": "Optional list of permissions granted to the user" }, "filter": { "type": "string", "description": "Optional JSON string defining filter for objects visible to the user" }, "lastLogin": { "type": "string", "description": "UTC Timestamp of user's last login session", "readOnly": true }, "cdate": { "type": "string", "description": "Creation timestamp (UTC)", "readOnly": true }, "edate": { "type": "string", "description": "Last modification timestamp (UTC)", "readOnly": true } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUser" }, "task": true }, { "name": "resetActiveSessions", "summary": "ResetActiveSessions", "description": "Resets active sessions for a user specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the the user whose sessions should be reset: string", "required": true, "schema": { "title": "id", "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": "/resetActiveSessions" }, "task": true }, { "name": "resetApiToken", "summary": "ResetApiToken", "description": "Resets API token for a user specified by ID.", "input": [ { "name": "id", "type": "string", "info": "ID of the the user whose API token should be reset: string", "required": true, "schema": { "title": "id", "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": "/resetApiToken" }, "task": true } ], "views": [] }