On-Call

List On-Call notification rules for a user

List the notification rules for a user. The authenticated user must be the target user or have the on_call_admin permission

get/api/v2/on-call/users/{user_id}/notification-rules

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token

Path parameters

user_idstring required
Example:00000000-0000-0000-0000-000000000000

The user ID

Query parameters

includestring

Comma-separated list of included relationships to be returned. Allowed values: channel.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "channel_settings": {
          "method": "sms",
          "type": "phone"
        }
      },
      "relationships": {
        "channel": {
          "data": {
            "type": "notification_channels"
          }
        }
      },
      "type": "notification_rules"
    }
  ],
  "included": [
    {
      "attributes": {
        "config": {
          "type": "phone"
        }
      },
      "type": "notification_channels"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.