Alerting profiles API - GET all profiles

Lists all alerting profiles available in your DESK 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.dexp.ae/api/config/v1/alertingProfiles

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

The request doesn't provide any configurable parameters.

Response format

Response parameters JSON model

The StubList object

An ordered list of short representations of DESK entities.

Element	Type	Description
values	EntityShortRepresentation[]	An ordered list of short representations of DESK entities.

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK entity.

    
{
  "values": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "DESK entity 1",
      "description": "DESK entity 1 for the REST API example\n"
    },
    {
      "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
      "name": "DESK 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.dexp.ae/api/config/v1/alertingProfiles \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/config/v1/alertingProfiles

Response 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