Alerting profiles API - GET all profiles
Lists all alerting profiles available in your Dynatrace environment.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/alertingProfiles |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/alertingProfiles | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/alertingProfiles |
Authentication
To execute this request, you need Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Stub | Success |
Response body objects
The StubList object
An ordered list of short representations of Dynatrace entities.
| Element | Type | Description | Required |
|---|---|---|---|
| values | Entity | An ordered list of short representations of Dynatrace entities. | required |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the Dynatrace entity. | required |
| name | string | The name of the Dynatrace entity. | optional |
| description | string | A short description of the Dynatrace entity. | optional |
Response body JSON model
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}Example
In this example, the request lists all alerting profiles in the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/alertingProfiles \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/alertingProfilesResponse body
{
"values": [
{
"id": "c005735d-e797-4a54-9492-3f11074d440c",
"name": "App availability"
},
{
"id": "3a1f6d83-4324-48ae-838a-ca47245adf44",
"name": "Transaction slowdown"
},
{
"id": "8165d174-2ad3-4623-85a6-23ffcf2ac9a4",
"name": "Errors in booking service"
}
]
}Response code
200