• Home
  • Dynatrace API
  • Configuration
  • Alerting profiles
  • GET all profiles

Alerting profiles API - GET all profiles

Lists all alerting profiles available in your Dynatrace environment.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GETManaged 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 an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200StubList

Success

Response body objects

The StubList object

An ordered list of short representations of Dynatrace entities.

ElementTypeDescription
valuesEntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

Response body JSON model

json
{ "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

shell
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/config/v1/alertingProfiles \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/alertingProfiles

Response body

json
{ "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

Related topics
  • Alerting profiles

    Learn how to create and manage alerting profiles.

  • Dynatrace API - Tokens and authentication

    Find out how to get authenticated to use the Dynatrace API.