Instana Event Settings API
The Event Settings API from Instana — 37 operation(s) for event settings.
OpenAPI Specification
openapi: 3.0.1
info:
contact:
email: support@instana.com
name: © Instana
url: http://instana.com
termsOfService: https://www.instana.com/terms-of-use/
title: Instana REST API documentation Event Settings API
version: 1.307.1417
x-ibm-ahub-try: true
x-logo:
altText: instana logo
backgroundColor: '#FAFBFC'
url: header-logo.svg
description: "Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).\n\n<div style=\"background-color:#e6f0ff; padding: 12px; border-left: 6px solid #0052cc; font-size: 14px; display: flex; align-items: center;\">\n <img src=\"https://img.icons8.com/ios-filled/50/0052cc/info.png\" width=\"18\" height=\"18\" style=\"margin-right: 8px;\" alt=\"info icon\"/>\n <span>\n <b>Our API documentation is moving to</b> \n <a href=\"https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction\" target=\"_blank\">API Hub</a>\n\t — please update your bookmarks now, as the current site will be deprecated after Release-306.\n </span>\n</div>\n\n## Overview\nThe Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.\n\n### Navigating the API documentation\nThe API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include:\n- Websites & Mobile Apps\n- Applications\n- Infrastructure\n- Synthetic Monitoring\n- Events\n- Automation\n- Service Levels\n- Settings\n- etc\n\n### Rate Limiting\nA rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.\n\n- **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour.\n- **X-RateLimit-Remaining:** How many calls may still be executed within the current hour.\n- **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.\n\n### Further Reading\nWe provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.\n\n## Getting Started with the REST API\n\n### API base URL\nThe base URL for an specific instance of Instana can be determined using the tenant and unit information.\n- `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface.\n- `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.\n\n### Curl Example\nHere is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n\nNext we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.\n\n```bash\ncurl --request POST \\\n --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\\n --header 'content-type: application/json' \\\n --data '{\n \"group\":{\n \"groupbyTag\":\"endpoint.name\"\n },\n \"tagFilters\":[\n \t{\n \t\t\"name\":\"call.error.count\",\n \t\t\"value\":\"0\",\n \t\t\"operator\":\"GREATER_THAN\"\n \t}\n ],\n \"metrics\":[\n \t{\n \t\t\"metric\":\"errors\",\n \t\t\"aggregation\":\"MEAN\"\n \t}\n ]\n }'\n```\n\n### Generating REST API clients\n\nThe API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format.\nYou can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).\n\nOpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made.\nTo generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).\n\n#### Go\nFor example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:\n\n```bash\n#!/bin/bash\n\n### This script assumes you have the `java` and `wget` commands on the path\n\nexport UNIT_NAME='myunit' # for example: prod\nexport TENANT_NAME='mytenant' # for example: awesomecompany\n\n//Download the generator to your current working directory:\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"\n\n//generate a client library that you can vendor into your repository\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\\n -o pkg/instana/openapi \\\n --skip-validate-spec\n\n//(optional) format the Go code according to the Go code standard\ngofmt -s -w pkg/instana/openapi\n```\n\nThe generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:\n\n```go\nimport instana \"./pkg/instana/openapi\"\n\n// readTags will read all available application monitoring tags along with their type and category\nfunc readTags() {\n\tconfiguration := instana.NewConfiguration()\n\tconfiguration.Host = \"tenant-unit.instana.io\"\n\tconfiguration.BasePath = \"https://tenant-unit.instana.io\"\n\n\tclient := instana.NewAPIClient(configuration)\n\tauth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{\n\t\tKey: apiKey,\n\t\tPrefix: \"apiToken\",\n\t})\n\n\ttags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)\n\tif err != nil {\n\t\tfmt.Fatalf(\"Error calling the API, aborting.\")\n\t}\n\n\tfor _, tag := range tags {\n\t\tfmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)\n\t}\n}\n```\n\n#### Java\nFollow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).\n\nDepending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification:\n```\n//Nativ Java HTTP Client\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native\n\n//Spring WebClient\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient\n\n//Spring RestTemplate\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate\n\n```\n"
servers:
- description: Instana Backend
url: https://{unit}-{tenant}.instana.io
variables:
tenant:
default: tenant
description: Customer tenant unit
unit:
default: unit
description: Customer tenant name
- description: Instana Self-Hosted Backend
url: https://{domain}
variables:
domain:
default: example.com
description: Customer Self-Hosted domain
tags:
- name: Event Settings
paths:
/api/events/settings/alertingChannels:
get:
description: Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
operationId: getAlertingChannels
parameters:
- description: List of IDs of alert channels defined in Instana. Can be left empty.
example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]'
in: query
name: ids
schema:
type: array
items:
type: string
uniqueItems: true
responses:
'200':
content:
application/json:
example:
- id: 18iiwkDxHD7_A4mIlouise
name: Email Alert Channel
customEmailSubjectPrefix: null
emails:
- youremail@email.com
kind: EMAIL
- id: 1pFirIMvrZk9NO2R
name: Stan Test Slack Channel
webhookUrl: https://hooks.slack.com/testwebhook
iconUrl: ''
channel: team-stan-test-channel
emojiRendering: false
kind: SLACK
schema:
type: array
items:
$ref: '#/components/schemas/AbstractIntegration'
description: OK
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Get all Alerting Channels
tags:
- Event Settings
x-ibm-ahub-byok: true
post:
description: Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
operationId: postAlertingChannel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractIntegration'
required: true
responses:
'200':
content:
application/json:
example:
id: 18iiwkDxHD7_A4mIlouise
name: Email Alert Channel
customEmailSubjectPrefix: null
emails:
- youremail@email.com
kind: EMAIL
schema:
$ref: '#/components/schemas/AbstractIntegration'
description: created the alert channel setting
'302':
description: 'Redirect to the integration service for continuing the configuration with the 3rd party system '
'400':
content:
application/json:
schema:
type: string
description: Failed creating the alert channel setting
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Create Alert Channel
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alertingChannels/infos:
get:
description: Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
operationId: getAlertingChannelsOverview
parameters:
- description: List of IDs of alert channels defined in Instana. Can be left empty.
example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]'
in: query
name: ids
schema:
type: array
items:
type: string
uniqueItems: true
responses:
'200':
content:
application/json:
example:
- id: qbhfsL9vTtlaBOAt
kind: WEB_HOOK
name: alert-response-generic-webhook
properties: {}
- id: V_gYaoRFPe6S-T-l
kind: OPS_GENIE
name: OpsGenie QA
properties:
Alias: ''
Tags: k8s-test
schema:
type: array
items:
$ref: '#/components/schemas/IntegrationOverview'
description: OK
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Get Overview of Alerting Channels
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alertingChannels/notify/{id}:
post:
description: 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.
operationId: sendTestAlertingById
parameters:
- description: ID of the alerting channel to be notified on.
example: YbcFlaG8k5oIkxD0
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManualAlertingChannelConfiguration'
required: true
responses:
default:
content:
application/json: {}
description: default response
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alertingChannels/test:
put:
description: 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.
operationId: sendTestAlerting
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractIntegration'
x-example: alertingChannelTestCall
required: true
responses:
'200':
content:
application/json:
examples:
Failure:
description: Failure
value:
status: failure
message: Alerting channel was unsuccessful.
Success:
description: Success
value:
status: success
message: Alerting Channel was successfully triggered, please check the channel!
description: Test alerting channel response
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Test Alerting Channel
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alertingChannels/{id}:
delete:
description: Deletes an alert channel. Requires the permission called CanConfigureIntegrations.
operationId: deleteAlertingChannel
parameters:
- description: ID of the Alerting Channel to delete.
example: YbcFlaG8k5oIkxD0
in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Successful - no content to return.
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Delete Alerting Channel
tags:
- Event Settings
x-ibm-ahub-byok: true
get:
description: Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
operationId: getAlertingChannel
parameters:
- description: ID of the Alerting Channel to get.
example: YbcFlaG8k5oIkxD0
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
id: 18iiwkDxHD7_A4mIlouise
name: Email Alert Channel
customEmailSubjectPrefix: null
emails:
- youremail@email.com
kind: EMAIL
schema:
$ref: '#/components/schemas/AbstractIntegration'
description: OK
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Get Alerting Channel
tags:
- Event Settings
x-ibm-ahub-byok: true
put:
description: Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
operationId: putAlertingChannel
parameters:
- description: ID of the Alerting Channel to update.
example: YbcFlaG8k5oIkxD0
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractIntegration'
required: true
responses:
'200':
content:
application/json:
example:
id: 18iiwkDxHD7_A4mIlouise
name: Email Alert Channel
customEmailSubjectPrefix: null
emails:
- youremail@email.com
kind: EMAIL
schema:
$ref: '#/components/schemas/AbstractIntegration'
description: Updated the alert channel setting
'302':
description: 'Redirect to the integration service for continuing the configuration with the 3rd party system '
'400':
content:
application/json:
schema:
type: string
description: Failed updating the alert channel setting
security:
- ApiKeyAuth:
- CanConfigureIntegrations
summary: Update Alert Channel
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alerts:
get:
description: Gets all Alert Configurations
operationId: getAlerts
responses:
'200':
content:
application/json:
example:
- id: 5GJXiK9aciVaBPnu
alertName: CMH Alert Test
muteUntil: 9007199254740991
integrationIds:
- GcqLyri-worP8sXX
eventFilteringConfiguration:
query: entity.host.fqdn:robot-shop-pink1.fyre.ibm.com
ruleIds:
- roILHzyaMBRDZE3FxaeZ5T_wx4Q
eventTypes: []
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields:
- type: staticString
key: cmhtest
value: cmhval
lastUpdated: 1702590551696
invalid: false
alertChannelNames:
- CMH Email test
applicationNames: []
- id: E8Z88ThbA7RDPgbz
alertName: SQL Server Write txns Alert
muteUntil: 0
integrationIds:
- Hrigl1epXxAc0Tym
eventFilteringConfiguration:
query: null
ruleIds:
- v1jc5yEjHRNbX8_i
eventTypes: []
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields: []
lastUpdated: 1702590551748
invalid: false
alertChannelNames:
- Servicenow Webhook Sunny
applicationNames: []
- id: Z9eXY8LOfTuAf43e
alertName: IBM i All Alerts
muteUntil: 0
integrationIds: []
eventFilteringConfiguration:
query: entity.ibmi.os.hostname:ut31p37.rch.stglabs.ibm.com AND event.text:*
ruleIds: []
eventTypes:
- warning
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields: []
lastUpdated: 1704894496752
invalid: false
alertChannelNames: []
applicationNames: []
schema:
type: array
items:
$ref: '#/components/schemas/ValidatedAlertingConfiguration'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
security:
- ApiKeyAuth:
- CanConfigureCustomAlerts
summary: Get all Alert Configurations
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alerts/infos:
get:
description: Gets all alert configurations that relate to the given alert channel.
operationId: getAlertingConfigurationInfos
parameters:
- description: ID of a specific alert channel configuration.
example: hu6ynJbwgB4X1rjk
in: query
name: integrationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
- id: Xt67tttZF4yzemPQ
label: Production Availability Alerts
query: entity.zone:prod
eventTypes: []
selectedEvents: 2
enabled: true
type: Alert
entityId: null
invalid: false
- id: wNbFtdyvQgeA4k8JdBSsyA
label: Database Cluster Alerts
query: null
eventTypes: null
selectedEvents: null
enabled: false
type: ApplicationSmartAlert
entityId: mwVo3lG-TD-4ssDa3w0pGA
invalid: false
schema:
type: array
items:
$ref: '#/components/schemas/ValidatedAlertingChannelInputInfo'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
security:
- ApiKeyAuth:
- CanConfigureCustomAlerts
summary: All alerting configuration info
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/alerts/{id}:
delete:
description: Delete a specific Alert Configuration by ID
operationId: deleteAlert
parameters:
- description: ID of a specific Alert Configuration to delete.
example: hu6ynJbwgB4X1rjkkw
in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Successful - no content to return.
'401':
description: Unauthorized access - requires user authentication.
security:
- ApiKeyAuth:
- CanConfigureCustomAlerts
summary: Delete Alert Configuration
tags:
- Event Settings
x-ibm-ahub-byok: true
get:
description: Get a specific Alert Configuration by ID.
operationId: getAlert
parameters:
- description: ID of a specific Alert Configuration to retrieve.
example: iSjG7UWK3Dy6bDUc
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
id: iSjG7UWK3Dy6bDUc
alertName: test-email-alert
muteUntil: 0
integrationIds:
- B1PdA6BUdA9JJRZG
eventFilteringConfiguration:
query: event.text:*BRUCE*
ruleIds: []
eventTypes:
- warning
- incident
- critical
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields: []
lastUpdated: 1718828552918
schema:
$ref: '#/components/schemas/AlertingConfigurationWithLastUpdated'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
'404':
description: Resource not found.
security:
- ApiKeyAuth:
- CanConfigureCustomAlerts
summary: Get Alert Configuration
tags:
- Event Settings
x-ibm-ahub-byok: true
put:
description: Create or update a specific Alert configuration by ID
operationId: putAlert
parameters:
- description: ID of a specific Alert Configuration to create or update.
example: hu6ynJbwgB4X1rjk
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
id: hu6ynJbwgB4X1rjk
alertName: Alerts Test
muteUntil: 9007199254740991
integrationIds:
- ctCR9Q373YAY27H_
- wyAPFbP_xZCeEUn6
- M01h5MDfb7YVQPAz
- BH4nVcoPdSpJH_4U
- ldF14o6dCKmQFJxP
- IbQkmZ46_oUGV-L7
- wpWi9SYL7cJOu_UZ
- ds1Lpvix2WVoWTKg
eventFilteringConfiguration:
query: null
ruleIds: []
eventTypes:
- incident
- critical
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields:
- type: staticString
key: assignment_group
value: ITSM App-Dev
- type: staticString
key: category
value: Software
- type: staticString
key: change_test
value: test kevin
- type: staticString
key: assigned_to
value: Antony Alldis
schema:
$ref: '#/components/schemas/AlertingConfiguration'
required: true
responses:
'200':
content:
application/json:
example:
id: hu6ynJbwgB4X1rjk
alertName: Alerts Test
muteUntil: 0
integrationIds:
- ctCR9Q373YAY27H_
- wyAPFbP_xZCeEUn6
- M01h5MDfb7YVQPAz
- BH4nVcoPdSpJH_4U
- ldF14o6dCKmQFJxP
- IbQkmZ46_oUGV-L7
- wpWi9SYL7cJOu_UZ
- ds1Lpvix2WVoWTKg
eventFilteringConfiguration:
query: null
ruleIds: []
eventTypes:
- incident
- critical
applicationAlertConfigIds: []
validVersion: 1
customPayloadFields:
- type: staticString
key: assignment_group
value: ITSM App-Dev
- type: staticString
key: category
value: Software
- type: staticString
key: change_test
value: test kevin
- type: staticString
key: assigned_to
value: Antony Alldis
schema:
$ref: '#/components/schemas/AlertingConfigurationWithLastUpdated'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
'422':
description: Unprocessable request - missing/invalid data.
security:
- ApiKeyAuth:
- CanConfigureCustomAlerts
summary: Create or update Alert Configuration
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/custom-payload-configurations:
delete:
description: Deletes a Global Custom Payload Configuration.
operationId: deleteCustomPayloadConfiguration
responses:
'204':
description: Successful - no content to return.
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
security:
- ApiKeyAuth:
- CanConfigureGlobalAlertPayload
summary: Delete Custom Payload Configuration
tags:
- Event Settings
x-ibm-ahub-byok: true
get:
description: Gets All Global Custom Payload Configurations.
operationId: getCustomPayloadConfigurations
parameters:
- in: query
name: context
schema:
type: string
default: ALL
description: The type of Smart Alert that the custom payload is associated with.
enum:
- ALL
- APPLICATION
- WEBSITE
- SYNTHETIC
- MOBILE_APP
- INFRA
- LOG
responses:
'200':
content:
application/json:
example:
- fields:
- type: dynamic
key: zone
value:
tagName: agent.zone
key: app
- type: staticString
key: global_custom_payload
value: 42+1
lastUpdated: 1723212859513
schema:
$ref: '#/components/schemas/CustomPayloadWithVersion'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
security:
- ApiKeyAuth:
- CanConfigureGlobalAlertPayload
summary: Get All Global Custom Payload Configurations
tags:
- Event Settings
x-ibm-ahub-byok: true
put:
description: Creates or Updates Global Custom Payload Configuration.
operationId: upsertCustomPayloadConfiguration
requestBody:
content:
application/json:
example:
fields:
- type: staticString
key: string
value: customValue
- type: dynamic
key: string
value:
tagName: agent.zone
key: string
schema:
$ref: '#/components/schemas/CustomPayloadConfiguration'
required: true
responses:
'200':
content:
application/json:
example:
- fields:
- type: staticString
key: string
value: customValue
- type: dynamic
key: string
value:
tagName: agent.zone
key: string
lastUpdated: 1723212859513
schema:
type: array
items:
$ref: '#/components/schemas/CustomPayloadWithLastUpdated'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'403':
description: Insufficient permissions.
'422':
description: Unable to process request, request data is invalid.
security:
- ApiKeyAuth:
- CanConfigureGlobalAlertPayload
summary: Create/Update Global Custom Payload Configuration
tags:
- Event Settings
x-ibm-ahub-byok: true
/api/events/settings/custom-payload-configurations/catalog:
get:
description: 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.
operationId: getCustomPayloadTagCatalog
responses:
'200':
content:
application/json:
example:
- tagTree:
- label: Agent
# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-event-settings-api-openapi.yml