{ "swagger": "2.0", "info": { "description": "
The REST API enables you to interact with the VMware Aria Operations for Applications service (formerly known as Tanzu Observability by Wavefront) by using standard REST API tools. You can use the REST API to automate commonly executed operations, for example, to tag sources automatically.
When you make REST API calls outside the REST API documentation UI, to authenticate to the service, you must use an API token associated with your user account or a service account. For information on how to get the API token and examples, see Use the Operations for Applications REST API.
", "version": "v2", "title": "Operations for Applications REST API Documentation" }, "basePath": "/", "tags": [{ "name": "Access Policy" }, { "name": "Account (User and Service Account)" }, { "name": "Alert" }, { "name": "Alert Analytics" }, { "name": "ApiToken" }, { "name": "Cloud Integration" }, { "name": "Dashboard" }, { "name": "Derived Metric" }, { "name": "Direct ingestion" }, { "name": "Event" }, { "name": "External Link" }, { "name": "IngestionSpy" }, { "name": "Integration" }, { "name": "Maintenance Window" }, { "name": "Message" }, { "name": "Metric" }, { "name": "Metrics Policy" }, { "name": "Monitored Application" }, { "name": "Monitored Service" }, { "name": "MonitoredCluster" }, { "name": "Notificant" }, { "name": "Proxy" }, { "name": "Query" }, { "name": "Recent AppMap Search" }, { "name": "Recent Traces Search" }, { "name": "Role" }, { "name": "Saved AppMap Search" }, { "name": "Saved AppMap Search Group" }, { "name": "Saved Search" }, { "name": "Saved Traces Search" }, { "name": "Saved Traces Search Group" }, { "name": "Search" }, { "name": "Source" }, { "name": "Span Sampling Policy" }, { "name": "Usage" }, { "name": "User" }, { "name": "UserGroup" }, { "name": "Wavefront" }, { "name": "Webhook" } ], "paths": { "/api/spy/deltas": { "get": { "tags": ["IngestionSpy"], "summary": "Gets new delta counters that are added to existing time series.", "description": "Try it Out button won't work in this case, as it's a streaming API. Endpoint: https://.wavefront.com/api/spy/deltas. \n", "operationId": "spyOnDeltaCounters", "produces": ["text/plain"], "parameters": [{ "name": "counter", "in": "query", "description": "List a delta counter only if its name starts with the specified case-sensitive prefix.\n E.g., counter=orderShirt matches counters named orderShirt and orderShirts, but not OrderShirts.", "required": false, "type": "string" }, { "name": "host", "in": "query", "description": "List a delta counter only if the name of its source starts with the specified case-sensitive prefix.", "required": false, "type": "string" }, { "name": "counterTagKey", "in": "query", "description": "List a delta counter only if it has the specified tag key. Add this parameter multiple times to specify multiple tags, e.g. counterTagKey=cluster&counterTagKey=shard\n put cluster in the first line, put shard in the second line as values", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "sampling", "in": "query", "required": false, "type": "number", "default": 0.01, "format": "double" } ], "responses": { "default": { "description": "successful operation" } } } }, "/api/spy/histograms": { "get": { "tags": ["IngestionSpy"], "summary": "Gets new histograms that are added to existing time series.", "description": "Try it Out button won't work in this case, as it's a streaming API. Endpoint: https://.wavefront.com/api/spy/histograms \n. \n Details usage can be find at: https://docs.wavefront.com/wavefront_monitoring_spy.html#get-ingested-histograms-with-spy", "operationId": "spyOnHistograms", "produces": ["text/plain"], "parameters": [{ "name": "histogram", "in": "query", "description": "List a histogram only if its name starts with the specified case-sensitive prefix.\nE.g., histogram=orderShirt matches histograms named orderShirt and orderShirts, but not OrderShirts.", "required": false, "type": "string" }, { "name": "host", "in": "query", "description": "List a histogram only if the name of its source starts with the specified case-sensitive prefix.", "required": false, "type": "string" }, { "name": "histogramTagKey", "in": "query", "description": "List a histogram only if it has the specified tag key. Add this parameter multiple times to specify multiple tags, e.g. histogramTagKey=cluster&histogramTagKey=shard\n put cluster in the first line, put shard in the second line as values", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "sampling", "in": "query", "required": false, "type": "number", "default": 0.01, "format": "double" } ], "responses": { "default": { "description": "successful operation" } } } }, "/api/spy/ids": { "get": { "tags": ["IngestionSpy"], "summary": "Gets newly allocated IDs that correspond to new metric names, source names, point tags, or span tags. A new ID generally indicates that a new time series has been introduced.", "description": "Try it Out button won't work in this case, as it's a streaming API.\n Endpoint: https://{\n \"policyRules\": [{\n \"name\": \"rule name\",\n \"description\": \"desc\",\n \"action\": \"ALLOW\",\n \"subnet\": \"12.148.72.0/23\"\n }]\n}", "required": false, "schema": { "$ref": "#/definitions/AccessPolicy" }, "x-examples": { "application/json": "{\n \"policyRules\": [{\n \"name\": \"rule name\",\n \"description\": \"desc\",\n \"action\": \"ALLOW\",\n \"subnet\": \"12.148.72.0/23\"\n }]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAccessPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/accesspolicy/validate": { "get": { "tags": ["Access Policy"], "summary": "Validate a given url and ip address", "description": "", "operationId": "validateUrl", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "ip", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAccessPolicyAction" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account": { "get": { "tags": ["Account (User and Service Account)"], "summary": "Get all accounts (users and service accounts) of a customer", "description": "", "operationId": "getAllAccounts", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedAccount" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/deleteAccounts": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Deletes multiple accounts (users or service accounts)", "description": "", "operationId": "deleteMultipleAccounts", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "list of accounts' identifiers to be deleted", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/grant/{permission}": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Grant a permission to accounts (users or service accounts)", "description": "", "operationId": "grantPermissionToAccounts", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "permission", "in": "path", "description": "The permission to grant. Note that
host_tag_management
is the equivalent of the **Source Tag Management** permission, monitored_application_service_management
is the equivalent of the **Integrations** permission, agent_management
is the equivalent of the **Proxies** permission.",
"required": true,
"type": "string",
"enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"]
}, {
"in": "body",
"name": "body",
"description": "List of accounts the specified permission to be granted to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserModel"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/revoke/{permission}": {
"post": {
"tags": ["Account (User and Service Account)"],
"summary": "Revoke a permission from accounts (users or service accounts)",
"description": "",
"operationId": "revokePermissionFromAccounts",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "permission",
"in": "path",
"description": "The permission to revoke. Note that host_tag_management
is the equivalent of the **Source Tag Management** permission, monitored_application_service_management
is the equivalent of the **Integrations** permission, agent_management
is the equivalent of the **Proxies** permission.",
"required": true,
"type": "string",
"enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"]
}, {
"in": "body",
"name": "body",
"description": "List of accounts the specified permission to be revoked from",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserModel"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/serviceaccount": {
"get": {
"tags": ["Account (User and Service Account)"],
"summary": "Get all service accounts",
"description": "",
"operationId": "getAllServiceAccounts",
"produces": ["application/json"],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerListServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
},
"post": {
"tags": ["Account (User and Service Account)"],
"summary": "Creates a service account",
"description": "",
"operationId": "createServiceAccount",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/ServiceAccountWrite"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/serviceaccount/{id}": {
"get": {
"tags": ["Account (User and Service Account)"],
"summary": "Retrieves a service account by identifier",
"description": "",
"operationId": "getServiceAccount",
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
},
"put": {
"tags": ["Account (User and Service Account)"],
"summary": "Updates the service account",
"description": "",
"operationId": "updateServiceAccount",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}, {
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/ServiceAccountWrite"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/serviceaccount/{id}/activate": {
"post": {
"tags": ["Account (User and Service Account)"],
"summary": "Activates the given service account",
"description": "",
"operationId": "activateAccount",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/serviceaccount/{id}/deactivate": {
"post": {
"tags": ["Account (User and Service Account)"],
"summary": "Deactivates the given service account",
"description": "",
"operationId": "deactivateAccount",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerServiceAccount"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/account/user": {
"get": {
"tags": ["Account (User and Service Account)"],
"summary": "Get all user accounts",
"description": "Returns all user accounts",
"operationId": "getAllUserAccounts",
"produces": ["application/json"],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerListUserDTO"
}
}
},
"security": [{
"api_key": []
}
]
},
"post": {
"tags": ["Account (User and Service Account)"],
"summary": "Creates or updates a user account",
"description": "",
"operationId": "createOrUpdateUserAccount",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "sendEmail",
"in": "query",
"description": "Whether to send email notification to the user, if created. Default: false",
"required": false,
"type": "boolean",
"enum": ["true", "false"]
}, {
"in": "body",
"name": "body",
"description": "Example Body: \n{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}", "required": false, "schema": { "$ref": "#/definitions/UserToCreate" }, "x-examples": { "application/json": "{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/user/admin": { "get": { "tags": ["Account (User and Service Account)"], "summary": "Get all users with Accounts permission", "description": "Returns all users with Accounts permission", "operationId": "getUsersWithAccountsPermission", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/user/invite": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Invite user accounts with given user groups and permissions.", "description": "", "operationId": "inviteUserAccounts", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
[\n{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}\n]", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserToCreate" } }, "x-examples": { "application/json": "{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/user/{id}": { "get": { "tags": ["Account (User and Service Account)"], "summary": "Retrieves a user by identifier (email address)", "description": "", "operationId": "getUserAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Account (User and Service Account)"], "summary": "Update user with given user groups and permissions.", "description": "", "operationId": "updateUserAccount", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"identifier\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/UserRequestDTO" }, "x-examples": { "application/json": "{\n \"identifier\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/validateAccounts": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Returns valid accounts (users and service accounts), also invalid identifiers from the given list", "description": "", "operationId": "validateAccounts", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerValidatedUsersDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}": { "get": { "tags": ["Account (User and Service Account)"], "summary": "Get a specific account (user or service account)", "description": "", "operationId": "getAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAccount" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Account (User and Service Account)"], "summary": "Deletes an account (user or service account) identified by id", "description": "", "operationId": "deleteAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAccount" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/addRoles": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Adds specific roles to the account (user or service account)", "description": "", "operationId": "addAccountToRoles", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of roles that should be added to the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/addUserGroups": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Adds specific groups to the account (user or service account)", "description": "", "operationId": "addAccountToUserGroups", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of groups that should be added to the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/businessFunctions": { "get": { "tags": ["Account (User and Service Account)"], "summary": "Returns business functions of a specific account (user or service account).", "description": "", "operationId": "getAccountBusinessFunctions", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSetBusinessFunction" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/grant/{permission}": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Grants a specific permission to account (user or service account)", "description": "", "operationId": "grantAccountPermission", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "permission", "in": "path", "description": "Permission to grant to the account. Please note that'host_tag_management' is the equivalent of the 'Source Tag Management' permission", "required": true, "type": "string", "enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"] } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/removeRoles": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Removes specific roles from the account (user or service account)", "description": "", "operationId": "removeAccountFromRoles", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of roles that should be removed from the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/removeUserGroups": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Removes specific groups from the account (user or service account)", "description": "", "operationId": "removeAccountFromUserGroups", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of groups that should be removed from the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/account/{id}/revoke/{permission}": { "post": { "tags": ["Account (User and Service Account)"], "summary": "Revokes a specific permission from account (user or service account)", "description": "", "operationId": "revokeAccountPermission", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "permission", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert": { "get": { "tags": ["Alert"], "summary": "Get all alerts for a customer", "description": "", "operationId": "getAllAlert", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedAlert" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Alert"], "summary": "Create a specific alert", "description": "", "operationId": "createAlert", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "useMultiQuery", "in": "query", "description": "A flag indicates whether to use the new multi-query alert structures when thefeature is enabled.
{\n \"name\": \"Alert Name\",\n \"target\": \"target:alert-target-id\",\n \"condition\": \"ts(~sample.cpu.loadavg.1m) > 1\",\n \"conditionQueryType\": \"WQL\",\n \"displayExpression\": \"ts(~sample.cpu.loadavg.1m)\",\n \"displayExpressionQueryType\": \"WQL\",\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"severity\": \"INFO\",\n \"alertTriageDashboards\": [{\n \"dashboardId\": \"dashboard-name\",\n \"parameters\": {\n \"constants\": {\n \"key\": \"value\"\n }\n },\n \"description\": \"dashboard description\"\n }\n ],\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n }\n}\nExample Classic Body with multi queries: \n
{\n \"name\": \"Alert Name\",\n \"alertType\": \"CLASSIC\",\n \"alertSources\": [ {\n \"name\": \"A\",\n \"query\": \"${B} > 2\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"severity\": \"WARN\",\n \"minutes\": 5\n}\nExample Threshold Body: \n
{\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"conditions\": {\n \"info\": \"ts(~sample.cpu.loadavg.1m) > 0\",\n \"warn\": \"ts(~sample.cpu.loadavg.1m) > 2\"\n },\n \"displayExpression\": \"ts(~sample.cpu.loadavg.1m)\",\n \"minutes\": 5,\n \"additionalInformation\": \"conditions value entry needs to be of the form: displayExpression operator threshold\"\n}\nExample Threshold Body with multi queries: \n
{\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"alertSources\": [\n {\n \"name\": \"A\",\n \"query\": \"${B}\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"conditions\": {\n \"info\": \"${B} > bool 0\",\n \"warn\": \"${B} > bool 2\"\n },\n \"minutes\": 5\n}\nSupported Characters of Tags: \n
Tag names can contain alphanumeric (a-z, A-Z, 0-9), \ndash (-), underscore (_), and colon (:) characters.\nThe space character is not supported.\n", "required": false, "schema": { "$ref": "#/definitions/Alert" }, "x-examples": { "application/json": "{\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"alertSources\": [\n {\n \"name\": \"A\",\n \"query\": \"${B}\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"conditions\": {\n \"info\": \"${B} > bool 0\",\n \"warn\": \"${B} > bool 2\"\n },\n \"minutes\": 5\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/acl": { "get": { "tags": ["Alert"], "summary": "Get Access Control Lists' union for the specified alerts", "description": "", "operationId": "getAlertAccessControlList", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListAccessControlListReadDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/acl/add": { "post": { "tags": ["Alert"], "summary": "Adds the specified ids to the given alerts' ACL", "description": "", "operationId": "addAlertAccess", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/acl/remove": { "post": { "tags": ["Alert"], "summary": "Removes the specified ids from the given alerts' ACL", "description": "", "operationId": "removeAlertAccess", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/acl/set": { "put": { "tags": ["Alert"], "summary": "Set ACL for the specified alerts", "description": "", "operationId": "setAlertAcl", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/analytics/global": { "get": { "tags": ["Alert Analytics"], "summary": "Get Global Alert Analytics for a customer", "description": "", "operationId": "getGlobalAlertAnalytics", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "start", "in": "query", "description": "Start time in epoch seconds", "required": true, "type": "integer", "format": "int64" }, { "name": "end", "in": "query", "description": "End time in epoch seconds", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerGlobalAlertAnalytic" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/checkQuery": { "post": { "tags": ["Alert"], "summary": "Return the type of provided query.", "description": "", "operationId": "checkQueryType", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/QueryTypeDTO" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerQueryTypeDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/preview": { "post": { "tags": ["Alert"], "summary": "Get all the notification preview for a specific alert", "description": "", "operationId": "previewAlertNotification", "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/Alert" }, "x-examples": { "application/json": "{\n \"name\": \"Alert Name\",\n \"target\": \"target:alert-target-id\",\n \"condition\": \"ts(~sample.cpu.loadavg.1m) > 1\",\n \"conditionQueryType\": \"WQL\",\n \"displayExpression\": \"ts(~sample.cpu.loadavg.1m)\",\n \"displayExpressionQueryType\": \"WQL\",\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"severity\": \"INFO\",\n \"alertTriageDashboards\": [{\n \"dashboardId\": \"dashboard-name\",\n \"parameters\": {\n \"constants\": {\n \"key\": \"value\"\n }\n },\n \"description\": \"dashboard description\"\n }\n ],\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListNotification Messages" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/summary": { "get": { "tags": ["Alert"], "summary": "Count alerts of various statuses for a customer", "description": "", "operationId": "getAlertsSummary", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMapStringInteger" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}": { "get": { "tags": ["Alert"], "summary": "Get a specific alert", "description": "", "operationId": "getAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Alert"], "summary": "Update a specific alert", "description": "", "operationId": "updateAlert", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "useMultiQuery", "in": "query", "description": "A flag indicates whether to use the new multi-query alert structures when the feature is enabled.
{\n \"id\": \"1459375928549\",\n \"name\": \"Alert Name\",\n \"target\": \"target:alert-target-id\",\n \"condition\": \"ts(~sample.cpu.loadavg.1m) > 1\",\n \"conditionQueryType\": \"WQL\",\n \"displayExpression\": \"ts(~sample.cpu.loadavg.1m)\",\n \"displayExpressionQueryType\": \"WQL\",\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"severity\": \"INFO\",\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n }\n}\nExample Classic Body with multi queries: \n
{\n \"id\": \"1459375928549\",\n \"name\": \"Alert Name\",\n \"alertType\": \"CLASSIC\",\n \"alertSources\": [ {\n \"name\": \"A\",\n \"query\": \"${B} > 2\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"severity\": \"WARN\",\n \"minutes\": 5\n}\nExample Threshold Body: \n
{\n \"id\": \"1459375928550\",\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"conditions\": {\n \"info\": \"ts(~sample.cpu.loadavg.1m) > 0\",\n \"warn\": \"ts(~sample.cpu.loadavg.1m) > 5\"\n },\n \"displayExpression\": \"ts(~sample.cpu.loadavg.1m)\",\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"additionalInformation\": \"conditions value entry needs to be of the form: displayExpression operator threshold\"\n}\nExample Threshold Body with multi queries: \n
{\n \"id\": \"1459375928549\",\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"alertSources\": [\n {\n \"name\": \"A\",\n \"query\": \"${B}\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"conditions\": {\n \"info\": \"${B} > bool 0\",\n \"warn\": \"${B} > bool 2\"\n },\n \"minutes\": 5\n}\nSupported Characters of Tags: \n
Tag names can contain alphanumeric (a-z, A-Z, 0-9), \ndash (-), underscore (_), and colon (:) characters.\nThe space character is not supported.\n", "required": false, "schema": { "$ref": "#/definitions/Alert" }, "x-examples": { "application/json": "{\n \"id\": \"1459375928549\",\n \"name\": \"Alert Name\",\n \"alertType\": \"THRESHOLD\",\n \"alertSources\": [\n {\n \"name\": \"A\",\n \"query\": \"${B}\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"CONDITION\"]\n },\n {\n \"name\": \"B\",\n \"query\": \"sum_over_time(~sample.network.bytes.recv[1m])\",\n \"queryType\": \"PROMQL\",\n \"alertSourceType\": [\"AUDIT\"]\n }\n ],\n \"conditions\": {\n \"info\": \"${B} > bool 0\",\n \"warn\": \"${B} > bool 2\"\n },\n \"minutes\": 5\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Alert"], "summary": "Delete a specific alert", "description": "", "operationId": "deleteAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "skipTrash", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/clone": { "post": { "tags": ["Alert"], "summary": "Clones the specified alert", "description": "", "operationId": "cloneAlert", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "v", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/history": { "get": { "tags": ["Alert"], "summary": "Get the version history of a specific alert", "description": "", "operationId": "getAlertHistory", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/history/{version}": { "get": { "tags": ["Alert"], "summary": "Get a specific historical version of a specific alert", "description": "", "operationId": "getAlertVersion", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/install": { "post": { "tags": ["Alert"], "summary": "Unhide a specific integration alert", "description": "", "operationId": "unhideAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/snooze": { "post": { "tags": ["Alert"], "summary": "Snooze a specific alert for some number of seconds", "description": "", "operationId": "snoozeAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "seconds", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/tag": { "get": { "tags": ["Alert"], "summary": "Get all tags associated with a specific alert", "description": "", "operationId": "getAlertTags", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerTagsResponse" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Alert"], "summary": "Set all tags associated with a specific alert", "description": "", "operationId": "setAlertTags", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Supported Characters of Tags: \n
Tag names can contain alphanumeric (a-z, A-Z, 0-9), \ndash (-), underscore (_), and colon (:) characters.\nThe space character is not supported.\n", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerVoid" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/tag/{tagValue}": { "put": { "tags": ["Alert"], "summary": "Add a tag to a specific alert", "description": "", "operationId": "addAlertTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "description": "Supported Characters of Tags: \n
Tag names can contain alphanumeric (a-z, A-Z, 0-9), \ndash (-), underscore (_), and colon (:) characters.\nThe space character is not supported.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerVoid" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Alert"], "summary": "Remove a tag from a specific alert", "description": "", "operationId": "removeAlertTag", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "description": "Supported Characters of Tags: \n
Tag names can contain alphanumeric (a-z, A-Z, 0-9), \ndash (-), underscore (_), and colon (:) characters.\nThe space character is not supported.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerVoid" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/undelete": { "post": { "tags": ["Alert"], "summary": "Undelete a specific alert", "description": "", "operationId": "undeleteAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/uninstall": { "post": { "tags": ["Alert"], "summary": "Hide a specific integration alert ", "description": "", "operationId": "hideAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/alert/{id}/unsnooze": { "post": { "tags": ["Alert"], "summary": "Unsnooze a specific alert", "description": "", "operationId": "unsnoozeAlert", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken": { "get": { "tags": ["ApiToken"], "summary": "Get all api tokens for a user", "description": "", "operationId": "getAllTokens", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["ApiToken"], "summary": "Create new api token", "description": "Returns the list of all api tokens for a user. The newly created api token is the last element of returned list.", "operationId": "createToken", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/customertokens": { "get": { "tags": ["ApiToken"], "summary": "Get all api tokens for a customer", "description": "", "operationId": "getCustomerTokens", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListApiTokenModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/customertokens/revoke": { "put": { "tags": ["ApiToken"], "summary": "Delete the specified api token for a customer", "description": "", "operationId": "deleteCustomerToken", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/UserApiToken" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserApiToken" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/customertokens/{id}": { "get": { "tags": ["ApiToken"], "summary": "Get the specified api token for a customer", "description": "", "operationId": "getCustomerToken", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerApiTokenModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/serviceaccount/{id}": { "get": { "tags": ["ApiToken"], "summary": "Get all api tokens for the given service account", "description": "", "operationId": "getTokensServiceAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["ApiToken"], "summary": "Create a new api token for the service account", "description": "Returns the list of all api tokens for the service account. The newly created api token is the last element of returned list.", "operationId": "generateTokenServiceAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/UserApiToken" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/serviceaccount/{id}/{token}": { "put": { "tags": ["ApiToken"], "summary": "Update the name of the specified api token for the given service account", "description": "", "operationId": "updateTokenNameServiceAccount", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "token", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"tokenID\": \"Token identifier\",\n \"tokenName\": \"Token name\"\n}", "required": false, "schema": { "$ref": "#/definitions/UserApiToken" }, "x-examples": { "application/json": "{\n \"tokenID\": \"Token identifier\",\n \"tokenName\": \"Token name\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserApiToken" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["ApiToken"], "summary": "Delete the specified api token of the given service account", "description": "", "operationId": "deleteTokenServiceAccount", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "token", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/apitoken/{id}": { "put": { "tags": ["ApiToken"], "summary": "Update the name of the specified api token", "description": "", "operationId": "updateTokenName", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"tokenID\": \"Token identifier\",\n \"tokenName\": \"Token name\"\n}", "required": false, "schema": { "$ref": "#/definitions/UserApiToken" }, "x-examples": { "application/json": "{\n \"tokenID\": \"Token identifier\",\n \"tokenName\": \"Token name\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserApiToken" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["ApiToken"], "summary": "Delete the specified api token", "description": "", "operationId": "deleteToken", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListUserApiToken" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/chart/api": { "get": { "tags": ["Query"], "summary": "Perform a charting query against Wavefront servers that returns the appropriate points in the specified time window and granularity", "description": "Long time spans and small granularities can take a long time to calculate", "operationId": "queryApi", "produces": ["application/json", "application/x-javascript; charset=UTF-8", "application/javascript; charset=UTF-8"], "parameters": [{ "name": "n", "in": "query", "description": "name used to identify the query", "required": false, "type": "string" }, { "name": "q", "in": "query", "description": "the query expression to execute", "required": true, "type": "string" }, { "name": "queryType", "in": "query", "description": "the query type of the query", "required": false, "type": "string", "default": "HYBRID", "enum": ["WQL", "PROMQL", "HYBRID"] }, { "name": "s", "in": "query", "description": "the start time of the query window in epoch milliseconds", "required": true, "type": "string" }, { "name": "e", "in": "query", "description": "the end time of the query window in epoch milliseconds (null to use now)", "required": false, "type": "string" }, { "name": "g", "in": "query", "description": "the granularity of the points returned", "required": true, "type": "string", "enum": ["d", "h", "m", "s"] }, { "name": "p", "in": "query", "description": "the approximate maximum number of points to return (may not limit number of points exactly)", "required": false, "type": "string" }, { "name": "i", "in": "query", "description": "whether series with only points that are outside of the query window will be returned (defaults to true)", "required": false, "type": "boolean" }, { "name": "autoEvents", "in": "query", "description": "whether events for sources included in the query will be automatically returned by the query", "required": false, "type": "boolean" }, { "name": "summarization", "in": "query", "description": "summarization strategy to use when bucketing points together", "required": false, "type": "string", "enum": ["MEAN", "MEDIAN", "MIN", "MAX", "SUM", "COUNT", "LAST", "FIRST"] }, { "name": "listMode", "in": "query", "description": "retrieve events more optimally displayed for a list", "required": false, "type": "boolean" }, { "name": "strict", "in": "query", "description": "do not return points outside the query window [s;e), defaults to false", "required": false, "type": "boolean" }, { "name": "view", "in": "query", "description": "view of the query result, metric or histogram, defaults to metric", "required": false, "type": "string", "default": "METRIC", "enum": ["METRIC", "HISTOGRAM", "AUTO"] }, { "name": "includeObsoleteMetrics", "in": "query", "description": "include metrics that have not been reporting recently, defaults to false", "required": false, "type": "boolean" }, { "name": "sorted", "in": "query", "description": "sorts the output so that returned series are in order, defaults to false", "required": false, "type": "boolean", "default": false }, { "name": "cached", "in": "query", "description": "whether the query cache is used, defaults to true", "required": false, "type": "boolean", "default": true }, { "name": "dimensionTuples", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "useRawQK", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/QueryResult" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/chart/metric/detail": { "get": { "tags": ["Metric"], "summary": "Get more details on a metric, including reporting sources and approximate last time reported", "description": "", "operationId": "getMetricDetails", "produces": ["application/json", "application/x-javascript", "application/javascript"], "parameters": [{ "name": "m", "in": "query", "description": "Metric name", "required": true, "type": "string" }, { "name": "l", "in": "query", "description": "limit", "required": false, "type": "integer", "format": "int32" }, { "name": "c", "in": "query", "description": "cursor value to continue if the number of results exceeds 1000", "required": false, "type": "string" }, { "name": "h", "in": "query", "description": "glob pattern for sources to include in the query result", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/MetricDetailsResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/chart/raw": { "get": { "tags": ["Query"], "summary": "Perform a raw data query against Wavefront servers that returns second granularity points grouped by tags", "description": "An API to check if ingested points are as expected. Points ingested within a single second are averaged when returned.", "operationId": "queryRaw", "produces": ["application/json"], "parameters": [{ "name": "host", "in": "query", "description": "host to query ingested points for (cannot contain wildcards). host or source is equivalent, only one should be used.", "required": false, "type": "string" }, { "name": "source", "in": "query", "description": "source to query ingested points for (cannot contain wildcards). host or source is equivalent, only one should be used.", "required": false, "type": "string" }, { "name": "metric", "in": "query", "description": "metric to query ingested points for (cannot contain wildcards)", "required": true, "type": "string" }, { "name": "startTime", "in": "query", "description": "start time in epoch milliseconds (cannot be more than a day in the past) null to use an hour before endTime", "required": false, "type": "integer", "format": "int64" }, { "name": "endTime", "in": "query", "description": "end time in epoch milliseconds (cannot be more than a day in the past) null to use now", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/RawTimeseries" } } }, "400": { "description": "Invalid request parameters" }, "401": { "description": "Authorization Error" }, "404": { "description": "Metric not found for specified source/host" }, "500": { "description": "Server Error" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration": { "get": { "tags": ["Cloud Integration"], "summary": "Get all cloud integrations for a customer", "description": "", "operationId": "getAllCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedCloudIntegration" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Cloud Integration"], "summary": "Create a cloud integration", "description": "", "operationId": "createCloudIntegration", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\":\"CloudWatch integration\",\n \"service\":\"CLOUDWATCH\",\n \"cloudWatch\":{\n \"baseCredentials\":{\n \"roleArn\":\"arn:aws:iam::<accountid>:role/<rolename>\"\n },\n \"metricFilterRegex\":\"^aws.(sqs|ec2|ebs|elb).*$\",\n \"pointTagFilterRegex\":\"(region|name)\"\n },\n \"serviceRefreshRateInMins\":5\n}", "required": false, "schema": { "$ref": "#/definitions/CloudIntegration" }, "x-examples": { "application/json": "{\n \"name\":\"CloudWatch integration\",\n \"service\":\"CLOUDWATCH\",\n \"cloudWatch\":{\n \"baseCredentials\":{\n \"roleArn\":\"arn:aws:iam::<accountid>:role/<rolename>\"\n },\n \"metricFilterRegex\":\"^aws.(sqs|ec2|ebs|elb).*$\",\n \"pointTagFilterRegex\":\"(region|name)\"\n },\n \"serviceRefreshRateInMins\":5\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/awsExternalId": { "post": { "tags": ["Cloud Integration"], "summary": "Create an external id", "description": "", "operationId": "createAWSExternalId", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/awsExternalId/{id}": { "get": { "tags": ["Cloud Integration"], "summary": "GETs (confirms) a valid external id that was created by Wavefront", "description": "", "operationId": "getAWSExternalId", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Cloud Integration"], "summary": "DELETEs an external id that was created by Wavefront", "description": "", "operationId": "deleteAWSExternalId", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/{id}": { "get": { "tags": ["Cloud Integration"], "summary": "Get a specific cloud integration", "description": "", "operationId": "getCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Cloud Integration"], "summary": "Update a specific cloud integration", "description": "", "operationId": "updateCloudIntegration", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\":\"CloudWatch integration\",\n \"service\":\"CLOUDWATCH\",\n \"cloudWatch\":{\n \"baseCredentials\":{\n \"roleArn\":\"arn:aws:iam::<accountid>:role/<rolename>\"\n },\n \"metricFilterRegex\":\"^aws.(sqs|ec2|ebs|elb).*$\",\n \"pointTagFilterRegex\":\"(region|name)\"\n },\n \"serviceRefreshRateInMins\":5\n}", "required": false, "schema": { "$ref": "#/definitions/CloudIntegration" }, "x-examples": { "application/json": "{\n \"name\":\"CloudWatch integration\",\n \"service\":\"CLOUDWATCH\",\n \"cloudWatch\":{\n \"baseCredentials\":{\n \"roleArn\":\"arn:aws:iam::<accountid>:role/<rolename>\"\n },\n \"metricFilterRegex\":\"^aws.(sqs|ec2|ebs|elb).*$\",\n \"pointTagFilterRegex\":\"(region|name)\"\n },\n \"serviceRefreshRateInMins\":5\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Cloud Integration"], "summary": "Delete a specific cloud integration", "description": "", "operationId": "deleteCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "skipTrash", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/{id}/disable": { "post": { "tags": ["Cloud Integration"], "summary": "Disable a specific cloud integration", "description": "", "operationId": "disableCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/{id}/enable": { "post": { "tags": ["Cloud Integration"], "summary": "Enable a specific cloud integration", "description": "", "operationId": "enableCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cloudintegration/{id}/undelete": { "post": { "tags": ["Cloud Integration"], "summary": "Undelete a specific cloud integration", "description": "", "operationId": "undeleteCloudIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/cluster/info": { "get": { "tags": ["Wavefront"], "summary": "API endpoint to get cluster info", "description": "", "operationId": "getClusterInfo", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerClusterInfoDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard": { "get": { "tags": ["Dashboard"], "summary": "Get all dashboards for a customer", "description": "", "operationId": "getAllDashboard", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDashboard" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Dashboard"], "summary": "Create a specific dashboard", "description": "", "operationId": "createDashboard", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Dashboard API example\",\n \"id\": \"api-example\",\n \"url\": \"api-example\",\n \"description\": \"Dashboard Description\",\n \"sections\": [\n {\n \"name\": \"Section 1\",\n \"rows\": [\n {\n \"charts\": [\n {\n \"name\": \"Chart 1\",\n \"description\": \"description1\",\n \"sources\": [\n {\n \"name\": \"Source1\",\n \"query\": \"ts()\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/Dashboard" }, "x-examples": { "application/json": "{\n \"name\": \"Dashboard API example\",\n \"id\": \"api-example\",\n \"url\": \"api-example\",\n \"description\": \"Dashboard Description\",\n \"sections\": [\n {\n \"name\": \"Section 1\",\n \"rows\": [\n {\n \"charts\": [\n {\n \"name\": \"Chart 1\",\n \"description\": \"description1\",\n \"sources\": [\n {\n \"name\": \"Source1\",\n \"query\": \"ts()\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/acl": { "get": { "tags": ["Dashboard"], "summary": "Get list of Access Control Lists for the specified dashboards", "description": "", "operationId": "getDashboardAccessControlList", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListAccessControlListReadDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/acl/add": { "post": { "tags": ["Dashboard"], "summary": "Adds the specified ids to the given dashboards' ACL", "description": "", "operationId": "addDashboardAccess", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/acl/remove": { "post": { "tags": ["Dashboard"], "summary": "Removes the specified ids from the given dashboards' ACL", "description": "", "operationId": "removeDashboardAccess", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/acl/set": { "put": { "tags": ["Dashboard"], "summary": "Set ACL for the specified dashboards", "description": "", "operationId": "setDashboardAcl", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessControlListWriteDTO" } } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}": { "get": { "tags": ["Dashboard"], "summary": "Get a specific dashboard", "description": "", "operationId": "getDashboard", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Dashboard"], "summary": "Update a specific dashboard", "description": "", "operationId": "updateDashboard", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Dashboard API example\",\n \"id\": \"api-example\",\n \"url\": \"api-example\",\n \"description\": \"Dashboard Description\",\n \"sections\": [\n {\n \"name\": \"Section 1\",\n \"rows\": [\n {\n \"charts\": [\n {\n \"name\": \"Chart 1\",\n \"description\": \"description1\",\n \"sources\": [\n {\n \"name\": \"Source1\",\n \"query\": \"ts()\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/Dashboard" }, "x-examples": { "application/json": "{\n \"name\": \"Dashboard API example\",\n \"id\": \"api-example\",\n \"url\": \"api-example\",\n \"description\": \"Dashboard Description\",\n \"sections\": [\n {\n \"name\": \"Section 1\",\n \"rows\": [\n {\n \"charts\": [\n {\n \"name\": \"Chart 1\",\n \"description\": \"description1\",\n \"sources\": [\n {\n \"name\": \"Source1\",\n \"query\": \"ts()\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Dashboard"], "summary": "Delete a specific dashboard", "description": "", "operationId": "deleteDashboard", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "skipTrash", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/favorite": { "post": { "tags": ["Dashboard"], "summary": "Mark a dashboard as favorite", "description": "", "operationId": "favoriteDashboard", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/history": { "get": { "tags": ["Dashboard"], "summary": "Get the version history of a specific dashboard", "description": "", "operationId": "getDashboardHistory", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/history/{version}": { "get": { "tags": ["Dashboard"], "summary": "Get a specific version of a specific dashboard", "description": "", "operationId": "getDashboardVersion", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/tag": { "get": { "tags": ["Dashboard"], "summary": "Get all tags associated with a specific dashboard", "description": "", "operationId": "getDashboardTags", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerTagsResponse" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Dashboard"], "summary": "Set all tags associated with a specific dashboard", "description": "", "operationId": "setDashboardTags", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/tag/{tagValue}": { "put": { "tags": ["Dashboard"], "summary": "Add a tag to a specific dashboard", "description": "", "operationId": "addDashboardTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Dashboard"], "summary": "Remove a tag from a specific dashboard", "description": "", "operationId": "removeDashboardTag", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/undelete": { "post": { "tags": ["Dashboard"], "summary": "Undelete a specific dashboard", "description": "", "operationId": "undeleteDashboard", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/dashboard/{id}/unfavorite": { "post": { "tags": ["Dashboard"], "summary": "Unmark a dashboard as favorite", "description": "", "operationId": "unfavoriteDashboard", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric": { "get": { "tags": ["Derived Metric"], "summary": "Get all derived metric definitions for a customer", "description": "", "operationId": "getAllDerivedMetrics", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Derived Metric"], "summary": "Create a specific derived metric definition", "description": "", "operationId": "createDerivedMetric", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Query Name\",\n \"query\": \"aliasMetric(ts(~sample.cpu.loadavg.1m), \\\"my.new.metric\\\")\",\n \"minutes\": 5,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"derivedMetricTag1\"\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/DerivedMetricDefinition" }, "x-examples": { "application/json": "{\n \"name\": \"Query Name\",\n \"query\": \"aliasMetric(ts(~sample.cpu.loadavg.1m), \\\"my.new.metric\\\")\",\n \"minutes\": 5,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"derivedMetricTag1\"\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}": { "get": { "tags": ["Derived Metric"], "summary": "Get a specific registered query", "description": "", "operationId": "getDerivedMetric", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Derived Metric"], "summary": "Update a specific derived metric definition", "description": "", "operationId": "updateDerivedMetric", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"id\": \"1459375928549\",\n \"name\": \"Query Name\",\n \"createUserId\": \"user\",\n \"query\": \"aliasMetric(ts(~sample.cpu.loadavg.1m), \\\"my.new.metric\\\")\",\n \"minutes\": 5,\n \"additionalInformation\": \"Additional Info\"\n}", "required": false, "schema": { "$ref": "#/definitions/DerivedMetricDefinition" }, "x-examples": { "application/json": "{\n \"id\": \"1459375928549\",\n \"name\": \"Query Name\",\n \"createUserId\": \"user\",\n \"query\": \"aliasMetric(ts(~sample.cpu.loadavg.1m), \\\"my.new.metric\\\")\",\n \"minutes\": 5,\n \"additionalInformation\": \"Additional Info\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Derived Metric"], "summary": "Delete a specific derived metric definition", "description": "", "operationId": "deleteDerivedMetric", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "skipTrash", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}/history": { "get": { "tags": ["Derived Metric"], "summary": "Get the version history of a specific derived metric definition", "description": "", "operationId": "getDerivedMetricHistory", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}/history/{version}": { "get": { "tags": ["Derived Metric"], "summary": "Get a specific historical version of a specific derived metric definition", "description": "", "operationId": "getDerivedMetricByVersion", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}/tag": { "get": { "tags": ["Derived Metric"], "summary": "Get all tags associated with a specific derived metric definition", "description": "", "operationId": "getDerivedMetricTags", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerTagsResponse" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Derived Metric"], "summary": "Set all tags associated with a specific derived metric definition", "description": "", "operationId": "setDerivedMetricTags", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}/tag/{tagValue}": { "put": { "tags": ["Derived Metric"], "summary": "Add a tag to a specific Derived Metric", "description": "", "operationId": "addTagToDerivedMetric", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Derived Metric"], "summary": "Remove a tag from a specific Derived Metric", "description": "", "operationId": "removeTagFromDerivedMetric", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/derivedmetric/{id}/undelete": { "post": { "tags": ["Derived Metric"], "summary": "Undelete a specific derived metric definition", "description": "", "operationId": "undeleteDerivedMetric", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event": { "get": { "tags": ["Event"], "summary": "List all the events for a customer within a time range", "description": "", "operationId": "getAllEventsWithTimeRange", "produces": ["application/json"], "parameters": [{ "name": "earliestStartTimeEpochMillis", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "latestStartTimeEpochMillis", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "cursor", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedEvent" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Event"], "summary": "Create a specific event", "description": "The following fields are readonly and will be ignored when passed in the request:
id
, isEphemeral
, isUserEvent
, runningState
, canDelete
, canClose
, creatorType
, createdAt
, updatedAt
, createdEpochMillis
, updatedEpochMillis
, updaterId
, creatorId
, and summarizedEvents
",
"operationId": "createEvent",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "Example Body: \n{\n \"name\": \"Event API Example\",\n \"annotations\": {\n \"severity\": \"info\",\n \"type\": \"event type\",\n \"details\": \"description\"\n },\n \"tags\" : [\n \"eventTag1\"\n ],\n \"startTime\": 1490000000000,\n \"endTime\": 1490000000001\n}", "required": false, "schema": { "$ref": "#/definitions/Event" }, "x-examples": { "application/json": "{\n \"name\": \"Event API Example\",\n \"annotations\": {\n \"severity\": \"info\",\n \"type\": \"event type\",\n \"details\": \"description\"\n },\n \"tags\" : [\n \"eventTag1\"\n ],\n \"startTime\": 1490000000000,\n \"endTime\": 1490000000001\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/alertFirings": { "get": { "tags": ["Event"], "summary": "Get firings events of an alert within a time range", "description": "", "operationId": "getAlertFiringEvents", "produces": ["application/json"], "parameters": [{ "name": "alertId", "in": "query", "required": true, "type": "string" }, { "name": "earliestStartTimeEpochMillis", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "latestStartTimeEpochMillis", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" }, { "name": "asc", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}": { "get": { "tags": ["Event"], "summary": "Get a specific event", "description": "", "operationId": "getEvent", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerEvent" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Event"], "summary": "Update a specific user event.", "description": "This API supports only user events.\nThe API does not support update of system events (e.g. alert events).\nThe following fields are readonly and will be ignored when passed in the request:
id
, isEphemeral
, isUserEvent
, runningState
, canDelete
, canClose
, creatorType
, createdAt
, updatedAt
, createdEpochMillis
, updatedEpochMillis
, updaterId
, creatorId
, and summarizedEvents
",
"operationId": "updateUserEvent",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}, {
"in": "body",
"name": "body",
"description": "Example Body: \n{\n \"name\": \"Event API Example\",\n \"annotations\": {\n \"severity\": \"info\",\n \"type\": \"event type\",\n \"details\": \"description\"\n },\n \"tags\" : [\n \"eventTag1\"\n ],\n \"startTime\": 1490000000000,\n \"endTime\": 1490000000001\n}", "required": false, "schema": { "$ref": "#/definitions/Event" }, "x-examples": { "application/json": "{\n \"name\": \"Event API Example\",\n \"annotations\": {\n \"severity\": \"info\",\n \"type\": \"event type\",\n \"details\": \"description\"\n },\n \"tags\" : [\n \"eventTag1\"\n ],\n \"startTime\": 1490000000000,\n \"endTime\": 1490000000001\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerEvent" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Event"], "summary": "Delete a specific user event", "description": "This API supports only user events.\nThe API does not support deletion of system events (e.g. alert events).", "operationId": "deleteUserEvent", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/alertFiringDetails": { "get": { "tags": ["Event"], "summary": "Return details of a particular alert firing, including all the series that fired during the referred alert firing", "description": "", "operationId": "getAlertFiringDetails", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "description": "id of an event of type alert or alert-detail, used to lookup the particular alert firing", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSetSourceLabelPair" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/alertQueriesSlug": { "get": { "tags": ["Event"], "summary": "If the specified event is associated with an alert, returns a slug encoding the queries having to do with that alert firing or resolution", "description": "", "operationId": "getAlertEventQueriesSlug", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/close": { "post": { "tags": ["Event"], "summary": "Close a specific event", "description": "This API supports only user events.\nThe API does not support close of system events (e.g. alert events).", "operationId": "closeUserEvent", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/events": { "get": { "tags": ["Event"], "summary": "List all related events for a specific firing event with a time span of one hour", "description": "", "operationId": "getRelatedEventsWithTimeSpan", "produces": ["application/json"], "parameters": [{ "name": "isOverlapped", "in": "query", "required": false, "type": "boolean" }, { "name": "renderingMethod", "in": "query", "required": false, "type": "string", "enum": ["HOST", "METRIC", "SIMILARITY"] }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" }, { "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/tag": { "get": { "tags": ["Event"], "summary": "Get all tags associated with a specific event", "description": "", "operationId": "getEventTags", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerTagsResponse" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Event"], "summary": "Set all tags associated with a specific event", "description": "", "operationId": "setEventTags", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/event/{id}/tag/{tagValue}": { "put": { "tags": ["Event"], "summary": "Add a tag to a specific event", "description": "", "operationId": "addEventTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Event"], "summary": "Remove a tag from a specific event", "description": "", "operationId": "removeEventTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/extlink": { "get": { "tags": ["External Link"], "summary": "Get all external links for a customer", "description": "", "operationId": "getAllExternalLink", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedExternalLink" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["External Link"], "summary": "Create a specific external link", "description": "", "operationId": "createExternalLink", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"External Link API Example\",\n \"template\": \"https://example.com/{{source}}\",\n \"description\": \"External Link Description\"\n}", "required": false, "schema": { "$ref": "#/definitions/ExternalLink" }, "x-examples": { "application/json": "{\n \"name\": \"External Link API Example\",\n \"template\": \"https://example.com/{{source}}\",\n \"description\": \"External Link Description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerExternalLink" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/extlink/{id}": { "get": { "tags": ["External Link"], "summary": "Get a specific external link", "description": "", "operationId": "getExternalLink", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerExternalLink" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["External Link"], "summary": "Update a specific external link", "description": "", "operationId": "updateExternalLink", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"External Link API Example\",\n \"template\": \"https://example.com/{{source}}\",\n \"description\": \"External Link Description\"\n}", "required": false, "schema": { "$ref": "#/definitions/ExternalLink" }, "x-examples": { "application/json": "{\n \"name\": \"External Link API Example\",\n \"template\": \"https://example.com/{{source}}\",\n \"description\": \"External Link Description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerExternalLink" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["External Link"], "summary": "Delete a specific external link", "description": "", "operationId": "deleteExternalLink", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerExternalLink" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration": { "get": { "tags": ["Integration"], "summary": "Gets a flat list of all Wavefront integrations available, along with their status", "description": "", "operationId": "getAllIntegration", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/installed": { "get": { "tags": ["Integration"], "summary": "Gets a flat list of all Integrations that are installed, along with their status", "description": "", "operationId": "getInstalledIntegration", "produces": ["application/json"], "parameters": [{ "name": "hasContent", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "returnContent", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/manifests": { "get": { "tags": ["Integration"], "summary": "Gets all Wavefront integrations as structured in their integration manifests, along with their status and content", "description": "", "operationId": "getAllIntegrationInManifests", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListIntegrationManifestGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/manifests/min": { "get": { "tags": ["Integration"], "summary": "Gets all Wavefront integrations as structured in their integration manifests.", "description": "", "operationId": "getAllIntegrationInManifestsMin", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListIntegrationManifestGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/status": { "get": { "tags": ["Integration"], "summary": "Gets the status of all Wavefront integrations", "description": "", "operationId": "getAllIntegrationStatuses", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMapStringIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}": { "get": { "tags": ["Integration"], "summary": "Gets a single Wavefront integration by its id, along with its status", "description": "", "operationId": "getIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "refresh", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}/install": { "post": { "tags": ["Integration"], "summary": "Installs a Wavefront integration", "description": "", "operationId": "installIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}/install-all-alerts": { "post": { "tags": ["Integration"], "summary": "Enable all alerts associated with this integration", "description": "", "operationId": "installAllIntegrationAlerts", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/InstallAlerts" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}/status": { "get": { "tags": ["Integration"], "summary": "Gets the status of a single Wavefront integration", "description": "", "operationId": "getIntegrationStatus", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}/uninstall": { "post": { "tags": ["Integration"], "summary": "Uninstalls a Wavefront integration", "description": "", "operationId": "uninstallIntegration", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/integration/{id}/uninstall-all-alerts": { "post": { "tags": ["Integration"], "summary": "Disable all alerts associated with this integration", "description": "", "operationId": "uninstallAllIntegrationAlerts", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIntegrationStatus" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/maintenancewindow": { "get": { "tags": ["Maintenance Window"], "summary": "Get all maintenance windows for a customer", "description": "", "operationId": "getAllMaintenanceWindow", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Maintenance Window"], "summary": "Create a maintenance window", "description": "", "operationId": "createMaintenanceWindow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"reason\": \"MW Reason\",\n \"title\": \"MW Title\",\n \"startTimeInSeconds\": 1483228800,\n \"endTimeInSeconds\": 1483232400,\n \"relevantCustomerTags\": [\n \"alertId1\"\n ],\n \"relevantHostTags\": [\n \"sourceTag1\"\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/MaintenanceWindow" }, "x-examples": { "application/json": "{\n \"reason\": \"MW Reason\",\n \"title\": \"MW Title\",\n \"startTimeInSeconds\": 1483228800,\n \"endTimeInSeconds\": 1483232400,\n \"relevantCustomerTags\": [\n \"alertId1\"\n ],\n \"relevantHostTags\": [\n \"sourceTag1\"\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/maintenancewindow/{id}": { "get": { "tags": ["Maintenance Window"], "summary": "Get a specific maintenance window", "description": "", "operationId": "getMaintenanceWindow", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Maintenance Window"], "summary": "Update a specific maintenance window", "description": "", "operationId": "updateMaintenanceWindow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"reason\": \"MW Reason\",\n \"title\": \"MW Title\",\n \"startTimeInSeconds\": 1483228800,\n \"endTimeInSeconds\": 1483232400,\n \"relevantCustomerTags\": [\n \"alertId1\"\n ],\n \"relevantHostTags\": [\n \"sourceTag1\"\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/MaintenanceWindow" }, "x-examples": { "application/json": "{\n \"reason\": \"MW Reason\",\n \"title\": \"MW Title\",\n \"startTimeInSeconds\": 1483228800,\n \"endTimeInSeconds\": 1483232400,\n \"relevantCustomerTags\": [\n \"alertId1\"\n ],\n \"relevantHostTags\": [\n \"sourceTag1\"\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Maintenance Window"], "summary": "Delete a specific maintenance window", "description": "", "operationId": "deleteMaintenanceWindow", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/message": { "get": { "tags": ["Message"], "summary": "Gets messages applicable to the current user, i.e. within time range and distribution scope", "description": "", "operationId": "userGetMessages", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" }, { "name": "unreadOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMessage" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/message/{id}/read": { "post": { "tags": ["Message"], "summary": "Mark a specific message as read", "description": "", "operationId": "userReadMessage", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMessage" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/metricspolicy": { "get": { "tags": ["Metrics Policy"], "summary": "Get the metrics policy", "description": "", "operationId": "getMetricsPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMetricsPolicyReadModel" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Metrics Policy"], "summary": "Update the metrics policy", "description": "", "operationId": "updateMetricsPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n\"policyRules\": [{\n \"name\": \"Policy rule1 name\",\n \"description\": \"Policy rule1 description\",\n \"prefixes\": [\"revenue.*\"],\n \"tags\": [{\"key\":\"sensitive\", \"value\":\"false\"},\n {\"key\":\"source\", \"value\":\"app1\"}],\n \"tagsAnded\": \"true\",\n \"accessType\": \"ALLOW\",\n \"accounts\": [\"accountId1\", \"accountId2\"],\n \"userGroups\": [\"userGroupId1\"],\n \"roles\": [\"roleId\"]\n},\n{\n \"name\": \"Policy rule2 name\",\n \"description\": \"Policy rule2 description\",\n \"prefixes\": [\"revenue.*\"],\n \"accessType\": \"BLOCK\",\n \"accounts\": [\"accountId3\"],\n \"userGroups\": [\"userGroupId1\"]\n}]\n}", "required": false, "schema": { "$ref": "#/definitions/MetricsPolicyWriteModel" }, "x-examples": { "application/json": "{\n\"policyRules\": [{\n \"name\": \"Policy rule1 name\",\n \"description\": \"Policy rule1 description\",\n \"prefixes\": [\"revenue.*\"],\n \"tags\": [{\"key\":\"sensitive\", \"value\":\"false\"},\n {\"key\":\"source\", \"value\":\"app1\"}],\n \"tagsAnded\": \"true\",\n \"accessType\": \"ALLOW\",\n \"accounts\": [\"accountId1\", \"accountId2\"],\n \"userGroups\": [\"userGroupId1\"],\n \"roles\": [\"roleId\"]\n},\n{\n \"name\": \"Policy rule2 name\",\n \"description\": \"Policy rule2 description\",\n \"prefixes\": [\"revenue.*\"],\n \"accessType\": \"BLOCK\",\n \"accounts\": [\"accountId3\"],\n \"userGroups\": [\"userGroupId1\"]\n}]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMetricsPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/metricspolicy/history": { "get": { "tags": ["Metrics Policy"], "summary": "Get the version history of metrics policy", "description": "", "operationId": "getMetricsPolicyHistory", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/metricspolicy/history/{version}": { "get": { "tags": ["Metrics Policy"], "summary": "Get a specific historical version of a metrics policy", "description": "", "operationId": "getMetricsPolicyByVersion", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMetricsPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/metricspolicy/revert/{version}": { "post": { "tags": ["Metrics Policy"], "summary": "Revert to a specific historical version of a metrics policy", "description": "", "operationId": "revertMetricsPolicyByVersion", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMetricsPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredapplication": { "get": { "tags": ["Monitored Application"], "summary": "Get all monitored services", "description": "", "operationId": "getAllApplications", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredApplicationDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredapplication/{application}": { "get": { "tags": ["Monitored Application"], "summary": "Get a specific application", "description": "", "operationId": "getApplication", "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMonitoredApplicationDTO" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Monitored Application"], "summary": "Update a specific service", "description": "", "operationId": "updateService", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"application\": \"beachshirts\",\n \"satisfiedLatencyMillis\": \"100000\",\n \"hidden\": \"false\"\n}", "required": false, "schema": { "$ref": "#/definitions/MonitoredApplicationDTO" }, "x-examples": { "application/json": "{\n \"application\": \"beachshirts\",\n \"satisfiedLatencyMillis\": \"100000\",\n \"hidden\": \"false\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMonitoredApplicationDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice": { "get": { "tags": ["Monitored Service"], "summary": "Get all monitored services", "description": "", "operationId": "getAllServices", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice/components": { "get": { "tags": ["Monitored Service"], "summary": "Get all monitored services with components", "description": "", "operationId": "getAllComponents", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice/services": { "put": { "tags": ["Monitored Service"], "summary": "Update multiple applications and services in a batch. Batch size is limited to 100.", "description": "", "operationId": "batchUpdate", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
[{\n \"satisfiedLatencyMillis\": \"100000\",\n \"customDashboardLink\": \"shopping-dashboard\",\n \"hidden\": \"false\"\n},{\n \"satisfiedLatencyMillis\": \"100\",\n \"customDashboardLink\": \"shopping-dashboard\",\n \"hidden\": \"false\"\n}]", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/MonitoredServiceDTO" } }, "x-examples": { "application/json": "{\n \"satisfiedLatencyMillis\": \"100000\",\n \"customDashboardLink\": \"shopping-dashboard\",\n \"hidden\": \"false\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } }, "204": { "description": "Successful Update. No content." }, "207": { "description": "Bad request payload. Partial payload updated. One or more errors" }, "400": { "description": "Bad request payload. One or more entities were not found for update" }, "403": { "description": "Don't have permission for this operation. Check token." }, "500": { "description": "Internal server error" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice/{application}": { "get": { "tags": ["Monitored Service"], "summary": "Get a specific application", "description": "", "operationId": "getServicesOfApplication", "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" }, { "name": "includeComponent", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice/{application}/{service}": { "get": { "tags": ["Monitored Service"], "summary": "Get a specific application", "description": "", "operationId": "getService", "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" }, { "name": "service", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Monitored Service"], "summary": "Update a specific service", "description": "", "operationId": "updateService", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" }, { "name": "service", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"satisfiedLatencyMillis\": \"100000\",\n \"customDashboardLink\": \"shopping-dashboard\",\n \"hidden\": \"false\"\n}", "required": false, "schema": { "$ref": "#/definitions/MonitoredServiceDTO" }, "x-examples": { "application/json": "{\n \"satisfiedLatencyMillis\": \"100000\",\n \"customDashboardLink\": \"shopping-dashboard\",\n \"hidden\": \"false\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/monitoredservice/{application}/{service}/{component}": { "get": { "tags": ["Monitored Service"], "summary": "Get a specific application", "description": "", "operationId": "getComponent", "produces": ["application/json"], "parameters": [{ "name": "application", "in": "path", "required": true, "type": "string" }, { "name": "service", "in": "path", "required": true, "type": "string" }, { "name": "component", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/notificant": { "get": { "tags": ["Notificant"], "summary": "Get all notification targets for a customer", "description": "", "operationId": "getAllNotificants", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedNotificant" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Notificant"], "summary": "Create a notification target", "description": "", "operationId": "createNotificant", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"description\": \"Notificant Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"Email title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"method\": \"EMAIL\",\n \"recipient\": \"value@example.com\",\n \"emailSubject\": \"Email subject cannot contain new line\"\n}", "required": false, "schema": { "$ref": "#/definitions/Notificant" }, "x-examples": { "application/json": "{\n \"description\": \"Notificant Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"Email title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"method\": \"EMAIL\",\n \"recipient\": \"value@example.com\",\n \"emailSubject\": \"Email subject cannot contain new line\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/notificant/test/{id}": { "post": { "tags": ["Notificant"], "summary": "Test a specific notification target", "description": "", "operationId": "testNotificant", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/notificant/{id}": { "get": { "tags": ["Notificant"], "summary": "Get a specific notification target", "description": "", "operationId": "getNotificant", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Notificant"], "summary": "Update a specific notification target", "description": "", "operationId": "updateNotificant", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"description\": \"Notificant Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"Email title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"method\": \"EMAIL\",\n \"recipient\": \"value@example.com\",\n \"emailSubject\": \"Email subject cannot contain new line\"\n}", "required": false, "schema": { "$ref": "#/definitions/Notificant" }, "x-examples": { "application/json": "{\n \"description\": \"Notificant Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"Email title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"method\": \"EMAIL\",\n \"recipient\": \"value@example.com\",\n \"emailSubject\": \"Email subject cannot contain new line\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Notificant"], "summary": "Delete a specific notification target", "description": "", "operationId": "deleteNotificant", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "unlink", "in": "query", "description": "If set to true, explicitly deletes a notification target even if it’s in use by alerts.
{\n \"name\": \"New Name for proxy\"\n}", "required": false, "schema": { "$ref": "#/definitions/Proxy" }, "x-examples": { "application/json": "{\n \"name\": \"New Name for proxy\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerProxy" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Proxy"], "summary": "Delete a specific proxy", "description": "", "operationId": "deleteProxy", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "skipTrash", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerProxy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/proxy/{id}/config": { "get": { "tags": ["Proxy"], "summary": "Get a specific proxy config", "description": "", "operationId": "getProxyConfig", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMap" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/proxy/{id}/preprocessorRules": { "get": { "tags": ["Proxy"], "summary": "Get a specific proxy preprocessor rules", "description": "", "operationId": "getProxyPreprocessorRules", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerMap" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/proxy/{id}/undelete": { "post": { "tags": ["Proxy"], "summary": "Undelete a specific proxy", "description": "", "operationId": "undeleteProxy", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerProxy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/recentappmapsearch": { "get": { "tags": ["Recent AppMap Search"], "summary": "Get all searches for a user", "description": "", "operationId": "getAllRecentAppMapSearches", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 10, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedRecentAppMapSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Recent AppMap Search"], "summary": "Create a search", "description": "", "operationId": "createRecentAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/RecentAppMapSearch" }, "x-examples": { "application/json": "{\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRecentAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/recentappmapsearch/{id}": { "get": { "tags": ["Recent AppMap Search"], "summary": "Get a specific search", "description": "", "operationId": "getRecentAppMapSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRecentAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/recenttracessearch": { "get": { "tags": ["Recent Traces Search"], "summary": "Get all searches for a user", "description": "", "operationId": "getAllRecentTracesSearches", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedRecentTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Recent Traces Search"], "summary": "Create a search", "description": "", "operationId": "createRecentTracesSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/RecentTracesSearch" }, "x-examples": { "application/json": "{\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRecentTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/recenttracessearch/{id}": { "get": { "tags": ["Recent Traces Search"], "summary": "Get a specific search", "description": "", "operationId": "getRecentTracesSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRecentTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/role": { "get": { "tags": ["Role"], "summary": "Get all roles", "description": "Returns all existing roles in the service instance with detailed information for each role, including assigned groups and accounts, management properties, permissions, name, ID, description, and the time of the last update and who has done it.", "operationId": "getAllRoles", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedRoleDTO" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Role"], "summary": "Create a role", "description": "Creates a role with a specific unique name. Optionally, you can grant permissions to the role, assign the role to accounts and groups, specify a description, and configure the management properties of the role.", "operationId": "createRole", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "An example body for a role with all permissions: \n
{\n \"name\": \"Role_name\",\n \"permissions\": [\n \"agent_management\", \"alerts_management\",\n \"application_management\", \"batch_query_priority\",\n \"dashboard_management\", \"derived_metrics_management\",\n \"embedded_charts\", \"events_management\",\n \"external_links_management\", \"host_tag_management\",\n \"ingestion\", \"metrics_management\",\n \"monitored_application_service_management\", \"saml_sso_management\",\n \"token_management\", \"user_management\"\n ],\n \"description\": \"Role_description\"\n}", "required": true, "schema": { "$ref": "#/definitions/RoleCreateDTO" }, "x-examples": { "application/json": "{\n \"name\": \"Role_name\",\n \"permissions\": [\n \"agent_management\", \"alerts_management\",\n \"application_management\", \"batch_query_priority\",\n \"dashboard_management\", \"derived_metrics_management\",\n \"embedded_charts\", \"events_management\",\n \"external_links_management\", \"host_tag_management\",\n \"ingestion\", \"metrics_management\",\n \"monitored_application_service_management\", \"saml_sso_management\",\n \"token_management\", \"user_management\"\n ],\n \"description\": \"Role_description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRoleDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/role/grant/{permission}": { "post": { "tags": ["Role"], "summary": "Grant a permission to roles", "description": "Grants a given permission to a list of roles.", "operationId": "grantPermissionToRoles", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "permission", "in": "path", "description": "The permission to grant. Note that
host_tag_management
is the equivalent of the **Source Tag Management** permission, monitored_application_service_management
is the equivalent of the **Integrations** permission, agent_management
is the equivalent of the **Proxies** permission.",
"required": true,
"type": "string",
"enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"]
}, {
"in": "body",
"name": "body",
"description": "A list of role IDs to which to grant the permission.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/role/revoke/{permission}": {
"post": {
"tags": ["Role"],
"summary": "Revoke a permission from roles",
"description": "Revokes a given permission from a list of roles.",
"operationId": "revokePermissionFromRoles",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "permission",
"in": "path",
"description": "The permission to revoke. Note that host_tag_management
is the equivalent of the **Source Tag Management** permission, monitored_application_service_management
is the equivalent of the **Integrations** permission, agent_management
is the equivalent of the **Proxies** permission.",
"required": true,
"type": "string",
"enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"]
}, {
"in": "body",
"name": "body",
"description": "A list of role IDs from which to revoke the permission.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/role/{id}": {
"get": {
"tags": ["Role"],
"summary": "Get a role by ID",
"description": "Returns the details of a role with a given ID. The response includes assigned groups and accounts, management properties, permissions, name, description, and the time of the last update and who has done it.",
"operationId": "getRole",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "The ID of the role to get. If you don't know the role's ID, run the Get all roles
API call to return all roles and their IDs.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
},
"put": {
"tags": ["Role"],
"summary": "Update a role by ID",
"description": "Updates a role with a given ID. You can update the assigned groups and accounts, management properties, permissions, ID, name, and description.",
"operationId": "updateRole",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "The ID of the role to update. If you don't know the role's ID, run the Get all roles
API call to return all roles and their IDs.",
"required": true,
"type": "string"
}, {
"in": "body",
"name": "body",
"description": "You can first run the Get a role by ID
API call, and then you can copy and edit the response body. An example body for a role with all permissions: \n{\n \"id\": \"Role_ID\",\n \"name\": \"Role_name\",\n \"permissions\": [\n \"agent_management\", \"alerts_management\",\n \"application_management\", \"batch_query_priority\",\n \"derived_metrics_management\", \"dashboard_management\",\n \"embedded_charts\", \"events_management\",\n \"external_links_management\", \"host_tag_management\",\n \"ingestion\", \"metrics_management\",\n \"monitored_application_service_management\", \"saml_sso_management\",\n \"token_management\", \"user_management\"\n ],\n \"description\": \"Role_description\"\n}", "required": true, "schema": { "$ref": "#/definitions/RoleUpdateDTO" }, "x-examples": { "application/json": "{\n \"id\": \"Role_ID\",\n \"name\": \"Role_name\",\n \"permissions\": [\n \"agent_management\", \"alerts_management\",\n \"application_management\", \"batch_query_priority\",\n \"derived_metrics_management\", \"dashboard_management\",\n \"embedded_charts\", \"events_management\",\n \"external_links_management\", \"host_tag_management\",\n \"ingestion\", \"metrics_management\",\n \"monitored_application_service_management\", \"saml_sso_management\",\n \"token_management\", \"user_management\"\n ],\n \"description\": \"Role_description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerRoleDTO" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Role"], "summary": "Delete a role by ID", "description": "Deletes a role with a given ID.", "operationId": "deleteRole", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "description": "The ID of the role to delete. If you don't know the role's ID, run the
Get all roles
API call to return all roles and their IDs.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/role/{id}/addAssignees": {
"post": {
"tags": ["Role"],
"summary": "Add accounts and groups to a role",
"description": "Assigns a role with a given ID to a list of user and service accounts and groups.",
"operationId": "addAssignees",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "The ID of the role to assign. If you don't know the role's ID, run the Get all roles
API call to return all roles and their IDs.",
"required": true,
"type": "string"
}, {
"in": "body",
"name": "body",
"description": "A list of accounts and groups to add to the role.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/role/{id}/removeAssignees": {
"post": {
"tags": ["Role"],
"summary": "Remove accounts and groups from a role",
"description": "Revokes a role with a given ID from a list of user and service accounts and groups.",
"operationId": "removeAssignees",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "The ID of the role to revoke. If you don't know the role's ID, run the Get all roles
API call to return all roles and their IDs.",
"required": true,
"type": "string"
}, {
"in": "body",
"name": "body",
"description": "A list of accounts and groups to remove from the role.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerRoleDTO"
}
}
},
"security": [{
"api_key": []
}
]
}
},
"/api/v2/savedappmapsearch": {
"get": {
"tags": ["Saved AppMap Search"],
"summary": "Get all searches for a customer",
"description": "",
"operationId": "getAllSavedAppMapSearches",
"produces": ["application/json"],
"parameters": [{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"default": 0,
"format": "int32"
}, {
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"default": 100,
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ResponseContainerPagedSavedAppMapSearch"
}
}
},
"security": [{
"api_key": []
}
]
},
"post": {
"tags": ["Saved AppMap Search"],
"summary": "Create a search",
"description": "",
"operationId": "createSavedAppMapSearch",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "Example Body: \n{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedAppMapSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearch/defaultAppMapSearch": { "get": { "tags": ["Saved AppMap Search"], "summary": "Get default app map search for a user", "description": "", "operationId": "defaultAppMapSearch", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDefaultSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved AppMap Search"], "summary": "Set default app map search at user level", "description": "", "operationId": "defaultAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "defaultAppMapSearch", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearch/defaultCustomerAppMapSearch": { "post": { "tags": ["Saved AppMap Search"], "summary": "Set default app map search at customer level", "description": "", "operationId": "defaultCustomerAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "defaultAppMapSearch", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearch/owned": { "get": { "tags": ["Saved AppMap Search"], "summary": "Get all searches for a user", "description": "", "operationId": "getAllSavedAppMapSearchesForUser", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearch/owned/{id}": { "put": { "tags": ["Saved AppMap Search"], "summary": "Update a search belonging to the user", "description": "", "operationId": "updateSavedAppMapSearchForUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedAppMapSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved AppMap Search"], "summary": "Delete a search belonging to the user", "description": "", "operationId": "deleteSavedAppMapSearchForUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearch/{id}": { "get": { "tags": ["Saved AppMap Search"], "summary": "Get a specific search", "description": "", "operationId": "getSavedAppMapSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Saved AppMap Search"], "summary": "Update a search", "description": "", "operationId": "updateSavedAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedAppMapSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved AppMap Search"], "summary": "Delete a search", "description": "", "operationId": "deleteSavedAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearchgroup": { "get": { "tags": ["Saved AppMap Search Group"], "summary": "Get all search groups for a user", "description": "", "operationId": "getAllSavedAppMapSearchGroup", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedAppMapSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved AppMap Search Group"], "summary": "Create a search group", "description": "", "operationId": "createSavedAppMapSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Search Group 1\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedAppMapSearchGroup" }, "x-examples": { "application/json": "{\n \"name\": \"Search Group 1\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearchGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearchgroup/{id}": { "get": { "tags": ["Saved AppMap Search Group"], "summary": "Get a specific search group", "description": "", "operationId": "getSavedAppMapSearchGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Saved AppMap Search Group"], "summary": "Update a search group", "description": "", "operationId": "updateSavedAppMapSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Search Group 1\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedAppMapSearchGroup" }, "x-examples": { "application/json": "{\n \"name\": \"Search Group 1\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved AppMap Search Group"], "summary": "Delete a search group", "description": "", "operationId": "deleteSavedAppMapSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedAppMapSearchGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearchgroup/{id}/addSearch/{searchId}": { "post": { "tags": ["Saved AppMap Search Group"], "summary": "Add a search to a search group", "description": "", "operationId": "addSavedAppMapSearchToGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "searchId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearchgroup/{id}/removeSearch/{searchId}": { "post": { "tags": ["Saved AppMap Search Group"], "summary": "Remove a search from a search group", "description": "", "operationId": "removeSavedAppMapSearchFromGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "searchId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedappmapsearchgroup/{id}/searches": { "get": { "tags": ["Saved AppMap Search Group"], "summary": "Get all searches for a search group", "description": "", "operationId": "getSavedAppMapSearchesForGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedsearch": { "get": { "tags": ["Saved Search"], "summary": "Get all saved searches for a user", "description": "", "operationId": "getAllSavedSearches", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved Search"], "summary": "Create a saved search", "description": "", "operationId": "createSavedSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"query\": {\n \"foo\": \"{\\\"searchTerms\\\":[{\\\"type\\\":\\\"freetext\\\",\\\"value\\\":\\\"foo\\\"}]}\"\n },\n \"entityType\": \"DASHBOARD\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedSearch" }, "x-examples": { "application/json": "{\n \"query\": {\n \"foo\": \"{\\\"searchTerms\\\":[{\\\"type\\\":\\\"freetext\\\",\\\"value\\\":\\\"foo\\\"}]}\"\n },\n \"entityType\": \"DASHBOARD\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedsearch/type/{entitytype}": { "get": { "tags": ["Saved Search"], "summary": "Get all saved searches for a specific entity type for a user", "description": "", "operationId": "getAllEntityTypeSavedSearches", "produces": ["application/json"], "parameters": [{ "name": "entitytype", "in": "path", "required": true, "type": "string", "enum": ["DASHBOARD", "ALERT", "MAINTENANCE_WINDOW", "NOTIFICANT", "EVENT", "SOURCE", "EXTERNAL_LINK", "AGENT", "CLOUD_INTEGRATION", "USER", "USER_GROUP", "SERVICE_ACCOUNT", "INGESTION_POLICY", "ROLE", "TOKEN"] }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedsearch/{id}": { "get": { "tags": ["Saved Search"], "summary": "Get a specific saved search", "description": "", "operationId": "getSavedSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedSearch" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Saved Search"], "summary": "Update a specific saved search", "description": "", "operationId": "updateSavedSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"query\": {\n \"foo\": \"{\\\"searchTerms\\\":[{\\\"type\\\":\\\"freetext\\\",\\\"value\\\":\\\"foo\\\"}]}\"\n },\n \"entityType\": \"DASHBOARD\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedSearch" }, "x-examples": { "application/json": "{\n \"query\": {\n \"foo\": \"{\\\"searchTerms\\\":[{\\\"type\\\":\\\"freetext\\\",\\\"value\\\":\\\"foo\\\"}]}\"\n },\n \"entityType\": \"DASHBOARD\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedSearch" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved Search"], "summary": "Delete a specific saved search", "description": "", "operationId": "deleteSavedSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch": { "get": { "tags": ["Saved Traces Search"], "summary": "Get all searches for a customer", "description": "", "operationId": "getAllSavedTracesSearches", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved Traces Search"], "summary": "Create a search", "description": "", "operationId": "createSavedTracesSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedTracesSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch/defaultCustomerTracesSearch": { "post": { "tags": ["Saved Traces Search"], "summary": "Set default traces search at customer level", "description": "", "operationId": "defaultCustomerTracesSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "defaultTracesSearch", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch/defaultTracesSearch": { "get": { "tags": ["Saved Traces Search"], "summary": "Get default traces search for a user", "description": "", "operationId": "defaultTracesSearch", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerDefaultSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved Traces Search"], "summary": "Set default traces search at user level", "description": "", "operationId": "defaultAppMapSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "defaultTracesSearch", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch/owned": { "get": { "tags": ["Saved Traces Search"], "summary": "Get all searches for a user", "description": "", "operationId": "getAllSavedTracesSearchesForUser", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch/owned/{id}": { "put": { "tags": ["Saved Traces Search"], "summary": "Update a search belonging to the user", "description": "", "operationId": "updateSavedTracesSearchForUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedTracesSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved Traces Search"], "summary": "Delete a search belonging to the user", "description": "", "operationId": "deleteSavedTracesSearchForUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearch/{id}": { "get": { "tags": ["Saved Traces Search"], "summary": "Get a specific search", "description": "", "operationId": "getSavedTracesSearch", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Saved Traces Search"], "summary": "Update a search", "description": "", "operationId": "updateSavedTracesSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}", "required": false, "schema": { "$ref": "#/definitions/SavedTracesSearch" }, "x-examples": { "application/json": "{\n \"name\": \"beachshirts shopping\",\n \"searchFilters\": {\n \"filters\": [\n {\n \"filterType\": \"OPERATION\",\n \"values\": {\n \"logicalValue\": [\n [\n \"beachshirts.\", \"shopping.\", \"'*\"\n ]\n ]\n }\n }\n ]\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved Traces Search"], "summary": "Delete a search", "description": "", "operationId": "deleteSavedTracesSearch", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearchgroup": { "get": { "tags": ["Saved Traces Search Group"], "summary": "Get all search groups for a user", "description": "", "operationId": "getAllSavedTracesSearchGroup", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedTracesSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Saved Traces Search Group"], "summary": "Create a search group", "description": "", "operationId": "createSavedTracesSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Search Group 1\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedTracesSearchGroup" }, "x-examples": { "application/json": "{\n \"name\": \"Search Group 1\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearchGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearchgroup/{id}": { "get": { "tags": ["Saved Traces Search Group"], "summary": "Get a specific search group", "description": "", "operationId": "getSavedTracesSearchGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Saved Traces Search Group"], "summary": "Update a search group", "description": "", "operationId": "updateSavedTracesSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Search Group 1\"\n}", "required": false, "schema": { "$ref": "#/definitions/SavedTracesSearchGroup" }, "x-examples": { "application/json": "{\n \"name\": \"Search Group 1\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearchGroup" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Saved Traces Search Group"], "summary": "Delete a search group", "description": "", "operationId": "deleteSavedTracesSearchGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSavedTracesSearchGroup" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearchgroup/{id}/addSearch/{searchId}": { "post": { "tags": ["Saved Traces Search Group"], "summary": "Add a search to a search group", "description": "", "operationId": "addSavedTracesSearchToGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "searchId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearchgroup/{id}/removeSearch/{searchId}": { "post": { "tags": ["Saved Traces Search Group"], "summary": "Remove a search from a search group", "description": "", "operationId": "removeSavedTracesSearchFromGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "searchId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/savedtracessearchgroup/{id}/searches": { "get": { "tags": ["Saved Traces Search Group"], "summary": "Get all searches for a search group", "description": "", "operationId": "getSavedTracesSearchesForGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/account": { "post": { "tags": ["Search"], "summary": "Search over a customer's accounts", "description": "", "operationId": "searchAccountEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedAccount" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/account/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's accounts", "description": "", "operationId": "searchAccountForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/account/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's accounts", "description": "", "operationId": "searchAccountForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted alerts", "description": "", "operationId": "searchAlertEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedAlertWithStats" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted alerts", "description": "", "operationId": "searchAlertDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedAlert" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted alerts", "description": "", "operationId": "searchAlertDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted alerts", "description": "", "operationId": "searchAlertDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted alerts", "description": "", "operationId": "searchAlertForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/alert/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted alerts", "description": "", "operationId": "searchAlertForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedCloudIntegration" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/cloudintegration/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted cloud integrations", "description": "", "operationId": "searchCloudIntegrationForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted dashboards", "description": "", "operationId": "searchDashboardEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted dashboards", "description": "", "operationId": "searchDashboardDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDashboard" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted dashboards", "description": "", "operationId": "searchDashboardDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted dashboards", "description": "", "operationId": "searchDashboardDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted dashboards", "description": "", "operationId": "searchDashboardForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/dashboard/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted dashboards", "description": "", "operationId": "searchDashboardForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted derived metric definitions", "description": "", "operationId": "searchRegisteredQueryEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDerivedMetricDefinitionWithStats" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted derived metric definitions", "description": "", "operationId": "searchRegisteredQueryDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedDerivedMetricDefinition" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted derived metric definitions", "description": "", "operationId": "searchRegisteredQueryDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted derived metric definitions", "description": "", "operationId": "searchRegisteredQueryDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted derived metric definition", "description": "", "operationId": "searchRegisteredQueryForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/derivedmetric/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted derived metric definitions", "description": "", "operationId": "searchRegisteredQueryForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/event": { "post": { "tags": ["Search"], "summary": "Search over a customer's events", "description": "", "operationId": "searchReportEventEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/EventSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/event/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's events", "description": "", "operationId": "searchReportEventForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/event/related/{eventId}": { "post": { "tags": ["Search"], "summary": "List the related events over a firing event", "description": "", "operationId": "searchRelatedReportEventEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "eventId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/EventSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedRelatedEvent" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/event/related/{eventId}/withAnomalies": { "post": { "tags": ["Search"], "summary": "List the related events and anomalies over a firing event", "description": "", "operationId": "searchRelatedReportEventAnomalyEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "eventId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/EventSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedReportEventAnomalyDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/event/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's events", "description": "", "operationId": "searchReportEventForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/extlink": { "post": { "tags": ["Search"], "summary": "Search over a customer's external links", "description": "", "operationId": "searchExternalLinkEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedExternalLink" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/extlink/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's external links", "description": "", "operationId": "searchExternalLinksForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/extlink/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's external links", "description": "", "operationId": "searchExternalLinksForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/ingestionpolicy": { "post": { "tags": ["Search"], "summary": "Search over a customer's ingestion policies", "description": "", "operationId": "searchIngestionPolicyEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/ingestionpolicy/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's ingestion policies", "description": "", "operationId": "searchIngestionPolicyForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/ingestionpolicy/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's ingestion policies", "description": "", "operationId": "searchIngestionPolicyForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/maintenancewindow": { "post": { "tags": ["Search"], "summary": "Search over a customer's maintenance windows", "description": "", "operationId": "searchMaintenanceWindowEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMaintenanceWindow" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/maintenancewindow/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's maintenance windows", "description": "", "operationId": "searchMaintenanceWindowForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/maintenancewindow/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's maintenance windows", "description": "", "operationId": "searchMaintenanceWindowForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredapplication": { "post": { "tags": ["Search"], "summary": "Search over all the customer's non-deleted monitored applications", "description": "", "operationId": "searchMonitoredApplicationEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredApplicationDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredapplication/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted monitored clusters", "description": "", "operationId": "searchMonitoredApplicationForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredapplication/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted monitored application", "description": "", "operationId": "searchMonitoredApplicationForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredservice": { "post": { "tags": ["Search"], "summary": "Search over all the customer's non-deleted monitored services", "description": "", "operationId": "searchMonitoredServiceEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedMonitoredServiceDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredservice/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted monitored clusters", "description": "", "operationId": "searchMonitoredServiceForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/monitoredservice/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted monitored application", "description": "", "operationId": "searchMonitoredServiceForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/notificant": { "post": { "tags": ["Search"], "summary": "Search over a customer's notificants", "description": "", "operationId": "searchNotificantEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/notificant/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's notificants", "description": "", "operationId": "searchNotficantForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/notificant/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's notificants", "description": "", "operationId": "searchNotificantForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted proxies", "description": "", "operationId": "searchProxyEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedProxy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted proxies", "description": "", "operationId": "searchProxyDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedProxy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted proxies", "description": "", "operationId": "searchProxyDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted proxies", "description": "", "operationId": "searchProxyDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted proxies", "description": "", "operationId": "searchProxyForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/proxy/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted proxies", "description": "", "operationId": "searchProxyForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/role": { "post": { "tags": ["Search"], "summary": "Search over a customer's roles", "description": "", "operationId": "searchRoleEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedRoleDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/role/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's roles", "description": "", "operationId": "searchRoleForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/role/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's roles", "description": "", "operationId": "searchRoleForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedappmapsearch": { "post": { "tags": ["Search"], "summary": "Search over all the customer's non-deleted saved app map searches", "description": "", "operationId": "searchSavedAppMapEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedAppMapSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedappmapsearch/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted app map searches", "description": "", "operationId": "searchSavedAppMapForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedappmapsearch/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted app map searches", "description": "", "operationId": "searchSavedAppMapForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedtracessearch": { "post": { "tags": ["Search"], "summary": "Search over all the customer's non-deleted saved traces searches", "description": "", "operationId": "searchSavedTracesEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSavedTracesSearch" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedtracessearch/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted traces searches", "description": "", "operationId": "searchTracesMapForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/savedtracessearch/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted traces searches", "description": "", "operationId": "searchTracesMapForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/serviceaccount": { "post": { "tags": ["Search"], "summary": "Search over a customer's service accounts", "description": "", "operationId": "searchServiceAccountEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedServiceAccount" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/serviceaccount/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's service accounts", "description": "", "operationId": "searchServiceAccountForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/serviceaccount/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's service accounts", "description": "", "operationId": "searchServiceAccountForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/source": { "post": { "tags": ["Search"], "summary": "Search over a customer's sources", "description": "", "operationId": "searchTaggedSourceEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SourceSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSource" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/source/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's sources", "description": "", "operationId": "searchTaggedSourceForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/source/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's sources", "description": "", "operationId": "searchTaggedSourceForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy": { "post": { "tags": ["Search"], "summary": "Search over a customer's non-deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy/deleted": { "post": { "tags": ["Search"], "summary": "Search over a customer's deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyDeletedEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy/deleted/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyDeletedForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy/deleted/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyDeletedForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's non-deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/spansamplingpolicy/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's non-deleted span sampling policies", "description": "", "operationId": "searchSpanSamplingPolicyForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/token": { "post": { "tags": ["Search"], "summary": "Search over a customer's api tokens", "description": "", "operationId": "searchTokenEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedApiTokenModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/token/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's api tokens", "description": "", "operationId": "searchTokenForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/token/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's api tokens", "description": "", "operationId": "searchTokenForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/user": { "post": { "tags": ["Search"], "summary": "Search over a customer's users", "description": "", "operationId": "searchUserEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedCustomerFacingUserObject" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/user/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's users", "description": "", "operationId": "searchUserForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/user/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's users", "description": "", "operationId": "searchUserForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/usergroup": { "post": { "tags": ["Search"], "summary": "Search over a customer's user groups", "description": "", "operationId": "searchUserGroupEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/usergroup/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's user groups", "description": "", "operationId": "searchUserGroupForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/usergroup/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's user groups", "description": "", "operationId": "searchUserGroupForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/webhook": { "post": { "tags": ["Search"], "summary": "Search over a customer's webhooks", "description": "", "operationId": "searchWebHookEntities", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SortableSearchRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/webhook/facets": { "post": { "tags": ["Search"], "summary": "Lists the values of one or more facets over the customer's webhooks", "description": "", "operationId": "searchWebhookForFacets", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetsSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetsResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/search/webhook/{facet}": { "post": { "tags": ["Search"], "summary": "Lists the values of a specific facet over the customer's webhooks", "description": "", "operationId": "searchWebHookForFacet", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "facet", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/FacetSearchRequestContainer" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerFacetResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/source": { "get": { "tags": ["Source"], "summary": "Get all sources for a customer", "description": "", "operationId": "getAllSource", "produces": ["application/json"], "parameters": [{ "name": "cursor", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "max limit: 1000", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSource" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Source"], "summary": "Create metadata (description or tags) for a specific source", "description": "", "operationId": "createSource", "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"sourceName\": \"source.name\",\n \"tags\": {\"sourceTag1\": true},\n \"description\": \"Source Description\"\n}", "required": false, "schema": { "$ref": "#/definitions/Source" }, "x-examples": { "application/json": "{\n \"sourceName\": \"source.name\",\n \"tags\": {\"sourceTag1\": true},\n \"description\": \"Source Description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSource" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/source/{id}": { "get": { "tags": ["Source"], "summary": "Get a specific source for a customer", "description": "", "operationId": "getSource", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSource" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Source"], "summary": "Update metadata (description or tags) for a specific source.", "description": "The \"hidden\" property is stored as a tag. To set the value, add \"hidden\": <value> to the list of tags.", "operationId": "updateSource", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"sourceName\": \"source.name\",\n \"tags\": {\"sourceTag1\": true},\n \"description\": \"Source Description\"\n}", "required": false, "schema": { "$ref": "#/definitions/Source" }, "x-examples": { "application/json": "{\n \"sourceName\": \"source.name\",\n \"tags\": {\"sourceTag1\": true},\n \"description\": \"Source Description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSource" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Source"], "summary": "Delete metadata (description and tags) for a specific source", "description": "", "operationId": "deleteSource", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSource" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/source/{id}/description": { "post": { "tags": ["Source"], "summary": "Set description associated with a specific source", "description": "", "operationId": "setDescription", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Source"], "summary": "Remove description from a specific source", "description": "", "operationId": "removeDescription", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/source/{id}/tag": { "get": { "tags": ["Source"], "summary": "Get all tags associated with a specific source", "description": "", "operationId": "getSourceTags", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerTagsResponse" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Source"], "summary": "Set all tags associated with a specific source", "description": "", "operationId": "setSourceTags", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/source/{id}/tag/{tagValue}": { "put": { "tags": ["Source"], "summary": "Add a tag to a specific source", "description": "", "operationId": "addSourceTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Source"], "summary": "Remove a tag from a specific source", "description": "", "operationId": "removeSourceTag", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "tagValue", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainer" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy": { "get": { "tags": ["Span Sampling Policy"], "summary": "Get all sampling policies for a customer", "description": "", "operationId": "getAllSpanSamplingPolicy", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Span Sampling Policy"], "summary": "Create a span sampling policy", "description": "", "operationId": "createSpanSamplingPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Test\",\n \"id\": \"test\",\n \"active\": false,\n \"expression\": \"{{sourceName}}='localhost'\",\n \"description\": \"test description\",\n \"samplingPercent\": 100\n}", "required": false, "schema": { "$ref": "#/definitions/SpanSamplingPolicy" }, "x-examples": { "application/json": "{\n \"name\": \"Test\",\n \"id\": \"test\",\n \"active\": false,\n \"expression\": \"{{sourceName}}='localhost'\",\n \"description\": \"test description\",\n \"samplingPercent\": 100\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy/deleted": { "get": { "tags": ["Span Sampling Policy"], "summary": "Get all deleted sampling policies for a customer", "description": "", "operationId": "getAllDeletedSpanSamplingPolicy", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy/{id}": { "get": { "tags": ["Span Sampling Policy"], "summary": "Get a specific span sampling policy", "description": "", "operationId": "getSpanSamplingPolicy", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Span Sampling Policy"], "summary": "Update a specific span sampling policy", "description": "", "operationId": "updateSpanSamplingPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Test\",\n \"id\": \"test\",\n \"active\": false,\n \"expression\": \"{{sourceName}}='localhost'\",\n \"description\": \"test description\",\n \"samplingPercent\": 100\n}", "required": false, "schema": { "$ref": "#/definitions/SpanSamplingPolicy" }, "x-examples": { "application/json": "{\n \"name\": \"Test\",\n \"id\": \"test\",\n \"active\": false,\n \"expression\": \"{{sourceName}}='localhost'\",\n \"description\": \"test description\",\n \"samplingPercent\": 100\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Span Sampling Policy"], "summary": "Delete a specific span sampling policy", "description": "", "operationId": "deleteSpanSamplingPolicy", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy/{id}/history": { "get": { "tags": ["Span Sampling Policy"], "summary": "Get the version history of a specific sampling policy", "description": "", "operationId": "getSpanSamplingPolicyHistory", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy/{id}/history/{version}": { "get": { "tags": ["Span Sampling Policy"], "summary": "Get a specific historical version of a specific sampling policy", "description": "", "operationId": "getSpanSamplingPolicyVersion", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/spansamplingpolicy/{id}/undelete": { "post": { "tags": ["Span Sampling Policy"], "summary": "Restore a deleted span sampling policy", "description": "", "operationId": "undeleteSpanSamplingPolicy", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerSpanSamplingPolicy" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/exportcsv": { "get": { "tags": ["Usage"], "summary": "Export a CSV report", "description": "", "operationId": "exportCSV", "consumes": ["application/json"], "produces": ["application/csv"], "parameters": [{ "name": "startTime", "in": "query", "description": "start time in epoch seconds", "required": true, "type": "integer", "format": "int64" }, { "name": "endTime", "in": "query", "description": "end time in epoch seconds, null to use now", "required": false, "type": "integer", "format": "int64" } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/ingestionpolicy": { "get": { "tags": ["Usage"], "summary": "Get all ingestion policies for a customer", "description": "", "operationId": "getAllIngestionPolicies", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Usage"], "summary": "Create a specific ingestion policy", "description": "", "operationId": "createIngestionPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Ingestion policy name\",\n \"description\": \"Ingestion policy description\",\n \"scope\": \"GROUP\",\n \"groups\": [\"g1\",\"g2\"],\n \"isLimited\": \"true\",\n \"limitPPS\": \"1000\",\n \"alert\": {\n \"name\": \"Alert Name\",\n \"targets\": {\n \"severe\": \"user1@mail.com\"\n },\n \"conditionPercentages\": {\n \"info\": 70,\n \"warn\": 90\n },\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"evaluateRealtimeData\": false,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n },\n \"conditionsThresholdOperator\": \">\"\n }\n}", "required": false, "schema": { "$ref": "#/definitions/IngestionPolicyWriteModel" }, "x-examples": { "application/json": "{\n \"name\": \"Ingestion policy name\",\n \"description\": \"Ingestion policy description\",\n \"scope\": \"GROUP\",\n \"groups\": [\"g1\",\"g2\"],\n \"isLimited\": \"true\",\n \"limitPPS\": \"1000\",\n \"alert\": {\n \"name\": \"Alert Name\",\n \"targets\": {\n \"severe\": \"user1@mail.com\"\n },\n \"conditionPercentages\": {\n \"info\": 70,\n \"warn\": 90\n },\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"evaluateRealtimeData\": false,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n },\n \"conditionsThresholdOperator\": \">\"\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/ingestionpolicy/{id}": { "get": { "tags": ["Usage"], "summary": "Get a specific ingestion policy", "description": "", "operationId": "getIngestionPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Usage"], "summary": "Update a specific ingestion policy", "description": "", "operationId": "updateIngestionPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"Ingestion policy name\",\n \"description\": \"Ingestion policy description\",\n \"scope\": \"GROUP\",\n \"groups\": [\"g1\",\"g2\"],\n \"isLimited\": \"true\",\n \"limitPPS\": \"1000\",\n \"alert\": {\n \"name\": \"Alert Name\",\n \"targets\": {\n \"severe\": \"user1@mail.com\"\n },\n \"conditionPercentages\": {\n \"info\": 70,\n \"warn\": 90\n },\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"evaluateRealtimeData\": false,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n },\n \"conditionsThresholdOperator\": \">\"\n }\n}", "required": false, "schema": { "$ref": "#/definitions/IngestionPolicyWriteModel" }, "x-examples": { "application/json": "{\n \"name\": \"Ingestion policy name\",\n \"description\": \"Ingestion policy description\",\n \"scope\": \"GROUP\",\n \"groups\": [\"g1\",\"g2\"],\n \"isLimited\": \"true\",\n \"limitPPS\": \"1000\",\n \"alert\": {\n \"name\": \"Alert Name\",\n \"targets\": {\n \"severe\": \"user1@mail.com\"\n },\n \"conditionPercentages\": {\n \"info\": 70,\n \"warn\": 90\n },\n \"minutes\": 5,\n \"resolveAfterMinutes\": 2,\n \"evaluateRealtimeData\": false,\n \"additionalInformation\": \"Additional Info\",\n \"tags\": {\n \"customerTags\": [\n \"alertTag1\"\n ]\n },\n \"conditionsThresholdOperator\": \">\"\n }\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Usage"], "summary": "Delete a specific ingestion policy", "description": "", "operationId": "deleteIngestionPolicy", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/ingestionpolicy/{id}/history": { "get": { "tags": ["Usage"], "summary": "Get the version history of ingestion policy", "description": "", "operationId": "getIngestionPolicyHistory", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerHistoryResponse" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/ingestionpolicy/{id}/history/{version}": { "get": { "tags": ["Usage"], "summary": "Get a specific historical version of a ingestion policy", "description": "", "operationId": "getIngestionPolicyByVersion", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usage/ingestionpolicy/{id}/revert/{version}": { "post": { "tags": ["Usage"], "summary": "Revert to a specific historical version of a ingestion policy", "description": "", "operationId": "revertIngestionPolicyByVersion", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "version", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerIngestionPolicyReadModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user": { "get": { "tags": ["User"], "summary": "Get all users", "description": "Returns all users", "operationId": "getAllUsers", "produces": ["application/json"], "parameters": [], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserModel" } } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["User"], "summary": "Creates an user if the user doesn't already exist.", "description": "", "operationId": "createUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "sendEmail", "in": "query", "description": "Whether to send email notification to the user, if created. Default: false", "required": false, "type": "boolean", "enum": ["true", "false"] }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}", "required": false, "schema": { "$ref": "#/definitions/UserToCreate" }, "x-examples": { "application/json": "{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/deleteUsers": { "post": { "tags": ["User"], "summary": "Deletes multiple users or service accounts", "description": "", "operationId": "deleteMultipleUsers", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "identifiers of list of users which should be deleted", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerListString" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/grant/{permission}": { "post": { "tags": ["User"], "summary": "Grants a specific permission to multiple users or service accounts", "description": "", "operationId": "grantPermissionToUsers", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "permission", "in": "path", "description": "Permission to grant to the users. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission", "required": true, "type": "string", "enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"] }, { "in": "body", "name": "body", "description": "List of users which should be granted by specified permission", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/invite": { "post": { "tags": ["User"], "summary": "Invite users with given user groups and permissions.", "description": "", "operationId": "inviteUsers", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
[\n{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}\n]", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserToCreate" } }, "x-examples": { "application/json": "{\n \"emailAddress\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ],\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/revoke/{permission}": { "post": { "tags": ["User"], "summary": "Revokes a specific permission from multiple users or service accounts", "description": "", "operationId": "revokePermissionFromUsers", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "permission", "in": "path", "description": "Permission to revoke from the accounts. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission", "required": true, "type": "string", "enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"] }, { "in": "body", "name": "body", "description": "List of users or service accounts which should be revoked by specified permission", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/validateUsers": { "post": { "tags": ["User"], "summary": "Returns valid users and service accounts, also invalid identifiers from the given list", "description": "", "operationId": "validateUsers", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerValidatedUsersDTO" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}": { "get": { "tags": ["User"], "summary": "Retrieves a user by identifier (email address)", "description": "", "operationId": "getUser", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["User"], "summary": "Update user with given user groups, permissions and ingestion policy.", "description": "", "operationId": "updateUser", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"identifier\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ]\n}", "required": false, "schema": { "$ref": "#/definitions/UserRequestDTO" }, "x-examples": { "application/json": "{\n \"identifier\": \"user@example.com\",\n \"groups\": [\n \"user_management\"\n ],\n \"userGroups\": [\n \"8b23136b-ecd2-4cb5-8c92-62477dcc4090\"\n ],\n \"roles\": [\n \"Role\"\n ]\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["User"], "summary": "Deletes a user or service account identified by id", "description": "", "operationId": "deleteUser", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}/addUserGroups": { "post": { "tags": ["User"], "summary": "Adds specific groups to the user or service account", "description": "", "operationId": "addUserToUserGroups", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of groups that should be added to the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}/businessFunctions": { "get": { "tags": ["User"], "summary": "Returns business functions of a specific user or service account.", "description": "", "operationId": "getUserBusinessFunctions", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}/grant": { "post": { "tags": ["User"], "summary": "Grants a specific permission to user or service account", "description": "", "operationId": "grantUserPermission", "consumes": ["application/x-www-form-urlencoded"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "group", "in": "formData", "description": "Permission group to grant to the account. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission", "required": false, "type": "string", "enum": ["log_management", "dashboard_management", "events_management", "alerts_management", "derived_metrics_management", "host_tag_management", "agent_management", "token_management", "ingestion", "user_management", "embedded_charts", "metrics_management", "external_links_management", "application_management", "batch_query_priority", "saml_sso_management", "monitored_application_service_management"] } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}/removeUserGroups": { "post": { "tags": ["User"], "summary": "Removes specific groups from the user or service account", "description": "", "operationId": "removeUserFromUserGroups", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The list of groups that should be removed from the account", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/user/{id}/revoke": { "post": { "tags": ["User"], "summary": "Revokes a specific permission from user or service account", "description": "", "operationId": "revokeUserPermission", "consumes": ["application/x-www-form-urlencoded"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "group", "in": "formData", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/UserModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup": { "get": { "tags": ["UserGroup"], "summary": "Get all user groups for a customer", "description": "", "operationId": "getAllUserGroups", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedUserGroupModel" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["UserGroup"], "summary": "Create a specific user group", "description": "", "operationId": "createUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"name\": \"UserGroup name\",\n \"roleIDs\": [\n \"role1\",\n \"role2\",\n \"role3\"\n ],\n \"description\": \"UserGroup description\"\n}", "required": false, "schema": { "$ref": "#/definitions/UserGroupWrite" }, "x-examples": { "application/json": "{\n \"name\": \"UserGroup name\",\n \"roleIDs\": [\n \"role1\",\n \"role2\",\n \"role3\"\n ],\n \"description\": \"UserGroup description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup/{id}": { "get": { "tags": ["UserGroup"], "summary": "Get a specific user group", "description": "", "operationId": "getUserGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["UserGroup"], "summary": "Update a specific user group", "description": "", "operationId": "updateUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"id\": \"UserGroup identifier\",\n \"name\": \"UserGroup name\",\n \"roleIDs\": [\n \"role1\",\n \"role2\",\n \"role3\"\n ],\n \"description\": \"UserGroup description\"\n}", "required": false, "schema": { "$ref": "#/definitions/UserGroupWrite" }, "x-examples": { "application/json": "{\n \"id\": \"UserGroup identifier\",\n \"name\": \"UserGroup name\",\n \"roleIDs\": [\n \"role1\",\n \"role2\",\n \"role3\"\n ],\n \"description\": \"UserGroup description\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["UserGroup"], "summary": "Delete a specific user group", "description": "", "operationId": "deleteUserGroup", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup/{id}/addRoles": { "post": { "tags": ["UserGroup"], "summary": "Add multiple roles to a specific user group", "description": "", "operationId": "addRolesToUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "List of roles that should be added to user group", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup/{id}/addUsers": { "post": { "tags": ["UserGroup"], "summary": "Add multiple users to a specific user group", "description": "", "operationId": "addUsersToUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "List of users that should be added to user group", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup/{id}/removeRoles": { "post": { "tags": ["UserGroup"], "summary": "Remove multiple roles from a specific user group", "description": "", "operationId": "removeRolesFromUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "List of roles that should be removed from user group", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/usergroup/{id}/removeUsers": { "post": { "tags": ["UserGroup"], "summary": "Remove multiple users from a specific user group", "description": "", "operationId": "removeUsersFromUserGroup", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "List of users that should be removed from user group", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerUserGroupModel" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/webhook": { "get": { "tags": ["Webhook"], "summary": "Get all webhooks for a customer", "description": "", "operationId": "getAllWebhooks", "produces": ["application/json"], "parameters": [{ "name": "offset", "in": "query", "required": false, "type": "integer", "default": 0, "format": "int32" }, { "name": "limit", "in": "query", "required": false, "type": "integer", "default": 100, "format": "int32" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerPagedNotificant" } } }, "security": [{ "api_key": [] } ] }, "post": { "tags": ["Webhook"], "summary": "Create a specific webhook", "description": "", "operationId": "createWebhook", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "body", "description": "Example Body: \n
{\n \"description\": \"WebHook Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"WebHook Title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"recipient\": \"http://example.com\",\n \"customHttpHeaders\": {},\n \"contentType\": \"text/plain\"\n}", "required": false, "schema": { "$ref": "#/definitions/Notificant" }, "x-examples": { "application/json": "{\n \"description\": \"WebHook Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"WebHook Title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"recipient\": \"http://example.com\",\n \"customHttpHeaders\": {},\n \"contentType\": \"text/plain\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/api/v2/webhook/{id}": { "get": { "tags": ["Webhook"], "summary": "Get a specific webhook", "description": "", "operationId": "getWebhook", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] }, "put": { "tags": ["Webhook"], "summary": "Update a specific webhook", "description": "", "operationId": "updateWebhook", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Example Body: \n
{\n \"description\": \"WebHook Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"WebHook Title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"recipient\": \"http://example.com\",\n \"customHttpHeaders\": {},\n \"contentType\": \"text/plain\"\n}", "required": false, "schema": { "$ref": "#/definitions/Notificant" }, "x-examples": { "application/json": "{\n \"description\": \"WebHook Description\",\n \"template\": \"POST Body -- Mustache syntax\",\n \"title\": \"WebHook Title\",\n \"triggers\": [\n \"ALERT_OPENED\"\n ],\n \"recipient\": \"http://example.com\",\n \"customHttpHeaders\": {},\n \"contentType\": \"text/plain\"\n}" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] }, "delete": { "tags": ["Webhook"], "summary": "Delete a specific webhook", "description": "", "operationId": "deleteWebhook", "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "unlink", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/ResponseContainerNotificant" } } }, "security": [{ "api_key": [] } ] } }, "/report": { "post": { "tags": ["Direct ingestion"], "summary": "Directly ingest data/data stream with specified format", "description": "", "operationId": "report", "consumes": ["application/octet-stream", "application/x-www-form-urlencoded", "text/plain"], "parameters": [{ "name": "f", "in": "query", "description": "Format of data to be ingested", "required": false, "type": "string", "default": "wavefront", "enum": ["wavefront", "histogram", "trace"] }, { "in": "body", "name": "body", "description": "Data to be ingested, in the specified format. See https://docs.wavefront.com/direct_ingestion.html for more detail on how to format the data. Example in \"wavefront\" format: \n
test.metric 100 source=test.source\nwhich ingests a time series point with metric name \"test.metric\", source name \"test.source\", and value of 100 with timestamp of now.", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "successful operation" } }, "security": [{ "api_key": [] } ] } } }, "securityDefinitions": { "api_key": { "type": "apiKey", "name": "X-AUTH-TOKEN", "in": "header" } }, "definitions": { "ResponseContainer": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "object" } }, "description": "JSON container for the HTTP response along with status" }, "ResponseContainerString": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "string" } }, "description": "JSON container for the HTTP response along with status" }, "ResponseStatus": { "type": "object", "required": ["code", "result"], "properties": { "result": { "type": "string", "enum": ["OK", "ERROR"] }, "message": { "type": "string", "description": "Descriptive message of the status of this response" }, "code": { "type": "integer", "format": "int64", "description": "HTTP Response code corresponding to this response" } } }, "AccessPolicy": { "type": "object", "properties": { "lastUpdatedMs": { "type": "integer", "format": "int64" }, "policyRules": { "type": "array", "items": { "$ref": "#/definitions/AccessPolicyRuleDTO" } }, "customer": { "type": "string" } }, "description": "Access policy information for customer" }, "AccessPolicyRuleDTO": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "subnet": { "type": "string" }, "action": { "type": "string", "enum": ["ALLOW", "DENY"] } } }, "ResponseContainerAccessPolicy": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/AccessPolicy" } }, "description": "JSON container for the HTTP response along with status" }, "ResponseContainerAccessPolicyAction": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "string", "enum": ["ALLOW", "DENY"] } }, "description": "JSON container for the HTTP response along with status" }, "Account": { "type": "object", "required": ["identifier"], "properties": { "unitedRoles": { "type": "array", "description": "The list of account's roles assigned directly or through user groups assigned to it", "uniqueItems": true, "items": { "type": "string" } }, "unitedPermissions": { "type": "array", "description": "The list of account's permissions assigned directly or through united roles assigned to it", "uniqueItems": true, "items": { "type": "string" } }, "identifier": { "type": "string", "description": "The unique identifier of an account." }, "groups": { "type": "array", "description": "The list of account's permissions.", "items": { "type": "string" } }, "roles": { "type": "array", "description": "The list of account's roles.", "items": { "type": "string" } }, "userGroups": { "type": "array", "description": "The list of account's user groups.", "items": { "type": "string" } } }, "description": "Wavefront account entity." }, "Paged": { "type": "object", "properties": { "items": { "type": "array", "description": "List of requested items", "items": { "type": "object" } }, "offset": { "type": "integer", "format": "int32", "readOnly": true }, "limit": { "type": "integer", "format": "int32" }, "cursor": { "type": "string", "description": "The id at which the current (limited) search can be continued to obtain more matching items" }, "totalItems": { "type": "integer", "format": "int32", "description": "An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries" }, "moreItems": { "type": "boolean", "description": "Whether more items are available for return by increment offset or cursor" }, "sort": { "$ref": "#/definitions/Sorting" } } }, "PagedAccount": { "type": "object", "properties": { "items": { "type": "array", "description": "List of requested items", "items": { "$ref": "#/definitions/Account" } }, "offset": { "type": "integer", "format": "int32", "readOnly": true }, "limit": { "type": "integer", "format": "int32" }, "cursor": { "type": "string", "description": "The id at which the current (limited) search can be continued to obtain more matching items" }, "totalItems": { "type": "integer", "format": "int32", "description": "An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries" }, "moreItems": { "type": "boolean", "description": "Whether more items are available for return by increment offset or cursor" }, "sort": { "$ref": "#/definitions/Sorting" } } }, "ResponseContainerPagedAccount": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/PagedAccount" } }, "description": "JSON container for the HTTP response along with status" }, "Sorting": { "type": "object", "required": ["ascending", "field"], "properties": { "ascending": { "type": "boolean", "description": "Whether to sort ascending. If undefined, sorting is not guaranteed" }, "field": { "type": "string", "description": "The facet by which to sort" }, "default": { "type": "boolean", "description": "Whether this sort requests the default ranking order. Ascending/descending does not matter if this attribute is true.", "readOnly": true } }, "description": "Specifies how returned items should be sorted" }, "ResponseContainerAccount": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/Account" } }, "description": "JSON container for the HTTP response along with status" }, "RoleDTO": { "type": "object", "properties": { "sampleLinkedGroups": { "type": "array", "description": "A sample of the groups assigned to this role. Please use the Role facet of the Group Search API to get the full list of groups for this role", "uniqueItems": true, "items": { "$ref": "#/definitions/UserGroup" } }, "linkedGroupsCount": { "type": "integer", "format": "int32", "description": "Total number of groups that are linked to the role", "readOnly": true }, "sampleLinkedAccounts": { "type": "array", "description": "A sample of the accounts assigned to this role. Please use the Role facet of the Account Search API to get the full list of accounts for this role", "uniqueItems": true, "items": { "type": "string" } }, "linkedAccountsCount": { "type": "integer", "format": "int32", "description": "Total number of accounts that are linked to the role", "readOnly": true }, "restrictedPermissions": { "type": "array", "description": "The list of permissions that are restricted with the role. Currently only CSP roles have restrictions.", "readOnly": true, "uniqueItems": true, "items": { "type": "string" } }, "properties": { "description": "The properties of the role", "readOnly": true, "$ref": "#/definitions/RolePropertiesDTO" }, "permissions": { "type": "array", "description": "List of permissions the role has been granted access to", "items": { "type": "string" } }, "name": { "type": "string", "description": "The name of the role" }, "id": { "type": "string", "description": "The unique identifier of the role" }, "description": { "type": "string", "description": "The description of the role" }, "createdEpochMillis": { "type": "integer", "format": "int64" }, "lastUpdatedMs": { "type": "integer", "format": "int64", "description": "The last time when the role is updated, in epoch milliseconds" }, "lastUpdatedAccountId": { "type": "string", "description": "The account that updated this role last time" }, "customer": { "type": "string", "description": "The id of the customer to which the role belongs" } } }, "RolePropertiesDTO": { "type": "object", "properties": { "nameEditable": { "type": "boolean" }, "usersRemovable": { "type": "boolean" }, "usersAddable": { "type": "boolean" }, "permsEditable": { "type": "boolean" }, "deletable": { "type": "boolean" } } }, "UserGroup": { "type": "object", "properties": { "id": { "type": "string", "example": "04e5fd3a-c916-45aa-923c-2fa02e9eddac", "description": "Unique ID for the user group" }, "name": { "type": "string", "description": "Name of the user group" }, "customer": { "type": "string", "description": "ID of the customer to which the user group belongs" }, "users": { "type": "array", "description": "List of Users that are members of the user group. Maybe incomplete.", "items": { "type": "string" } }, "userCount": { "type": "integer", "format": "int32", "description": "Total number of users that are members of the user group" }, "properties": { "description": "The properties of the user group(name editable, users editable, etc.)", "$ref": "#/definitions/UserGroupPropertiesDTO" }, "description": { "type": "string", "description": "The description of the user group" }, "roles": { "type": "array", "description": "List of roles the user group has been linked to", "items": { "$ref": "#/definitions/RoleDTO" } } }, "description": "Api model for user group" }, "UserGroupPropertiesDTO": { "type": "object", "properties": { "nameEditable": { "type": "boolean" }, "usersEditable": { "type": "boolean" }, "rolesEditable": { "type": "boolean" } } }, "UserModel": { "type": "object", "required": ["customer", "groups", "identifier", "userGroups"], "properties": { "identifier": { "type": "string", "description": "The unique identifier of this user, which must be their valid email address" }, "customer": { "type": "string", "description": "The id of the customer to which this user belongs" }, "ssoId": { "type": "string" }, "lastSuccessfulLogin": { "type": "integer", "format": "int64" }, "groups": { "type": "array", "description": "The permissions granted to this user", "items": { "type": "string" } }, "userGroups": { "type": "array", "description": "The list of user groups the user belongs to", "items": { "$ref": "#/definitions/UserGroup" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleDTO" } } }, "description": "Model for an user object" }, "UserToCreate": { "type": "object", "required": ["emailAddress", "groups", "userGroups"], "properties": { "emailAddress": { "type": "string", "description": "The (unique) identifier of the user to create. Must be a valid email address" }, "groups": { "type": "array", "description": "List of permission groups to grant to this user. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission. Possible values are log_management, dashboard_management, events_management, alerts_management, derived_metrics_management, host_tag_management, agent_management, token_management, ingestion, user_management, embedded_charts, metrics_management, external_links_management, application_management, batch_query_priority, saml_sso_management, monitored_application_service_management", "items": { "type": "string" } }, "userGroups": { "type": "array", "description": "List of user groups to this user. ", "items": { "type": "string" } }, "roles": { "type": "array", "description": "The list of role ids, the user will be added to.", "items": { "type": "string" } } } }, "ResponseContainerServiceAccount": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/ServiceAccount" } }, "description": "JSON container for the HTTP response along with status" }, "ServiceAccount": { "type": "object", "required": ["active", "identifier"], "properties": { "unitedRoles": { "type": "array", "description": "The list of account's roles assigned directly or through user groups assigned to it", "uniqueItems": true, "items": { "type": "string" } }, "unitedPermissions": { "type": "array", "description": "The list of account's permissions assigned directly or through united roles assigned to it", "uniqueItems": true, "items": { "type": "string" } }, "tokens": { "type": "array", "description": "The service account's API tokens.", "items": { "$ref": "#/definitions/UserApiToken" } }, "userGroups": { "type": "array", "description": "The list of service account's user groups.", "items": { "$ref": "#/definitions/UserGroup" } }, "roles": { "type": "array", "description": "The list of service account's roles.", "items": { "$ref": "#/definitions/RoleDTO" } }, "active": { "type": "boolean", "description": "The state of the service account." }, "description": { "type": "string", "description": "The description of the service account." }, "identifier": { "type": "string", "description": "The unique identifier of a service account." }, "groups": { "type": "array", "description": "The list of service account's permissions.", "items": { "type": "string" } }, "lastUsed": { "type": "integer", "format": "int64", "description": "The last time when a token of the service account was used." } }, "description": "Wavefront service account entity." }, "UserApiToken": { "type": "object", "required": ["tokenID"], "properties": { "tokenID": { "type": "string", "description": "The identifier of the user API token" }, "tokenName": { "type": "string", "description": "The name of the user API token" }, "account": { "type": "string", "description": "The account who generated this token." }, "accountType": { "type": "string", "description": "The user or service account generated this token.", "enum": ["USER_ACCOUNT", "SERVICE_ACCOUNT", "INACTIVE_SERVICE_ACCOUNT"] }, "lastUsed": { "type": "integer", "format": "int64", "description": "The last time this token was used", "readOnly": true }, "dateGenerated": { "type": "integer", "format": "int64", "description": "The generation date of the token." } }, "description": "Wavefront user api token entity for update requests" }, "ServiceAccountWrite": { "type": "object", "required": ["identifier"], "properties": { "identifier": { "type": "string", "description": "The unique identifier for a service account." }, "active": { "type": "boolean", "description": "The current state of the service account." }, "description": { "type": "string", "description": "The description of the service account to be created." }, "tokens": { "type": "array", "description": "The service account's API tokens.", "items": { "type": "string" } }, "userGroups": { "type": "array", "description": "The list of user group ids, the service account will be added to.", "items": { "type": "string" } }, "groups": { "type": "array", "description": "The list of permissions, the service account will be granted.", "items": { "type": "string" } }, "roles": { "type": "array", "description": "The list of role ids, the service account will be added to.\"", "items": { "type": "string" } } }, "description": "Wavefront service account entity for write requests." }, "ResponseContainerListString": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "array", "items": { "type": "string" } } }, "description": "JSON container for the HTTP response along with status" }, "UserRequestDTO": { "type": "object", "properties": { "identifier": { "type": "string" }, "ssoId": { "type": "string" }, "customer": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "userGroups": { "type": "array", "items": { "type": "string" } }, "credential": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "ResponseContainerUserDTO": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/UserDTO" } }, "description": "JSON container for the HTTP response along with status" }, "UserDTO": { "type": "object", "properties": { "identifier": { "type": "string" }, "customer": { "type": "string" }, "ssoId": { "type": "string" }, "lastSuccessfulLogin": { "type": "integer", "format": "int64" }, "groups": { "type": "array", "items": { "type": "string" } }, "userGroups": { "type": "array", "items": { "$ref": "#/definitions/UserGroup" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleDTO" } } } }, "ResponseContainerListUserDTO": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "array", "items": { "$ref": "#/definitions/UserDTO" } } }, "description": "JSON container for the HTTP response along with status" }, "ResponseContainerValidatedUsersDTO": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/ValidatedUsersDTO" } }, "description": "JSON container for the HTTP response along with status" }, "ValidatedUsersDTO": { "type": "object", "properties": { "validUsers": { "type": "array", "items": { "$ref": "#/definitions/UserDTO" } }, "invalidIdentifiers": { "type": "array", "items": { "type": "string" } } } }, "ResponseContainerSetBusinessFunction": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": ["VIEW_MONITORED_APPLICATION_SERVICE", "VIEW_MONITORED_CLUSTER", "VIEW_MONITORED_CLUSTER_TAGS", "VIEW_DASHBOARDS", "VIEW_DASHBOARDS_TAGS", "VIEW_METRIC_TIMESERIES", "VIEW_HOSTS", "VIEW_HOST_TAGS", "VIEW_AGENT_TAGS", "VIEW_EVENTS", "VIEW_EVENT_TAGS", "VIEW_ALERTS", "VIEW_ALERT_TAGS", "VIEW_REGISTERED_QUERIES", "VIEW_REGISTERED_QUERY_TAGS", "VIEW_MAINTENANCE_WINDOWS", "VIEW_NOTIFICANTS", "VIEW_CUSTOM_METRICS", "VIEW_TARGETS", "VIEW_AGENTS", "VIEW_SSH_CONFIGS", "VIEW_EXTERNAL_SERVICES", "VIEW_EXTERNAL_SERVICES_TAGS", "VIEW_EXTERNAL_LINKS", "VIEW_EXTERNAL_LINK_DIGESTS", "VIEW_EXTERNAL_LINK_TAGS", "VIEW_LOGS", "VIEW_SLOW_QUERY_PAGE", "VIEW_SAVED_SEARCHES", "VIEW_MY_MESSAGES", "VIEW_APPLICATIONS", "VIEW_ANOMALY", "SPY_ON_POINTS", "SPY_ON_ID_CREATIONS", "SPY_UNUSED_METRICS", "VIEW_SAML_SSO_SETTINGS", "VIEW_INGESTION_POLICY", "VIEW_CLUSTER_INFO", "MODIFY_MONITORED_APPLICATION_SERVICE", "MODIFY_MONITORED_CLUSTER", "MODIFY_MONITORED_CLUSTER_TAGS", "MODIFY_PRIVATE_TAGS", "MODIFY_CUSTOM_METRICS", "MODIFY_DASHBOARDS", "MODIFY_EVENTS", "MODIFY_EVENT_TAGS", "MODIFY_AGENTS", "MODIFY_AGENT_TAGS", "MODIFY_HOSTS", "MODIFY_HOST_TAGS", "MODIFY_MACHINES", "MODIFY_SSH_CONFIGS", "MODIFY_ALERTS", "MODIFY_ALERT_TAGS", "MODIFY_REGISTERED_QUERIES", "MODIFY_REGISTERED_QUERY_TAGS", "MODIFY_MAINTENANCE_WINDOWS", "MODIFY_NOTIFICANTS", "MODIFY_DASHBOARD_TAGS", "MODIFY_TARGETS", "MODIFY_EXTERNAL_SERVICES", "MODIFY_EXTERNAL_SERVICES_TAGS", "CREATE_EMBEDDED_CHARTS", "MODIFY_METRIC_VISIBILITY", "MODIFY_EXTERNAL_LINKS", "MODIFY_EXTERNAL_LINK_TAGS", "MODIFY_SAVED_SEARCHES", "MODIFY_SAVED_TRACES_SEARCH", "MODIFY_OWN_ONBOARDING_STATE", "MODIFY_APPLICATIONS", "INGESTION_POLICY_MANAGEMENT", "METRICS_POLICY_MANAGEMENT", "MODIFY_SAML_SSO_SETTINGS", "METRIC_INGESTION", "METRIC_INGESTION_LISTENER", "LOGIN", "LOGOUT", "CHANGE_PASSWORD", "SEND_FORGOTTEN_PASSWORD_EMAILS", "CHANGE_USER_PREFERENCE", "CREATE_TOKEN", "REVOKE_ALL_SESSIONS", "REVOKE_ALL_TOKENS", "REVOKE_TOKEN", "GET_TOKENS", "GET_ALL_ACCOUNTS", "GET_ALL_USERS", "GET_ALL_SERVICE_ACCOUNTS", "ADMINISTER_GROUPS", "DELETE_ACCOUNT", "INVITE_USER", "ADMINISTER_SERVICE_ACCOUNTS", "NO_REAUTH_INVITE_USER", "ADMINISTER_USER_GROUPS", "ADMINISTER_ALL_TOKENS", "ADMINISTER_CUSTOMER_PREFERENCES", "ROLES_MANAGEMENT", "VIEW_CUSTOMERS", "MODIFY_CUSTOMER", "DELETE_CUSTOMER", "SEND_UI_METRICS", "TOKEN"] } } }, "description": "JSON container for the HTTP response along with status" }, "ResponseContainerListServiceAccount": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "type": "array", "items": { "$ref": "#/definitions/ServiceAccount" } } }, "description": "JSON container for the HTTP response along with status" }, "GlobalAlertAnalytic": { "type": "object", "properties": { "failed": { "type": "integer", "format": "int32" }, "success": { "type": "integer", "format": "int32" }, "errorBreakdown": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "ResponseContainerGlobalAlertAnalytic": { "type": "object", "required": ["status"], "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "response": { "$ref": "#/definitions/GlobalAlertAnalytic" } }, "description": "JSON container for the HTTP response along with status" }, "AccessControlListSimple": { "type": "object", "properties": { "canView": { "type": "array", "items": { "type": "string" } }, "canModify": { "type": "array", "items": { "type": "string" } } } }, "Alert": { "type": "object", "required": ["condition", "minutes", "name"], "properties": { "tagpaths": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "targetEndpoints": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "modifyAclAccess": { "type": "boolean", "description": "Whether the user has modify ACL access to the alert." }, "lastEventTime": { "type": "integer", "format": "int64", "description": "Start time (in epoch millis) of the last event associated with this alert.", "readOnly": true }, "hidden": { "type": "boolean", "readOnly": true }, "severity": { "type": "string", "description": "Severity of the alert", "enum": ["INFO", "SMOKE", "WARN", "SEVERE"] }, "minutes": { "type": "integer", "format": "int32", "description": "The number of consecutive minutes that a series matching the condition query must evaluate to \"true\" (non-zero value) before the alert fires" }, "name": { "type": "string" }, "id": { "type": "string" }, "target": { "type": "string", "description": "The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert target ID}). You cannot update this value." }, "application": { "type": "array", "description": "Lists the applications from the failingHostLabelPair of the alert.", "readOnly": true, "items": { "type": "string" } }, "service": { "type": "array", "description": "Lists the services from the failingHostLabelPair of the alert.", "readOnly": true, "items": { "type": "string" } }, "createdEpochMillis": { "type": "integer", "format": "int64", "readOnly": true }, "updatedEpochMillis": { "type": "integer", "format": "int64", "readOnly": true }, "targetInfo": { "type": "array", "description": "List of alert targets display information that includes name, id and type.", "readOnly": true, "items": { "$ref": "#/definitions/TargetInfo" } }, "systemOwned": { "type": "boolean", "description": "Whether this alert is system-owned and not writeable", "readOnly": true }, "tags": { "$ref": "#/definitions/WFTags" }, "status": { "type": "array", "description": "Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA", "readOnly": true, "items": { "type": "string" } }, "event": { "$ref": "#/definitions/Event" }, "orphan": { "type": "boolean", "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "acl": { "readOnly": true, "$ref": "#/definitions/AccessControlListSimple" }, "created": { "type": "integer", "format": "int64", "description": "When this alert was created, in epoch millis", "readOnly": true }, "processRateMinutes": { "type": "integer", "format": "int32", "description": "The interval between checks for this alert, in minutes. Defaults to 1 minute" }, "createUserId": { "type": "string", "readOnly": true }, "updated": { "type": "integer", "format": "int64", "description": "When the alert was last updated, in epoch millis", "readOnly": true }, "updateUserId": { "type": "string", "description": "The user that last updated this alert", "readOnly": true }, "queryFailing": { "type": "boolean", "description": "Whether there was an exception when the alert condition last ran", "readOnly": true }, "lastFailedTime": { "type": "integer", "format": "int64", "description": "The time of the last error encountered when running this alert's condition query, in epoch millis", "readOnly": true }, "lastErrorMessage": { "type": "string", "description": "The last error encountered when running this alert's condition query", "readOnly": true }, "additionalInformation": { "type": "string", "description": "User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc" }, "metricsUsed": { "type": "array", "description": "Number of metrics checked by the alert condition", "readOnly": true, "items": { "type": "string" } }, "hostsUsed": { "type": "array", "description": "Number of hosts checked by the alert condition", "readOnly": true, "items": { "type": "string" } }, "inTrash": { "type": "boolean" }, "lastProcessedMillis": { "type": "integer", "format": "int64", "description": "The time when this alert was last checked, in epoch millis", "readOnly": true }, "pointsScannedAtLastQuery": { "type": "integer", "format": "int64", "description": "A derived field recording the number of data points scanned when the system last computed this alert's condition", "readOnly": true }, "includeObsoleteMetrics": { "type": "boolean", "description": "Whether to include obsolete metrics in alert query" }, "lastQueryTime": { "type": "integer", "format": "int64", "description": "Last query time of the alert, averaged on hourly basis", "readOnly": true }, "condition": { "type": "string", "description": "A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes" }, "conditionQueryType": { "type": "string", "enum": ["WQL", "PROMQL", "HYBRID"] }, "conditionQBEnabled": { "type": "boolean", "description": "Whether the condition query was created using the Query Builder. Default false" }, "conditionQBSerialization": { "type": "string", "description": "The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true" }, "displayExpression": { "type": "string", "description": "A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted" }, "conditions": { "type": "object", "description": "Multi - alert conditions.", "additionalProperties": { "type": "string" } }, "displayExpressionQueryType": { "type": "string", "enum": ["WQL", "PROMQL", "HYBRID"] }, "displayExpressionQBEnabled": { "type": "boolean", "description": "Whether the display expression query was created using the Query Builder. Default false" }, "creatorId": { "type": "string", "readOnly": true }, "updaterId": { "type": "string", "readOnly": true }, "displayExpressionQBSerialization": { "type": "string", "description": "The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true" }, "alertSources": { "type": "array", "description": "A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION.", "items": { "$ref": "#/definitions/Alert Source" } }, "resolveAfterMinutes": { "type": "integer", "format": "int32", "description": "The number of consecutive minutes that a firing series matching the condition query must evaluate to \"false\" (zero value) before the alert resolves. When unset, this defaults to the same value as \"minutes\"" }, "targets": { "type": "object", "description": "Targets for severity.", "additionalProperties": { "type": "string" } }, "snoozed": { "type": "integer", "format": "int64", "description": "The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely" }, "failingHostLabelPairs": { "type": "array", "description": "Failing host/metric pairs", "readOnly": true, "items": { "$ref": "#/definitions/SourceLabelPair" } }, "querySyntaxError": { "type": "boolean", "description": "Whether there was an query syntax exception when the alert condition last ran", "readOnly": true }, "runbookLinks": { "type": "array", "description": "User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered", "items": { "type": "string" } }, "triageDashboards": { "type": "array", "description": "Deprecated for alertTriageDashboards", "items": { "$ref": "#/definitions/TriageDashboard" } }, "alertTriageDashboards": { "type": "array", "description": "User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported", "items": { "$ref": "#/definitions/AlertDashboard" } }, "inMaintenanceHostLabelPairs": { "type": "array", "description": "Lists the sources that will not be checked for this alert, due to matching a maintenance window", "readOnly": true, "items": { "$ref": "#/definitions/SourceLabelPair" } }, "activeMaintenanceWindows": { "type": "array", "description": "The names of the active maintenance windows that are affecting this alert", "readOnly": true, "items": { "type": "string" } }, "prefiringHostLabelPairs": { "type": "array", "description": "Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the \"minutes\" parameter", "readOnly": true, "items": { "$ref": "#/definitions/SourceLabelPair" } }, "notificants": { "type": "array", "description": "A derived field listing the webhook ids used by this alert", "readOnly": true, "items": { "type": "string" } }, "lastNotificationMillis": { "type": "integer", "format": "int64", "description": "When this alert last caused a notification, in epoch millis", "readOnly": true }, "notificationResendFrequencyMinutes": { "type": "integer", "format": "int64", "description": "How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs" }, "alertsLastDay": { "type": "integer", "format": "int32", "readOnly": true }, "alertsLastWeek": { "type": "integer", "format": "int32", "readOnly": true }, "alertsLastMonth": { "type": "integer", "format": "int32", "readOnly": true }, "numPointsInFailureFrame": { "type": "integer", "format": "int32", "description": "Number of points scanned in alert query time frame.", "readOnly": true }, "noDataEvent": { "description": "No data event related to the alert", "readOnly": true, "$ref": "#/definitions/Event" }, "systemAlertVersion": { "type": "integer", "format": "int32", "description": "If this is a system alert, the version of it" }, "alertType": { "type": "string", "description": "Alert type.", "enum": ["CLASSIC", "THRESHOLD"] }, "evaluateRealtimeData": { "type": "boolean", "description": "Whether to alert on the real-time ingestion stream (may be noisy due to late data)" }, "secureMetricDetails": { "type": "boolean", "description": "Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security." }, "enablePDIncidentBySeries": { "type": "boolean" }, "chartSettings": { "description": "The old chart settings for the alert (e.g. chart type, chart range etc.).", "$ref": "#/definitions/ChartSettings" }, "chartAttributes": { "description": "Additional chart settings for the alert (e.g. pie chart has its chart settings in this section).", "$ref": "#/definitions/JsonNode" }, "ingestionPolicyId": { "type": "string", "description": "Get the ingestion policy Id associated with ingestion policy alert." }, "failingHostLabelPairLinks": { "type": "array", "description": "List of links to tracing applications that caused a failing series", "readOnly": true, "uniqueItems": true, "items": { "type": "string" } }, "sortAttr": { "type": "integer", "format": "int32", "description": "Attribute used for default alert sort that is derived from state and severity", "readOnly": true }, "severityList": { "type": "array", "description": "Alert severity list for multi-threshold type.", "readOnly": true, "items": { "type": "string", "enum": ["INFO", "SMOKE", "WARN", "SEVERE"] } }, "alertChartUnits": { "type": "string", "description": "The y-axis unit of Alert chart." }, "alertChartBase": { "type": "integer", "format": "int32", "description": "The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1." }, "alertChartDescription": { "type": "string", "description": "The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart." } }, "description": "Wavefront Alert" }, "Alert Source": { "type": "object", "properties": { "hidden": { "type": "boolean", "description": "A flag to indicate whether the alert source is hidden or not." }, "color": { "type": "string", "description": "The color of the alert source." }, "name": { "type": "string", "description": "The alert source query name. Used as the variable name in the other query." }, "query": { "type": "string", "description": "The alert query. Support both Wavefront Query and Prometheus Query." }, "description": { "type": "string", "description": "The additional long description of the alert source." }, "queryType": { "type": "string", "description": "The type of the alert query. Supported types are [PROMQL, WQL].", "enum": ["WQL", "PROMQL", "HYBRID"] }, "queryBuilderEnabled": { "type": "boolean", "description": "A flag indicate whether the alert source query builder enabled or not." }, "queryBuilderSerialization": { "type": "string", "description": "The string serialization of the alert source query builder, mostly used by Wavefront UI." }, "alertSourceType": { "type": "array", "description": "The types of the alert source (an array of CONDITION, AUDIT, VARIABLE) and the default one is [VARIABLE]. CONDITION alert source is the condition query in the alert. AUDIT alert source is the query to get more details when the alert changes state. VARIABLE alert source is a variable used in the other queries.", "items": { "type": "string", "enum": ["VARIABLE", "CONDITION", "AUDIT"] } } }, "description": "An AlertSource represents a single query used in an alert. Like ChartSource inDashboard, it includes the query and all the related fields." }, "AlertDashboard": { "type": "object", "properties": { "dashboardId": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": { "type": "string" } } }, "Annotation": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "ChartSettings": { "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "description": "Chart Type. 'line' refers to the Line Plot, 'scatter' to the Point Plot, 'stacked-area' to the Stacked Area plot, 'table' to the Tabular View, 'scatterploy-xy' to Scatter Plot, 'markdown-widget' to the Markdown display, and 'sparkline' to the Single Stat view", "enum": ["line", "scatterplot", "stacked-area", "stacked-column", "table", "scatterplot-xy", "markdown-widget", "sparkline", "globe", "nodemap", "top-k", "status-list", "histogram", "heatmap", "gauge", "pie"] }, "min": { "type": "number", "format": "double", "description": "Min value of Y-axis. Set to null or leave blank for auto" }, "max": { "type": "number", "format": "double", "description": "Max value of Y-axis. Set to null or leave blank for auto" }, "customTags": { "type": "array", "description": "For the tabular view, a list of point tags to display when using the \"custom\" tag display mode", "items": { "type": "string" } }, "expectedDataSpacing": { "type": "integer", "format": "int64", "description": "Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s" }, "fixedLegendEnabled": { "type": "boolean", "description": "Whether to enable a fixed tabular legend adjacent to the chart" }, "fixedLegendUseRawStats": { "type": "boolean", "description": "If true, the legend uses non-summarized stats instead of summarized" }, "plainMarkdownContent": { "type": "string", "description": "The Markdown content for a Markdown display, in plain text. Use this field instead of `markdownContent`." }, "lineType": { "type": "string", "description": "Plot interpolation type. linear is default", "enum": ["linear", "step-before", "step-after", "basis", "cardinal", "monotone"] }, "stackType": { "type": "string", "description": "Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means Normalized from 0 to 1. wiggle means Minimize weighted changes. silhouette means to Center the Stream", "enum": ["zero", "expand", "wiggle", "silhouette", "bars"] }, "windowing": { "type": "string", "description": "For the tabular view, whether to use the full time window for the query or the last X minutes", "enum": ["full", "last"] }, "windowSize": { "type": "integer", "format": "int64", "description": "Width, in minutes, of the time window to use for \"last\" windowing" }, "showHosts": { "type": "boolean", "description": "For the tabular view, whether to display sources. Default: true" }, "showLabels": { "type": "boolean", "description": "For the tabular view, whether to display labels. Default: true" }, "showRawValues": { "type": "boolean", "description": "For the tabular view, whether to display raw values. Default: false" }, "showValueColumn": { "type": "boolean", "description": "For the tabular view, whether to display value column. Default: true" }, "autoColumnTags": { "type": "boolean", "description": "deprecated" }, "columnTags": { "type": "string", "description": "deprecated" }, "tagMode": { "type": "string", "description": "For the tabular view, which mode to use to determine which point tags to display", "enum": ["all", "top", "custom"] }, "numTags": { "type": "integer", "format": "int32", "description": "For the tabular view, how many point tags to display" }, "groupBySource": { "type": "boolean", "description": "For the tabular view, whether to group multi metrics into a single row by a common source. If false, each metric for each source is displayed in its own row. If true, multiple metrics for the same host will be displayed as different columns in the same row" }, "sortValuesDescending": { "type": "boolean", "description": "For the tabular view, whether to display display values in descending order. Default: false" }, "defaultSortColumn": { "type": "string", "description": "For the tabular view, to select column for default sort" }, "y1Max": { "type": "number", "format": "double", "description": "For plots with multiple Y-axes, max value for right-side Y-axis. Set null for auto" }, "y1Min": { "type": "number", "format": "double", "description": "For plots with multiple Y-axes, min value for right-side Y-axis. Set null for auto" }, "y1Units": { "type": "string", "description": "For plots with multiple Y-axes, units for right-side Y-axis" }, "y0ScaleSIBy1024": { "type": "boolean", "description": "Default: false. Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)" }, "y1ScaleSIBy1024": { "type": "boolean", "description": "Default: false. Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)" }, "y0UnitAutoscaling": { "type": "boolean", "description": "Default: false. Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units" }, "y1UnitAutoscaling": { "type": "boolean", "description": "Default: false. Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units" }, "invertDynamicLegendHoverControl": { "type": "boolean", "description": "Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed)" }, "fixedLegendPosition": { "type": "string", "description": "Where the fixed legend should be displayed with respect to the chart", "enum": ["RIGHT", "TOP", "LEFT", "BOTTOM"] }, "fixedLegendDisplayStats": { "type": "array", "description": "For a chart with a fixed legend, a list of statistics to display in the legend", "items": { "type": "string" } }, "fixedLegendFilterSort": { "type": "string", "description": "Whether to display \"Top\"- or \"Bottom\"-ranked series in the fixed legend", "enum": ["TOP", "BOTTOM"] }, "fixedLegendShowSourceName": { "type": "boolean", "description": "Whether to display Source Name fixed legend" }, "fixedLegendShowMetricName": { "type": "boolean", "description": "Whether to display Metric Name fixed legend" }, "fixedLegendFilterLimit": { "type": "integer", "format": "int32", "description": "Number of series to include in the fixed legend" }, "fixedLegendFilterField": { "type": "string", "description": "Statistic to use for determining whether a series is displayed on the fixed legend", "enum": ["CURRENT", "MEAN", "MEDIAN", "SUM", "MIN", "MAX", "COUNT"] }, "fixedLegendHideLabel": { "type": "boolean", "description": "deprecated" }, "xmax": { "type": "number", "format": "double", "description": "For x-y scatterplots, max value for X-axis. Set null for auto" }, "xmin": { "type": "number", "format": "double", "description": "For x-y scatterplots, min value for X-axis. Set null for auto" }, "ymax": { "type": "number", "format": "double", "description": "For x-y scatterplots, max value for Y-axis. Set null for auto" }, "ymin": { "type": "number", "format": "double", "description": "For x-y scatterplots, min value for Y-axis. Set null for auto" }, "timeBasedColoring": { "type": "boolean", "description": "For x-y scatterplots, whether to color more recent points as darker than older points. Default: false" }, "sparklineDisplayValueType": { "type": "string", "description": "For the single stat view, whether to display the name of the query or the value of query", "enum": ["VALUE", "LABEL"] }, "sparklineDisplayColor": { "type": "string", "description": "For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in \"rgba(<rval>, <gval>, <bval>, <aval>)\" format" }, "sparklineDisplayVerticalPosition": { "type": "string", "description": "deprecated" }, "sparklineDisplayHorizontalPosition": { "type": "string", "description": "For the single stat view, the horizontal position of the displayed text", "enum": ["MIDDLE", "LEFT", "RIGHT"] }, "sparklineDisplayFontSize": { "type": "string", "description": "For the single stat view, the font size of the displayed text, in percent" }, "sparklineDisplayPrefix": { "type": "string", "description": "For the single stat view, a string to add before the displayed text" }, "sparklineDisplayPostfix": { "type": "string", "description": "For the single stat view, a string to append to the displayed text" }, "sparklineSize": { "type": "string", "description": "For the single stat view, a misleadingly named property. This determines whether the sparkline of the statistic is displayed in the chart BACKGROUND, BOTTOM, or NONE", "enum": ["BACKGROUND", "BOTTOM", "NONE"] }, "sparklineLineColor": { "type": "string", "description": "For the single stat view, the color of the line. Values should be in \"rgba(<rval>, <gval>, <bval>, <aval>)\" format" }, "sparklineFillColor": { "type": "string", "description": "For the single stat view, the color of the background fill. Values should be in \"rgba(<rval>, <gval>, <bval>, <aval>)\" format" }, "sparklineValueColorMapColors": { "type": "array", "description": "For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparklineValueColorMapValuesV2. Values should be in \"rgba(<rval>, <gval>, <bval>, <aval>)\" format", "items": { "type": "string" } }, "sparklineValueColorMapValuesV2": { "type": "array", "description": "For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one less element than sparklineValueColorMapColors", "items": { "type": "number", "format": "float" } }, "sparklineValueColorMapValues": { "type": "array", "description": "deprecated", "items": { "type": "integer", "format": "int64" } }, "sparklineValueColorMapApplyTo": { "type": "string", "description": "For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND", "enum": ["TEXT", "BACKGROUND"] }, "sparklineDecimalPrecision": { "type": "integer", "format": "int32", "description": "For the single stat view, the decimal precision of the displayed number" }, "sparklineValueTextMapText": { "type": "array", "description": "For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparklineValueTextMapThresholds", "items": { "type": "string" } }, "sparklineValueTextMapThresholds": { "type": "array", "description": "For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one less element than sparklineValueTextMapText", "items": { "type": "number", "format": "float" } }, "chartDefaultColor": { "type": "string", "description": "Default color that will be used in any chart rendering. Values should be in \"rgba(<rval>, <gval>, <bval>, <aval>)\" format" }, "logsTable": { "$ref": "#/definitions/LogsTable" } }, "description": "Representation of the settings of a Wavefront chart" }, "ClassLoader": { "type": "object", "properties": { "name": { "type": "string" }, "registeredAsParallelCapable": { "type": "boolean" }, "parent": { "$ref": "#/definitions/ClassLoader" }, "unnamedModule": { "$ref": "#/definitions/Module" }, "definedPackages": { "type": "array", "items": { "$ref": "#/definitions/Package" } } } }, "Conversion": { "type": "object", "properties": { "logicalTypeName": { "type": "string" }, "recommendedSchema": { "$ref": "#/definitions/Schema" } } }, "ConversionObject": { "type": "object", "properties": { "logicalTypeName": { "type": "string" }, "recommendedSchema": { "$ref": "#/definitions/Schema" } } }, "Event": { "type": "object", "required": ["annotations", "name", "startTime"], "properties": { "computedHlps": { "type": "array", "description": "All the host/label/tags of the event.", "readOnly": true, "uniqueItems": true, "items": { "$ref": "#/definitions/SourceLabelPair" } }, "table": { "type": "string", "description": "The customer to which the event belongs", "readOnly": true }, "dimensions": { "type": "object", "description": "A string->