Skip to content

Instantly share code, notes, and snippets.

@CodingFabian
Created January 27, 2021 15:05
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save CodingFabian/312a57b1ebe165680a169c619546c0f5 to your computer and use it in GitHub Desktop.
Save CodingFabian/312a57b1ebe165680a169c619546c0f5 to your computer and use it in GitHub Desktop.
{
"openapi": "3.0.1",
"info": {
"contact": {
"email": "support@instana.com",
"name": "© Instana",
"url": "http://instana.com"
},
"termsOfService": "https://www.instana.com/terms-of-use/",
"title": "Introduction to Instana public APIs",
"version": "1.193.696",
"x-logo": {
"altText": "instana logo",
"backgroundColor": "#FAFBFC",
"url": "header-logo.svg"
},
"description": "## Agent REST API\n### Event SDK REST Web Service\nUsing the Event SDK REST Web Service, it is possible to integrate custom health checks and other event sources into Instana. Each one running the Instana Agent can be used to feed in manual events. The agent has an endpoint which listens on `http://localhost:42699/com.instana.plugin.generic.event` and accepts the following JSON via a POST request:\n\n```json\n{\n \"title\": <string>,\n \"text\": <string>,\n \"severity\": <integer> , -1, 5 or 10\n \"timestamp\": <integer>, timestamp in milliseconds from epoch\n \"duration\": <integer>, duration in milliseconds\n}\n```\n\n*Title* and *text* are used for display purposes.\n\n*Severity* is an optional integer of -1, 5 and 10. A value of -1 or EMPTY will generate a Change. A value of 5 will generate a *warning Issue*, and a value of 10 will generate a *critical Issue*.\n\nWhen absent, the event is treated as a change without severity. *Timestamp* is the timestamp of the event, but it is optional, in which case the current time is used. *Duration* can be used to mark a timespan for the event. It also is optional, in which case the event will be marked as \"instant\" rather than \"from-to.\"\n\nThe endpoint also accepts a batch of events, which then need to be given as an array:\n\n```json\n[\n {\n // event as above\n },\n {\n // event as above\n }\n]\n```\n\n#### Ruby Example\n\n```ruby\nduration = (Time.now.to_f * 1000).floor - deploy_start_time_in_ms\npayload = {}\npayload[:title] = 'Deployed MyApp'\npayload[:text] = 'pglombardo deployed MyApp@revision'\npayload[:duration] = duration\n\nuri = URI('http://localhost:42699/com.instana.plugin.generic.event')\nreq = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')\nreq.body = payload.to_json\nNet::HTTP.start(uri.hostname, uri.port) do |http|\n http.request(req)\nend\n```\n\n#### Curl Example\n\n```bash\ncurl -XPOST http://localhost:42699/com.instana.plugin.generic.event -H \"Content-Type: application/json\" -d '{\"title\":\"Custom API Events \", \"text\": \"Failure Redeploying Service Duration\", \"duration\": 5000, \"severity\": -1}'\n```\n\n#### PowerShell Example\n\nFor Powershell you can either use the standard Cmdlets `Invoke-WebRequest` or `Invoke-RestMethod`. The parameters to be provided are basically the same.\n\n```bash\nInvoke-RestMethod\n -Uri http://localhost:42699/com.instana.plugin.generic.event\n -Method POST\n -Body '{\"title\":\"PowerShell Event \", \"text\": \"You used PowerShell to create this event!\", \"duration\": 5000, \"severity\": -1}'\n```\n\n```bash\nInvoke-WebRequest\n -Uri http://localhost:42699/com.instana.plugin.generic.event\n -Method Post\n -Body '{\"title\":\"PowerShell Event \", \"text\": \"You used PowerShell to create this event!\", \"duration\": 5000, \"severity\": -1}'\n```\n## Backend REST API\nThe Instana API allows retrieval and configuration of key data points. Among others, this API enables automatic reaction and further analysis of identified incidents as well as reporting capabilities.\n\nThe API documentation referes to two crucial parameters that you need to know about before reading further:\nbase: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface.\napiToken: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.\n\n### Example\nHere is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n\nNext we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.\n\n```bash\ncurl --request POST \\\n --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\\n --header 'content-type: application/json' \\\n --data '{\n \"group\":{\n \"groupbyTag\":\"endpoint.name\"\n },\n \"tagFilters\":[\n \t{\n \t\t\"name\":\"call.error.count\",\n \t\t\"value\":\"0\",\n \t\t\"operator\":\"GREATER_THAN\"\n \t}\n ],\n \"metrics\":[\n \t{\n \t\t\"metric\":\"errors\",\n \t\t\"aggregation\":\"MEAN\"\n \t}\n ]\n }'\n```\n\n\n### Rate Limiting\nA rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.\n\n**X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour.\n\n**X-RateLimit-Remaining:** How many calls may still be executed within the current hour.\n\n**X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.\n\n## Generating REST API clients\n\nThe API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format.\nYou can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).\n\nOpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made.\nTo generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).\n\n### Go\nFor example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:\n\n```bash\n#!/bin/bash\n\n### This script assumes you have the `java` and `wget` commands on the path\n\nexport UNIT_NAME='myunit' # for example: prod\nexport TENANT_NAME='mytenant' # for example: awesomecompany\n\n//Download the generator to your current working directory:\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"\n\n//generate a client library that you can vendor into your repository\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\\n -o pkg/instana/openapi \\\n --skip-validate-spec\n\n//(optional) format the Go code according to the Go code standard\ngofmt -s -w pkg/instana/openapi\n```\n\nThe generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:\n\n```go\nimport instana \"./pkg/instana/openapi\"\n\n// readTags will read all available application monitoring tags along with their type and category\nfunc readTags() {\n\tconfiguration := instana.NewConfiguration()\n\tconfiguration.Host = \"tenant-unit.instana.io\"\n\tconfiguration.BasePath = \"https://tenant-unit.instana.io\"\n\n\tclient := instana.NewAPIClient(configuration)\n\tauth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{\n\t\tKey: apiKey,\n\t\tPrefix: \"apiToken\",\n\t})\n\n\ttags, _, err := client.ApplicationCatalogApi.GetTagsForApplication(auth)\n\tif err != nil {\n\t\tfmt.Fatalf(\"Error calling the API, aborting.\")\n\t}\n\n\tfor _, tag := range tags {\n\t\tfmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)\n\t}\n}\n```\n\n### Java\nDownload the latest openapi generator cli:\n```\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar\n```\n\nA list for calls for different java http client implementations, which creates a valid generated source code for our spec.\n```\n//Nativ Java HTTP Client\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native\n\n//Spring WebClient\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient\n\n//Spring RestTemplate\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate\n\n```\n"
},
"servers": [
{
"description": "Instana Backend",
"url": "https://release-instana.instana.rocks",
"variables": {
"tenant": {
"default": "tenant",
"description": "Customer tenant unit"
},
"unit": {
"default": "unit",
"description": "Customer tenant name"
}
}
}
],
"tags": [
{
"name": "Infrastructure Metrics",
"description": "This endpoint retrieves the metrics for infrastructure components.\r\n\r\n### Mandatory Parameters\r\n**plugin:** Plugins are entities' for which we collect metrics, for example : \"Host\", \"Cassandra node\", \"Cassandra Connection\".\r\n\r\nThe available plugins are depending on the system you are monitoring. Therefore you will need to [retrieve plugins](#operation/getInfrastructureCatalogPlugins) where we have data for you.\r\n\r\n**query or snapshotIds:** choose between dynamic focus query or [snapshotId](#operation/getSnapshots) (a unique identifier the metrics are assigned to)\r\n\r\nTo make the it easy to get started this endpoint has two modes that can be used for metrics retrieval:\r\n1. Search metrics with a query\r\n You are using the [Dynamic Focus](https://docs.instana.io/core_concepts/dynamic_focus/) query to filter the result.\r\n To get usable search parameters you can either query the search [catalog endpoint](#operation/getInfrastructureCatalogSearchFields) or use the UI\r\n\r\n1. Search for metrics for snapshotIds\r\n For advanced use cases, pagination for example, its recommended to use fixed snapshotIds. This also pushes the API call limit for this endpoint from 500 to 1000 calls per Minute\r\n\r\n**metrics:** Id of the exact metric you want to retrieve, eg. \"cpu.user\", \"clientrequests.read.mean\"\r\n\r\nOnce you have selected the plugin you can define up to five metrics you want to retrieve with the call.\r\nPlease use our [metrics catalog call](#operation/getInfrastructureCatalogMetrics) to get the available metrics for the selected plugin.\r\n\r\n### Optional Parameters\r\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\r\n```\r\n windowSize to\r\n (ms) (unix-timestamp)\r\n<----------------------|\r\n```\r\n\r\n**rollup:** Depending on the selected timeFrame its possible to selected the rollup.\r\n\r\nThe available rollup is depending on two factors:\r\n1. [Retention times](https://docs.instana.io/core_concepts/data_collection/#data-retention)\r\n\r\n\tFor example if you select a to timestamp that is 3 Weeks in the past the most accurate rollup you can query for would be 1min\r\n1. Size of the selected windowSize\r\n\r\n\tThe limitation is that we only return 600 Data points per call, thus if you select a windowSize of 1hour the most accurate rollup you can query for would be 5s\r\n\r\nValid rollups are:\r\n\r\n| rollup | value |\r\n| ------------- | ------------- |\r\n| 1 second | 1 |\r\n| 5 seconds | 5 |\r\n| 1 minute | 60 |\r\n| 5 minutes | 300 |\r\n| 1 hour | 3600 |\r\n\r\n\r\n### Defaults\r\n**timeframe:**\r\n```\r\n\"timeFrame\": {\r\n\t\"windowSize\": 60000,\r\n\t\"to\": {current timestamp}\r\n}\r\n```\r\n\r\n**rollup**: 1\r\n\r\n### Limits\r\n500 Calls per Hour\r\n1000 Calls per Hour\r\n\r\nTo keep the response size reasonable the limit is set to 30 retrieved items. To implement pagination see [1]\r\n\r\nA maximum of 600 data points are returned per metric.\r\n\r\nYou can only retrieve metrics [above](https://docs.instana.io/core_concepts/dynamic_graph/) the selected Dynamic Focus filter. Work around can be found under [2]\r\n\r\nThe following example will return an empty result, because the selected plugin \"host\" is below the dynamic focus filter \"java\" :\r\n```\r\nquery=entity.selfType:java\r\nplugin=host\r\nmetric=cpu.steal\r\n```\r\n### Tips\r\n[1] **Pagination**\r\nSometimes the query you are interested in returns more than 30 items, you have to use the [find snapshots](#operation/getSnapshots) endpoint to get a full list of Ids for your query and then use the [metrics endpoint](#operation/getInfrastructureMetrics) with the returned snapshotIds\r\n\r\n\r\n[2] **Application filter**\r\nYou can work around the aforementioned limitation by querying one of the crosscutting entities like applications, services and endpoints. For the example above you could create an Application with jvm.version isPresent filter. And search Query then for the created application name\r\n```\r\nquery=entity.application.name:\"Java Applications\"\r\n```\r\n"
},
{
"name": "Infrastructure Resources"
},
{
"name": "Infrastructure Catalog",
"description": "The endpoints of this group retrieve all available resources to query infrastructure metrics.\n"
},
{
"name": "Application Metrics",
"description": "The endpoints of this group retrieve the metrics for defined applications, discovered services and endpoints.\r\n### Mandatory Parameters\r\n\r\n**metrics** A list of metric objects that define which metric should be returned, with the defined aggregation. Each metrics objects consists of minimum two items:\r\n1. *metric* select a particular metric to get a list of available metrics query the [catalogue endpoint](#operation/getMetricDefinitions)\r\n2. *aggregation* depending on the selected metric different aggregations are available e.g. SUM, MEAN, P95. The aforementioned [catalogue endpoint](#operation/getMetricDefinitions) gives you the metrics with the available aggregations.\r\n\r\n### Optional Parameters\r\n\r\n**metrics** Default you will get an aggregated metric with for the selected timeFrame \r\n\r\n* *granularity* \r\n * if it is not set you will get a an aggregated value for the selected timeframe. \r\n * if the granularity is set you will get data points with the specified granularity in seconds\r\n * The value can be selected freely between 1 - selected windowSize.\r\n \r\n**pagination** if you use pagination you most probably want to fix the timeFrame for the retrieved metrics\r\n1. *page* select the page number you want to retrieve\r\n2. *pageSize* set the number of applications you want to return with one query\r\n\r\n**order** You can order the returned items alphanumerical by label, either ascending or descending\r\n1. *by* if the granularity is set to 1 you can use the metric name eg. \"latency.p95\" to order by that value\r\n1. *direction* either ascending or descending\r\n\r\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\r\n```\r\n windowSize to\r\n (ms) (unix-timestamp)\r\n<----------------------|\r\n```\r\n\r\nTo narrow down the result set you have four options to search for an application.\r\n\r\n**nameFilter | applicationId | serviceId | endpointId**\r\n\r\n* *nameFilter:* filter by name with \"contains\" semantic.\r\n\r\n* *applicationId:* search directly for an application by applicationId \r\n\r\n* *serviceId:* search for applications that include a particular service by serviceId\r\n\r\n* *endpointId:* search for applications that include a particular endpoint by endpointId\r\n\r\n### Defaults\r\n\r\n**metrics**\r\n* *granularity:* 1\r\n\r\n**order**\r\n* by application label ascending.\r\n\r\n**timeFrame**\r\n```\r\n\"timeFrame\": {\r\n\t\"windowSize\": 60000,\r\n\t\"to\": {current timestamp}\r\n}\r\n```\r\n**nameFilter | applicationId | serviceId | endpointId**\r\n* no filters are applied in the default call\r\n"
},
{
"name": "Application Catalog",
"description": "The endpoints of this group retrieve all available resources to query application metrics.\n"
},
{
"name": "Application Resources"
},
{
"name": "Application Analyze",
"description": "The following four endpoints expose our analyze functionality.\nPart of this are two group endpoints to retrieve metrics for traces and calls rolled up and filtered individually. \nFurthermore you can [search and filter all traces](#operation/getTraces) and retrieve [all details](#operation/getTrace) attached to the trace.\n\n## Parameters\n### Mandatory Parameters (only for group Endpoints):\n**group** It is mandatory to select a tag by which the calls and traces are grouped for the distinct endpoint call\n* *groupByTag* select a tag by which the calls and traces are grouped \n * a full list of available tags can be retrieved from [tags catalogue](#operation/getTagsForApplication)\n * for the trace endpoint only two tags are reasonable and working: `trace.endpoint.name` and `trace.service.name` which indicate the entry endpoint or service for the trace\n* *groupByTagSecondLevelKey* tags of type KEY_VALUE_PAIR need a second parameter e.g for `kubernetes.deployment.label` you would need provide the label you want to groupBy here.\n\n### Optional Parameters\n**pagination**\n* *offset* set the starting point for the data retrieval\n* *retrievalSize* you set the number of returned values\n* *ingestionTime* if you want to paginate through your result set you are interested in having the data for a fixed time point, the results set has a `cursor` class that has a ingestionTime property that indicates what you have to enter here.\n**order**\n\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\n```\n windowSize to\n (ms) (unix-timestamp)\n<----------------------|\n```\n\n**tagFilters** As in the UI you able to filter your query by a tag. To get a list of all available tags you can query the [tag catalog](#operation/getApplicationCatalogTags)\n* *name* The name of the tag as returned by the catalog\n* *value* The filter value of the tag, possible types are:\n * \"STRING\" alphanumerical values, valid operators: \"EQUALS\", \"CONTAINS\", \"NOT_EQUAL\", \"NOT_CONTAIN\", \"NOT_EMPTY\", \"IS_EMPTY\"\n * \"NUMBER\" numerical values, valid operators: \"EQUALS\", \"LESS_THAN\" \"GREATER_THAN\"\n * \"KEY_VALUE_PAIR\" \n* *operator* one of the valid operators for the type of the selected tag\n\n**metrics** A list of metric objects that define which metric should be returned, with the defined aggregation. Each metrics objects consists of minimum two items:\n1. *metric* select a particular metric, available metrics in this context are\n * Latency Mean\n * Error Rate\n * Traces Sum\n2. *aggregation* depending on the selected metric different aggregations are available e.g. SUM, MEAN, P95. The aforementioned [catalogue endpoint](#operation/getApplicationCatalogMetrics) gives you the metrics with the available aggregations.\n3. *granularity* \n * if it is not set you will get a an aggregated value for the selected timeframe. \n * if the granularity is set you will get data points with the specified granularity in seconds\n * The value can be selected freely between 1 - selected windowSize.\n\n### Defaults:\n**timeFrame**\n```\n\"timeFrame\": {\n\t\"windowSize\": 60000,\n\t\"to\": {current timestamp}\n}\n```\n"
},
{
"name": "Application Settings"
},
{
"name": "Website Metrics"
},
{
"name": "Website Catalog",
"description": "The endpoints of this group retrieve all available resources to query website metrics.\n"
},
{
"name": "Website Configuration"
},
{
"name": "Website Analyze",
"description": "The following four endpoints expose our analyze functionality.\n\n## Mandatory Parameters :\n\n**type** \n\n**group (only for group Endpoints)** It is mandatory to select a tag by which the beacons are grouped for the distinct endpoint call\n* *groupByTag* select a tag by which the beacons are grouped \n * a full list of available tags can be retrieved from [tags catalogue](#operation/getTagsForWeb)\n* *groupByTagSecondLevelKey* tags of type KEY_VALUE_PAIR need a second parameter e.g for `beacon.meta` you would need provide the label you want to groupBy here.\n\n\n## Optional Parameters:\n\n**pagination**\n* *offset* set the starting point for the data retrieval\n* *retrievalSize* you set the number of returned values\n* *ingestionTime* if you want to paginate through your result set you are interested in having the data for a fixed time point, the results set has a `cursor` class that has a ingestionTime property that indicates what you have to enter here.\n\n**order**\n\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\n```\n windowSize to\n (ms) (unix-timestamp)\n<----------------------|\n```\n\n**tagFilters** As in the UI you able to filter your query by a tag. To get a list of all available tags you can query the [tag catalog](#operation/getTagsForApplication)\n* *name* The name of the tag as returned by the catalog, e.g `beacon.meta`, `beacon.http.path`\n* *value* The filter value of the tag, possible types are:\n * \"STRING\" alphanumerical values, valid operators: \"EQUALS\", \"CONTAINS\", \"NOT_EQUAL\", \"NOT_CONTAIN\", \"NOT_EMPTY\", \"IS_EMPTY\"\n * \"NUMBER\" numerical values, valid operators: \"EQUALS\", \"LESS_THAN\" \"GREATER_THAN\"\n * \"KEY_VALUE_PAIR\" of you are using meta tags `beacon.meta` you can filter for those by setting `yourMetaTagName=foo` in the value field, valid operators: \"EQUALS\", \"CONTAINS\", \"NOT_EQUAL\", \"NOT_CONTAIN\", \"NOT_EMPTY\", \"IS_EMPTY\"\n* *operator* one of the valid operators for the type of the selected tag\n\n**metrics** A list of metric objects that define which metric should be returned, with the defined aggregation. Each metrics objects consists of minimum two items:\n1. *metric* select a particular metric, available metrics in this context are\n * Latency Mean\n * Error Rate\n2. *aggregation* depending on the selected metric different aggregations are available e.g. SUM, MEAN, P95. The aforementioned [catalogue endpoint](#operation/getMetricDefinitions) gives you the metrics with the available aggregations.\n3. *granularity* \n * if it is not set you will get a an aggregated value for the selected timeframe. \n * if the granularity is set you will get data points with the specified granularity in seconds\n * The value can be selected freely between 1 - selected windowSize.\n \n\n## Defaults:\n\n**timeFrame**\n```\n\"timeFrame\": {\n\t\"windowSize\": 60000,\n\t\"to\": {current timestamp}\n}\n```\n"
},
{
"name": "Events"
},
{
"name": "Event Settings"
},
{
"name": "Application Alert Configuration",
"description": "The endpoints of this group can be used to manage Application alert configurations. These endpoints are only available for customers who have opted-in for the BETA feature \"Application Smart Alerts\".\nIn order to use this feature or to have more information, please contact <support@instana.com>.\n\n"
},
{
"name": "Host Agent",
"description": "Endpoints of this group can be used to list and configure host agents. "
},
{
"name": "User"
},
{
"name": "Groups"
},
{
"name": "Audit Log"
},
{
"name": "API Token"
},
{
"name": "Session Settings"
},
{
"name": "Maintenance Configuration"
},
{
"name": "Synthetic Calls"
},
{
"name": "Releases"
},
{
"name": "SLI Settings"
},
{
"name": "SLI Report"
},
{
"name": "Health"
},
{
"name": "Custom Dashboards",
"description": "You can use these API endpoints to manage custom dashboards. We recommend\nthat you leverage the `Edit as JSON` feature found within our user interface\nto construct the desired request payloads. Specifically to help you build\ncorrect widget configurations and access rules.\n\nTo identify the correct values for the `relatedId` field of the access rules,\nwe recommend using the `/api/custom-dashboard/shareable-users` and\n`/api/custom-dashboard/shareable-api-tokens` endpoints. These endpoints return\nour internal IDs for users and API tokens."
},
{
"name": "Usage"
}
],
"paths": {
"/api/application-monitoring/analyze/call-groups": {
"post": {
"operationId": "getCallGroup",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCallGroups"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallGroupsResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get grouped call metrics",
"tags": [
"Application Analyze"
],
"description": "This endpoint retrieves the metrics for calls.\r\n\r\n**Manditory Paramters:**\r\n\r\n**Optional Paramters:**\r\n\r\n**Defaults:**\r\n\r\n**Limits:**\r\n\r\n**Tips:**\r\n"
}
},
"/api/application-monitoring/analyze/trace-groups": {
"post": {
"operationId": "getTraceGroups",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTraceGroups"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceGroupsResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get grouped trace metrics",
"tags": [
"Application Analyze"
]
}
},
"/api/application-monitoring/analyze/traces": {
"post": {
"operationId": "getTraces",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTraces"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceResult"
}
}
},
"x-example": "TraceResult"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get all traces",
"tags": [
"Application Analyze"
],
"x-code-samples": [
{
"lang": "JAVA",
"source": "CloseableHttpClient client = HttpClients.createDefault();\nString url = \"https://unit-tenant.instana.com/api/application-monitoring/analyse/traces\";\nHttpPost httpPost = new HttpPost(url);\nString json = \"{\"\n + \"\\\"pagination\\\":{\\\"retrievalSize\\\":20,\\\"offset\\\":0},\"\n + \"\\\"timeFrame\\\":{\\\"windowSize\\\":3600000}\"\n + \"}\"\nStringEntity entity = new StringEntity(json);\nhttpPost.setEntity(entity);\nhttpPost.setHeader(\"Accept\", \"application/json\");\nhttpPost.setHeader(\"Content-type\", \"application/json\");\nhttpPost.setHeader(\"Authorization\", \"apiToken xxxxxxxx\");\n\nCloseableHttpResponse response = client.execute(httpPost);\n\nassertThat(response.getStatusLine().getStatusCode(), equalTo(200));\nString traceResult = EntityUtils.toString(response.getEntity());\nclient.close();\n"
},
{
"lang": "SHELL",
"source": "curl --request POST \\\n --url https://unit-tenant.instana.io/api/application-monitoring/analyze/call-groups \\\n --header 'authorization: apiToken {apiToken}}' \\\n --header 'content-type: application/json' \\\n --data '{ \n\n\"timeFrame\": { \n\"windowSize\": 36000000 \n}, \n\"order\":{\n\t\"by\": \"errors\", \n\"direction\": \"DESC\" \n},\n\"group\": { \n\"groupbyTag\": \"application.name\"\n}, \n\"metrics\": [ \n{ \n\"metric\": \"errors\", \n\"aggregation\": \"MEAN\" \n} \n] \n} '"
}
],
"description": "This endpoint retrieves the metrics for traces.\r\n\r\n**Manditory Paramters:**\r\n\r\n**Optional Paramters:**\r\n\r\n**Defaults:**\r\n\r\n**Limits:**\r\n\r\n**Tips:**\r\n"
}
},
"/api/application-monitoring/analyze/traces/{id}": {
"get": {
"operationId": "getTrace",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullTrace"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get trace detail",
"tags": [
"Application Analyze"
]
}
},
"/api/application-monitoring/applications": {
"get": {
"operationId": "getApplications",
"parameters": [
{
"in": "query",
"name": "nameFilter",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "applicationBoundaryScope",
"schema": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get applications",
"tags": [
"Application Resources"
]
}
},
"/api/application-monitoring/applications/services": {
"get": {
"operationId": "getApplicationServices",
"parameters": [
{
"in": "query",
"name": "nameFilter",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "applicationBoundaryScope",
"schema": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get applications/services",
"tags": [
"Application Resources"
]
}
},
"/api/application-monitoring/applications/services/endpoints": {
"get": {
"operationId": "application.resources.endpoints",
"parameters": [
{
"in": "query",
"name": "nameFilter",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "types",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
{
"in": "query",
"name": "technologies",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "applicationBoundaryScope",
"schema": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get endpoints",
"tags": [
"Application Resources"
]
}
},
"/api/application-monitoring/catalog": {
"get": {
"operationId": "getApplicationTagCatalog",
"parameters": [
{
"in": "query",
"name": "from",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "dataSource",
"schema": {
"type": "string",
"enum": [
"CALLS",
"TRACES"
]
}
},
{
"in": "query",
"name": "useCase",
"schema": {
"type": "string",
"enum": [
"GROUPING",
"FILTERING",
"SMART_ALERTS",
"SLI_MANAGEMENT",
"APPLICATION_CONFIG",
"APPLICATION_CONFIG_BLUEPRINT"
]
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagCatalog"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get application tag catalog",
"tags": [
"Application Catalog"
]
}
},
"/api/application-monitoring/catalog/metrics": {
"get": {
"operationId": "getApplicationCatalogMetrics",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricDescription"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get Metric catalog",
"tags": [
"Application Catalog"
],
"description": "This endpoint retrieves all available metric definitions for application monitoring.\n"
}
},
"/api/application-monitoring/catalog/tags": {
"get": {
"deprecated": true,
"operationId": "getApplicationTags",
"parameters": [
{
"in": "query",
"name": "from",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "dataSource",
"schema": {
"type": "string",
"enum": [
"CALLS",
"TRACES"
]
}
},
{
"in": "query",
"name": "useCase",
"schema": {
"type": "string",
"enum": [
"GROUPING",
"FILTERING",
"SMART_ALERTS",
"SLI_MANAGEMENT",
"APPLICATION_CONFIG",
"APPLICATION_CONFIG_BLUEPRINT"
]
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get application tags",
"tags": [
"Application Catalog"
],
"description": "This endpoint retrieves all available tags for your monitored system.\n\nThese tags can be used to group metric results.\n```\n\"group\": {\n \"groupbyTag\": \"service.name\"\n}\n```\n\nThese tags can be used to filter metric results.\n```\n\"tagFilters\": [{\n\t\"name\": \"application.name\",\n\t\"operator\": \"EQUALS\",\n\t\"value\": \"example\"\n}]\n```\n"
}
},
"/api/application-monitoring/metrics/applications": {
"post": {
"operationId": "getApplicationMetrics",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetApplications"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationMetricResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get Application Metrics",
"tags": [
"Application Metrics"
]
}
},
"/api/application-monitoring/metrics/endpoints": {
"post": {
"operationId": "getEndpointsMetrics",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEndpoints"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointMetricResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get Endpoint metrics",
"tags": [
"Application Metrics"
]
}
},
"/api/application-monitoring/metrics/services": {
"post": {
"operationId": "getServicesMetrics",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetServices"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceMetricResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get Service metrics",
"tags": [
"Application Metrics"
]
}
},
"/api/application-monitoring/services": {
"get": {
"operationId": "getServices",
"parameters": [
{
"in": "query",
"name": "nameFilter",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get services",
"tags": [
"Application Resources"
]
}
},
"/api/application-monitoring/settings/application": {
"get": {
"operationId": "getApplicationConfigs",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationConfig"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "All Application configurations",
"tags": [
"Application Settings"
]
},
"post": {
"operationId": "addApplicationConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewApplicationConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Add application configuration",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/application/{id}": {
"delete": {
"operationId": "deleteApplicationConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Delete application configuration",
"tags": [
"Application Settings"
]
},
"get": {
"operationId": "getApplicationConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Application configuration",
"tags": [
"Application Settings"
]
},
"put": {
"operationId": "putApplicationConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Update application configuration",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/http-endpoint": {
"get": {
"operationId": "getEndpointConfigs",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "All Endpoint configurations",
"tags": [
"Application Settings"
]
},
"post": {
"operationId": "createEndpointConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Create endpoint configuration",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/http-endpoint/{id}": {
"delete": {
"operationId": "deleteEndpointConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Delete endpoint configuration",
"tags": [
"Application Settings"
]
},
"get": {
"operationId": "getEndpointConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Endpoint configuration",
"tags": [
"Application Settings"
]
},
"put": {
"operationId": "updateEndpointConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpEndpointConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Update endpoint configuration",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/service": {
"get": {
"operationId": "getServiceConfigs",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "All service configurations",
"tags": [
"Application Settings"
]
},
"post": {
"operationId": "addServiceConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Add service configuration",
"tags": [
"Application Settings"
]
},
"put": {
"operationId": "replaceAll",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Replace all service configurations",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/service/order": {
"put": {
"operationId": "orderServiceConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Order of service configuration",
"tags": [
"Application Settings"
]
}
},
"/api/application-monitoring/settings/service/{id}": {
"delete": {
"operationId": "deleteServiceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Delete service configuration",
"tags": [
"Application Settings"
]
},
"get": {
"operationId": "getServiceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Service configuration",
"tags": [
"Application Settings"
]
},
"put": {
"operationId": "putServiceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Update service configuration",
"tags": [
"Application Settings"
]
}
},
"/api/custom-dashboard": {
"get": {
"operationId": "getCustomDashboards",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get accessible custom dashboards",
"tags": [
"Custom Dashboards"
]
},
"post": {
"operationId": "addCustomDashboard",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
},
"responses": {
"400": {
"description": "Invalid payload or when attempting to share dashboards without the canCreatePublicCustomDashboards permission."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Add custom dashboard",
"tags": [
"Custom Dashboards"
]
}
},
"/api/custom-dashboard/shareable-api-tokens": {
"get": {
"operationId": "getShareableApiTokens",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"CreatePublicCustomDashboards"
]
}
],
"summary": "Get all API tokens.",
"tags": [
"Custom Dashboards"
]
}
},
"/api/custom-dashboard/shareable-users": {
"get": {
"operationId": "getShareableUsers",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"CreatePublicCustomDashboards"
]
}
],
"summary": "Get all users (without invitations).",
"tags": [
"Custom Dashboards"
]
}
},
"/api/custom-dashboard/{customDashboardId}": {
"delete": {
"operationId": "deleteCustomDashboard",
"parameters": [
{
"in": "path",
"name": "customDashboardId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Custom dashboard successfully removed"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Remove custom dashboard",
"tags": [
"Custom Dashboards"
]
},
"get": {
"operationId": "getCustomDashboard",
"parameters": [
{
"in": "path",
"name": "customDashboardId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get custom dashboard",
"tags": [
"Custom Dashboards"
]
},
"put": {
"operationId": "updateCustomDashboard",
"parameters": [
{
"in": "path",
"name": "customDashboardId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
},
"responses": {
"400": {
"description": "Invalid payload or when attempting to share dashboards without the canCreatePublicCustomDashboards permission."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDashboard"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Update custom dashboard",
"tags": [
"Custom Dashboards"
]
}
},
"/api/events": {
"get": {
"operationId": "getEvents",
"parameters": [
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "from",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "excludeTriggeredBefore",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get all events",
"tags": [
"Events"
]
}
},
"/api/events/settings/alertingChannels": {
"get": {
"operationId": "getAlertingChannels",
"parameters": [
{
"in": "query",
"name": "ids",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AbstractIntegration"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "All alerting channels",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alertingChannels/infos": {
"get": {
"operationId": "getAlertingChannelsOverview",
"parameters": [
{
"in": "query",
"name": "ids",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationOverview"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "Overview over all alerting channels",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alertingChannels/test": {
"put": {
"operationId": "sendTestAlerting",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AbstractIntegration"
}
}
},
"required": true,
"x-example": "alertingChannelTestCall"
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "Test alerting channel",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alertingChannels/{id}": {
"delete": {
"operationId": "deleteAlertingChannel",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "Delete alerting channel",
"tags": [
"Event Settings"
]
},
"get": {
"operationId": "getAlertingChannel",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AbstractIntegration"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "Alerting channel",
"tags": [
"Event Settings"
]
},
"put": {
"operationId": "putAlertingChannel",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AbstractIntegration"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureIntegrations"
]
}
],
"summary": "Update alerting channel",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alerts": {
"get": {
"operationId": "getAlerts",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidatedAlertingConfiguration"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Get all Alert Configurations",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alerts/infos": {
"get": {
"operationId": "getAlertingConfigurationInfos",
"parameters": [
{
"in": "query",
"name": "integrationId",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidatedAlertingChannelInputInfo"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All alerting configuration info",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/alerts/{id}": {
"delete": {
"operationId": "deleteAlert",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Delete Alert Configuration",
"tags": [
"Event Settings"
]
},
"get": {
"operationId": "getAlert",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingConfigurationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Find an Alert Configuration by ID",
"tags": [
"Event Settings"
]
},
"put": {
"operationId": "putAlert",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingConfiguration"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingConfigurationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Update Alert Configuration",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/application-alert-configs": {
"get": {
"description": "Configs are sorted descending by their created date.",
"operationId": "findActiveApplicationAlertConfigs",
"parameters": [
{
"in": "query",
"name": "applicationId",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All Application Alert Configs",
"tags": [
"Application Alert Configuration"
]
},
"post": {
"operationId": "createApplicationAlertConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationAlertConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Create Application Alert Config",
"tags": [
"Application Alert Configuration"
]
}
},
"/api/events/settings/application-alert-configs/{id}": {
"delete": {
"operationId": "deleteApplicationAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Delete Application Alert Config",
"tags": [
"Application Alert Configuration"
]
},
"get": {
"description": "Find a Application Alert Config by ID. This will deliver deleted configs too.",
"operationId": "findApplicationAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "validOn",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Get Application Alert Config",
"tags": [
"Application Alert Configuration"
]
},
"post": {
"operationId": "updateApplicationAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationAlertConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Update Application Alert Config",
"tags": [
"Application Alert Configuration"
]
}
},
"/api/events/settings/application-alert-configs/{id}/disable": {
"put": {
"operationId": "disableApplicationAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Disable Application Alert Config",
"tags": [
"Application Alert Configuration"
]
}
},
"/api/events/settings/application-alert-configs/{id}/enable": {
"put": {
"operationId": "enableApplicationAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Enable Application Alert Config",
"tags": [
"Application Alert Configuration"
]
}
},
"/api/events/settings/application-alert-configs/{id}/versions": {
"get": {
"description": "Find all versions of a Application Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date.",
"operationId": "findApplicationAlertConfigVersions",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigVersion"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Get versions of Application Alert Config",
"tags": [
"Application Alert Configuration"
]
}
},
"/api/events/settings/custom-payload-configurations": {
"delete": {
"operationId": "deleteCustomPayloadConfiguration",
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureGlobalAlertPayload"
]
}
],
"summary": "Delete Custom Payload Configuration",
"tags": [
"Event Settings"
]
},
"get": {
"operationId": "getCustomPayloadConfigurations",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomPayloadWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureGlobalAlertPayload"
]
}
],
"summary": "Get Custom Payload Configuration",
"tags": [
"Event Settings"
]
},
"put": {
"operationId": "upsertCustomPayloadConfiguration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomPayloadConfiguration"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomPayloadWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureGlobalAlertPayload"
]
}
],
"summary": "Create / Update Custom Payload Configuration",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/custom-payload-configurations/catalog": {
"get": {
"operationId": "getCustomPayloadTagCatalog",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagCatalog"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureGlobalAlertPayload"
]
}
],
"summary": "Get tag catalog for custom payload in alerting",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/built-in": {
"get": {
"operationId": "getBuiltInEventSpecifications",
"parameters": [
{
"in": "query",
"name": "ids",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuiltInEventSpecificationWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All built-in event specification",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/built-in/{eventSpecificationId}": {
"delete": {
"operationId": "deleteBuiltInEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Delete built-in event specification",
"tags": [
"Event Settings"
]
},
"get": {
"operationId": "getBuiltInEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuiltInEventSpecification"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Built-in event specifications",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/built-in/{eventSpecificationId}/disable": {
"post": {
"operationId": "disableBuiltInEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuiltInEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Disable built-in event specification",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/built-in/{eventSpecificationId}/enable": {
"post": {
"operationId": "enableBuiltInEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuiltInEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Enable built-in event specification",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/custom": {
"get": {
"operationId": "getCustomEventSpecifications",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomEventSpecificationWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All custom event specifications",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/custom/systemRules": {
"get": {
"operationId": "getSystemRules",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemRuleLabel"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All system rules for custom event specifications",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/custom/{eventSpecificationId}": {
"delete": {
"operationId": "deleteCustomEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Delete custom event specification",
"tags": [
"Event Settings"
]
},
"get": {
"operationId": "getCustomEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Custom event specification",
"tags": [
"Event Settings"
]
},
"put": {
"operationId": "putCustomEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEventSpecification"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Create or Update custom event specification",
"tags": [
"Event Settings"
],
"description": "This endpoint creates or updates the Custom Event Specification \n\n## Mandatory Parameters:\n\n- **eventSpecificationId(Path Parameter):** A unique identifier for each custom event\n\n- **id:** Same as the eventSpecificationId\n\n- **name:** Name for the custom event\n\n- **entityType:** Name of tha available plugins for the selected source\n\n- **rules.ruleType:** Type of the rule being set for the custom event\n\n### Rule-type specific parameters\n\nDepending on the chosen `ruleType`, there are further required parameters:\n\n#### Threshold Rule using a dynamic built-in metric by pattern :\n\n- **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window\n\n- **rules.metricPattern.prefix:** Prefix pattern for the metric\n\n- **rules.metricPattern.operator:** Operator for matching the metric\n\n```\ncurl --request PUT 'https://<HOST>/api/events/settings/event-specifications/custom/09876543225' \\\n--header 'Authorization: apiToken <Token>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \"id\" :\"09876543225\", \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\",\n\"query\":<Query>, \n\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"},\n\"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false\n}'\n```\nThe above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope.\n\n#### Threshold Rule using fixed metric :\n\n- **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window\n\n- **rules.metricName:** Metric name for the event\n\n```\ncurl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/09876543226' \\\n--header 'Authorization: apiToken <Token>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \"id\" :\"09876543226\", \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\n\"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \n\"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false\n}'\n```\n\n#### System Rule:\n\n- **rules.systemRuleId:** Id of the System Rule being set \n\n```\ncurl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/09876543227' \\\n--header 'Authorization: apiToken <Token>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \"id\" :\"09876543227\", \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\",\n\"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false\n}'\n```\n\n#### Entity Verification Rule:\n\n- **rules.matchingEntityType:** Type of the Entity\n- **rules.matchingOperator:** Operator for matching the Entity name\n- **rules.matchingEntityLabel:** Name Pattern for the Entity\n\n```\ncurl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/09876543228' \\\n--header 'Authorization: apiToken <Token>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \"id\" :\"09876543228\", \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\n\"name\":\"Event for OpenAPI Entity Verification Rule\",\n\"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \n\"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false\n}'\n``\n"
}
},
"/api/events/settings/event-specifications/custom/{eventSpecificationId}/disable": {
"post": {
"operationId": "disableCustomEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Disable custom event specification",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/custom/{eventSpecificationId}/enable": {
"post": {
"operationId": "enableCustomEventSpecification",
"parameters": [
{
"in": "path",
"name": "eventSpecificationId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEventSpecificationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Enable custom event specification",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/event-specifications/infos": {
"get": {
"operationId": "getEventSpecificationInfos",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSpecificationInfo"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Summary of all built-in and custom event specifications",
"tags": [
"Event Settings"
]
},
"post": {
"description": "Summary of all built-in and custom event specifications by IDs",
"operationId": "getEventSpecificationInfosByIds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSpecificationInfo"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All built-in and custom event specifications",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/website-alert-configs": {
"get": {
"description": "Configs are sorted descending by their created date.",
"operationId": "findActiveWebsiteAlertConfigs",
"parameters": [
{
"in": "query",
"name": "websiteId",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "All Website Alert Configs",
"tags": [
"Event Settings"
]
},
"post": {
"operationId": "createWebsiteAlertConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebsiteAlertConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Create Website Alert Config",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/website-alert-configs/{id}": {
"delete": {
"operationId": "deleteWebsiteAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Delete Website Alert Config",
"tags": [
"Event Settings"
]
},
"get": {
"description": "Find a Website Alert Config by ID. This will deliver deleted configs too.",
"operationId": "findWebsiteAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "validOn",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Get Website Alert Config",
"tags": [
"Event Settings"
]
},
"post": {
"operationId": "updateWebsiteAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebsiteAlertConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Update Website Alert Config",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/website-alert-configs/{id}/disable": {
"put": {
"operationId": "disableWebsiteAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Disable Website Alert Config",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/website-alert-configs/{id}/enable": {
"put": {
"operationId": "enableWebsiteAlertConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"nullable": true
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteAlertConfigWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Enable Website Alert Config",
"tags": [
"Event Settings"
]
}
},
"/api/events/settings/website-alert-configs/{id}/versions": {
"get": {
"description": "Find all versions of a Website Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date.",
"operationId": "findWebsiteAlertConfigVersions",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigVersion"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureCustomAlerts"
]
}
],
"summary": "Get versions of Website Alert Config",
"tags": [
"Event Settings"
]
}
},
"/api/events/{eventId}": {
"get": {
"operationId": "getEvent",
"parameters": [
{
"in": "path",
"name": "eventId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get a particular event",
"tags": [
"Events"
]
}
},
"/api/host-agent": {
"get": {
"operationId": "search",
"parameters": [
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "offline",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnapshotResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Query host agent snapshots",
"tags": [
"Host Agent"
]
}
},
"/api/host-agent/configuration": {
"post": {
"operationId": "updateConfigurationByQuery",
"parameters": [
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "offline",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigurationUpdate"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"canConfigureAgents"
]
}
],
"summary": "Update agent configuration by query",
"tags": [
"Host Agent"
],
"description": "This endpoint can be used to initialize or change configuration management settings for all agents selected by the given Dynamic Focus Query.\n\n"
}
},
"/api/host-agent/{hostId}/configuration": {
"post": {
"operationId": "updateConfigurationByHost",
"parameters": [
{
"in": "path",
"name": "hostId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigurationUpdate"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"canConfigureAgents"
]
}
],
"summary": "Update agent configuration by host",
"tags": [
"Host Agent"
],
"description": "This endpoint can be used to initialize or change configuration management settings for a specific host agent.\n\n"
}
},
"/api/host-agent/{hostId}/logs": {
"get": {
"operationId": "getLogs",
"parameters": [
{
"in": "path",
"name": "hostId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "download",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "file",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
],
"responses": {
"default": {
"content": {
"application/octet-stream": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"canConfigureAgents"
]
}
],
"summary": "Agent download logs",
"tags": [
"Host Agent"
]
}
},
"/api/host-agent/{hostId}/update": {
"post": {
"operationId": "update",
"parameters": [
{
"in": "path",
"name": "hostId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
},
{
"ApiKeyAuth": [
"canConfigureAgents"
]
}
],
"summary": "Agent update",
"tags": [
"Host Agent"
]
}
},
"/api/host-agent/{id}": {
"get": {
"operationId": "getAgentSnapshot",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnapshotItem"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get host agent snapshot details",
"tags": [
"Host Agent"
]
}
},
"/api/infrastructure-monitoring/catalog/metrics/{plugin}": {
"get": {
"operationId": "getInfrastructureCatalogMetrics",
"parameters": [
{
"in": "path",
"name": "plugin",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInstance"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get metric catalog",
"tags": [
"Infrastructure Catalog"
],
"description": "This endpoint retrieves all available metric definitions of the requested plugin.\n\n### Path Parameters:\n\n**plugin** The plugin id from [available plugins](#operation/getInfrastructureCatalogPlugins)\n\n### Optional Parameters:\n\n**filter** You can restrict the returned metric definitions by passing a filter.\n\n* `custom` to retrieve custom metric definitions only.\n* `builtin` to retrieve built-in metric definitions only.\n"
}
},
"/api/infrastructure-monitoring/catalog/plugins": {
"get": {
"operationId": "getInfrastructureCatalogPlugins",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get plugin catalog",
"tags": [
"Infrastructure Catalog"
],
"description": "This endpoint retrieves all available plugin ids for your monitored system.\n"
}
},
"/api/infrastructure-monitoring/catalog/plugins-with-custom-metrics": {
"get": {
"operationId": "getInfrastructureCatalogPluginsWithCustomMetrics",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get all plugins with custom metrics catalog",
"tags": [
"Infrastructure Catalog"
]
}
},
"/api/infrastructure-monitoring/catalog/search": {
"get": {
"operationId": "getInfrastructureCatalogSearchFields",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchFieldResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "get search field catalog",
"tags": [
"Infrastructure Catalog"
],
"description": "This endpoint retrieves all available search keywords for dynamic focus queries.\n\nThese search fields can be accessed via lucene queries. Each field belongs to a context, e.g. to entity, trace or event data.\nSome fields contain a set of possible fixed values, in this case a deviant value is invalid.\n\n```\n?query={keyword}:{value}\n```\n"
}
},
"/api/infrastructure-monitoring/graph/related-hosts/{snapshotId}": {
"get": {
"operationId": "getRelatedHosts",
"parameters": [
{
"in": "path",
"name": "snapshotId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Related hosts",
"tags": [
"Infrastructure Resources"
]
}
},
"/api/infrastructure-monitoring/graph/views": {
"get": {
"operationId": "getInfrastructureViewTree",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TreeNodeResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get view tree",
"tags": [
"Infrastructure Resources"
]
}
},
"/api/infrastructure-monitoring/metrics": {
"post": {
"operationId": "getInfrastructureMetrics",
"parameters": [
{
"in": "query",
"name": "offline",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCombinedMetrics"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InfrastructureMetricResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get infrastructure metrics",
"tags": [
"Infrastructure Metrics"
],
"description": "- The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.\r\n"
}
},
"/api/infrastructure-monitoring/monitoring-state": {
"get": {
"operationId": "getMonitoringState",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitoringState"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Monitored host count",
"tags": [
"Infrastructure Resources"
]
}
},
"/api/infrastructure-monitoring/snapshots": {
"get": {
"operationId": "getSnapshots",
"parameters": [
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "plugin",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "offline",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnapshotResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Search snapshots",
"tags": [
"Infrastructure Metrics"
],
"description": "These APIs can be used to retrieve information about hosts, processes, JVMs and other entities that we are calling snapshots. A snapshot represents static information about an entity as it was at a specific point in time. To clarify:\r\n**Static information** is any information which is seldom changing, e.g. process IDs, host FQDNs or a list of host hard disks. The counterpart to static information are metrics which have a much higher change rate, e.g. host CPU usage or JVM garbage collection activity. Snapshots only contain static information.\r\n- Snapshots are **versioned** and represent an entity's state for a specific point in time. While snapshots only contain static information, even that information may change. For example you may add another hard disk to a server. For such a change, a new snapshot would be created.\r\n- The **size** parameter can be used in order to limit the maximum number of retrieved snapshots.\r\n- The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.\r\n"
}
},
"/api/infrastructure-monitoring/snapshots/{id}": {
"get": {
"operationId": "getSnapshot",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "windowSize",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnapshotItem"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get snapshot details",
"tags": [
"Infrastructure Metrics"
]
}
},
"/api/infrastructure-monitoring/software/versions": {
"get": {
"description": "Retrieve information about the software you are running. This includes runtime and package manager information.\n\nThe `name`, `version`, `origin` and `type` parameters are optional filters that can be used to reduce the result data set.",
"operationId": "softwareVersions",
"parameters": [
{
"in": "query",
"name": "time",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "origin",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "version",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SoftwareVersion"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get installed software",
"tags": [
"Infrastructure Resources"
]
}
},
"/api/instana/health": {
"get": {
"operationId": "getHealthState",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthState"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Basic health traffic light",
"tags": [
"Health"
],
"description": "The returned JSON object will provide a health property which contains a simple traffic light (GREEN/YELLO/RED). For any non-Green-state a list \nof reasons will be provided in the messages array.\n\nPossible messages:\n* No data being processed\n* No data arriving from agents\n"
}
},
"/api/instana/usage/api": {
"get": {
"operationId": "getAllUsage",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanSeeUsageInformation"
]
}
],
"summary": "API usage by customer",
"tags": [
"Usage"
]
}
},
"/api/instana/usage/api/{day}/{month}/{year}": {
"get": {
"operationId": "getUsagePerDay",
"parameters": [
{
"in": "path",
"name": "day",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "month",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanSeeUsageInformation"
]
}
],
"summary": "API usage day / month / year",
"tags": [
"Usage"
]
}
},
"/api/instana/usage/api/{month}/{year}": {
"get": {
"operationId": "getUsagePerMonth",
"parameters": [
{
"in": "path",
"name": "month",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanSeeUsageInformation"
]
}
],
"summary": "API usage month / year",
"tags": [
"Usage"
]
}
},
"/api/instana/usage/hosts/{day}/{month}/{year}": {
"get": {
"operationId": "getHostsPerDay",
"parameters": [
{
"in": "path",
"name": "day",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "month",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanSeeUsageInformation"
]
}
],
"summary": "Host count day / month / year",
"tags": [
"Usage"
]
}
},
"/api/instana/usage/hosts/{month}/{year}": {
"get": {
"operationId": "getHostsPerMonth",
"parameters": [
{
"in": "path",
"name": "month",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanSeeUsageInformation"
]
}
],
"summary": "Host count month / year",
"tags": [
"Usage"
]
}
},
"/api/instana/version": {
"get": {
"operationId": "getVersion",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstanaVersionInfo"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "API version information",
"tags": [
"Health"
]
}
},
"/api/releases": {
"get": {
"operationId": "getAllReleases",
"parameters": [
{
"in": "query",
"name": "from",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "maxResults",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseWithMetadata"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureReleases"
]
}
],
"summary": "Get all releases",
"tags": [
"Releases"
],
"description": "This endpoint exposes the Releases functionality.\n\nThese APIs can be used to create, update, delete and fetch already existing releases.\n\n## Mandatory Parameters:\n\n**releaseId:** A unique identifier assigned to each release.\n\n## Optional Parameters:\n\n**name:** Name of the exact release you want to retrieve, eg. \"Release-161\", \"Release-162\".\n\n**start:** Start time of the particular release.\n\n**from:** Filters the releases to retrieve only the releases which have \"start\" time greater than or equal to this value.\n\n**to:** Filters the releases to retrieve only the releases which have \"start\" time lesser than or equal to this value.\n\n**maxResults:** Maximum number of releases to be retrieved.\n\n## Defaults:\n\n**from, to, maxResults:** By default these parameters are not set. "
},
"post": {
"operationId": "postRelease",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Release"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseWithMetadata"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureReleases"
]
}
],
"summary": "Create release",
"tags": [
"Releases"
]
}
},
"/api/releases/{releaseId}": {
"delete": {
"operationId": "deleteRelease",
"parameters": [
{
"in": "path",
"name": "releaseId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureReleases"
]
}
],
"summary": "Delete release",
"tags": [
"Releases"
]
},
"get": {
"operationId": "getRelease",
"parameters": [
{
"in": "path",
"name": "releaseId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseWithMetadata"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureReleases"
]
}
],
"summary": "Get release",
"tags": [
"Releases"
]
},
"put": {
"operationId": "putRelease",
"parameters": [
{
"in": "path",
"name": "releaseId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Release"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseWithMetadata"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"CanConfigureReleases"
]
}
],
"summary": "Update release",
"tags": [
"Releases"
]
}
},
"/api/settings/api-tokens": {
"get": {
"operationId": "getApiTokens",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureApiTokens"
]
}
],
"summary": "All API tokens",
"tags": [
"API Token"
]
},
"post": {
"operationId": "postApiToken",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiToken"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If token already exist on other environment."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureApiTokens"
]
}
],
"summary": "Create an API token",
"tags": [
"API Token"
]
}
},
"/api/settings/api-tokens/{internalId}": {
"delete": {
"operationId": "deleteApiToken",
"parameters": [
{
"in": "path",
"name": "internalId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"*/*": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureApiTokens"
]
}
],
"summary": "Delete API token",
"tags": [
"API Token"
]
},
"get": {
"operationId": "getApiToken",
"parameters": [
{
"in": "path",
"name": "internalId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureApiTokens"
]
}
],
"summary": "API token",
"tags": [
"API Token"
]
},
"put": {
"operationId": "putApiToken",
"parameters": [
{
"in": "path",
"name": "internalId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiToken"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If token already exist on other environment."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureApiTokens"
]
}
],
"summary": "Create or update an API token",
"tags": [
"API Token"
]
}
},
"/api/settings/auditlog": {
"get": {
"operationId": "getAuditLogs",
"parameters": [
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogResponse"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ViewAuditLog"
]
}
],
"summary": "Audit log",
"tags": [
"Audit Log"
]
}
},
"/api/settings/groups": {
"get": {
"operationId": "getGroups",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiGroup"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Get groups",
"tags": [
"Groups"
]
},
"post": {
"operationId": "createGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiGroup"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiGroup"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Create group",
"tags": [
"Groups"
]
}
},
"/api/settings/groups/user/{email}": {
"get": {
"operationId": "getGroupsByUser",
"parameters": [
{
"in": "path",
"name": "email",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiGroup"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Get groups of a single user",
"tags": [
"Groups"
]
}
},
"/api/settings/groups/{id}": {
"delete": {
"operationId": "deleteGroup",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Delete group",
"tags": [
"Groups"
]
},
"get": {
"operationId": "getGroup",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiGroup"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Get group",
"tags": [
"Groups"
]
},
"put": {
"operationId": "updateGroup",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiGroup"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiGroup"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureGroups"
]
}
],
"summary": "Update group",
"tags": [
"Groups"
]
}
},
"/api/settings/maintenance": {
"get": {
"operationId": "getMaintenanceConfigs",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidatedMaintenanceConfigWithStatus"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureCustomAlerts"
]
}
],
"summary": "All maintenance configurations",
"tags": [
"Maintenance Configuration"
]
}
},
"/api/settings/maintenance/{id}": {
"delete": {
"operationId": "deleteMaintenanceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureCustomAlerts"
]
}
],
"summary": "Delete maintenance configuration",
"tags": [
"Maintenance Configuration"
]
},
"get": {
"operationId": "getMaintenanceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceConfigWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureCustomAlerts"
]
}
],
"summary": "Maintenance configuration",
"tags": [
"Maintenance Configuration"
]
},
"put": {
"operationId": "putMaintenanceConfig",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Maintenance config has been created or updated, and successfully scheduled immediately if needed"
},
"202": {
"description": "Maintenance config has been created or updated, but could not to be scheduled immediately. It will therefore be scheduled during the next auto-refresh with a delay of up to 4 minutes."
},
"400": {
"description": "Invalid JSON or mismatching IDs have been provided"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceConfigWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureCustomAlerts"
]
}
],
"summary": "Create or update maintenance configuration",
"tags": [
"Maintenance Configuration"
]
}
},
"/api/settings/session": {
"delete": {
"operationId": "deleteSessionSettings",
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureSessionSettings"
]
}
],
"summary": "Delete session settings",
"tags": [
"Session Settings"
]
},
"get": {
"operationId": "getSessionSettings",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionSettings"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureSessionSettings"
]
}
],
"summary": "Session settings",
"tags": [
"Session Settings"
]
},
"put": {
"operationId": "setSessionSettings",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionSettings"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionSettings"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureSessionSettings"
]
}
],
"summary": "Configure session settings",
"tags": [
"Session Settings"
]
}
},
"/api/settings/sli": {
"get": {
"operationId": "getSli_1",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SliConfigurationWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Get All SLI Configs",
"tags": [
"SLI Settings"
]
},
"post": {
"operationId": "createSli",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SliConfiguration"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SliConfigurationWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Create SLI Config",
"tags": [
"SLI Settings"
]
}
},
"/api/settings/sli/{id}": {
"delete": {
"operationId": "delete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Delete SLI Config",
"tags": [
"SLI Settings"
]
},
"get": {
"operationId": "getSli_2",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SliConfigurationWithLastUpdated"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Get SLI Config",
"tags": [
"SLI Settings"
]
},
"put": {
"operationId": "putSli",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SliConfigurationWithLastUpdated"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SliConfigurationWithLastUpdated"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Update SLI Config",
"tags": [
"SLI Settings"
]
}
},
"/api/settings/synthetic-calls": {
"delete": {
"operationId": "deleteSyntheticCall",
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Delete synthetic call configurations",
"tags": [
"Synthetic Calls"
]
},
"get": {
"operationId": "getSyntheticCalls",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyntheticCallWithDefaultsConfig"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Synthetic call configurations",
"tags": [
"Synthetic Calls"
]
},
"put": {
"operationId": "updateSyntheticCall",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyntheticCallConfig"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureServiceMapping"
]
}
],
"summary": "Update synthetic call configurations",
"tags": [
"Synthetic Calls"
]
}
},
"/api/settings/users": {
"get": {
"operationId": "getUsers",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "All users (without invitations)",
"tags": [
"User"
]
}
},
"/api/settings/users/invitations": {
"delete": {
"operationId": "revokePendingInvitations",
"parameters": [
{
"in": "query",
"name": "email",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "Revoke pending invitation",
"tags": [
"User"
]
},
"get": {
"operationId": "getInvitations",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResult"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "All pending invitations",
"tags": [
"User"
]
},
"post": {
"operationId": "sendInvitation",
"parameters": [
{
"in": "query",
"name": "email",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "roleId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "Send user invitation",
"tags": [
"User"
]
}
},
"/api/settings/users/overview": {
"get": {
"operationId": "getUsersIncludingInvitations",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsersResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "All users (incl. invitations)",
"tags": [
"User"
]
}
},
"/api/settings/users/{userId}": {
"delete": {
"operationId": "removeUserFromTenant",
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {}
},
"description": "default response"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureUsers"
]
}
],
"summary": "Remove user from tenant",
"tags": [
"User"
]
}
},
"/api/sli/report/{sliId}": {
"get": {
"operationId": "getSli",
"parameters": [
{
"in": "path",
"name": "sliId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "slo",
"schema": {
"type": "number",
"format": "double"
}
},
{
"in": "query",
"name": "from",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "to",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SliReport"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"canConfigureServiceLevelIndicators"
]
}
],
"summary": "Generate SLI report",
"tags": [
"SLI Report"
]
}
},
"/api/website-monitoring/analyze/beacon-groups": {
"post": {
"operationId": "getBeaconGroups",
"parameters": [
{
"in": "query",
"name": "fillTimeSeries",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebsiteBeaconGroups"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BeaconGroupsResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get grouped beacon metrics",
"tags": [
"Website Analyze"
]
}
},
"/api/website-monitoring/analyze/beacons": {
"post": {
"operationId": "getBeacons",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebsiteBeacons"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BeaconResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get all beacons",
"tags": [
"Website Analyze"
]
}
},
"/api/website-monitoring/catalog": {
"get": {
"operationId": "getWebsiteTagCatalog",
"parameters": [
{
"in": "query",
"name": "beaconType",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "useCase",
"required": true,
"schema": {
"type": "string",
"enum": [
"GROUPING",
"FILTERING",
"SMART_ALERTS",
"SLI_MANAGEMENT",
"APPLICATION_CONFIG",
"APPLICATION_CONFIG_BLUEPRINT"
]
}
}
],
"responses": {
"400": {
"description": "When the combination of beaconType and useCase is unsupported/unknown."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagCatalog"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get website tag catalog",
"tags": [
"Website Catalog"
]
}
},
"/api/website-monitoring/catalog/metrics": {
"get": {
"operationId": "getWebsiteCatalogMetrics",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteMonitoringMetricDescription"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Metric catalog",
"tags": [
"Website Catalog"
],
"description": "This endpoint retrieves all available metric definitions for website monitoring.\n"
}
},
"/api/website-monitoring/catalog/tags": {
"get": {
"operationId": "getWebsiteCatalogTags",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get all existing website tags",
"tags": [
"Website Catalog"
],
"description": "This endpoint retrieves all available tags for your monitored system.\n\nThese tags can be used to group metric results.\n```\n\"group\": {\n \"groupbyTag\": \"beacon.page.name\"\n}\n```\n\nThese tags can be used to filter metric results.\n```\n\"tagFilters\": [{\n\t\"name\": \"beacon.website.name\",\n\t\"operator\": \"EQUALS\",\n\t\"value\": \"example\"\n}]\n```\n"
}
},
"/api/website-monitoring/config": {
"get": {
"operationId": "getWebsites",
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Website"
}
}
}
}
}
},
"summary": "Get configured websites",
"tags": [
"Website Configuration"
]
},
"post": {
"operationId": "post",
"parameters": [
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Website"
}
}
},
"description": "Website successfully configured"
},
"400": {
"description": "Missing name query parameter or name already used for a configured website"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureEumApplications"
]
}
],
"summary": "Configure new website",
"tags": [
"Website Configuration"
]
}
},
"/api/website-monitoring/config/{websiteId}": {
"delete": {
"operationId": "delete_1",
"parameters": [
{
"in": "path",
"name": "websiteId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Website successfully removed"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureEumApplications"
]
}
],
"summary": "Remove website",
"tags": [
"Website Configuration"
]
},
"get": {
"operationId": "get",
"parameters": [
{
"in": "path",
"name": "websiteId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Website"
}
}
}
}
},
"summary": "Get configured website",
"tags": [
"Website Configuration"
]
},
"put": {
"operationId": "rename",
"parameters": [
{
"in": "path",
"name": "websiteId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Website"
}
}
},
"description": "Website successfully renamed"
},
"400": {
"description": "Missing name query parameter or name already used for a configured website"
}
},
"security": [
{
"ApiKeyAuth": [
"ConfigureEumApplications"
]
}
],
"summary": "Rename website",
"tags": [
"Website Configuration"
]
}
},
"/api/website-monitoring/metrics": {
"post": {
"operationId": "getBeaconMetrics",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebsiteMetrics"
}
}
}
},
"responses": {
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebsiteMetricResult"
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get beacon metrics",
"tags": [
"Website Metrics"
]
}
},
"/api/website-monitoring/page-load": {
"get": {
"operationId": "getPageLoad",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "matrix"
},
{
"in": "path",
"name": "timestamp",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"style": "matrix"
}
],
"responses": {
"400": {
"description": "Missing page id"
},
"404": {
"description": "Website not found"
},
"default": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteMonitoringBeacon"
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": [
"Default"
]
}
],
"summary": "Get page load",
"tags": [
"Website Metrics"
]
}
}
},
"components": {
"schemas": {
"AbstractIntegration": {
"type": "object",
"discriminator": {
"mapping": {
"EMAIL": "#/components/schemas/EmailIntegration",
"GOOGLE_CHAT": "#/components/schemas/GoogleChatIntegration",
"OFFICE_365": "#/components/schemas/Office365Integration",
"OPS_GENIE": "#/components/schemas/OpsgenieIntegration",
"PAGER_DUTY": "#/components/schemas/PagerdutyIntegration",
"PROMETHEUS_WEBHOOK": "#/components/schemas/PrometheusWebhookIntegration",
"SLACK": "#/components/schemas/SlackIntegration",
"SPLUNK": "#/components/schemas/SplunkIntegration",
"VICTOR_OPS": "#/components/schemas/VictorOpsIntegration",
"WEBEX_TEAMS_WEBHOOK": "#/components/schemas/WebexTeamsWebhookIntegration",
"WEB_HOOK": "#/components/schemas/WebhookIntegration"
},
"propertyName": "kind"
},
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"kind",
"name"
]
},
"AbstractRule": {
"type": "object",
"discriminator": {
"mapping": {
"entity_verification": "#/components/schemas/EntityVerificationRule",
"system": "#/components/schemas/SystemRule",
"threshold": "#/components/schemas/ThresholdRule"
},
"propertyName": "ruleType"
},
"properties": {
"ruleType": {
"type": "string",
"description": "Values: `\"THRESHOLD\"` `\"SYSTEM\"` `\"ENTITY_VERIFICATION\"`"
},
"severity": {
"type": "integer",
"format": "int32"
}
},
"required": [
"ruleType"
]
},
"AccessRule": {
"type": "object",
"properties": {
"accessType": {
"type": "string",
"enum": [
"READ",
"READ_WRITE"
]
},
"relatedId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"relationType": {
"type": "string",
"enum": [
"USER",
"API_TOKEN",
"ROLE",
"TEAM",
"GLOBAL"
]
}
},
"required": [
"accessType",
"relationType"
]
},
"AgentConfigurationUpdate": {
"type": "object",
"properties": {
"remoteBranch": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"remoteName": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"remoteUri": {
"type": "string",
"maxLength": 65536,
"minLength": 0
}
}
},
"AlertingConfiguration": {
"type": "object",
"properties": {
"alertName": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"eventFilteringConfiguration": {
"$ref": "#/components/schemas/EventFilteringConfiguration"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"muteUntil": {
"type": "integer",
"format": "int64"
}
},
"required": [
"alertName",
"eventFilteringConfiguration",
"id",
"integrationIds"
]
},
"AlertingConfigurationWithLastUpdated": {
"type": "object",
"properties": {
"alertName": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"eventFilteringConfiguration": {
"$ref": "#/components/schemas/EventFilteringConfiguration"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"muteUntil": {
"type": "integer",
"format": "int64"
}
},
"required": [
"alertName",
"eventFilteringConfiguration",
"id",
"integrationIds"
]
},
"ApiGroup": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMember"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"name": {
"type": "string"
},
"permissionSet": {
"$ref": "#/components/schemas/ApiPermissionSet"
}
},
"required": [
"members",
"name"
]
},
"ApiMember": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"userId"
]
},
"ApiPermissionSet": {
"type": "object",
"properties": {
"applicationIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"infraDfqFilter": {
"type": "string"
},
"kubernetesClusterUUIDs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"kubernetesNamespaceUIDs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"mobileAppIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"websiteIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"applicationIds",
"kubernetesClusterUUIDs",
"kubernetesNamespaceUIDs",
"mobileAppIds",
"permissions",
"websiteIds"
]
},
"ApiToken": {
"type": "object",
"properties": {
"accessGrantingToken": {
"type": "string"
},
"canConfigureAgentRunMode": {
"type": "boolean"
},
"canConfigureAgents": {
"type": "boolean"
},
"canConfigureApiTokens": {
"type": "boolean"
},
"canConfigureApplications": {
"type": "boolean"
},
"canConfigureAuthenticationMethods": {
"type": "boolean"
},
"canConfigureCustomAlerts": {
"type": "boolean"
},
"canConfigureEumApplications": {
"type": "boolean"
},
"canConfigureGlobalAlertPayload": {
"type": "boolean"
},
"canConfigureIntegrations": {
"type": "boolean"
},
"canConfigureLogManagement": {
"type": "boolean"
},
"canConfigureMobileAppMonitoring": {
"type": "boolean"
},
"canConfigureReleases": {
"type": "boolean"
},
"canConfigureServiceLevelIndicators": {
"type": "boolean"
},
"canConfigureServiceMapping": {
"type": "boolean"
},
"canConfigureSessionSettings": {
"type": "boolean"
},
"canConfigureTeams": {
"type": "boolean"
},
"canConfigureUsers": {
"type": "boolean"
},
"canCreatePublicCustomDashboards": {
"type": "boolean"
},
"canInstallNewAgents": {
"type": "boolean"
},
"canSeeOnPremLicenseInformation": {
"type": "boolean"
},
"canSeeUsageInformation": {
"type": "boolean"
},
"canViewAccountAndBillingInformation": {
"type": "boolean"
},
"canViewAuditLog": {
"type": "boolean"
},
"canViewLogs": {
"type": "boolean"
},
"canViewTraceDetails": {
"type": "boolean"
},
"id": {
"type": "string"
},
"internalId": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"accessGrantingToken",
"internalId",
"name"
]
},
"AppDataMetricConfiguration": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"granularity": {
"type": "integer",
"format": "int32"
},
"metric": {
"type": "string"
}
},
"required": [
"aggregation",
"metric"
]
},
"Application": {
"type": "object",
"properties": {
"boundaryScope": {
"type": "string"
},
"entityType": {
"type": "string",
"enum": [
"APPLICATION",
"SERVICE",
"ENDPOINT"
]
},
"id": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"boundaryScope",
"id",
"label"
]
},
"ApplicationAlertConfig": {
"type": "object",
"properties": {
"alertChannelIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"applicationId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"granularity": {
"type": "integer",
"format": "int32",
"default": 600000,
"enum": [
60000,
300000,
600000,
900000,
1200000,
1800000
]
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"rule": {
"$ref": "#/components/schemas/ApplicationAlertRule"
},
"severity": {
"type": "integer",
"format": "int32"
},
"tagFilterExpression": {
"$ref": "#/components/schemas/TagFilterExpressionElement"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"threshold": {
"$ref": "#/components/schemas/Threshold"
},
"timeThreshold": {
"$ref": "#/components/schemas/ApplicationTimeThreshold"
},
"triggering": {
"type": "boolean"
}
},
"required": [
"alertChannelIds",
"applicationId",
"boundaryScope",
"description",
"name",
"rule",
"tagFilters",
"threshold",
"timeThreshold"
]
},
"ApplicationAlertConfigWithMetadata": {
"type": "object",
"properties": {
"alertChannelIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"applicationId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"created": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"granularity": {
"type": "integer",
"format": "int32",
"default": 600000,
"enum": [
60000,
300000,
600000,
900000,
1200000,
1800000
]
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"readOnly": {
"type": "boolean"
},
"rule": {
"$ref": "#/components/schemas/ApplicationAlertRule"
},
"severity": {
"type": "integer",
"format": "int32"
},
"tagFilterExpression": {
"$ref": "#/components/schemas/TagFilterExpressionElement"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"threshold": {
"$ref": "#/components/schemas/Threshold"
},
"timeThreshold": {
"$ref": "#/components/schemas/ApplicationTimeThreshold"
},
"triggering": {
"type": "boolean"
}
},
"required": [
"alertChannelIds",
"applicationId",
"boundaryScope",
"description",
"id",
"name",
"rule",
"tagFilters",
"threshold",
"timeThreshold"
]
},
"ApplicationAlertRule": {
"type": "object",
"discriminator": {
"mapping": {
"errorRate": "#/components/schemas/ErrorRateApplicationAlertRule",
"logs": "#/components/schemas/LogsApplicationAlertRule",
"slowness": "#/components/schemas/SlownessApplicationAlertRule",
"statusCode": "#/components/schemas/StatusCodeApplicationAlertRule",
"throughput": "#/components/schemas/ThroughputApplicationAlertRule"
},
"propertyName": "alertType"
},
"properties": {
"aggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"alertType": {
"type": "string"
},
"metricName": {
"type": "string"
}
},
"required": [
"alertType",
"metricName"
]
},
"ApplicationConfig": {
"type": "object",
"properties": {
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND",
"DEFAULT"
]
},
"id": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"label": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"matchSpecification": {
"$ref": "#/components/schemas/MatchExpressionDTO"
},
"scope": {
"type": "string",
"enum": [
"INCLUDE_NO_DOWNSTREAM",
"INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING",
"INCLUDE_ALL_DOWNSTREAM"
]
}
},
"required": [
"boundaryScope",
"id",
"label",
"scope"
]
},
"ApplicationEventResult": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"ApplicationItem": {
"type": "object",
"properties": {
"application": {
"$ref": "#/components/schemas/Application"
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"required": [
"application",
"metrics"
]
},
"ApplicationMetricResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationItem"
}
},
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"ApplicationResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"totalHits": {
"type": "integer",
"format": "int32"
}
}
},
"ApplicationScope": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"name"
]
},
"ApplicationScopeWithMetadata": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id"
]
},
"ApplicationSliEntity": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SliEntity"
},
{
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"endpointId": {
"type": "string"
},
"serviceId": {
"type": "string"
}
}
}
],
"required": [
"boundaryScope",
"sliType"
]
},
"ApplicationTimeThreshold": {
"type": "object",
"discriminator": {
"mapping": {
"requestImpact": "#/components/schemas/RequestImpactApplicationTimeThreshold",
"violationsInPeriod": "#/components/schemas/ViolationsInPeriodApplicationTimeThreshold",
"violationsInSequence": "#/components/schemas/ViolationsInSequenceApplicationTimeThreshold"
},
"propertyName": "type"
},
"properties": {
"timeWindow": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"AuditLogEntry": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"actor": {
"$ref": "#/components/schemas/LogEntryActor"
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"timestamp": {
"type": "integer",
"format": "int64"
}
},
"required": [
"action",
"actor",
"id",
"message",
"meta"
]
},
"AuditLogResponse": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLogEntry"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"AvailabilitySliEntity": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SliEntity"
},
{
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"badEventFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 1
},
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"endpointId": {
"type": "string"
},
"goodEventFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 1
},
"serviceId": {
"type": "string"
}
}
}
],
"required": [
"boundaryScope",
"sliType"
]
},
"BeaconGroupsResult": {
"type": "object",
"properties": {
"canLoadMore": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteBeaconGroupsItem"
}
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"totalRepresentedItemCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"BeaconResult": {
"type": "object",
"properties": {
"canLoadMore": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteBeaconsItem"
}
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"totalRepresentedItemCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"BinaryOperatorDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/MatchExpressionDTO"
},
{
"type": "object",
"properties": {
"conjunction": {
"type": "string",
"enum": [
"AND",
"OR"
]
},
"left": {
"$ref": "#/components/schemas/MatchExpressionDTO"
},
"right": {
"$ref": "#/components/schemas/MatchExpressionDTO"
}
}
}
],
"required": [
"conjunction",
"left",
"right"
]
},
"BuiltInEventSpecification": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"hyperParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HyperParam"
},
"maxItems": 32,
"minItems": 0
},
"id": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"ruleInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RuleInput"
},
"maxItems": 32,
"minItems": 0
},
"severity": {
"type": "integer",
"format": "int32"
},
"shortPluginId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"triggering": {
"type": "boolean"
}
},
"required": [
"hyperParams",
"id",
"name",
"ruleInputs",
"shortPluginId"
]
},
"BuiltInEventSpecificationWithLastUpdated": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"hyperParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HyperParam"
},
"maxItems": 32,
"minItems": 0
},
"id": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"ruleInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RuleInput"
},
"maxItems": 32,
"minItems": 0
},
"severity": {
"type": "integer",
"format": "int32"
},
"shortPluginId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"triggering": {
"type": "boolean"
}
},
"required": [
"hyperParams",
"id",
"name",
"ruleInputs",
"shortPluginId"
]
},
"CallGroupsItem": {
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/IngestionOffsetCursor"
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"cursor",
"metrics",
"name"
]
},
"CallGroupsResult": {
"type": "object",
"properties": {
"canLoadMore": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallGroupsItem"
}
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"totalRepresentedItemCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"CloudfoundryPhysicalContext": {
"type": "object",
"properties": {
"application": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"cfInstanceIndex": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"space": {
"$ref": "#/components/schemas/SnapshotPreview"
}
}
},
"ConfigVersion": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
}
},
"required": [
"id"
]
},
"CursorPagination": {
"type": "object",
"properties": {
"ingestionTime": {
"type": "integer",
"format": "int64"
},
"offset": {
"type": "integer",
"format": "int32"
},
"retrievalSize": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1
}
}
},
"CustomDashboard": {
"type": "object",
"properties": {
"accessRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessRule"
},
"maxItems": 64,
"minItems": 1
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"widgets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Widget"
},
"maxItems": 128,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"accessRules",
"id",
"title",
"widgets"
]
},
"CustomEventSpecification": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"entityType": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"expirationTime": {
"type": "integer",
"format": "int64"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AbstractRule"
},
"maxItems": 1,
"minItems": 1,
"uniqueItems": true
},
"triggering": {
"type": "boolean"
}
},
"required": [
"entityType",
"id",
"name",
"rules"
]
},
"CustomEventSpecificationWithLastUpdated": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"entityType": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"expirationTime": {
"type": "integer",
"format": "int64"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AbstractRule"
},
"maxItems": 1,
"minItems": 1,
"uniqueItems": true
},
"triggering": {
"type": "boolean"
}
},
"required": [
"entityType",
"id",
"name",
"rules"
]
},
"CustomPayloadConfiguration": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomPayloadField"
},
"maxItems": 20,
"minItems": 0
}
},
"required": [
"fields"
]
},
"CustomPayloadField": {
"type": "object",
"discriminator": {
"mapping": {
"dynamic": "#/components/schemas/DynamicField",
"staticBoolean": "#/components/schemas/StaticBooleanField",
"staticNumber": "#/components/schemas/StaticNumberField",
"staticString": "#/components/schemas/StaticStringField"
},
"propertyName": "type"
},
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"key",
"type"
]
},
"CustomPayloadWithLastUpdated": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomPayloadField"
},
"maxItems": 20,
"minItems": 0
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"fields"
]
},
"DynamicField": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CustomPayloadField"
},
{
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/DynamicFieldValue"
}
}
}
],
"required": [
"key",
"type",
"value"
]
},
"DynamicFieldValue": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"tagName": {
"type": "string"
}
},
"required": [
"tagName"
]
},
"EmailIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
],
"required": [
"emails",
"id",
"kind",
"name"
]
},
"Endpoint": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"enum": [
"APPLICATION",
"SERVICE",
"ENDPOINT"
]
},
"id": {
"type": "string"
},
"isSynthetic": {
"type": "boolean",
"writeOnly": true
},
"label": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"synthetic": {
"type": "boolean"
},
"syntheticType": {
"type": "string",
"enum": [
"NON_SYNTHETIC",
"SYNTHETIC",
"MIXED"
]
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"type": {
"type": "string",
"enum": [
"UNDEFINED",
"RPC",
"EVENT",
"GRAPHQL",
"BATCH",
"SHELL",
"HTTP",
"SDK",
"INTERNAL",
"DATABASE",
"MESSAGING",
"PAGE",
"PAGE_RESOURCE"
]
}
},
"required": [
"id",
"label",
"serviceId",
"technologies",
"type"
]
},
"EndpointEventResult": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"endpointId": {
"type": "string"
},
"endpointServiceId": {
"type": "string"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"EndpointItem": {
"type": "object",
"properties": {
"endpoint": {
"$ref": "#/components/schemas/Endpoint"
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"required": [
"endpoint",
"metrics"
]
},
"EndpointMetricResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndpointItem"
}
},
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"EndpointResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Endpoint"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"totalHits": {
"type": "integer",
"format": "int32"
}
}
},
"EntityVerificationRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractRule"
},
{
"type": "object",
"properties": {
"matchingEntityLabel": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"matchingEntityType": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"matchingOperator": {
"type": "string",
"enum": [
"is",
"contains",
"startsWith",
"endsWith"
]
},
"offlineDuration": {
"type": "integer",
"format": "int64"
}
}
}
],
"required": [
"matchingEntityLabel",
"matchingEntityType",
"matchingOperator",
"ruleType"
]
},
"ErrorRateApplicationAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationAlertRule"
}
],
"required": [
"alertType",
"metricName"
]
},
"EventFilteringConfiguration": {
"type": "object",
"properties": {
"eventTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident",
"critical",
"warning",
"change",
"online",
"offline",
"agent_monitoring_issue",
"none"
]
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"ruleIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
}
}
},
"EventResult": {
"type": "object",
"discriminator": {
"mapping": {
"APPLICATION": "#/components/schemas/ApplicationEventResult",
"ENDPOINT": "#/components/schemas/EndpointEventResult",
"INFRASTRUCTURE": "#/components/schemas/InfraEventResult",
"SERVICE": "#/components/schemas/ServiceEventResult",
"WEBSITE": "#/components/schemas/WebsiteEventResult"
},
"propertyName": "entityType"
},
"properties": {
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"EventSpecificationInfo": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"entityType": {
"type": "string"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"invalid": {
"type": "boolean"
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"severity": {
"type": "integer",
"format": "int32"
},
"triggering": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"BUILT_IN",
"CUSTOM"
]
}
},
"required": [
"entityType",
"id",
"name",
"type"
]
},
"FixedHttpPathSegmentMatchingRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HttpPathSegmentMatchingRule"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
],
"required": [
"name",
"type"
]
},
"FullTrace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rootSpan": {
"$ref": "#/components/schemas/Span"
},
"totalErrorCount": {
"type": "integer",
"format": "int32",
"minimum": 0
}
},
"required": [
"id",
"rootSpan"
]
},
"GetApplications": {
"type": "object",
"properties": {
"applicationBoundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"applicationId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"endpointId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"endpointTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"UNDEFINED",
"RPC",
"EVENT",
"GRAPHQL",
"BATCH",
"SHELL",
"HTTP",
"SDK",
"INTERNAL",
"DATABASE",
"MESSAGING",
"PAGE",
"PAGE_RESOURCE"
]
},
"uniqueItems": true,
"writeOnly": true
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppDataMetricConfiguration"
},
"maxItems": 5,
"minItems": 1
},
"nameFilter": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"serviceId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"writeOnly": true
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"metrics"
]
},
"GetCallGroups": {
"type": "object",
"properties": {
"group": {
"$ref": "#/components/schemas/Group"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricConfig"
},
"maxItems": 5,
"minItems": 1
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/CursorPagination"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 10,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"group",
"metrics"
]
},
"GetCombinedMetrics": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"uniqueItems": true
},
"plugin": {
"type": "string"
},
"query": {
"type": "string"
},
"rollup": {
"type": "integer",
"format": "int32"
},
"snapshotIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 30,
"minItems": 1,
"uniqueItems": true
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"metrics",
"plugin"
]
},
"GetEndpoints": {
"type": "object",
"properties": {
"applicationBoundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"applicationId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"endpointId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"endpointTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"UNDEFINED",
"RPC",
"EVENT",
"GRAPHQL",
"BATCH",
"SHELL",
"HTTP",
"SDK",
"INTERNAL",
"DATABASE",
"MESSAGING",
"PAGE",
"PAGE_RESOURCE"
]
},
"maxItems": 8,
"minItems": 0,
"uniqueItems": true
},
"excludeSynthetic": {
"type": "boolean"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppDataMetricConfiguration"
},
"maxItems": 5,
"minItems": 1
},
"nameFilter": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"serviceId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"metrics"
]
},
"GetServices": {
"type": "object",
"properties": {
"applicationBoundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND"
]
},
"applicationId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"contextScope": {
"type": "string",
"enum": [
"NONE",
"UPSTREAM",
"DOWNSTREAM"
]
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppDataMetricConfiguration"
},
"maxItems": 5,
"minItems": 1
},
"nameFilter": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"serviceId": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"minItems": 0,
"uniqueItems": true
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"metrics"
]
},
"GetTraceGroups": {
"type": "object",
"properties": {
"group": {
"$ref": "#/components/schemas/Group"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricConfig"
},
"maxItems": 5,
"minItems": 1
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/CursorPagination"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
},
"required": [
"group",
"metrics"
]
},
"GetTraces": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/CursorPagination"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
}
}
},
"GetWebsiteBeaconGroups": {
"type": "object",
"properties": {
"group": {
"$ref": "#/components/schemas/WebsiteBeaconTagGroup"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteMonitoringMetricsConfiguration"
},
"maxItems": 5,
"minItems": 1
},
"order": {
"$ref": "#/components/schemas/Order"
},
"pagination": {
"$ref": "#/components/schemas/CursorPagination"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
},
"type": {
"type": "string",
"enum": [
"PAGELOAD",
"RESOURCELOAD",
"HTTPREQUEST",
"ERROR",
"CUSTOM",
"PAGE_CHANGE"
]
}
},
"required": [
"group",
"metrics",
"type"
]
},
"GetWebsiteBeacons": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/CursorPagination"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
},
"type": {
"type": "string",
"enum": [
"PAGELOAD",
"RESOURCELOAD",
"HTTPREQUEST",
"ERROR",
"CUSTOM",
"PAGE_CHANGE"
]
}
},
"required": [
"type"
]
},
"GetWebsiteMetrics": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebsiteMonitoringMetricsConfiguration"
},
"maxItems": 5,
"minItems": 1
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 32,
"minItems": 0
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrame"
},
"type": {
"type": "string",
"enum": [
"PAGELOAD",
"RESOURCELOAD",
"HTTPREQUEST",
"ERROR",
"CUSTOM",
"PAGE_CHANGE"
]
}
},
"required": [
"metrics",
"type"
]
},
"GoogleChatIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"webhookUrl": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"webhookUrl"
]
},
"Group": {
"type": "object",
"properties": {
"groupbyTag": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"groupbyTagEntity": {
"type": "string",
"enum": [
"NOT_APPLICABLE",
"DESTINATION",
"SOURCE"
]
},
"groupbyTagSecondLevelKey": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"groupbyTag",
"groupbyTagEntity"
]
},
"HealthState": {
"type": "object",
"properties": {
"health": {
"type": "string",
"enum": [
"RED",
"YELLOW",
"GREEN"
]
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"HistoricBaseline": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Threshold"
},
{
"type": "object",
"properties": {
"baseline": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
"deviationFactor": {
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"maximum": 16,
"minimum": 0.5
},
"seasonality": {
"type": "string",
"enum": [
"WEEKLY",
"DAILY"
]
}
}
}
],
"required": [
"operator",
"seasonality",
"type"
]
},
"HttpEndpointConfig": {
"type": "object",
"properties": {
"endpointNameByCollectedPathTemplateRuleEnabled": {
"type": "boolean"
},
"endpointNameByFirstPathSegmentRuleEnabled": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HttpEndpointRule"
},
"maxItems": 500,
"minItems": 0
},
"serviceId": {
"type": "string"
}
},
"required": [
"rules",
"serviceId"
]
},
"HttpEndpointRule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"pathSegments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HttpPathSegmentMatchingRule"
},
"maxItems": 16,
"minItems": 1
},
"testCases": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 32,
"minItems": 0
}
},
"required": [
"pathSegments"
]
},
"HttpPathSegmentMatchingRule": {
"type": "object",
"discriminator": {
"mapping": {
"FIXED": "#/components/schemas/FixedHttpPathSegmentMatchingRule",
"MATCH_ALL": "#/components/schemas/MatchAllHttpPathSegmentMatchingRule",
"PARAMETER": "#/components/schemas/PathParameterHttpPathSegmentMatchingRule",
"UNSUPPORTED": "#/components/schemas/UnsupportedHttpPathSegmentMatchingRule"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string",
"enum": [
"UNSUPPORTED",
"FIXED",
"PARAMETER",
"MATCH_ALL"
]
}
},
"required": [
"type"
]
},
"HyperParam": {
"type": "object",
"properties": {
"defaultValue": {
"type": "number",
"format": "double"
},
"description": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"maxValue": {
"type": "number",
"format": "double"
},
"minValue": {
"type": "number",
"format": "double"
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"valueFormat": {
"type": "string",
"enum": [
"NUMBER",
"BYTES",
"PERCENTAGE",
"MILLIS",
"SECONDS",
"MICROS",
"RATE",
"BYTE_RATE",
"UNDEFINED"
]
}
},
"required": [
"description",
"id",
"name"
]
},
"InfraEventResult": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"InfrastructureMetricResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricItem"
}
}
}
},
"InfrastructureSliEntity": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SliEntity"
},
{
"type": "object",
"properties": {
"instanceAggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"query": {
"type": "string"
}
}
}
],
"required": [
"instanceAggregation",
"query",
"sliType"
]
},
"IngestionOffsetCursor": {
"type": "object",
"properties": {
"ingestionTime": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"offset": {
"type": "integer",
"format": "int32",
"minimum": 0
}
}
},
"InstanaVersionInfo": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"commit": {
"type": "string"
},
"imageTag": {
"type": "string"
}
}
},
"IntegrationOverview": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"id",
"kind",
"name"
]
},
"KubernetesPhysicalContext": {
"type": "object",
"properties": {
"cluster": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"namespace": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"node": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"pod": {
"$ref": "#/components/schemas/SnapshotPreview"
}
}
},
"LogEntryActor": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"USER",
"API_TOKEN"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"LogsApplicationAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationAlertRule"
},
{
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"WARN",
"ERROR",
"ANY"
]
},
"loglevel": {
"type": "string",
"enum": [
"WARN",
"ERROR",
"ANY"
],
"writeOnly": true
},
"message": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS",
"LESS_THAN",
"LESS_OR_EQUAL_THAN",
"GREATER_THAN",
"GREATER_OR_EQUAL_THAN",
"NOT_EMPTY",
"NOT_EQUAL",
"NOT_CONTAIN",
"IS_EMPTY",
"NOT_BLANK",
"IS_BLANK",
"STARTS_WITH",
"ENDS_WITH",
"NOT_STARTS_WITH",
"NOT_ENDS_WITH"
]
}
}
}
],
"required": [
"alertType",
"level",
"metricName",
"operator"
]
},
"MaintenanceConfig": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"windows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaintenanceWindow"
},
"maxItems": 1,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"id",
"name",
"query"
]
},
"MaintenanceConfigWithLastUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"windows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaintenanceWindow"
},
"maxItems": 1,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"id",
"name",
"query"
]
},
"MaintenanceWindow": {
"type": "object",
"properties": {
"end": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"start": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"id"
]
},
"MatchAllHttpPathSegmentMatchingRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HttpPathSegmentMatchingRule"
}
],
"required": [
"type"
]
},
"MatchExpressionDTO": {
"type": "object",
"discriminator": {
"mapping": {
"BINARY_OP": "#/components/schemas/BinaryOperatorDTO",
"LEAF": "#/components/schemas/TagMatcherDTO"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
}
},
"MetricConfig": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"granularity": {
"type": "integer",
"format": "int32"
},
"metric": {
"type": "string"
}
},
"required": [
"aggregation",
"metric"
]
},
"MetricConfiguration": {
"type": "object",
"properties": {
"metricAggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"metricName": {
"type": "string"
},
"threshold": {
"type": "number",
"format": "double",
"exclusiveMinimum": true,
"minimum": 0
}
},
"required": [
"metricName"
]
},
"MetricDescription": {
"type": "object",
"properties": {
"aggregations": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"description": {
"type": "string"
},
"formatter": {
"type": "string"
},
"label": {
"type": "string"
},
"metricId": {
"type": "string"
}
}
},
"MetricInstance": {
"type": "object",
"properties": {
"custom": {
"type": "boolean"
},
"description": {
"type": "string"
},
"formatter": {
"type": "string",
"enum": [
"NUMBER",
"BYTES",
"PERCENTAGE",
"MILLIS",
"SECONDS",
"MICROS",
"RATE",
"BYTE_RATE",
"UNDEFINED"
]
},
"label": {
"type": "string"
},
"metricId": {
"type": "string"
},
"pluginId": {
"type": "string"
}
},
"required": [
"description",
"formatter",
"label",
"metricId",
"pluginId"
]
},
"MetricItem": {
"type": "object",
"properties": {
"from": {
"type": "integer",
"format": "int64"
},
"host": {
"type": "string"
},
"label": {
"type": "string"
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"plugin": {
"type": "string"
},
"snapshotId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"to": {
"type": "integer",
"format": "int64"
}
}
},
"MetricPattern": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"is",
"contains",
"startsWith",
"endsWith",
"any"
]
},
"placeholder": {
"type": "string"
},
"postfix": {
"type": "string"
},
"prefix": {
"type": "string"
}
},
"required": [
"operator",
"prefix"
]
},
"MonitoringState": {
"type": "object",
"properties": {
"firstKnownReportingTime": {
"type": "integer",
"format": "int64"
},
"hostCount": {
"type": "integer",
"format": "int32"
},
"serverlessCount": {
"type": "integer",
"format": "int32"
}
}
},
"NewApplicationConfig": {
"type": "object",
"properties": {
"boundaryScope": {
"type": "string",
"enum": [
"ALL",
"INBOUND",
"DEFAULT"
]
},
"label": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"matchSpecification": {
"$ref": "#/components/schemas/MatchExpressionDTO"
},
"scope": {
"type": "string",
"enum": [
"INCLUDE_NO_DOWNSTREAM",
"INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING",
"INCLUDE_ALL_DOWNSTREAM"
]
}
},
"required": [
"boundaryScope",
"label",
"scope"
]
},
"Office365Integration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"webhookUrl": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"webhookUrl"
]
},
"OpsgenieIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"region": {
"type": "string",
"enum": [
"US",
"EU"
]
},
"tags": {
"type": "string"
}
}
}
],
"required": [
"apiKey",
"id",
"kind",
"name",
"region"
]
},
"Order": {
"type": "object",
"properties": {
"by": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"by",
"direction"
]
},
"PagerdutyIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"serviceIntegrationKey": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"serviceIntegrationKey"
]
},
"Pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1
}
}
},
"PathParameterHttpPathSegmentMatchingRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HttpPathSegmentMatchingRule"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
],
"required": [
"name",
"type"
]
},
"PhysicalContext": {
"type": "object",
"properties": {
"cloudfoundry": {
"$ref": "#/components/schemas/CloudfoundryPhysicalContext"
},
"cluster": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"container": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"host": {
"$ref": "#/components/schemas/SnapshotPreview"
},
"kubernetes": {
"$ref": "#/components/schemas/KubernetesPhysicalContext"
},
"process": {
"$ref": "#/components/schemas/SnapshotPreview"
}
}
},
"PluginResult": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"plugin": {
"type": "string"
}
}
},
"PrometheusWebhookIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"receiver": {
"type": "string"
},
"webhookUrl": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"webhookUrl"
]
},
"Release": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationScope"
},
"maxItems": 10,
"minItems": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceScope"
},
"maxItems": 10,
"minItems": 0
},
"start": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"name"
]
},
"ReleaseScope": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"applicationName": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"serviceName": {
"type": "string"
}
}
},
"ReleaseWithMetadata": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationScopeWithMetadata"
},
"maxItems": 10,
"minItems": 0
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseScope"
},
"writeOnly": true
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceScopeWithMetadata"
},
"maxItems": 10,
"minItems": 0
},
"start": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"id",
"name"
]
},
"RequestImpactApplicationTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationTimeThreshold"
},
{
"type": "object",
"properties": {
"requests": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
}
],
"required": [
"type"
]
},
"RuleInput": {
"type": "object",
"properties": {
"inputKind": {
"type": "string",
"enum": [
"METRIC",
"SNAPSHOT_FIELD",
"EVENT",
"DERIVED_METRIC",
"METRIC_PATTERN"
]
},
"inputName": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"inputKind",
"inputName"
]
},
"SearchFieldResult": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"description": {
"type": "string"
},
"fixedValues": {
"type": "array",
"items": {
"type": "string"
}
},
"keyword": {
"type": "string"
},
"termType": {
"type": "string"
}
}
},
"Service": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"enum": [
"APPLICATION",
"SERVICE",
"ENDPOINT"
]
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"UNDEFINED",
"RPC",
"EVENT",
"GRAPHQL",
"BATCH",
"SHELL",
"HTTP",
"SDK",
"INTERNAL",
"DATABASE",
"MESSAGING",
"PAGE",
"PAGE_RESOURCE"
]
},
"uniqueItems": true
}
},
"required": [
"id",
"label",
"technologies",
"types"
]
},
"ServiceConfig": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"matchSpecification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceMatchingRule"
},
"maxItems": 20,
"minItems": 0
},
"name": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
},
"required": [
"enabled",
"id",
"label",
"matchSpecification",
"name"
]
},
"ServiceEventResult": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"serviceId": {
"type": "string"
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"ServiceItem": {
"type": "object",
"properties": {
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"service": {
"$ref": "#/components/schemas/Service"
}
},
"required": [
"metrics",
"service"
]
},
"ServiceMatchingRule": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
},
"ServiceMetricResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceItem"
}
},
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"ServiceResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"totalHits": {
"type": "integer",
"format": "int32"
}
}
},
"ServiceScope": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"scopedTo": {
"$ref": "#/components/schemas/ServiceScopedTo"
}
},
"required": [
"name"
]
},
"ServiceScopeWithMetadata": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"scopedTo": {
"$ref": "#/components/schemas/ServiceScopedToWithMetadata"
}
},
"required": [
"id"
]
},
"ServiceScopedTo": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationScope"
},
"maxItems": 10,
"minItems": 1
}
},
"required": [
"applications"
]
},
"ServiceScopedToWithMetadata": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationScopeWithMetadata"
},
"maxItems": 10,
"minItems": 1
}
},
"required": [
"applications"
]
},
"SessionSettings": {
"type": "object",
"properties": {
"idleTimeInMillis": {
"type": "integer",
"format": "int64",
"maximum": 28800000,
"minimum": 60000
},
"tokenLifeTimeInMillis": {
"type": "integer",
"format": "int64",
"maximum": 604800000,
"minimum": 900000
}
}
},
"SlackIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"channel": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"webhookUrl": {
"type": "string"
}
}
}
],
"required": [
"channel",
"iconUrl",
"id",
"kind",
"name",
"webhookUrl"
]
},
"SliConfiguration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"initialEvaluationTimestamp": {
"type": "integer",
"format": "int64"
},
"metricConfiguration": {
"$ref": "#/components/schemas/MetricConfiguration"
},
"sliEntity": {
"$ref": "#/components/schemas/SliEntity"
},
"sliName": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"id",
"sliEntity",
"sliName"
]
},
"SliConfigurationWithLastUpdated": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"initialEvaluationTimestamp": {
"type": "integer",
"format": "int64"
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"metricConfiguration": {
"$ref": "#/components/schemas/MetricConfiguration"
},
"sliEntity": {
"$ref": "#/components/schemas/SliEntity"
},
"sliName": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"id",
"sliEntity",
"sliName"
]
},
"SliEntity": {
"type": "object",
"discriminator": {
"mapping": {
"application": "#/components/schemas/ApplicationSliEntity",
"availability": "#/components/schemas/AvailabilitySliEntity",
"custom": "#/components/schemas/InfrastructureSliEntity"
},
"propertyName": "sliType"
},
"properties": {
"sliType": {
"type": "string"
}
},
"required": [
"sliType"
]
},
"SliReport": {
"type": "object",
"properties": {
"errorBudgetRemaining": {
"type": "integer",
"format": "int32"
},
"fromTimestamp": {
"type": "integer",
"format": "int64"
},
"sli": {
"type": "number",
"format": "double"
},
"slo": {
"type": "number",
"format": "double"
},
"toTimestamp": {
"type": "integer",
"format": "int64"
},
"totalErrorBudget": {
"type": "integer",
"format": "int32"
},
"violationDistribution": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
}
}
}
},
"SlownessApplicationAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationAlertRule"
}
],
"required": [
"aggregation",
"alertType",
"metricName"
]
},
"SlownessWebsiteAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteAlertRule"
}
],
"required": [
"aggregation",
"alertType",
"metricName"
]
},
"SnapshotItem": {
"type": "object",
"properties": {
"from": {
"type": "integer",
"format": "int64"
},
"host": {
"type": "string"
},
"label": {
"type": "string"
},
"plugin": {
"type": "string"
},
"snapshotId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"to": {
"type": "integer",
"format": "int64"
}
}
},
"SnapshotPreview": {
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"plugin": {
"type": "string"
},
"time": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"id"
]
},
"SnapshotResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SnapshotItem"
}
}
}
},
"SoftwareUser": {
"type": "object",
"properties": {
"container": {
"type": "string"
},
"host": {
"type": "string"
},
"process": {
"type": "string"
}
}
},
"SoftwareVersion": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"origin": {
"type": "string"
},
"type": {
"type": "string"
},
"usedBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SoftwareUser"
},
"uniqueItems": true
},
"version": {
"type": "string"
}
},
"required": [
"name",
"origin",
"type",
"usedBy",
"version"
]
},
"Span": {
"type": "object",
"properties": {
"batchSelfTime": {
"type": "integer",
"format": "int64"
},
"batchSize": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"calculatedSelfTime": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"callId": {
"type": "string"
},
"childSpans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Span"
}
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"destination": {
"$ref": "#/components/schemas/SpanRelation"
},
"duration": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"errorCount": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"id": {
"type": "string"
},
"isSynthetic": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"UNKNOWN",
"ENTRY",
"EXIT",
"INTERMEDIATE"
]
},
"label": {
"type": "string",
"maxLength": 128,
"minLength": 0
},
"name": {
"type": "string"
},
"parentId": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/SpanRelation"
},
"stackTrace": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StackTraceItem"
}
},
"start": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"callId",
"childSpans",
"data",
"id",
"kind",
"label",
"name",
"stackTrace"
]
},
"SpanRelation": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Application"
},
"uniqueItems": true
},
"endpoint": {
"$ref": "#/components/schemas/Endpoint"
},
"physicalContext": {
"$ref": "#/components/schemas/PhysicalContext"
},
"service": {
"$ref": "#/components/schemas/Service"
}
},
"required": [
"applications"
]
},
"SpecificJsErrorsWebsiteAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteAlertRule"
},
{
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS",
"LESS_THAN",
"LESS_OR_EQUAL_THAN",
"GREATER_THAN",
"GREATER_OR_EQUAL_THAN",
"NOT_EMPTY",
"NOT_EQUAL",
"NOT_CONTAIN",
"IS_EMPTY",
"NOT_BLANK",
"IS_BLANK",
"STARTS_WITH",
"ENDS_WITH",
"NOT_STARTS_WITH",
"NOT_ENDS_WITH"
]
},
"value": {
"type": "string"
}
}
}
],
"required": [
"alertType",
"metricName",
"operator"
]
},
"SplunkIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"token",
"url"
]
},
"StackTraceItem": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"line": {
"type": "string"
},
"method": {
"type": "string"
}
}
},
"StackTraceLine": {
"type": "object",
"properties": {
"column": {
"type": "integer",
"format": "int32",
"minimum": -1
},
"file": {
"type": "string"
},
"line": {
"type": "integer",
"format": "int32",
"minimum": -1
},
"name": {
"type": "string"
},
"translationExplanation": {
"type": "string"
},
"translationStatus": {
"type": "integer",
"format": "int32",
"minimum": -1
}
},
"required": [
"file"
]
},
"StaticBooleanField": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CustomPayloadField"
},
{
"type": "object",
"properties": {
"value": {
"type": "boolean"
}
}
}
],
"required": [
"key",
"type"
]
},
"StaticNumberField": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CustomPayloadField"
},
{
"type": "object",
"properties": {
"value": {
"type": "number"
}
}
}
],
"required": [
"key",
"type",
"value"
]
},
"StaticStringField": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CustomPayloadField"
},
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
}
}
],
"required": [
"key",
"type",
"value"
]
},
"StaticThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Threshold"
},
{
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double",
"minimum": 0
}
}
}
],
"required": [
"operator",
"type"
]
},
"StatusCodeApplicationAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationAlertRule"
},
{
"type": "object",
"properties": {
"statusCodeEnd": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"statusCodeStart": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
}
],
"required": [
"alertType",
"metricName"
]
},
"StatusCodeWebsiteAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteAlertRule"
},
{
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS",
"LESS_THAN",
"LESS_OR_EQUAL_THAN",
"GREATER_THAN",
"GREATER_OR_EQUAL_THAN",
"NOT_EMPTY",
"NOT_EQUAL",
"NOT_CONTAIN",
"IS_EMPTY",
"NOT_BLANK",
"IS_BLANK",
"STARTS_WITH",
"ENDS_WITH",
"NOT_STARTS_WITH",
"NOT_ENDS_WITH"
]
},
"value": {
"type": "string"
}
}
}
],
"required": [
"alertType",
"metricName",
"operator",
"value"
]
},
"SyntheticCallConfig": {
"type": "object",
"properties": {
"customRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyntheticCallRule"
},
"maxItems": 500,
"minItems": 0
},
"defaultRulesEnabled": {
"type": "boolean"
}
},
"required": [
"customRules"
]
},
"SyntheticCallRule": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"matchSpecification": {
"$ref": "#/components/schemas/MatchExpressionDTO"
},
"name": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
},
"required": [
"matchSpecification",
"name"
]
},
"SyntheticCallWithDefaultsConfig": {
"type": "object",
"properties": {
"customRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyntheticCallRule"
},
"maxItems": 500,
"minItems": 0
},
"defaultRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyntheticCallRule"
}
},
"defaultRulesEnabled": {
"type": "boolean"
}
},
"required": [
"customRules",
"defaultRules"
]
},
"SystemRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractRule"
},
{
"type": "object",
"properties": {
"systemRuleId": {
"type": "string"
}
}
}
],
"required": [
"ruleType",
"systemRuleId"
]
},
"SystemRuleLabel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"Tag": {
"type": "object",
"properties": {
"canApplyToDestination": {
"type": "boolean"
},
"canApplyToSource": {
"type": "boolean"
},
"description": {
"type": "string"
},
"label": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"STRING",
"NUMBER",
"STRING_SET",
"STRING_LIST",
"KEY_VALUE_PAIR"
]
}
},
"required": [
"name",
"type"
]
},
"TagCatalog": {
"type": "object",
"properties": {
"tagTree": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagTreeLevel"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
},
"required": [
"tagTree",
"tags"
]
},
"TagFilter": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"enum": [
"NOT_APPLICABLE",
"DESTINATION",
"SOURCE"
]
},
"name": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS",
"LESS_THAN",
"LESS_OR_EQUAL_THAN",
"GREATER_THAN",
"GREATER_OR_EQUAL_THAN",
"NOT_EMPTY",
"NOT_EQUAL",
"NOT_CONTAIN",
"IS_EMPTY",
"NOT_BLANK",
"IS_BLANK",
"STARTS_WITH",
"ENDS_WITH",
"NOT_STARTS_WITH",
"NOT_ENDS_WITH"
]
},
"value": {
"type": "string"
}
},
"required": [
"name",
"operator",
"value"
]
},
"TagFilterExpression": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TagFilterExpressionElement"
},
{
"type": "object",
"properties": {
"elements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilterExpressionElement"
}
},
"logicalOperator": {
"type": "string",
"enum": [
"AND",
"OR"
]
}
}
}
],
"required": [
"elements",
"logicalOperator"
]
},
"TagFilterExpressionElement": {
"type": "object",
"discriminator": {
"mapping": {
"EXPRESSION": "#/components/schemas/TagFilterExpression",
"TAG_FILTER": "#/components/schemas/TagFilter"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
}
},
"TagMatcherDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/MatchExpressionDTO"
},
{
"type": "object",
"properties": {
"entity": {
"type": "string",
"enum": [
"NOT_APPLICABLE",
"DESTINATION",
"SOURCE"
]
},
"key": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"EQUALS",
"NOT_EQUAL",
"CONTAINS",
"NOT_CONTAIN",
"IS_EMPTY",
"NOT_EMPTY",
"IS_BLANK",
"NOT_BLANK",
"STARTS_WITH",
"ENDS_WITH",
"NOT_STARTS_WITH",
"NOT_ENDS_WITH",
"GREATER_OR_EQUAL_THAN",
"LESS_OR_EQUAL_THAN",
"LESS_THAN",
"GREATER_THAN"
]
},
"value": {
"type": "string"
}
}
}
],
"required": [
"entity",
"key",
"operator"
]
},
"TagTreeLevel": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagTreeNode"
}
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"searchable": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"required": [
"children",
"label",
"searchable"
]
},
"TagTreeNode": {
"type": "object",
"discriminator": {
"mapping": {
"LEVEL": "#/components/schemas/TagTreeLevel",
"TAG": "#/components/schemas/TagTreeTag"
},
"propertyName": "type"
},
"properties": {
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"TagTreeTag": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TagTreeNode"
},
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"tagName": {
"type": "string"
}
}
}
],
"required": [
"label",
"tagName"
]
},
"Threshold": {
"type": "object",
"discriminator": {
"mapping": {
"historicBaseline": "#/components/schemas/HistoricBaseline",
"staticThreshold": "#/components/schemas/StaticThreshold"
},
"propertyName": "type"
},
"properties": {
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"operator": {
"type": "string",
"enum": [
">",
">=",
"<",
"<="
]
},
"type": {
"type": "string"
}
},
"required": [
"operator",
"type"
]
},
"ThresholdRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractRule"
},
{
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"sum",
"avg",
"min",
"max"
]
},
"conditionOperator": {
"type": "string",
"enum": [
">",
">=",
"<",
"<=",
"=",
"!="
]
},
"conditionValue": {
"type": "number",
"format": "double"
},
"metricName": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"metricPattern": {
"$ref": "#/components/schemas/MetricPattern"
},
"rollup": {
"type": "integer",
"format": "int64"
},
"window": {
"type": "integer",
"format": "int64"
}
}
}
],
"required": [
"conditionOperator",
"ruleType"
]
},
"ThroughputApplicationAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationAlertRule"
}
],
"required": [
"alertType",
"metricName"
]
},
"ThroughputWebsiteAlertRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteAlertRule"
}
],
"required": [
"alertType",
"metricName"
]
},
"TimeFrame": {
"type": "object",
"properties": {
"to": {
"type": "integer",
"format": "int64"
},
"windowSize": {
"type": "integer",
"format": "int64",
"maximum": 2678400000,
"minimum": 0
}
}
},
"Trace": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"endpoint": {
"$ref": "#/components/schemas/Endpoint"
},
"erroneous": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"service": {
"$ref": "#/components/schemas/Service"
},
"startTime": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"required": [
"id",
"label"
]
},
"TraceGroupsItem": {
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/IngestionOffsetCursor"
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"cursor",
"metrics",
"name"
]
},
"TraceGroupsResult": {
"type": "object",
"properties": {
"canLoadMore": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TraceGroupsItem"
}
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"totalRepresentedItemCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"TraceItem": {
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/IngestionOffsetCursor"
},
"trace": {
"$ref": "#/components/schemas/Trace"
}
},
"required": [
"cursor",
"trace"
]
},
"TraceResult": {
"type": "object",
"properties": {
"canLoadMore": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TraceItem"
}
},
"totalHits": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"totalRepresentedItemCount": {
"type": "integer",
"format": "int64",
"minimum": 0
}
},
"required": [
"items"
]
},
"TreeNode": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreeNode"
}
},
"snapshotId": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"TreeNodeResult": {
"type": "object",
"properties": {
"tree": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreeNode"
}
}
}
},
"UnsupportedHttpPathSegmentMatchingRule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HttpPathSegmentMatchingRule"
},
{
"type": "object",
"properties": {
"unsupportedType": {
"type": "string"
}
}
}
],
"required": [
"type"
]
},
"UsageResult": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageResultItems"
}
},
"time": {
"type": "integer",
"format": "int64"
}
}
},
"UsageResultItems": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sims": {
"type": "integer",
"format": "int64"
}
}
},
"UserImpactWebsiteTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteTimeThreshold"
},
{
"type": "object",
"properties": {
"userPercentage": {
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": true,
"maximum": 1,
"minimum": 0
},
"users": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
}
],
"required": [
"type"
]
},
"UserResult": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"fullName": {
"type": "string"
},
"id": {
"type": "string"
},
"roleId": {
"type": "string"
}
}
},
"UsersResult": {
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResult"
},
"uniqueItems": true
}
}
},
"ValidatedAlertingChannelInputInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string"
},
"eventTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident",
"critical",
"warning",
"change",
"online",
"offline",
"agent_monitoring_issue",
"none"
]
},
"maxItems": 6,
"minItems": 0,
"uniqueItems": true
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"invalid": {
"type": "boolean"
},
"label": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"selectedEvents": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"Alert",
"WebsiteSmartAlert",
"ApplicationSmartAlert"
]
}
},
"required": [
"id",
"label",
"type"
]
},
"ValidatedAlertingConfiguration": {
"type": "object",
"properties": {
"alertChannelNames": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"alertName": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"applicationNames": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"eventFilteringConfiguration": {
"$ref": "#/components/schemas/EventFilteringConfiguration"
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"invalid": {
"type": "boolean"
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"muteUntil": {
"type": "integer",
"format": "int64"
}
},
"required": [
"alertName",
"eventFilteringConfiguration",
"id",
"integrationIds"
]
},
"ValidatedMaintenanceConfigWithStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"invalid": {
"type": "boolean"
},
"lastUpdated": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 0
},
"status": {
"type": "string",
"enum": [
"UNSCHEDULED",
"SCHEDULED",
"ACTIVE",
"FINISHED"
]
},
"windows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaintenanceWindow"
},
"maxItems": 1,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"id",
"name",
"query",
"status"
]
},
"VictorOpsIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"routingKey": {
"type": "string"
}
}
}
],
"required": [
"apiKey",
"id",
"kind",
"name",
"routingKey"
]
},
"ViolationsInPeriodApplicationTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationTimeThreshold"
},
{
"type": "object",
"properties": {
"violations": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1
}
}
}
],
"required": [
"type"
]
},
"ViolationsInPeriodWebsiteTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteTimeThreshold"
},
{
"type": "object",
"properties": {
"violations": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1
}
}
}
],
"required": [
"type"
]
},
"ViolationsInSequenceApplicationTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ApplicationTimeThreshold"
}
],
"required": [
"type"
]
},
"ViolationsInSequenceWebsiteTimeThreshold": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/WebsiteTimeThreshold"
}
],
"required": [
"type"
]
},
"WebexTeamsWebhookIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"webhookUrl": {
"type": "string"
}
}
}
],
"required": [
"id",
"kind",
"name",
"webhookUrl"
]
},
"WebhookIntegration": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractIntegration"
},
{
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "string"
}
},
"webhookUrls": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
],
"required": [
"id",
"kind",
"name",
"webhookUrls"
]
},
"Website": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"WebsiteAlertConfig": {
"type": "object",
"properties": {
"alertChannelIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"granularity": {
"type": "integer",
"format": "int32",
"default": 600000,
"enum": [
60000,
300000,
600000,
900000,
1200000,
1800000
]
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"rule": {
"$ref": "#/components/schemas/WebsiteAlertRule"
},
"severity": {
"type": "integer",
"format": "int32"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"threshold": {
"$ref": "#/components/schemas/Threshold"
},
"timeThreshold": {
"$ref": "#/components/schemas/WebsiteTimeThreshold"
},
"triggering": {
"type": "boolean"
},
"websiteId": {
"type": "string",
"maxLength": 64,
"minLength": 0
}
},
"required": [
"alertChannelIds",
"description",
"name",
"rule",
"tagFilters",
"threshold",
"timeThreshold",
"websiteId"
]
},
"WebsiteAlertConfigWithMetadata": {
"type": "object",
"properties": {
"alertChannelIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"baseline": {
"$ref": "#/components/schemas/HistoricBaseline"
},
"created": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 65536,
"minLength": 0
},
"enabled": {
"type": "boolean"
},
"granularity": {
"type": "integer",
"format": "int32",
"default": 600000,
"enum": [
60000,
300000,
600000,
900000,
1200000,
1800000
]
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"readOnly": {
"type": "boolean"
},
"rule": {
"$ref": "#/components/schemas/WebsiteAlertRule"
},
"severity": {
"type": "integer",
"format": "int32"
},
"tagFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
},
"maxItems": 1024,
"minItems": 0,
"uniqueItems": true
},
"threshold": {
"$ref": "#/components/schemas/Threshold"
},
"timeThreshold": {
"$ref": "#/components/schemas/WebsiteTimeThreshold"
},
"triggering": {
"type": "boolean"
},
"websiteId": {
"type": "string",
"maxLength": 64,
"minLength": 0
}
},
"required": [
"alertChannelIds",
"description",
"id",
"name",
"rule",
"tagFilters",
"threshold",
"timeThreshold",
"websiteId"
]
},
"WebsiteAlertRule": {
"type": "object",
"discriminator": {
"mapping": {
"slowness": "#/components/schemas/SlownessWebsiteAlertRule",
"specificJsError": "#/components/schemas/SpecificJsErrorsWebsiteAlertRule",
"statusCode": "#/components/schemas/StatusCodeWebsiteAlertRule",
"throughput": "#/components/schemas/ThroughputWebsiteAlertRule"
},
"propertyName": "alertType"
},
"properties": {
"aggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"alertType": {
"type": "string"
},
"metricName": {
"type": "string"
}
},
"required": [
"alertType",
"metricName"
]
},
"WebsiteBeaconGroupsItem": {
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/IngestionOffsetCursor"
},
"earliestTimestamp": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"metrics": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"name": {
"type": "string"
}
},
"required": [
"cursor",
"metrics",
"name"
]
},
"WebsiteBeaconTagGroup": {
"type": "object",
"properties": {
"groupbyTag": {
"type": "string",
"maxLength": 256,
"minLength": 0
},
"groupbyTagEntity": {
"type": "string",
"enum": [
"NOT_APPLICABLE",
"DESTINATION",
"SOURCE"
]
},
"groupbyTagSecondLevelKey": {
"type": "string",
"maxLength": 256,
"minLength": 0
}
},
"required": [
"groupbyTag",
"groupbyTagEntity"
]
},
"WebsiteBeaconsItem": {
"type": "object",
"properties": {
"beacon": {
"$ref": "#/components/schemas/WebsiteMonitoringBeacon"
},
"cursor": {
"$ref": "#/components/schemas/IngestionOffsetCursor"
}
},
"required": [
"beacon",
"cursor"
]
},
"WebsiteEventResult": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"end": {
"type": "integer",
"format": "int64"
},
"entityLabel": {
"type": "string"
},
"entityName": {
"type": "string"
},
"eventId": {
"type": "string"
},
"fixSuggestion": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"problem": {
"type": "string"
},
"recentEvents": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"severity": {
"type": "integer",
"format": "int32"
},
"snapshotId": {
"type": "string"
},
"start": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string"
},
"triggeringTime": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
},
"websiteId": {
"type": "string"
}
}
},
"WebsiteMetricResult": {
"type": "object",
"properties": {
"empty": {
"type": "boolean"
}
}
},
"WebsiteMonitoringBeacon": {
"type": "object",
"properties": {
"accuracyRadius": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"accurateTimingsAvailable": {
"type": "boolean"
},
"appCacheTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"backendTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"backendTraceId": {
"type": "string"
},
"batchSize": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"beaconId": {
"type": "string"
},
"browserName": {
"type": "string"
},
"browserVersion": {
"type": "string"
},
"cacheInteraction": {
"type": "string"
},
"childrenTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"city": {
"type": "string"
},
"clockSkew": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"componentStack": {
"type": "string"
},
"connectionType": {
"type": "string"
},
"continent": {
"type": "string"
},
"continentCode": {
"type": "string"
},
"country": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"cspBlockedUri": {
"type": "string"
},
"cspColumnNumber": {
"type": "integer",
"format": "int64"
},
"cspDisposition": {
"type": "string"
},
"cspEffectiveDirective": {
"type": "string"
},
"cspLineNumber": {
"type": "integer",
"format": "int64"
},
"cspOriginalPolicy": {
"type": "string"
},
"cspSample": {
"type": "string"
},
"cspSourceFile": {
"type": "string"
},
"cumulativeLayoutShift": {
"type": "number",
"format": "double"
},
"customEventName": {
"type": "string"
},
"decodedBodySize": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"deprecations": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 16,
"minItems": 0,
"uniqueItems": true
},
"deviceType": {
"type": "string"
},
"dnsTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"domTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"duration": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"encodedBodySize": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"errorCount": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"errorId": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"errorType": {
"type": "string"
},
"firstContentfulPaintTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"firstInputDelayTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"firstPaintTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"frontendTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"graphqlOperationName": {
"type": "string"
},
"graphqlOperationType": {
"type": "string"
},
"httpCallAsynchronous": {
"type": "boolean"
},
"httpCallCorrelationAttempted": {
"type": "boolean"
},
"httpCallMethod": {
"type": "string"
},
"httpCallOrigin": {
"type": "string"
},
"httpCallPath": {
"type": "string"
},
"httpCallStatus": {
"type": "integer",
"format": "int32",
"maximum": 599,
"minimum": -1
},
"httpCallUrl": {
"type": "string"
},
"initiator": {
"type": "string"
},
"largestContentfulPaintTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"latitude": {
"type": "number",
"format": "double"
},
"locationOrigin": {
"type": "string"
},
"locationPath": {
"type": "string"
},
"locationUrl": {
"type": "string"
},
"longitude": {
"type": "number",
"format": "double"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"onLoadTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"osName": {
"type": "string"
},
"osVersion": {
"type": "string"
},
"page": {
"type": "string"
},
"pageLoadId": {
"type": "string"
},
"parsedStackTrace": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StackTraceLine"
},
"maxItems": 64,
"minItems": 0
},
"phase": {
"type": "string"
},
"processingTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"redirectTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"requestTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"resourceType": {
"type": "string"
},
"responseTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"sessionId": {
"type": "string"
},
"snippetVersion": {
"type": "string"
},
"sslTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"stackTrace": {
"type": "string"
},
"stackTraceParsingStatus": {
"type": "integer",
"format": "int32",
"minimum": -1
},
"stackTraceReadability": {
"type": "integer",
"format": "int32",
"minimum": 0
},
"subdivision": {
"type": "string"
},
"subdivisionCode": {
"type": "string"
},
"tcpTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"timestamp": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"transferSize": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"type": {
"type": "string"
},
"unloadTime": {
"type": "integer",
"format": "int64",
"minimum": -1
},
"userEmail": {
"type": "string"
},
"userId": {
"type": "string"
},
"userIp": {
"type": "string"
},
"userLanguages": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0
},
"userName": {
"type": "string"
},
"websiteId": {
"type": "string"
},
"websiteLabel": {
"type": "string"
},
"windowHeight": {
"type": "integer",
"format": "int32",
"minimum": -1
},
"windowHidden": {
"type": "boolean"
},
"windowWidth": {
"type": "integer",
"format": "int32",
"minimum": -1
}
},
"required": [
"beaconId",
"locationOrigin",
"locationUrl",
"pageLoadId",
"type",
"websiteId",
"websiteLabel"
]
},
"WebsiteMonitoringMetricDescription": {
"type": "object",
"properties": {
"aggregations": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"beaconTypes": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"description": {
"type": "string"
},
"formatter": {
"type": "string"
},
"label": {
"type": "string"
},
"metricId": {
"type": "string"
}
}
},
"WebsiteMonitoringMetricsConfiguration": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"SUM",
"MEAN",
"MAX",
"MIN",
"P25",
"P50",
"P75",
"P90",
"P95",
"P98",
"P99",
"P99_9",
"P99_99",
"DISTINCT_COUNT"
]
},
"granularity": {
"type": "integer",
"format": "int32"
},
"metric": {
"type": "string"
}
},
"required": [
"aggregation",
"metric"
]
},
"WebsiteTimeThreshold": {
"type": "object",
"discriminator": {
"mapping": {
"userImpactOfViolationsInSequence": "#/components/schemas/UserImpactWebsiteTimeThreshold",
"violationsInPeriod": "#/components/schemas/ViolationsInPeriodWebsiteTimeThreshold",
"violationsInSequence": "#/components/schemas/ViolationsInSequenceWebsiteTimeThreshold"
},
"propertyName": "type"
},
"properties": {
"timeWindow": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Widget": {
"type": "object",
"properties": {
"config": {
"type": "object"
},
"height": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"id": {
"type": "string",
"maxLength": 64,
"minLength": 0
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"width": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1
},
"x": {
"type": "integer",
"format": "int32",
"maximum": 11,
"minimum": 0
},
"y": {
"type": "integer",
"format": "int32",
"minimum": 0
}
},
"required": [
"config",
"id",
"type"
]
}
},
"securitySchemes": {
"ApiKeyAuth": {
"in": "header",
"name": "authorization",
"scheme": "apiToken",
"type": "apiKey",
"description": "## Example\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n"
}
}
},
"x-tagGroups": [
{
"name": "Infrastructure Monitoring",
"tags": [
"Infrastructure Metrics",
"Infrastructure Resources",
"Infrastructure Catalog"
]
},
{
"name": "Application Monitoring",
"tags": [
"Application Metrics",
"Application Resources",
"Application Catalog",
"Application Analyze",
"Application Settings"
]
},
{
"name": "Website Monitoring",
"tags": [
"Website Metrics",
"Website Catalog",
"Website Analyze",
"Website Configuration"
]
},
{
"name": "Event",
"tags": [
"Events",
"Event Settings"
]
},
{
"name": "Host Agent",
"tags": [
"Host Agent"
]
},
{
"name": "Settings",
"tags": [
"Custom Dashboards",
"User",
"Groups",
"Audit Log",
"API Token",
"Maintenance Configuration",
"Synthetic Calls",
"Session Settings"
]
},
{
"name": "Pipeline Feedback",
"tags": [
"Releases"
]
},
{
"name": "Service Level Indicators",
"tags": [
"SLI Settings",
"SLI Report"
]
},
{
"name": "BETA Features",
"tags": [
"Application Alert Configuration"
]
},
{
"name": "Instana",
"tags": [
"Health",
"Usage"
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment