Introduction
Use Cases
Actions Service
Alert Definitions Service
Alert Events Service
API Keys Service
Contextual Data Integration Service
Custom Enrichments Service
Dashboard Folders Service
Dashboard Service
Data Usage Service
Enrichments Service
Events Service
Events2Metrics Service
Extension Deployment Service
Extension Service
Extension Testing Service
Folders for Views
Incidents Service
- Overview
- POSTAcknowledge incidents
- POSTAssign incidents to a user
- POSTClose incidents
- POSTGet available filter values
- POSTGet available incident event filter values
- POSTGet incident aggregations
- GETGet incident by ID
- GETGet incident events
- POSTGet multiple incidents by IDs
- POSTGet total count of incident events
- POSTList incident events with filters
- POSTList incidents with filters
- POSTRemove incident user assignments
- POSTResolve incidents
Integration Service
- Overview
- DELDelete integration
- GETGet all integrations
- GETGet deployed integration
- GETGet integration definition
- GETGet integration details
- GETGet integration template
- GETGet managed integration status
- GETGet RUM integration versions data
- GETList managed integration keys
- POSTSave integration registration metadata
- POSTTest integration
- POSTTrigger sync of RUM integration data
- PUTUpdate integration
Outgoing Webhooks Service
- Overview
- POSTCreate an outgoing webhook
- DELDelete an outgoing webhook
- GETGet outgoing webhook
- GETGet outgoing webhook type details
- GETGet outgoing webhook types
- GETList all outgoing webhooks
- GETList IBM event notification instances
- GETList outbound webhooks summary
- GETList outgoing webhooks
- POSTTest an existing outgoing webhook
- POSTTest an outgoing webhook
- PUTUpdate an outgoing webhook
Policies Service
Recording Rules Service
Retentions Service
Rule Groups Service
SAML Configuration Service
Scopes Service
Slos Service
Target Service
Team Permissions Management Service
- Overview
- POSTAdd Users To Team Group
- POSTAdd Users To Team Groups
- POSTCreate Team Group
- DELDelete Team Group
- GETGet Group Users
- GETGet Team Group
- GETGet Team Group By Name
- GETGet Team Group Scope
- GETGet Team Groups
- DELRemove Users From Team Group
- DELRemove Users From Team Groups
- POSTSet Team Group Scope
- PUTUpdate Team Group
Alert Definitions Service
Overview
Alert definitions service overview
View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert. Learn more about alerts in our documentation.Authentication and permissions
To use the Alert definitions service API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.| Presets | Permission | Description |
|---|---|---|
| Alerts | alerts:ReadConfig | Grants access to read alerts |
alerts:UpdateConfig | Required to create, update, or delete alerts |
Common error response codes
| Status Code | Description |
|---|---|
400 Bad Request | Response code 400 |
401 Unauthorized | Response code 401 |
500 Internal Server Error | Response code 500 |
Constants
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.