{ "opencollection": "1.0.0", "info": { "name": "Instana REST API documentation", "version": "1.307.1417" }, "items": [ { "info": { "name": "Apdex Report", "type": "folder" }, "items": [ { "info": { "name": "Generate Apdex report", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/apdex/report/:apdexId", "params": [ { "name": "apdexId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "path", "description": "Apdex Configuration ID" }, { "name": "from", "value": "1706713140000", "type": "query", "description": "Starting point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds" }, { "name": "to", "value": "1706813100000", "type": "query", "description": "Ending point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Generate Apdex Report for a specified Apdex ID." } ] }, { "info": { "name": "Application Analyze", "type": "folder" }, "items": [ { "info": { "name": "Resolve Trace IDs from Monitoring Beacons.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/analyze/backend-correlation", "params": [ { "name": "correlationId", "value": "0v7f55879ca12345", "type": "query", "description": "Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring.\nFor XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`.\n" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.\nFor more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze." }, { "info": { "name": "Get grouped call metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/analyze/call-groups", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query", "description": "If enabled, fill the missing data points in the metric result with timestamp and value 0." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves the metrics for calls.\r\n\r\n## Deprecated Parameters\r\n**tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.\r\n\r\n## Supported Aggregation on Get Grouped call metrics\r\n\r\n| Metric | Description | Allowed Aggregations |\r\n|------------------|-----------------------------------------------------------------------------" }, { "info": { "name": "Get grouped trace metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/analyze/trace-groups", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query", "description": "If enabled, fill the missing data points in the metric result with timestamp and value 0." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.\n\nThe supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. \n\n## Supported Aggregation on Get grouped trace metrics\n\n| Metric | Description | Allowed Aggregations |\n|------------------|--------------------------------------------------------------------------------------------|-----------------" }, { "info": { "name": "Get all traces", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/analyze/traces", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use the endpoint to retrieve a list of traces.\r\n\r\n**Deprecated Parameter:** `tagFilters` is deprecated. It is replaced by `tagFilterExpression`.\r\n" }, { "info": { "name": "Get trace detail", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/v2/analyze/traces/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "retrievalSize", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "ingestionTime", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrive comprehensive details of a particular trace.\nFor more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze." }, { "info": { "name": "Get call detail", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/v2/analyze/traces/:traceId/calls/:callId/details", "params": [ { "name": "traceId", "value": "", "type": "path" }, { "name": "callId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to retrieve a vast information about a call present in a trace.\n\nFor more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze." } ] }, { "info": { "name": "Application Resources", "type": "folder" }, "items": [ { "info": { "name": "Get applications", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/applications", "params": [ { "name": "nameFilter", "value": "", "type": "query", "description": "Name of application" }, { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" }, { "name": "page", "value": "", "type": "query", "description": "Page number from results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "applicationBoundaryScope", "value": "", "type": "query", "description": "Filter for application scope, i.e: INBOUND or ALL" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of Application Perspectives.\nA use case could be to view the application id of an Application Perspective.\n\nFor more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources." }, { "info": { "name": "Get applications/services", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/applications;id=/services", "params": [ { "name": "nameFilter", "value": "", "type": "query", "description": "Name of service (partial match allowed)" }, { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" }, { "name": "page", "value": "", "type": "query", "description": "Page number from results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "applicationBoundaryScope", "value": "", "type": "query", "description": "Filter for application scope, i.e: INBOUND or ALL" }, { "name": "includeSnapshotIds", "value": "", "type": "query", "description": "Include snapshot ids in the results" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of services in an Application Perspective.\nA use case could be to retrieve all service ids present in an Application Perspective.\n\nFor more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources." }, { "info": { "name": "Get endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/applications/services/endpoints", "params": [ { "name": "nameFilter", "value": "", "type": "query", "description": "Name of service" }, { "name": "types", "value": "", "type": "query", "description": "Type of Endpoint" }, { "name": "technologies", "value": "", "type": "query", "description": "List of technologies" }, { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" }, { "name": "page", "value": "", "type": "query", "description": "Page number from results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "applicationBoundaryScope", "value": "", "type": "query", "description": "Filter for application scope, i.e: INBOUND or ALL" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of Endpoints.\nA use case could be to view the endpoint id of an Endpoint.\n\nFor more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources." }, { "info": { "name": "Get services", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/services", "params": [ { "name": "nameFilter", "value": "", "type": "query", "description": "Name of service" }, { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" }, { "name": "page", "value": "", "type": "query", "description": "Page number from results" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "includeSnapshotIds", "value": "", "type": "query", "description": "Include snapshot ids in the results" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of Services.\nA use case could be to view the service id of a Service.\n\nFor more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources." } ] }, { "info": { "name": "Application Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get application tag catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/catalog", "params": [ { "name": "from", "value": "", "type": "query", "description": "The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp.\nEg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time.\n" }, { "name": "dataSource", "value": "", "type": "query", "description": "The source from where queryable tags should be fetched from. In Unbounded Analytics, Application Perspectives has 2 sources; `Calls` and `Traces`." }, { "name": "useCase", "value": "", "type": "query", "description": "The subset of queryable tags that is available for a particular use case.\nFor eg: If you select `dataSource` as `TRACES` and useCase as `Grouping`. The tags available for querying are `trace.endpoint.name` and `trace.service.name`.\nuseCase is helpful when one wants to know which tags are supported for querying.\n" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to retrieve a list of tags.\nThis API endpoint also shows tags which are grouped together. This grouping also denotes the dimensionality of an event. Eg: `Call` can have 9 attributes.\nAlso these tags have cardinality ranging from low to high which will help in examining broad or narrow patterns during the analysis.\nQueryable tags are a powerful enabler for slice and dice analysis in `Query Builder`. `Query Builder` can be found in `Unbounded Analytics`." }, { "info": { "name": "Get Metric catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/catalog/metrics", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves all available metric definitions for application monitoring.\n" }, { "info": { "name": "Get application tags", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/catalog/tags", "params": [ { "name": "from", "value": "", "type": "query", "description": "The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp.\nEg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time.\n" }, { "name": "dataSource", "value": "", "type": "query", "description": "The source from where queryable tags should be fetched from. In Unbounded Analytics, Application Perspectives has 2 sources; `Calls` and `Traces`." }, { "name": "useCase", "value": "", "type": "query", "description": "The subset of queryable tags that is available for a particular use case.\nFor eg: If you select `dataSource` as `TRACES` and useCase as `Grouping`. The tags available for querying are `trace.endpoint.name` and `trace.service.name`.\nuseCase is helpful when one wants to know which tags are supported for querying.\n" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "**Note:** This API Endpoint is deprecated. Use `Get application tag catalog` endpoint instead.\n\nThis 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" } ] }, { "info": { "name": "Application Metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Application Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/metrics/applications", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query", "description": "If enabled, fill the missing data points in the metric result with timestamp and value 0." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for an Application Perspective.\nFor eg: retrieve `MEAN` aggregation of `latency` metric for an Application Perspective `app`.\nFor more information on supported metrics, refer `Get Metric catalog`.\n\nFor more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics." }, { "info": { "name": "Get Endpoint metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/metrics/endpoints", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query", "description": "If enabled, fill the missing data points in the metric result with timestamp and value 0." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for an Endpoint.\nFor eg: retrieve `MEAN` aggregation of `latency` metric for an Endpoint `GET /api/foo`.\nFor more information on supported metrics, refer `Get Metric catalog`.\n\nFor more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics." }, { "info": { "name": "Get Service metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/metrics/services", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query", "description": "If enabled, fill the missing data points in the metric result with timestamp and value 0." }, { "name": "includeSnapshotIds", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for a Service.\nFor eg: retrieve `MEAN` aggregation of `latency` metric for a Service `payment`.\nFor more information on supported metrics, refer `Get Metric catalog`.\n\nFor more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics." }, { "info": { "name": "Get Application Data Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/v2/metrics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for a combination of entities.\nFor eg: retrieve `MEAN` aggregation of `latency` metric for an Endpoint `GET /api/foo`, Service `payment` and Application Perspective `app`.\nConsider this API endpoint an upgraded version of `Get Application Metrics`, `Get Endpoint metrics` and `Get Service metrics`.\nFor more information on supported metrics, refer `Get Metric catalog`.\n\nFor more information on App" } ] }, { "info": { "name": "Application Settings", "type": "folder" }, "items": [ { "info": { "name": "All Application configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/application", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of all Application Perspectives with their configuration settings.\nThis endpoint requires `canConfigureApplications` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and s" }, { "info": { "name": "Add application configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/application", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to create a new Application Perspective. This endpoint requires `canConfigureApplications` permission. \n\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Configuration of applications` to `true" }, { "info": { "name": "Application configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/application/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve an Application Perspective with its configuration setting.\nThis endpoint requires `canConfigureApplications` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Configurati" }, { "info": { "name": "Update application configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/application/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to update an existing Application Perspective. This endpoint requires `canConfigureApplications` permission. One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Configuration of applications` to `" }, { "info": { "name": "Delete application configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/application/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to delete an Application Perspective. This endpoint requires `canConfigureApplications` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\n\n## Deprecated Parameters\n**matchSpecification:** A binary tree structure of match expression connected with binary" }, { "info": { "name": "All Endpoint configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/endpoint", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a list of all endpoint configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and" }, { "info": { "name": "Create endpoint configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/endpoint", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to create an endpoint configuration of a service.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and " }, { "info": { "name": "Endpoint configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve the endpoint configuration of a service.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules a" }, { "info": { "name": "Update endpoint configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to update an existing endpoint configuration of a service.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service r" }, { "info": { "name": "Delete endpoint configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to delete an endpoint configuration of a service.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and " }, { "info": { "name": "All HTTP endpoint configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/http-endpoint", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This is a deprecated endpoint. Use `All Endpoint configurations` instead.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint ma" }, { "info": { "name": "Create HTTP endpoint configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/http-endpoint", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This is a deprecated endpoint. Use `Create endpoint configuration` instead.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint " }, { "info": { "name": "HTTP Endpoint configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/http-endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This is a deprecated endpoint. Use `Endpoint configuration` instead.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint mapping" }, { "info": { "name": "Update HTTP endpoint configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/http-endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This is a deprecated endpoint. Use `Update endpoint configuration` instead.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint " }, { "info": { "name": "Delete HTTP endpoint configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/http-endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This is a deprecated endpoint. Use `Delete endpoint configuration` instead.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint " }, { "info": { "name": "All manual service configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/manual-service", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API Endpoint if one wants to retrieve a list of all manual service configurations. This endpoint requires `CanConfigureServiceMapping` permission. \n\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service r" }, { "info": { "name": "Add manual service configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/manual-service", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to add a manual service configuration. This endpoint requires `CanConfigureServiceMapping` permission. \n\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint " }, { "info": { "name": "Replace all manual service configurations", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/manual-service", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to update more than 1 manual service configurations. This endpoint requires `CanConfigureServiceMapping` permission. \n\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules" }, { "info": { "name": "Update manual service configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/manual-service/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to update a manual service configuration.\n\n**This is an experimental endpoint to workaround service mapping issues.**\n\n### Use cases\n\nThe manual service configuration APIs enables mapping calls to services using tag filter expressions based on call tags.\n\nThere are two use cases on the usage of these APIs:\n\n1. Map to an Unmonitored Service with a Custom Name. For example, Map HTTP calls to different Google domains (`www.ibm.com`, `www.ibm.fr`) into a single ser" }, { "info": { "name": "Delete manual service configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/manual-service/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to delete a manual service configuration. This endpoint requires `CanConfigureServiceMapping` permission. \n\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoi" }, { "info": { "name": "All service configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrive a list of all service configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and e" }, { "info": { "name": "Add service configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to create a custom service rule.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint mapping`" }, { "info": { "name": "Replace all service configurations", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to modify 1 or more existing service configuration.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules an" }, { "info": { "name": "Order of service configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service/order", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to change the order of service configurations aka custom service rules.\nNote that all service configuration IDs have to be passed in the request to re-order the configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> A" }, { "info": { "name": "Service configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve a particular custom service rule.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endp" }, { "info": { "name": "Update service configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to update a particular custom service rule.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoi" }, { "info": { "name": "Delete service configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/settings/service/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to delete a service configuration.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and endpoint mappin" } ] }, { "info": { "name": "Application Topology", "type": "folder" }, "items": [ { "info": { "name": "Gets the service topology", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/application-monitoring/topology/services", "params": [ { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" }, { "name": "applicationId", "value": "", "type": "query", "description": "Filter by application ID" }, { "name": "applicationBoundaryScope", "value": "", "type": "query", "description": "Filter by application scope, i.e., INBOUND or ALL. The default value is INBOUND. Applies only if application ID filter is specified." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to retrieve services and connections (call paths) between them for calls in the scope given by the parameters.\n\n## Errata:\n\nThe following fields are unsupported but documented in the schema for the result `services`:\n- The `applications` field is always missing and the `snapshotIds` field is always empty, despite being declared as required in the result schema.\n- The `maxSeverity` and `numberOfOpenIssues` fields are always missing.\n" } ] }, { "info": { "name": "Action History", "type": "folder" }, "items": [ { "info": { "name": "Get the details of automation action run results from action run history.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/actioninstances", "params": [ { "name": "windowSize", "value": "10000", "type": "query", "description": "Window size filter in milliseconds (to compute the from date) to get the action run result details" }, { "name": "to", "value": "1706713140000", "type": "query", "description": "To date filter in milliseconds (13-digit) to get the action run result details" }, { "name": "page", "value": "2", "type": "query", "description": "Page to fetch -- used for paging the action run result records" }, { "name": "pageSize", "value": "50", "type": "query", "description": "Number of records to return in each page -- used for paging the action run result records" }, { "name": "targetSnapshotId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Target snapshot ID filter to get the action run result details" }, { "name": "eventId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Event ID filter to get the action run result details" }, { "name": "eventSpecificationId", "value": "1706713140000", "type": "query", "description": "Event specification ID filter to get the action run result details" }, { "name": "search", "value": "1706713140000", "type": "query", "description": "Text in action run result name, description and event name filter to get the action run result details" }, { "name": "types", "value": "One or more of the following types HTTP, SCRIPT, ANSIBLE, GITHUB, GITLAB, JIRA", "type": "query", "description": "Action type filter to get the action run result details" }, { "name": "actionStatuses", "value": "One or more of the following status SUBMITTED, IN_PROGRESS, SUCCESS, FAILED, TIMEOUT", "type": "query", "description": "Action status filter to get the action run result details" }, { "name": "actionIds", "value": "", "type": "query", "description": "Action IDs filter to get the action run result details for only these actions" }, { "name": "policyId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Policy ID filter to get the action run result details" }, { "name": "orderBy", "value": "Name of the action run result column. Default is action run result start date.", "type": "query", "description": "Action run result column to order the result set." }, { "name": "orderDirection", "value": "asc or desc", "type": "query", "description": "Sort order direction." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get the details of automation action run results from action run history. The results are filtered by the filters in the query parameters. The automation action run result will be fetched only if the action run results were created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is cu" }, { "info": { "name": "Run an automation action.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/automation/actioninstances", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Submits the automation action for execution on an agent. The automation action to execute and the agent on which to execute the action must be specified as actionId and hostId. For more details on the request payload see the request sample. This call requires `Execution of automation actions` permission." }, { "info": { "name": "Delete automation action run results.", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/automation/actioninstances", "params": [ { "name": "from", "value": "1706713140000", "type": "query", "description": "From date filter in milliseconds (13-digit) to look up the action run results to delete" }, { "name": "to", "value": "1706713140000", "type": "query", "description": "To date filter in milliseconds (13-digit) to look up the action run results to delete" }, { "name": "targetSnapshotId", "value": "aCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Target snapshot ID to look up the action run results to delete" }, { "name": "eventId", "value": "bCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Event ID filter to look up the action run results to delete" }, { "name": "eventSpecificationId", "value": "1706713140000", "type": "query", "description": "Event specification ID filter to look up the action run results to delete" }, { "name": "search", "value": "1706713140000", "type": "query", "description": "Text in action run result name, description and event name to filter the action run results to delete" }, { "name": "types", "value": "One or more of the following types HTTP, SCRIPT, ANSIBLE, GITHUB, GITLAB, JIRA", "type": "query", "description": "Action type filter to look up the action run results to delete" }, { "name": "actionStatuses", "value": "One or more of the following status SUBMITTED, IN_PROGRESS, SUCCESS, FAILED, TIMEOUT", "type": "query", "description": "Action status filter to look up the action run results to delete" }, { "name": "actionIds", "value": "cCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "List of action IDs to filter the action run results to delete" }, { "name": "policyId", "value": "bCtEoR6NSPqG61QkIkwwCw", "type": "query", "description": "Policy ID filter to look up the action run results to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes the automation action run results from the action run history. The results to delete is filtered by the filter values given in the query parameters. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. This call requires `Deletion of automation action history` permission and, `from` and `to` query parameters." }, { "info": { "name": "Get the details of an automation action run result by ID from action run history.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/actioninstances/:actionInstanceId", "params": [ { "name": "actionInstanceId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "path", "description": "action run result ID to get action run result details" }, { "name": "windowSize", "value": "10000", "type": "query", "description": "Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided." }, { "name": "to", "value": "1706713140000", "type": "query", "description": "To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get the details of automation action run result specified in the request path from action run history. The automation action run result will be fetched only if the action run result was created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. To get the automati" }, { "info": { "name": "Deletes an automation action run result from the action run history by ID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/automation/actioninstances/:actionInstanceId", "params": [ { "name": "actionInstanceId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "path", "description": "Automation action run result ID to delete." }, { "name": "from", "value": "1706713140000", "type": "query", "description": "From date filter in milliseconds (13-digit) to look up the action run result ID." }, { "name": "to", "value": "1706713190000", "type": "query", "description": "To date filter in milliseconds (13-digit) to look up the action run result ID." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes the automation action run result specified in the request path from the action run history. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` and `/api/automation/actioninstances/<{actionInstanceId}>` REST calls. This call requires `Deletion of automation action histo" } ] }, { "info": { "name": "Action Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get all automation actions.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/actions", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all automation actions. When using personal access tokens, the user must have at least `Viewer` access for Automation and the actions returned are also filtered based on the access set in `Limited access` permission settings." }, { "info": { "name": "Get an automation action by ID.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/actions/:id", "params": [ { "name": "id", "value": "d473c1b0-0740-4d08-95fe-31e5d0a9faff", "type": "path", "description": "Automation action ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get an automation action by ID specified in the request path. When using personal access tokens, the user must have at least `Viewer` access for Automation and the actions returned are also filtered based on the access set in `Limited access` permission settings." }, { "info": { "name": "Get action matches by application ID or snapshot ID.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/ai/action/match", "params": [ { "name": "applicationId", "value": "", "type": "query" }, { "name": "snapshotId", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "windowSize", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get automation actions that match based on application ID or snapshot ID within a specified time window." }, { "info": { "name": "Get automation actions that match the incidents or issues.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/automation/ai/action/match", "params": [ { "name": "targetSnapshotId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get automation actions that match the incident or issue data in the request body." }, { "info": { "name": "Resolve dynamic parameter values", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/automation/parameters/dynamic", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Resolve dynamic parameter values" }, { "info": { "name": "Get tag catalog for dynamic parameters", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/parameters/dynamic/catalog", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get tag catalog for dynamic parameters" } ] }, { "info": { "name": "Policies", "type": "folder" }, "items": [ { "info": { "name": "Get all automation policies.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies", "params": [ { "name": "triggerType", "value": "", "type": "query", "description": "Filter policies by the event or alert type that can trigger a policy. This is an optional parameter. Valid values are customEvent, builtinEvent, applicationSmartAlert, globalApplicationSmartAlert, websiteSmartAlert, infraSmartAlert, mobileAppSmartAlert, syntheticsSmartAlert, logSmartAlert, sloSmartAlert" }, { "name": "triggerId", "value": "", "type": "query", "description": "Trigger identifier. This is an optional parameter." }, { "name": "executionType", "value": "", "type": "query", "description": "Filter policies by policy execution type. This is an optional parameter. Valid values are automatic or manual" }, { "name": "actionId", "value": "", "type": "query", "description": "Filter policies by action ID. This is an optional parameter." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns all the automation policies filtered by the values in optional query parameters. When using personal access tokens, the user must have at least `Viewer` access for Automation and the automation policies returned are also filtered based on the access set in `Limited access` permission settings." }, { "info": { "name": "Create an automation policy.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new automation policy. Policy creation requires `Configuration of automation policies` permission." }, { "info": { "name": "Create automation policies.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies/bulk", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a list of automation policies. Policy creation requires `Configuration of automation policies` permission." }, { "info": { "name": "Get an automation policy by ID.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies/:id", "params": [ { "name": "id", "value": "a14700b0-401b-47eb-a751-deda0035fde3", "type": "path", "description": "Automation policy ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns the automation policy filtered by the ID in request parameter. When using personal access tokens, the user must have at least `Viewer` access for Automation and the automation policies returned are also filtered based on the access set in `Limited access` permission settings." }, { "info": { "name": "Updates an automation policy by identifier.", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an automation policy by identifier. Policy updates requires `Configuration of automation policies` permission. When using personal tokens the automation policies updated are based on the access set in `Limited access` permission settings." }, { "info": { "name": "Deletes an automation policy by identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/automation/policies/:id", "params": [ { "name": "id", "value": "a14700b0-401b-47eb-a751-deda0035fde3", "type": "path", "description": "Automation policy ID to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes an automation policy by identifier. Policy deletion requires `Configuration of automation policies` permission. When using personal tokens the automation policies deleted are based on the access set in `Limited access` permission settings." } ] }, { "info": { "name": "Business Monitoring", "type": "folder" }, "items": [ { "info": { "name": "Get Business Activities", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/activities", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get Business Activities" }, { "info": { "name": "Download Business Activities", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/activities/csv", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Download Business Activities" }, { "info": { "name": "Get all business perspectives", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/business-perspectives", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all business perspectives" }, { "info": { "name": "Create business perspective", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/business-perspectives", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create business perspective" }, { "info": { "name": "Get business perspective", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/business-perspectives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get business perspective" }, { "info": { "name": "Update business perspective", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/business-perspectives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update business perspective" }, { "info": { "name": "Delete business perspective", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/business-perspectives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete business perspective" }, { "info": { "name": "Get business tag catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/business-monitoring/catalog", "params": [ { "name": "from", "value": "", "type": "query" }, { "name": "useCase", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get business tag catalog" } ] }, { "info": { "name": "Custom Dashboards", "type": "folder" }, "items": [ { "info": { "name": "Get accessible custom dashboards", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard", "params": [ { "name": "query", "value": "BeeInstana", "type": "query", "description": "query" }, { "name": "pageSize", "value": "2", "type": "query", "description": "pageSize" }, { "name": "page", "value": "1", "type": "query", "description": "page" }, { "name": "withTotalHits", "value": "false", "type": "query", "description": "withTotalHits" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all accessible custom dashboards details.\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Add custom dashboard", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Get all API tokens.", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard/shareable-api-tokens", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all API tokens that have access to shareable custom dashboards.\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Get all users (without invitations).", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard/shareable-users", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all users (without invitations) that have access to shareable custom dashboards.\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Get custom dashboard", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard/:customDashboardId", "params": [ { "name": "customDashboardId", "value": "alHaYV5aSkKku_wcg53teQ", "type": "path", "description": "customDashboardId" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all Custom Dashboard Info for specified customDashboardId.\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Update custom dashboard", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard/:customDashboardId", "params": [ { "name": "customDashboardId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." }, { "info": { "name": "Remove custom dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/custom-dashboard/:customDashboardId", "params": [ { "name": "customDashboardId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards." } ] }, { "info": { "name": "Custom Entities", "type": "folder" }, "items": [ { "info": { "name": "List custom Entity Type Definition", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-entitytypes", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This end point lists custom Entity Type Definition" }, { "info": { "name": "Create a Custom Entity type", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/custom-entitytypes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This end point creates a custom entity type" }, { "info": { "name": "Get custom Entity Types", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/custom-entitytypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint gets custom Entity Type by ID" }, { "info": { "name": "Update a Custom Entity Type", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/custom-entitytypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This end points updates the definition of a custom entity type" }, { "info": { "name": "Delete a Custom Entity Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/custom-entitytypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This end point deletes a custom Entity type definition" } ] }, { "info": { "name": "End User Monitoring", "type": "folder" }, "items": [ { "info": { "name": "Get impacted users report", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/eum/impact/report/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a report of users impacted by an event which was created from a smart alert violation" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Get all Events", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events", "params": [ { "name": "to", "value": "1704096000000", "type": "query", "description": "A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time" }, { "name": "windowSize", "value": "600000", "type": "query", "description": "The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]" }, { "name": "from", "value": "1672560000000", "type": "query", "description": "A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]" }, { "name": "filterEventUpdates", "value": "true", "type": "query", "description": "Flag to filter the results to only show events with state changes within the timeframe." }, { "name": "excludeTriggeredBefore", "value": "true", "type": "query", "description": "Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe." }, { "name": "includeAgentMonitoringIssues", "value": "true", "type": "query", "description": "Flag to filter the results to include Agent Monitoring Issues." }, { "name": "includeKubernetesInfoEvents", "value": "true", "type": "query", "description": "Flag to filter the results to include Kubernetes Info Events." }, { "name": "eventTypeFilters", "value": "INCIDENT", "type": "query", "description": "A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`. " }, { "info": { "name": "Get Events by IDs", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a set of events by their IDs. " }, { "info": { "name": "Get Agent Monitoring Events", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/agent-monitoring-events", "params": [ { "name": "to", "value": "1704096000000", "type": "query", "description": "A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time" }, { "name": "windowSize", "value": "600000", "type": "query", "description": "The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]" }, { "name": "from", "value": "1672560000000", "type": "query", "description": "A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]" }, { "name": "filterEventUpdates", "value": "true", "type": "query", "description": "Flag to filter the results to only show events with state changes within the timeframe." }, { "name": "excludeTriggeredBefore", "value": "true", "type": "query", "description": "Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all Agent Monitoring Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`. " }, { "info": { "name": "Get Kubernetes Info Events", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/kubernetes-info-events", "params": [ { "name": "to", "value": "1704096000000", "type": "query", "description": "A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time" }, { "name": "windowSize", "value": "600000", "type": "query", "description": "The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]" }, { "name": "from", "value": "1672560000000", "type": "query", "description": "A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]" }, { "name": "filterEventUpdates", "value": "true", "type": "query", "description": "Flag to filter the results to only show events with state changes within the timeframe." }, { "name": "excludeTriggeredBefore", "value": "true", "type": "query", "description": "Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all Kubernetes Info Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`. " }, { "info": { "name": "Get Event", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/:eventId", "params": [ { "name": "eventId", "value": "LZOGo1lXR4WeCB2ftgtGGQ", "type": "path", "description": "ID of a specific Event to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific event." } ] }, { "info": { "name": "Event Settings", "type": "folder" }, "items": [ { "info": { "name": "Get all Alerting Channels", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels", "params": [ { "name": "ids", "value": "[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]", "type": "query", "description": "List of IDs of alert channels defined in Instana. Can be left empty." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all the alerting channels. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Create Alert Channel", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates an alerting channel. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Get Overview of Alerting Channels", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/infos", "params": [ { "name": "ids", "value": "[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]", "type": "query", "description": "List of IDs of alert channels defined in Instana. Can be left empty." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/notify/:id", "params": [ { "name": "id", "value": "YbcFlaG8k5oIkxD0", "type": "path", "description": "ID of the alerting channel to be notified on." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Sends alert for a specific event to an alerting channel. Provided the event Id, an alert could be sent to the alerting channel. This endpoint requires `canInvokeAlertChannel` permission." }, { "info": { "name": "Test Alerting Channel", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Get Alerting Channel", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/:id", "params": [ { "name": "id", "value": "YbcFlaG8k5oIkxD0", "type": "path", "description": "ID of the Alerting Channel to get." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets an alerting channel. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Update Alert Channel", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/:id", "params": [ { "name": "id", "value": "YbcFlaG8k5oIkxD0", "type": "path", "description": "ID of the Alerting Channel to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an alerting channel. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Delete Alerting Channel", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alertingChannels/:id", "params": [ { "name": "id", "value": "YbcFlaG8k5oIkxD0", "type": "path", "description": "ID of the Alerting Channel to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes an alert channel. Requires the permission called CanConfigureIntegrations." }, { "info": { "name": "Get all Alert Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alerts", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all Alert Configurations" }, { "info": { "name": "All alerting configuration info", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alerts/infos", "params": [ { "name": "integrationId", "value": "hu6ynJbwgB4X1rjk", "type": "query", "description": "ID of a specific alert channel configuration." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all alert configurations that relate to the given alert channel." }, { "info": { "name": "Get Alert Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alerts/:id", "params": [ { "name": "id", "value": "iSjG7UWK3Dy6bDUc", "type": "path", "description": "ID of a specific Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a specific Alert Configuration by ID." }, { "info": { "name": "Create or update Alert Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alerts/:id", "params": [ { "name": "id", "value": "hu6ynJbwgB4X1rjk", "type": "path", "description": "ID of a specific Alert Configuration to create or update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create or update a specific Alert configuration by ID" }, { "info": { "name": "Delete Alert Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/alerts/:id", "params": [ { "name": "id", "value": "hu6ynJbwgB4X1rjkkw", "type": "path", "description": "ID of a specific Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete a specific Alert Configuration by ID" }, { "info": { "name": "Get All Global Custom Payload Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/custom-payload-configurations", "params": [ { "name": "context", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets All Global Custom Payload Configurations." }, { "info": { "name": "Create/Update Global Custom Payload Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/custom-payload-configurations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates or Updates Global Custom Payload Configuration." }, { "info": { "name": "Delete Custom Payload Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/custom-payload-configurations", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes a Global Custom Payload Configuration." }, { "info": { "name": "Get Tag Catalog for Custom Payload", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/custom-payload-configurations/catalog", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Custom payload tags used to filter, extract and aggregate specific data like AP calls for alert notifications. The catalog defines available tags like application.name and their types, and other attributes." }, { "info": { "name": "Create/Update Global Custom Payload Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/custom-payload-configurations/v2", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates or Updates Global Custom Payload Configuration." }, { "info": { "name": "All built-in event specification", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/built-in", "params": [ { "name": "ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all built-in event specifications" }, { "info": { "name": "Built-in event specifications", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/built-in/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Built-in event specifications" }, { "info": { "name": "Delete built-in event specification", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/built-in/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete built-in event specification" }, { "info": { "name": "Disable built-in event specification", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/built-in/:eventSpecificationId/disable", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disable built-in event specification" }, { "info": { "name": "Enable built-in event specification", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/built-in/:eventSpecificationId/enable", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable built-in event specification" }, { "info": { "name": "All custom event specifications", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": " This API helps in getting all the custom event specifications." }, { "info": { "name": "Create new custom event specification", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint creates a new Custom Event Specification.\n\n## Mandatory Parameters:\n\n- **name:** Name for the custom event\n\n- **entityType:** Name of the 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 t" }, { "info": { "name": "All system rules for custom event specifications", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/systemRules", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API helps to get all the system rules for custom event specifications." }, { "info": { "name": "Custom event specification", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "Yojfl6Yn9SXaFhJG", "type": "path", "description": "eventSpecificationId" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API helps to get the Custom Event specification for the given ID." }, { "info": { "name": "Create or update custom event specification", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" }, { "name": "allowRestore", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint creates or updates a Custom Event Specification.\n\n## Mandatory Parameters:\n\n- **eventSpecificationId (Path Parameter):** A unique identifier for each custom event\n\n- **name:** Name for the custom event\n\n- **entityType:** Name of the 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 " }, { "info": { "name": "Delete custom event specification", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/:eventSpecificationId", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint deletes a Custom Event Specification.\n\nBy default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid.\nHowever, check out the docs for [updating a configuration](#operation/putCustomEventSpecification) how this default behavior can be changed using the `allowRestore` query parameter.\n\n\n## Mandatory Parameters:\n\n- **eventSpecificationId (Path Parameter):** A unique identifier for the custom event specification to " }, { "info": { "name": "Disable custom event specification", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/:eventSpecificationId/disable", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disable custom event specification" }, { "info": { "name": "Enable custom event specification", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/custom/:eventSpecificationId/enable", "params": [ { "name": "eventSpecificationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable custom event specification" }, { "info": { "name": "Summary of all built-in and custom event specifications", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/infos", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API helps to get the summary of all build-in and custom event specifications" }, { "info": { "name": "All built-in and custom event specifications", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/event-specifications/infos", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Summary of all built-in and custom event specifications by IDs" }, { "info": { "name": "Manually closing multiple events", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/manual-close", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Manually close a set of events. A close notification will be sent out and the event state will be updated accordingly for each event" }, { "info": { "name": "Manually close an event.", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/manual-close/:eventId", "params": [ { "name": "eventId", "value": "exampleEventId", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Manually close an event (issue or incident). A close notification will be sent out and the event state will be updated accordingly." }, { "info": { "name": "Get all Mobile Smart Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs", "params": [ { "name": "mobileAppId", "value": "tk2OLeusR3aQJD5h-rBh2A", "type": "query", "description": "The ID of a specific Mobile Application." }, { "name": "alertIds", "value": "smRTFp08juKWtn8I", "type": "query", "description": "A list of Smart Alert Configuration IDs. This allows Website Smart Alert Configuration of a specific set of Configurations. This query can be repeated to use multiple IDs." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order." }, { "info": { "name": "Create Mobile Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new Mobile Smart Alert Configuration. " }, { "info": { "name": "Get Mobile Smart Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to retrieve" }, { "name": "validOn", "value": "1722877985000", "type": "query", "description": "A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific Mobile Smart Alert Configuration. This may return a deleted Configuration." }, { "info": { "name": "Update Mobile Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an existing Mobile Smart Alert Configuration. " }, { "info": { "name": "Delete Mobile Smart Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes a Mobile Smart Alert Configuration" }, { "info": { "name": "Disable Mobile Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id/disable", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to disable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables a Mobile Smart Alert Configuration." }, { "info": { "name": "Enable Mobile Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id/enable", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to enable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enables a Mobile Smart Alert Configuration." }, { "info": { "name": "Restore Mobile Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id/restore/:created", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to restore." }, { "name": "created", "value": "1707726529124", "type": "path", "description": "Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restores a Mobile Smart Alert Configuration." }, { "info": { "name": "Recalculate Mobile Smart Alert Config Baseline", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id/update-baseline", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to recalculate." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time." }, { "info": { "name": "Get Mobile Smart Alert Config Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/mobile-app-alert-configs/:id/versions", "params": [ { "name": "id", "value": "qOW5jlR5TQafXKWDIceRkA", "type": "path", "description": "ID of a specific Mobile Smart Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all versions of a Mobile Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order." }, { "info": { "name": "Get all Website Smart Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs", "params": [ { "name": "websiteId", "value": "XIZGGVT1TX2O-0OFeT2Yig", "type": "query", "description": "The ID of a specific Website" }, { "name": "alertIds", "value": "smRTFp08juKWtn8I", "type": "query", "description": "A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order." }, { "info": { "name": "Create Website Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new Website Smart Alert Configuration." }, { "info": { "name": "Get Website Smart Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to retrieve." }, { "name": "validOn", "value": "1722877985000", "type": "query", "description": "A Unix timestamp representing a specific time the config was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific Website Smart Alert Configuration. This may return a deleted Configuration." }, { "info": { "name": "Update Website Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an existing Website Smart Alert Configuration." }, { "info": { "name": "Delete Website Smart Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes a Website Smart Alert Configuration." }, { "info": { "name": "Disable Website Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id/disable", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to disable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables a Website Smart Alert Configuration." }, { "info": { "name": "Enable Website Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id/enable", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to enable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enables a website alert configuration." }, { "info": { "name": "Restore Website Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id/restore/:created", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to restore." }, { "name": "created", "value": "1707726529124", "type": "path", "description": "Unix timestamp representing the creation time of a specific Website Smart Alert Configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restores a deleted Website Smart Alert Configuration." }, { "info": { "name": "Recalculate Website Smart Alert Config Baseline", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id/update-baseline", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to recalculate." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time." }, { "info": { "name": "Get Website Smart Alert Config Versions. ", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/website-alert-configs/:id/versions", "params": [ { "name": "id", "value": "G-h5p0znTHan2m2U3c-Z1Q", "type": "path", "description": "ID of a specific Website Smart Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all versions of a Website Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order." } ] }, { "info": { "name": "Application Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get all Smart Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs", "params": [ { "name": "applicationId", "value": "IYS1XOEcTNiT1eOD8pxgXg", "type": "query", "description": "The ID of a specific Application." }, { "name": "alertIds", "value": "IYS1XOEcTNiT1eOD8pxgXg", "type": "query", "description": "A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all the Smart Alert Configurations pertaining to a specific application. Configurations are sorted by creation date in descending order.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Create Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Get Smart Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to retrieve." }, { "name": "validOn", "value": "1706617456952", "type": "query", "description": "A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific Smart Alert Configuration. This may return a deleted Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Update Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an existing Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Delete Smart Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes an Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Disable Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id/disable", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to disable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables an Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Enable Application Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id/enable", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to enable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enables an Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Restore Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id/restore/:created", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to restore." }, { "name": "created", "value": "1707726529124", "type": "path", "description": "Unix timestamp representing the creation time of a specific Smart Alert Configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restores a deleted Smart Alert Configuration.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Recalculate Smart Alert Config Baseline", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id/update-baseline", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to recalculate." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." }, { "info": { "name": "Get Smart Alert Config Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/application-alert-configs/:id/versions", "params": [ { "name": "id", "value": "DKp0JArJRAiQIav9CoKSWQ", "type": "path", "description": "ID of a specific Smart Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all versions of an Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order.\nFor more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration." } ] }, { "info": { "name": "Global Application Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get all Global Smart Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications", "params": [ { "name": "applicationId", "value": "j02SxMRTSf-NCBXf5IdsjQ", "type": "query", "description": "The ID of a specific global application." }, { "name": "alertIds", "value": "IYS1XOEcTNiT1eOD8pxgXg", "type": "query", "description": "A list of Global Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all Global Smart Alert Configuration. Configurations are sorted by creation date in descending order.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Create Global Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Get Global Smart Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to retrieve." }, { "name": "validOn", "value": "1707305626330", "type": "query", "description": "A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific Global Smart Alert Configuration. This may return a deleted Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Update Global Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an existing Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Delete Global Smart Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables a Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Disable Global Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id/disable", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to disable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables a Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Enable Global Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id/enable", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to enable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enables a Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Restore Global Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id/restore/:created", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to restore." }, { "name": "created", "value": "1707305626330", "type": "path", "description": "Unix timestamp representing the creation time of a specific Global Smart Alert Configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restores a deleted Global Smart Alert Configuration.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." }, { "info": { "name": "Get Global Smart Alert Config Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/applications/:id/versions", "params": [ { "name": "id", "value": "vlFnxhVTS3KVb-wsN26PeQ", "type": "path", "description": "ID of a specific Global Smart Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all versions of a Global Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order.\nFor more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." } ] }, { "info": { "name": "Log Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "All Log Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs", "params": [ { "name": "alertIds", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Configs are sorted descending by their created date." }, { "info": { "name": "Create Log Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create Log Alert Config" }, { "info": { "name": "Get Log Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "validOn", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find a Log Alert Config by ID. This will deliver deleted configs too." }, { "info": { "name": "Update Log Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update Log Alert Config" }, { "info": { "name": "Delete Log Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete Log Alert Config" }, { "info": { "name": "Disable Log Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id/disable", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disable Log Alert Config" }, { "info": { "name": "Enable Log Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id/enable", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable Log Alert Config" }, { "info": { "name": "Restore Log Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id/restore/:created", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "created", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restore Log Alert Config" }, { "info": { "name": "Get versions of Log Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/logs/:id/versions", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find all versions of a Log Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date." } ] }, { "info": { "name": "Service Levels Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "All Service levels Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels", "params": [ { "name": "sloId", "value": "SLOEANnWh9tQOa2h88kGxK6wQ", "type": "query", "description": "Service Levels Objective(SLO) Configuration ID" }, { "name": "alertIds", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "query", "description": "List of Service Levels Alert Configuration IDs" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Configs are sorted descending by their created date." }, { "info": { "name": "Create Service levels Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create Service levels Alert Config" }, { "info": { "name": "Get Service levels Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" }, { "name": "validOn", "value": "1706617456952", "type": "query", "description": "Service Levels Alert Version Creation Date" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find a Service levels Alert Config by ID. This will deliver deleted configs too." }, { "info": { "name": "Update Service levels Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update Service levels Alert Config" }, { "info": { "name": "Delete Service levels Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete Service levels Alert Config" }, { "info": { "name": "Disable Service levels Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id/disable", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disable Service levels Alert Config" }, { "info": { "name": "Enable Service levels Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id/enable", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable Service levels Alert Config" }, { "info": { "name": "Restore Service levels Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id/restore/:created", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" }, { "name": "created", "value": "1706617456952", "type": "path", "description": "Service Levels Alert Version Creation Date" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restore Service levels Alert Config" }, { "info": { "name": "Get versions of Service levels Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/service-levels/:id/versions", "params": [ { "name": "id", "value": "ln3IGogYS-S7CPqcOQYTNA", "type": "path", "description": "Service Levels Alert Configuration ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find all versions of a Service levels Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date." } ] }, { "info": { "name": "Synthetic Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get all Synthetic Smart Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics", "params": [ { "name": "syntheticTestId", "value": "ic25Vt1T5dgKzi0K7812", "type": "query", "description": "The ID of a specific Synthetic Test. " }, { "name": "alertIds", "value": "smRTFp08juKWtn8I", "type": "query", "description": "A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all the Synthetic Smart Alert Configuration pertaining to a specific synthetic test. Configurations are sorted by creation date in descending order.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Create Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a new Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Get Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id", "params": [ { "name": "id", "value": "qgEwvI0vRfe3Al_D7T7LSA", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to retrieve." }, { "name": "validOn", "value": "1707149760053", "type": "query", "description": "A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets a specific Synthetic Smart Alert Configuration. This may return a deleted Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Update Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id", "params": [ { "name": "id", "value": "qgEwvI0vRfe3Al_D7T7LSA", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates an existing Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Delete Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id", "params": [ { "name": "id", "value": "2K1YQIeaSQKIcIkHPH7D3g", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Deletes a Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Disable Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id/disable", "params": [ { "name": "id", "value": "2K1YQIeaSQKIcIkHPH7D3g", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to disable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disables a Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Enable Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id/enable", "params": [ { "name": "id", "value": "2K1YQIeaSQKIcIkHPH7D3g", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to enable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enables a Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Restore Synthetic Smart Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id/restore/:created", "params": [ { "name": "id", "value": "2K1YQIeaSQKIcIkHPH7D3g", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to restore." }, { "name": "created", "value": "1707726529124", "type": "path", "description": "Unix timestamp representing the creation time of a specific Synthetic Smart Alert Configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restores a deleted Synthetic Smart Alert Configuration.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." }, { "info": { "name": "Get Synthetic Smart Alert Config Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/global-alert-configs/synthetics/:id/versions", "params": [ { "name": "id", "value": "qgEwvI0vRfe3Al_D7T7LSA", "type": "path", "description": "ID of a specific Synthetic Smart Alert Configuration to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets all versions of a Synthetic Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order.\nFor more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration." } ] }, { "info": { "name": "Infrastructure Alert Configuration", "type": "folder" }, "items": [ { "info": { "name": "All Infra Alert Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs", "params": [ { "name": "alertIds", "value": "[4kxgJAXdSDiu6swQaKXrJw, ZLo28grvQaiMqIaikJK1RQ]", "type": "query", "description": "List of IDs of Infra Smart Alert configurations" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Configs are sorted descending by their created date." }, { "info": { "name": "Create Infra Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create Infra Alert Config" }, { "info": { "name": "Get Infra Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration" }, { "name": "validOn", "value": "1722877985000", "type": "query", "description": "A Unix timestamp representing a specific time the config was active. If no timestamp is provided, the latest active version will be retrieved. " } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find a Infra Alert Config by ID. This will deliver deleted configs too." }, { "info": { "name": "Update Infra Alert Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update Infra Alert Config" }, { "info": { "name": "Delete Infra Alert Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete Infra Alert Config" }, { "info": { "name": "Disable Infra Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id/disable", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration to disable" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Disable Infra Alert Config" }, { "info": { "name": "Enable Infra Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id/enable", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration to enable" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable Infra Alert Config" }, { "info": { "name": "Restore Infra Alert Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id/restore/:created", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration to restore" }, { "name": "created", "value": "1722877985000", "type": "path", "description": "A Unix Timestamp of when the alert was created" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Restore Infra Alert Config" }, { "info": { "name": "Get versions of Infra Alert Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/events/settings/infra-alert-configs/:id/versions", "params": [ { "name": "id", "value": "4kxgJAXdSDiu6swQaKXrJw", "type": "path", "description": "ID of the Infra Smart Alert configuration" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Find all versions of a Infra Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date." } ] }, { "info": { "name": "Host Agent", "type": "folder" }, "items": [ { "info": { "name": "Query host agent snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/host-agent", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "windowSize", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "offline", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Query host agent snapshots" }, { "info": { "name": "Update agent configuration by query", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/configuration", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "windowSize", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "offline", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint can be used to initialize or change configuration management settings for all agents selected by the given Dynamic Focus Query.\n\n" }, { "info": { "name": "Agent CLR download logs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:hostId/clr-logs", "params": [ { "name": "hostId", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Agent CLR download logs" }, { "info": { "name": "Update agent configuration by host", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:hostId/configuration", "params": [ { "name": "hostId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint can be used to initialize or change configuration management settings for a specific host agent.\n\n" }, { "info": { "name": "Agent download logs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:hostId/logs", "params": [ { "name": "hostId", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" }, { "name": "file", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Agent download logs" }, { "info": { "name": "Agent download support information", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:hostId/support-info", "params": [ { "name": "hostId", "value": "", "type": "path" }, { "name": "supportInfoId", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Agent download support information" }, { "info": { "name": "Agent update", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:hostId/update", "params": [ { "name": "hostId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Agent update" }, { "info": { "name": "Get host agent snapshot details", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/host-agent/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "to", "value": "", "type": "query" }, { "name": "windowSize", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get host agent snapshot details" } ] }, { "info": { "name": "Infrastructure Analyze", "type": "folder" }, "items": [ { "info": { "name": "Get infrastructure entities", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/analyze/entities", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves entities for a given entity type along with the requested metrics.\nFor more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze." }, { "info": { "name": "Get grouped infrastructure entities with aggregated metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/analyze/entity-groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint groups entities for a given entity type and aggregates metrics for these groups.\nFor more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze." }, { "info": { "name": "Get available entity types", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/analyze/entity-types", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves available entity types.\nFor more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze." }, { "info": { "name": "Get available metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/analyze/metrics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves available metrics for an entity type.\nFor more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze." } ] }, { "info": { "name": "Infrastructure Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get metric catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/metrics/:plugin", "params": [ { "name": "plugin", "value": "", "type": "path" }, { "name": "filter", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "Get payload keys for plugin", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/payloads/:pluginId", "params": [ { "name": "pluginId", "value": "db2Database", "type": "path", "description": "plugin id" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get payload keys for plugin" }, { "info": { "name": "Get plugin catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/plugins", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves all available plugin ids for your monitored system.\n" }, { "info": { "name": "Get all plugins with custom metrics catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/plugins-with-custom-metrics", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all plugins with custom metrics catalog" }, { "info": { "name": "get search field catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/search", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "Get available tags", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/tags", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves the tag catalog." }, { "info": { "name": "Get available tags for a particular plugin", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/catalog/tags/:plugin", "params": [ { "name": "plugin", "value": "host", "type": "path", "description": "plugin" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves the tag catalog filtered by plugin." } ] }, { "info": { "name": "Infrastructure Topology", "type": "folder" }, "items": [ { "info": { "name": "Related hosts", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/graph/related-hosts/:snapshotId", "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "Snapshot ID running on the host" }, { "name": "windowSize", "value": "", "type": "query", "description": "Size of time window in milliseconds" }, { "name": "to", "value": "", "type": "query", "description": "Timestamp since Unix Epoch in milliseconds of the end of the time window" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets the Related Hosts" }, { "info": { "name": "Gets the infrastructure topology", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/topology", "params": [ { "name": "includeData", "value": "", "type": "query", "description": "Include snapshot data in nodes" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets the infrastructure topology" } ] }, { "info": { "name": "Infrastructure Metrics", "type": "folder" }, "items": [ { "info": { "name": "Get infrastructure metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/metrics", "params": [ { "name": "offline", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "- 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" } ] }, { "info": { "name": "Infrastructure Resources", "type": "folder" }, "items": [ { "info": { "name": "Monitored host count", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/monitoring-state", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API endpoint retrieves the current monitoring state of the system, providing details about the number of monitored hosts and serverless entities. It responds with a JSON object containing this information." }, { "info": { "name": "Get a payload for a snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/payloads/:snapshotId/:payloadKey", "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "Snapshot id." }, { "name": "payloadKey", "value": "topqueries", "type": "path", "description": "Payload key. Use [getAvailablePayloadKeysByPluginId](/openapi/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys." }, { "name": "to", "value": "1689018652000", "type": "query", "description": "End of timeframe expressed as the Unix epoch time in milliseconds." }, { "name": "windowSize", "value": "3600000", "type": "query", "description": "Window size in milliseconds." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a payload for a snapshot" }, { "info": { "name": "Search snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/snapshots", "params": [ { "name": "query", "value": "entity.zone:myZone*", "type": "query", "description": "query to use to filter snapshot retrieval" }, { "name": "to", "value": "1689018652000", "type": "query", "description": "end of timeframe expressed as the Unix epoch time in milliseconds" }, { "name": "windowSize", "value": "3600000", "type": "query", "description": "windowSize in milliseconds" }, { "name": "size", "value": "100", "type": "query", "description": "maximum number of snapshots to retrieve" }, { "name": "plugin", "value": "host", "type": "query", "description": "entity type" }, { "name": "offline", "value": "false", "type": "query", "description": "retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "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 acti" }, { "info": { "name": "Get snapshot details for multiple snapshots", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/snapshots", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified." }, { "info": { "name": "Get snapshot details", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/snapshots/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "snapshot id" }, { "name": "to", "value": "1689018652000", "type": "query", "description": "end of timeframe expressed as the Unix epoch time in milliseconds" }, { "name": "windowSize", "value": "3600000", "type": "query", "description": "windowSize in milliseconds" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all snapshot information" }, { "info": { "name": "Get installed software", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/infrastructure-monitoring/software/versions", "params": [ { "name": "time", "value": "", "type": "query", "description": "Timeframe expressed as the Unix epoch time in milliseconds" }, { "name": "discoveryType", "value": "NATIVE_SENSOR", "type": "query", "description": "Filter on discoveryType" }, { "name": "softwareType", "value": "DEPENDENCY", "type": "query", "description": "Filter on softwareType" }, { "name": "name", "value": "", "type": "query", "description": "Filter on this software name" }, { "name": "plugin", "value": "", "type": "query", "description": "Filter on this plugin" }, { "name": "version", "value": "", "type": "query", "description": "Filter on this version" }, { "name": "vendor", "value": "", "type": "query", "description": "Filter on this vendor" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information.\n\nThe `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set.\nThe `snapshotId` in `usedBy` is either of host or container, if available" } ] }, { "info": { "name": "Health", "type": "folder" }, "items": [ { "info": { "name": "Basic health traffic light", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/health", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "API version information", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/version", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API version information" } ] }, { "info": { "name": "Usage", "type": "folder" }, "items": [ { "info": { "name": "API usage by customer", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/usage/api", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API usage by customer" }, { "info": { "name": "API usage day / month / year", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/usage/api/:day/:month/:year", "params": [ { "name": "day", "value": "", "type": "path" }, { "name": "month", "value": "", "type": "path" }, { "name": "year", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API usage day / month / year" }, { "info": { "name": "API usage month / year", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/usage/api/:month/:year", "params": [ { "name": "month", "value": "", "type": "path" }, { "name": "year", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API usage month / year" }, { "info": { "name": "Host count day / month / year", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/usage/hosts/:day/:month/:year", "params": [ { "name": "day", "value": "", "type": "path" }, { "name": "month", "value": "", "type": "path" }, { "name": "year", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Host count day / month / year" }, { "info": { "name": "Host count month / year", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/instana/usage/hosts/:month/:year", "params": [ { "name": "month", "value": "", "type": "path" }, { "name": "year", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Host count month / year" } ] }, { "info": { "name": "AI Management", "type": "folder" }, "items": [ { "info": { "name": "Get all LLM capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/llm/capabilities", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all available LLM capabilities." }, { "info": { "name": "Get all LLM gateways", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler", "params": [ { "name": "enabled", "value": "", "type": "query", "description": "Filter by enabled status (true/false)" }, { "name": "capability", "value": "", "type": "query", "description": "Filter by capability name" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all LLM gateways. Optionally filter by enabled status or capability." }, { "info": { "name": "Create a new LLM gateway", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a new LLM gateway" }, { "info": { "name": "Get a LLM gateway by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "LLM gateway ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a LLM gateway by ID." }, { "info": { "name": "Update an existing LLM gateway.", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "LLM gateway ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an existing LLM gateway by ID." }, { "info": { "name": "Delete a LLM egress gateway", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "LLM gateway ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete a LLM egress gateway by ID." }, { "info": { "name": "Set the enabled status of a LLM gateway", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/llm/egress/handler/:id/enable", "params": [ { "name": "id", "value": "", "type": "path", "description": "LLM gateway ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Enable a LLM gateway by ID. Any other enabled gateway for the same capability will be automatically disabled." } ] }, { "info": { "name": "Logging Analyze", "type": "folder" }, "items": [ { "info": { "name": "Get Log Volume Usage", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/logging/logs/getLogVolumeUsage", "params": [ { "name": "fromTs", "value": "1682899200", "type": "query", "description": "Start timestamp in seconds. Must be <= `toTs`." }, { "name": "toTs", "value": "1682899201", "type": "query", "description": "End timestamp in seconds. Must be >= `fromTs`." }, { "name": "groupingTag", "value": "zone", "type": "query", "description": "Optional tag to group volume usage by. Valid groupingTag values are:\n`kubernetes_cluster_name`, `kubernetes_daemonset_name`, `kubernetes_namespace_name`,\n`kubernetes_deployment_name`, `host_name`, `zone`.\n" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns aggregated log volume usage data for a specified time range and optional grouping tag.\n`fromTs` and `toTs` are required and must define a valid time range (i.e., `fromTs` <= `toTs`).\nRefer to the query parameter description for valid `groupingTag` values.\n" } ] }, { "info": { "name": "Mobile App Analyze", "type": "folder" }, "items": [ { "info": { "name": "Get grouped beacon metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/analyze/beacon-groups", "params": [ { "name": "fillTimeSeries", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get grouped mobile app beacon metrics." }, { "info": { "name": "Get all beacons", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/analyze/beacons", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get all mobile app beacons with matching type." } ] }, { "info": { "name": "Mobile App Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get mobile app tag catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/catalog", "params": [ { "name": "beaconType", "value": "", "type": "query" }, { "name": "useCase", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get mobile app tag catalog" }, { "info": { "name": "Metric catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/catalog/metrics", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Metric catalog" }, { "info": { "name": "Get all existing mobile app tags", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/catalog/tags", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all existing mobile app tags" } ] }, { "info": { "name": "Mobile App Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get configured mobile apps", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get configured mobile apps." }, { "info": { "name": "Configure new mobile app", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name of the mobile app" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to add new mobile app." }, { "info": { "name": "Get mobile app configuration by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get a specific mobile app configuration by ID." }, { "info": { "name": "Rename mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "name", "value": "", "type": "query", "description": "New name of the mobile app" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to rename mobile app." }, { "info": { "name": "Remove mobile app", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to remove mobile app." }, { "info": { "name": "Get geo location configuration for mobile app", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/geo-location", "params": [ { "name": "mobileAppId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get geo location configuration for mobile app." }, { "info": { "name": "Update geo location configuration for mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/geo-location", "params": [ { "name": "mobileAppId", "value": "iiLxP1zaTuCS7fyk9m4W0W", "type": "path", "description": "Mobile App ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to update geo location configuration for mobile app." }, { "info": { "name": "Get custom geo mapping rules for mobile app", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/geo-mapping-rules", "params": [ { "name": "mobileAppId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get custom geo mapping rules for mobile app." }, { "info": { "name": "Set custom geo mapping rules for mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/geo-mapping-rules", "params": [ { "name": "mobileAppId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to set custom geo mapping rules for mobile app." }, { "info": { "name": "Get IP masking configuration for mobile app", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/ip-masking", "params": [ { "name": "mobileAppId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get IP masking configuration for mobile app." }, { "info": { "name": "Update IP masking configuration for mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/ip-masking", "params": [ { "name": "mobileAppId", "value": "iiLxP1zaTuCS7fyk9m4W0W", "type": "path", "description": "Mobile App ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to update IP masking configuration for mobile app." }, { "info": { "name": "Get all sourcemap configurations for mobile app", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get all sourcemap configurations for mobile app." }, { "info": { "name": "Add new sourcemap configuration for mobile app", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to add sourcemap configuration for mobile app." }, { "info": { "name": "Get sourcemap configuration for mobile app", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload/:sourceMapConfigId", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "sourceMapConfigId", "value": "97e0ad312110d3ad", "type": "path", "description": "Source Map Config ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get sourcemap configuration for mobile app." }, { "info": { "name": "Delete sourcemap configuration for mobile app", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload/:sourceMapConfigId", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "sourceMapConfigId", "value": "97e0ad312110d3ad", "type": "path", "description": "Source Map Config ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to delete sourcemap configuration for mobile app." }, { "info": { "name": "Clear sourcemap files for sourcemap upload configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload/:sourceMapConfigId/clear", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "sourceMapConfigId", "value": "97e0ad312110d3ad", "type": "path", "description": "Source Map Config ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to clear sourcemap files of a configuration for mobile app." }, { "info": { "name": "Commit sourcemap file upload for mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload/:sourceMapConfigId/commit", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "sourceMapConfigId", "value": "97e0ad312110d3ad", "type": "path", "description": "Source Map Config ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "fileId", "type": "text", "value": "" }, { "name": "fileType", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to commit sourcemap file upload for mobile app." }, { "info": { "name": "Upload sourcemap file for mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/sourcemap-upload/:sourceMapConfigId/form", "params": [ { "name": "mobileAppId", "value": "K3bP-bmCRkyimNai9vvq8o", "type": "path", "description": "Mobile App ID" }, { "name": "sourceMapConfigId", "value": "97e0ad312110d3ad", "type": "path", "description": "Source Map Config ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "blobIndex", "type": "text", "value": "" }, { "name": "fileFormat", "type": "text", "value": "" }, { "name": "fileId", "type": "text", "value": "" }, { "name": "fileType", "type": "text", "value": "" }, { "name": "sourceMap", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to upload sourcemap file for mobile app." }, { "info": { "name": "Update teams assigned to the mobile app", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/config/:mobileAppId/teams", "params": [ { "name": "mobileAppId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to update teams of a mobile app." } ] }, { "info": { "name": "Mobile App Metrics", "type": "folder" }, "items": [ { "info": { "name": "Get mobile app beacon metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/metrics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get mobile app monitoring beacon metrics." }, { "info": { "name": "Get mobile app session", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/session:id:timestamp", "params": [ { "name": "id", "value": "9CA9E31D-B0F7-40EC-8D32-FE163A6557AE", "type": "path", "description": "Identifier of the session to be retrieved" }, { "name": "timestamp", "value": "1730595029980", "type": "path", "description": "Timestamp of the session to be retrieved" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get a mobile app monitoring session." }, { "info": { "name": "Get beacon metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/mobile-app-monitoring/v2/metrics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to get mobile app monitoring beacon metrics." } ] }, { "info": { "name": "Releases", "type": "folder" }, "items": [ { "info": { "name": "Get all releases", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/releases", "params": [ { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to retrieve a list of all releases." }, { "info": { "name": "Create release", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/releases", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to create a release. Release can be created with four different scopes: \n\n1. Global\n - Release marker is shown on all dashboard pages for Application perspectives, Services, and Endpoints.\n\n2. Application Perspective\n - Release marker is shown on the dashboard for the Application perspective.\n\n3. Service\n - Release marker is shown on the dashboards for the Service and all Application perspective dashboards that contain the Service.\n\n4. Service within an Application" }, { "info": { "name": "Get release", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/releases/:releaseId", "params": [ { "name": "releaseId", "value": "XK1e1TF3T9SHKugndn_soQ", "type": "path", "description": "The unique release id which one wants to retrieve." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to retrieve a particular release." }, { "info": { "name": "Update release", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/releases/:releaseId", "params": [ { "name": "releaseId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to update a release." }, { "info": { "name": "Delete release", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/releases/:releaseId", "params": [ { "name": "releaseId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to delete a release." } ] }, { "info": { "name": "Audit Log", "type": "folder" }, "items": [ { "info": { "name": "Access log", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/accesslog", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "The offset within the result set" }, { "name": "query", "value": "username@example", "type": "query", "description": "The query to filter the results" }, { "name": "pageSize", "value": "10", "type": "query", "description": "The size of returned page" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all access logs using defined query." }, { "info": { "name": "Audit log", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/auditlog", "params": [ { "name": "offset", "value": "0", "type": "query", "description": "The offset within the result set" }, { "name": "query", "value": "username@example.com", "type": "query", "description": "The query to filter the results" }, { "name": "pageSize", "value": "10", "type": "query", "description": "The size of returned page" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all audit logs using defined query." } ] }, { "info": { "name": "Apdex Settings", "type": "folder" }, "items": [ { "info": { "name": "Get All Apdex Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/apdex", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API to Get All Apdex Configurations." }, { "info": { "name": "Create Apdex Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/apdex", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create Apdex Configuration" }, { "info": { "name": "Get all Apdex configurations for entity type and entity id", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/apdex/:entityType/:entityId", "params": [ { "name": "entityType", "value": "APPLICATION", "type": "path", "description": "Type of the Apdex Configuration, it could be APPLICATION or WEBSITE" }, { "name": "entityId", "value": "XIZGGVT1TX2O-0OFeT2Yig", "type": "path", "description": "Application or Website ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API to Get All Apdex Configurations for specified entity type and entity id." }, { "info": { "name": "Get Apdex Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/apdex/:id", "params": [ { "name": "id", "value": "NCAoNKqySWSK1U5GkmyZgQ", "type": "path", "description": "Apdex Configuration ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API to Get Apdex Configuration for specified ID." }, { "info": { "name": "Delete Apdex Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/apdex/:id", "params": [ { "name": "id", "value": "NCAoNKqySWSK1U5GkmyZgQ", "type": "path", "description": "Apdex Configuration ID" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete Apdex Configuration" } ] }, { "info": { "name": "API Token", "type": "folder" }, "items": [ { "info": { "name": "Get all API Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/api-tokens", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get the list of API Tokens for this Tenant-Unit\nFor more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken." }, { "info": { "name": "Create an API token", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/api-tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create an API Token on the Tenant-Unit. Each API Token entry also contains a set of permissions\nFor more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken." }, { "info": { "name": "Get API token", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/api-tokens/:internalId", "params": [ { "name": "internalId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns API Token details, including the set of permissions\nFor more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken." }, { "info": { "name": "Create or update an API token", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/api-tokens/:internalId", "params": [ { "name": "internalId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update API Token- Change Token name and associated permissions\nFor more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken." }, { "info": { "name": "Delete API token", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/api-tokens/:internalId", "params": [ { "name": "internalId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the Api Token\nFor more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken." } ] }, { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "Delete Google SSO configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/authentication/googleSSO", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the corresponding tenants Google SSO configuration." }, { "info": { "name": "Delete LDAP configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/authentication/ldap", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the corresponding tenants LDAP configuration." }, { "info": { "name": "Delete OIDC configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/authentication/oidc", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the corresponding tenants OIDC configuration." }, { "info": { "name": "Delete SAML configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/authentication/saml", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the corresponding tenants SAML configuration." } ] }, { "info": { "name": "SLO Correction Configurations", "type": "folder" }, "items": [ { "info": { "name": "Get All SLO Correction Window Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/correction", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "sloId", "value": "", "type": "query" }, { "name": "refresh", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get All SLO Correction Window Configs" }, { "info": { "name": "Create a new SLO Correction Window Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/correction", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a new SLO Correction Window Config" }, { "info": { "name": "Get an existing SLO Correction Window Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/correction/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "refresh", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get an existing SLO Correction Window Config" }, { "info": { "name": "Update an existing SLO Correction Window Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/correction/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an existing SLO Correction Window Config" }, { "info": { "name": "Delete an existing SLO Correction Window Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/correction/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete an existing SLO Correction Window Configuration" } ] }, { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Send user invitations", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/invitation/share", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API endpoint allows to invite users to this tenant. \nEach user requires the email address and the group to which the user will be added initially. \n\nInviting users whilst an IdP is configured will always result in failures, as in this case users will be provisioned during the login based on the IdP configuration. \nDuring the IdP configurations all pending invitations are automatically revoked.\n\nInviting users who are already members of the tenant will also provide an error result. " }, { "info": { "name": "All pending invitations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/invitations", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API endpoint retrieves the list of all pending invitations. \nDuring the IdP configuration all pending invitations will be dismissed and whilst an IdP is configured invitations are prevented. " }, { "info": { "name": "Send user invitations", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/invitations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API endpoint allows to invite users to this tenant. \nEach user requires the email address and the group to which the user will be added initially. \n\nInviting users whilst an IdP is configured will always result in failures, as in this case users will be provisioned during the login based on the IdP configuration. \nDuring the IdP configurations all pending invitations are automatically revoked.\n\nInviting users who are already members of the tenant will also provide an error result. " }, { "info": { "name": "Revoke pending invitation", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/invitations", "params": [ { "name": "email", "value": "username@example.com", "type": "query", "description": "Email of the invite for removal" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This API endpoint allows to delete an invitation, requires the users’ email as a Query parameter.\n" }, { "info": { "name": "All users (without invitations)", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/users", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieves all users with access to the tenant. The result will not contain pending invitations." }, { "info": { "name": "Remove users from tenant", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/users/delete", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove multiple users access to the tenant. Removing a user from a tenant does not delete their user account." }, { "info": { "name": "All users (incl. invitations)", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/users/overview", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieves all users with access to the tenant. The result will also contain pending invitations." }, { "info": { "name": "Change user name of single user", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/users/:email", "params": [ { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Updates the full name of the user." }, { "info": { "name": "Get single user", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/users/:userId", "params": [ { "name": "userId", "value": "userId", "type": "path", "description": "Id of the user for retrieval" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieves the user with access to the tenant." }, { "info": { "name": "Remove user from tenant", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/users/:userId", "params": [ { "name": "userId", "value": "userId", "type": "path", "description": "Id of the user for removal" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove the users access to the tenant. Removing a user from a tenant does not delete their user account." } ] }, { "info": { "name": "Maintenance Configuration", "type": "folder" }, "items": [ { "info": { "name": "All maintenance configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/maintenance", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations." }, { "info": { "name": "Maintenance configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/maintenance/:id", "params": [ { "name": "id", "value": "MPhKWoXRp0PBelqk", "type": "path", "description": "ID of the Maintenance Window Configuration to get." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations." }, { "info": { "name": "Create or update maintenance configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/maintenance/:id", "params": [ { "name": "id", "value": "MPhKWoXRp0PBelqk", "type": "path", "description": "ID of the Maintenance Window Configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations." }, { "info": { "name": "Delete maintenance configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/maintenance/:id", "params": [ { "name": "id", "value": "MPhKWoXRp0PBelqk", "type": "path", "description": "ID of the Maintenance Window Configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "\nFor more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations." }, { "info": { "name": "All maintenance configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves all available maintenance configurations. " }, { "info": { "name": "Get maintenance configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance/:id", "params": [ { "name": "id", "value": "8924aa6b", "type": "path", "description": "Id of the Maintenance Window Configuration to get." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a maintenance configuration given its ID.\n\n### Path Parameters:\n\n- **id:** The ID of the maintenance config to fetch." }, { "info": { "name": "Create or update maintenance configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance/:id", "params": [ { "name": "id", "value": "8924aa6b", "type": "path", "description": "Id of the Maintenance Window configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint creates or updates a maintenance configuration given its ID.\n\n### Path Parameters:\n\n- **id:** The ID of the maintenance config to create or update.\n\n### Maintenance Configuration Input\nThis is a description for the fields in the request body:\n\n**id**: maintenance configuration unique id \n**name**: maintenance configuration name \n**query**: dynamic focus query used to filter alert notifications that will be muted \n**scheduling**: defines when the maintenance configuration will be" }, { "info": { "name": "Delete maintenance configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance/:id", "params": [ { "name": "id", "value": "8924aa6b", "type": "path", "description": "Id of the Maintenance Window configuration to delete." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint deletes a maintenance configuration given its ID.\n\n### Path Parameters:\n\n- **id:** The ID of the maintenance config to delete." }, { "info": { "name": "Pause maintenance configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance/:id/pause", "params": [ { "name": "id", "value": "8924aa6b", "type": "path", "description": "Id of the Maintenance Window configuration to pause." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint pauses a maintenance configuration given its ID.\n\nWhen you pause a maintenance configuration, you will start receiving alerts again for the scope defined in the maintenance configuration.\n### Path Parameters:\n\n- **id:** The ID of the maintenance config to pause.\n" }, { "info": { "name": "Resume maintenance configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/maintenance/:id/resume", "params": [ { "name": "id", "value": "8924aa6b", "type": "path", "description": "Id of the Maintenance Window configuration to resume." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint resumes a maintenance configuration given its ID.\n\nIf the maintenance configuration becomes active when you resume the maintenance configuration, you will not receive alerts for the scope defined in the maintenance configuration.\n### Path Parameters:\n\n- **id:** The ID of the maintenance config to resume.\n" } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Get groups", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve the list of all groups on the tenant together with the `Permission Set` for the tenant unit.\n\nThe `Permission Set` object contains a set of permissions applied to the group.\n\nIn case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area.\n\nThe areas are included inside the `permissionSet`.\n\nThe scopeRoleId is a fixed value for each area type:\n\n| Area | value |\n| ----------------------- | -----" }, { "info": { "name": "Create group", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a group on the tenant. Each group entry also needs a `Permission Set` per unit.\n\nThe `Permission Set` object contains a set of permissions applied to the group.\n\nIn case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area.\n\nPossible access permissions values are:\n\n- `ACCESS_APPLICATIONS`\n- `ACCESS_INFRASTRUCTURE`\n- `ACCESS_KUBERNETES`\n- `ACCESS_MOBILE_APPS`\n- `ACCESS_WEBSITES`\n- `LIMITED_APPLICATIONS_SCOPE`\n- `LIMITED" }, { "info": { "name": "Delete groups", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete multiple groups\nFor more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups." }, { "info": { "name": "Get groups of a single user", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/user/:email", "params": [ { "name": "email", "value": "username@example.com", "type": "path", "description": "Email of the user for retrieval" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns a list of all groups a user belongs to. This includes data from these groups, the `members`, the `name` and the `Permission set`." }, { "info": { "name": "Add permissions to group", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:groupId/permissions", "params": [ { "name": "groupId", "value": "groupId", "type": "path", "description": "Id of the group to add permissions" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests.\n\nExamples of `Permissions`:\n\n- `ACCESS_APPLICATIONS`\n- `ACCESS_INFRASTRUCTURE`\n- `ACCESS_KUBERNETES`\n- `ACCESS_MOBILE_APPS`\n- `ACCESS_WEBSITES`\n- `CAN_CONFIGURE_AGENT_RUN_MODE`\n- `CAN_CONFIGURE_AGENTS`\n- `CAN_CONFIGURE_API_TOKENS`\n- `CAN_CONFIGURE_APPLICATIONS`\n- `CAN_CONFIGURE_AUTHENTICATION_METHODS`\n- `CAN_CONFIGURE_CUSTOM_ALERTS`\n- `CAN_CONFIGURE_EUM_APPLICATIONS`\n-" }, { "info": { "name": "Add users to group", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:groupId/users", "params": [ { "name": "groupId", "value": "groupId", "type": "path", "description": "Id of the group to add users" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Add one or more users to a group. The array contains the ids of the users to be added." }, { "info": { "name": "Get group", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:id", "params": [ { "name": "id", "value": "groupId", "type": "path", "description": "Id of the group for retrieval" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details." }, { "info": { "name": "Update group", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:id", "params": [ { "name": "id", "value": "groupId", "type": "path", "description": "Id of the group to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests.\n\nExamples of `Permissions`:\n\n- `ACCESS_APPLICATIONS`\n- `ACCESS_INFRASTRUCTURE`\n- `ACCESS_KUBERNETES`\n- `ACCESS_MOBILE_APPS`\n- `ACCESS_WEBSITES`\n- `CAN_CONFIGURE_AGENT_RUN_MODE`\n- `CAN_CONFIGURE_AGENTS`\n- `CAN_CONFIGURE_API_TOKENS`\n- `CAN_CONFIGURE_APPLICATIONS`\n- `CAN_CONFIGURE_AUTHENTICATION_METHODS`\n- `CAN_CONFIGURE_CUSTOM_ALERTS`\n- `CAN_CONFIGURE_EUM_APPLICATIONS`\n-" }, { "info": { "name": "Delete group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:id", "params": [ { "name": "id", "value": "groupId", "type": "path", "description": "Id of the group to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the group data.\nFor more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups." }, { "info": { "name": "Remove user from group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/groups/:id/user/:userId", "params": [ { "name": "id", "value": "groupId", "type": "path", "description": "Id of the group to remove user from" }, { "name": "userId", "value": "userId", "type": "path", "description": "Id of the user to remove" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove the user from a group.\nFor more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups." }, { "info": { "name": "Get all group mappings", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "If mappings between groups on the identity provider (LDAP, OIDC, SAML) and Instana groups where configured, this will return a list of those mappings.\n\nThis can be configured through the [api](#operation/createGroupMapping) or on Instana graphical user interface at Settings > Authentication > IDENTITY PROVIDERS > Group Mapping." }, { "info": { "name": "Create group mapping", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Creates a mapping between a group from the IdP (LDAP, OIDC, SAML) and an Instana group.\n\nIf the IdP is configured and mappings are enabled, the `key` `value` pairs a user sent by the idp will be evaluated every time this user logs in.\n\nIf they match the mapping, the user will be assigned to the group corresponding to the `groupId`.\n\nInside the payload, the `id` for the mapping is ignored, and instead, Instana generates a new id." }, { "info": { "name": "Delete multiple group mappings", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete multiple group mappings" }, { "info": { "name": "Check user restrictions for empty Idp group mapping", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Returns `RestrictEmptyIdpGroups` value indicating if access is denied for empty Idp group mapping. `RestrictEmptyIdpGroups = true` indicates that the tenant is locked and only those users are allowed access that have at least one working mapping rule applied to them during the login process." }, { "info": { "name": "Allow/Restrict users with empty Idp group mapping", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details." }, { "info": { "name": "Get all group mappings overview", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/overview", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all group mappings overview" }, { "info": { "name": "Get group mapping", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get group mapping" }, { "info": { "name": "Update group mapping", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/:id", "params": [ { "name": "id", "value": "mappingId", "type": "path", "description": "Id of the group mapping to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "See [creating group mapping](#operation/createGroupMapping)" }, { "info": { "name": "Delete group mapping", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/mappings/:id", "params": [ { "name": "id", "value": "mappingId", "type": "path", "description": "Id of the group mapping to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete group mapping" } ] }, { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "Get all roles", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/roles", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all roles for the current tenant unit." }, { "info": { "name": "Create role", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/roles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a new role." }, { "info": { "name": "Get role by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/roles/:id", "params": [ { "name": "id", "value": "roleId", "type": "path", "description": "Id of the role for retrieval" }, { "name": "includeTeamUsage", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a specific role by its ID." }, { "info": { "name": "Update role", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/roles/:id", "params": [ { "name": "id", "value": "roleId", "type": "path", "description": "Id of the role to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an existing role by ID." }, { "info": { "name": "Delete role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/roles/:id", "params": [ { "name": "id", "value": "roleId", "type": "path", "description": "Id of the role to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete a role by ID." } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Get all teams", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/teams", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve all user teams for the current tenant unit." }, { "info": { "name": "Create team", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/teams", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a new team." }, { "info": { "name": "Get team by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/teams/:id", "params": [ { "name": "id", "value": "teamId", "type": "path", "description": "Id of the team for retrieval" }, { "name": "includeTeamUsage", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a specific team by its ID." }, { "info": { "name": "Update team", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/teams/:id", "params": [ { "name": "id", "value": "teamId", "type": "path", "description": "Id of the team to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an existing team by ID." }, { "info": { "name": "Delete team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/rbac/teams/:id", "params": [ { "name": "id", "value": "teamId", "type": "path", "description": "Id of the team to delete" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete the team data." } ] }, { "info": { "name": "Session Settings", "type": "folder" }, "items": [ { "info": { "name": "Get session settings", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/session", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get the tenant unit session settings" }, { "info": { "name": "Configure session settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/session", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update individual tenant unit session settings." }, { "info": { "name": "Delete session settings", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/session", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete tenant unit session settings." } ] }, { "info": { "name": "SLI Settings", "type": "folder" }, "items": [ { "info": { "name": "Get All SLI Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/sli", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get All SLI Configs" }, { "info": { "name": "Create SLI Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/sli", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint creates the Service Level Indicator Configuration\n\n## Mandatory Parameters:\n\n- **id** A unique identifier for each SLI configuration\n\n- **sliName:** Name for the SLI configuration\n\n- **sliEntity:** Entity of the SLI configuration\n\n### SLI Entity specific parameters\n\nDepending on the chosen `sliType` in the `sliEntity`, there are further required parameters:\n\n#### Application SLI entity\n\nThis option can be used to create a Time-Based SLI\n\n- **sliEntity.applicationId:** The Id of the" }, { "info": { "name": "Get SLI Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/sli/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get SLI Config" }, { "info": { "name": "Update SLI Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/sli/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update SLI Config" }, { "info": { "name": "Delete SLI Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/sli/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete SLI Config" }, { "info": { "name": "Get All SLI Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/sli", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get All SLI Configs" }, { "info": { "name": "Create SLI Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/sli", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint creates the Service Level Indicator Configuration\n\n## Mandatory Parameters:\n\n- **id** A unique identifier for each SLI configuration\n\n- **sliName:** Name for the SLI configuration\n\n- **sliEntity:** Entity of the SLI configuration\n\n### SLI Entity specific parameters\n\nDepending on the chosen `sliType` in the `sliEntity`, there are further required parameters:\n\n#### Application SLI entity\n\nThis option can be used to create a Time-Based SLI\n\n- **sliEntity.applicationId:** The Id of the" }, { "info": { "name": "Get all SLI configs for entity type and entity id", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/sli/:entityType/:entityId", "params": [ { "name": "entityType", "value": "", "type": "path", "description": "Type of the Entity, whether it is an application or website" }, { "name": "entityId", "value": "DkPX-x9VQuKBKopuilrkYw", "type": "path", "description": "Unique ID of the Entity" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get all SLI configs for entity type and entity id" }, { "info": { "name": "Get SLI Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/sli/:id", "params": [ { "name": "id", "value": "HXcNRWhDSWiZs3HiUAKr7g", "type": "path", "description": "ID of the Service Level Indicator (SLI)" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get SLI Config" }, { "info": { "name": "Delete SLI Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/v2/sli/:id", "params": [ { "name": "id", "value": "HXcNRWhDSWiZs3HiUAKr7g", "type": "path", "description": "ID of the Service Level Indicator (SLI)" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete SLI Config" } ] }, { "info": { "name": "Service Levels Objective(SLO) Configurations", "type": "folder" }, "items": [ { "info": { "name": "Get All SLO Configs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "entityType", "value": "", "type": "query" }, { "name": "blueprint", "value": "", "type": "query" }, { "name": "sloIds", "value": "", "type": "query" }, { "name": "sloStatus", "value": "", "type": "query" }, { "name": "entityIds", "value": "", "type": "query" }, { "name": "grouped", "value": "", "type": "query" }, { "name": "refresh", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get All SLO Configs" }, { "info": { "name": "Create a new SLO Config", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a new SLO Config" }, { "info": { "name": "Get All SLO Config tags", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo/tags", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "entityType", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get All SLO Config tags" }, { "info": { "name": "Get an existing SLO Config", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "refresh", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get an existing SLO Config" }, { "info": { "name": "Update an existing SLO Config", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an existing SLO Config" }, { "info": { "name": "Delete an existing SLO Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/slo/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Delete an existing SLO Config" } ] }, { "info": { "name": "Synthetic Calls", "type": "folder" }, "items": [ { "info": { "name": "Synthetic call configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/settings/synthetic-calls", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to get all custom synthetic call configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and e" }, { "info": { "name": "Update synthetic call configurations", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/settings/synthetic-calls", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to get all custom synthetic call configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules and e" }, { "info": { "name": "Delete synthetic call configurations", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/settings/synthetic-calls", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Use this API endpoint if one wants to delete all custom synthetic call configurations.\nThis endpoint requires `CanConfigureServiceMapping` permission.\nOne can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`.\nIf one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token.\nThere one can update the existing token or create a new token and set `Customize service rules an" } ] }, { "info": { "name": "SLI Report", "type": "folder" }, "items": [ { "info": { "name": "Generate SLI report (Limitation: the Classic Edition API report can be available one hour after the SLI configuration created; other editions are around one minute.)", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/sli/report/:sliId", "params": [ { "name": "sliId", "value": "nCtEoR6NSPqG61QkIkwwCw", "type": "path", "description": "ID of the Service Level Indicator (SLI)" }, { "name": "slo", "value": "0.99", "type": "query", "description": "Target SLO" }, { "name": "from", "value": "1706713140000", "type": "query", "description": "From Timestamp in milliseconds (13-digit)" }, { "name": "to", "value": "1706713140000", "type": "query", "description": "To Timestamp in milliseconds (13-digit)" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Generate SLI report (Limitation: the Classic Edition API report can be available one hour after the SLI configuration created; other editions are around one minute.)" } ] }, { "info": { "name": "SLO Correction Windows", "type": "folder" }, "items": [ { "info": { "name": "Generate SLO Correction Windows", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/slo/correction", "params": [ { "name": "sloId", "value": "", "type": "query" }, { "name": "excludeCorrectionId", "value": "N1Xj6q8QTZu_cfJOGqy4mg", "type": "query", "description": "IDs of Correction Configurations to be Excluded from the result" }, { "name": "includeCorrectionId", "value": "uvP7Z03pSUuybDT8-WHLDA", "type": "query", "description": "IDs of Correction Configurations to be Included in the result" }, { "name": "tags", "value": "", "type": "query" }, { "name": "from", "value": "1706713140000", "type": "query", "description": "Correction starting timestamp in milliseconds (13-digit)" }, { "name": "to", "value": "1706713140000", "type": "query", "description": "Correction ending timestamp in milliseconds (13-digit)" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Generate SLO Correction Windows" } ] }, { "info": { "name": "Service Levels Objective(SLO) Report", "type": "folder" }, "items": [ { "info": { "name": "Generate Service Levels report", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/slo/report/:sloId", "params": [ { "name": "sloId", "value": "SLOEANnWh9tQOa2h88kGxK6wQ", "type": "path", "description": "Service Levels Objective(SLO) Configuration ID" }, { "name": "from", "value": "1706713140000", "type": "query", "description": "Starting point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds" }, { "name": "to", "value": "1706813100000", "type": "query", "description": "Ending point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds" }, { "name": "excludeCorrectionId", "value": "N1Xj6q8QTZu_cfJOGqy4mg", "type": "query", "description": "IDs of Correction Configurations to be Excluded from the result" }, { "name": "includeCorrectionId", "value": "uvP7Z03pSUuybDT8-WHLDA", "type": "query", "description": "IDs of Correction Configurations to be Included in the result" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Generate Service Levels report" } ] }, { "info": { "name": "Synthetic Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get synthetic tag catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/catalog", "params": [ { "name": "useCase", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get synthetic tag catalog" }, { "info": { "name": "Get Metric catalog", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/catalog/metrics", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get Metric catalog" } ] }, { "info": { "name": "Synthetic Metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Synthetic Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/metrics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve Synthetic Metrics.\nFor more information on Synthetic Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-metrics." } ] }, { "info": { "name": "Synthetic Test Playback Results", "type": "folder" }, "items": [ { "info": { "name": "Get Synthetic test playback results", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a list of aggregated playback results metrics for Synthetic tests matching the specified parameters\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get a list of Synthetic tests based on the specified analytic function", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/analytic", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a list of playback results metrics for Synthetic tests matching the specified parameters for the specified analytic\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get a list of Synthetic test playback results", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a list of playback results metrics for Synthetic tests matching the specified parameters\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get a list of Synthetic locations with last run test on each location data", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/locationsummarylist", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get summary information for Synthetic locations matching the specified parameters\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get a list of Synthetic tests with success rate and average response time data", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/testsummarylist", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Get a summary of the playback results metrics and success rate for Synthetic tests matching the specified parameters\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get Synthetic test playback detail result description(metadata)", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/:testid/:testresultid", "params": [ { "name": "testid", "value": "AMl0Y7tsvpp8XXrXt1XO", "type": "path", "description": "Test id of the test result detailed description to be retrieved" }, { "name": "testresultid", "value": "5623c161-31d6-49b8-b314-91d4fb598f55", "type": "path", "description": "Test result id of the test result detailed description to be retrieved" }, { "name": "startTime", "value": "1730295066008", "type": "query", "description": "Start time of the test result detailed description" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Gets the list of detailed data file names associated to a Synthetic playback result\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Get Synthetic test playback result detail data", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/:testid/:testresultid/detail", "params": [ { "name": "testid", "value": "AMl0Y7tsvpp8XXrXt1XO", "type": "path", "description": "Test id of the test result detailed file contents to be retrieved" }, { "name": "testresultid", "value": "5623c161-31d6-49b8-b314-91d4fb598f55", "type": "path", "description": "Test result id of the test result detailed file to be retrieved" }, { "name": "type", "value": "LOGS", "type": "query", "description": "Type of the test result detailed file contents" }, { "name": "name", "value": "console.log", "type": "query", "description": "Name of the test result detailed file, if more than one file available for the same type. Can be used when parameter type=LOGS" }, { "name": "startTime", "value": "1730295066008", "type": "query", "description": "Start time of the test result detailed file contents" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Download the contents of the Synthetic the playback result detail data file matching the specified file type\nFor more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results." }, { "info": { "name": "Download the synthetic test playback result detail data file", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/results/:testid/:testresultid/file", "params": [ { "name": "testid", "value": "AMl0Y7tsvpp8XXrXt1XO", "type": "path", "description": "Test id of the test result detailed file to be retrieved" }, { "name": "testresultid", "value": "5623c161-31d6-49b8-b314-91d4fb598f55", "type": "path", "description": "Test result id of the test result detailed file to be retrieved" }, { "name": "type", "value": "LOGS", "type": "query", "description": "Type of the test result detailed file" }, { "name": "startTime", "value": "1730295066008", "type": "query", "description": "Start time of the test result detailed file" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Download the synthetic test playback result detail data file" } ] }, { "info": { "name": "Synthetic Settings", "type": "folder" }, "items": [ { "info": { "name": "All Synthetic credential names", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve the names of all Synthetic Credentials.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "Create a Synthetic credential", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to create a Synthetic Credential.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "All Synthetic credentials", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials/associations", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve all Synthetic Credentials.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "A Synthetic credential", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials/associations/:name", "params": [ { "name": "name", "value": "password4test", "type": "path", "description": "Name of the credential to be retrieved" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve a Synthetic Credential with matching name.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "Update a Synthetic credential", "type": "http" }, "http": { "method": "PUT", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials/:name", "params": [ { "name": "name", "value": "password4db2", "type": "path", "description": "Name of the credential to be updated" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to update a Synthetic Credential.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "Patch a Synthetic credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials/:name", "params": [ { "name": "name", "value": "password4test", "type": "path", "description": "Name of the credential to be patched" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Patch a Synthetic credential" }, { "info": { "name": "Delete a Synthetic credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/credentials/:name", "params": [ { "name": "name", "value": "password4test", "type": "path", "description": "Name of the credential to be deleted" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to delete a Synthetic Credential.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "All Synthetic datacenters", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/datacenters", "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve all Synthetic Datacenters.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "A Synthetic datacenter", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/datacenters/:datacenterId", "params": [ { "name": "datacenterId", "value": "aws-us-east-1-NVirginia", "type": "path", "description": "Id of the datacenter to be retrieved" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to retrieve a Synthetic Datacenter with matching id.\nFor more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings." }, { "info": { "name": "All Synthetic locations", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/locations", "params": [ { "name": "sort", "value": "+label", "type": "query", "description": "Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC" }, { "name": "offset", "value": "1", "type": "query", "description": "Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations" }, { "name": "limit", "value": "10", "type": "query", "description": "Defines the size of a page - the number of synthetic locations that will be returned by the query" }, { "name": "filter", "value": "{locationType=Managed}", "type": "query", "description": "Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators." } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves Synthetic Locations.\n\n## Optional Parameters:\n\n- **filter** Filters the Synthetic Locations to retrieve only the ones that match the specified filter condition. \n Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'.\n The filter parameter is formatted as '**_{\\\\\\/api/synthetics/settings/tests \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"id\":\"test_id:12134-89\",\n \"" }, { "info": { "name": "Delete Synthetic tests", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/tests/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to delete a list of Synthetic Tests." }, { "info": { "name": "Update Synthetic tests", "type": "http" }, "http": { "method": "POST", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/tests/bulk-update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "API request to update a list of Synthetic Tests." }, { "info": { "name": "All Synthetic test CI/CDs", "type": "http" }, "http": { "method": "GET", "url": "https://{unit}-{tenant}.instana.io/api/synthetics/settings/tests/ci-cd", "params": [ { "name": "filter", "value": "{runType=OnDemand}", "type": "query", "description": "Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators." }, { "name": "offset", "value": "1", "type": "query", "description": "Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs" }, { "name": "limit", "value": "10", "type": "query", "description": "Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves Synthetic Test CI/CDs.\n\n## Optional Parameters:\n\n- **filter** Filters the Synthetic Test CI/CDs to retrieve only the ones that match the specified filter condition.\n Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'.\n The filter parameter is formatted as '**_{\\\\\\