Language

日本語 English Français 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 US1-FED

Domain Allowlist

Configure your Datadog Email Domain Allowlist directly through the Datadog API. The Email Domain Allowlist controls the domains that certain datadog emails can be sent to. For more information, see the Domain Allowlist docs page

Get Domain Allowlist

GET https://api.ap1.datadoghq.com/api/v2/domain_allowlisthttps://api.datadoghq.eu/api/v2/domain_allowlisthttps://api.ddog-gov.com/api/v2/domain_allowlisthttps://api.datadoghq.com/api/v2/domain_allowlisthttps://api.us3.datadoghq.com/api/v2/domain_allowlisthttps://api.us5.datadoghq.com/api/v2/domain_allowlist

概要

Get the domain allowlist for an organization. This endpoint requires the org_management permission.

OAuth apps require the org_management authorization scope to access this endpoint.

応答

OK

Response containing information about the email domain allowlist.

Expand All

フィールド

種類

説明

data

object

The email domain allowlist response for an org.

attributes

object

The details of the email domain allowlist.

domains

[string]

The list of domains in the email domain allowlist.

enabled

boolean

Whether the email domain allowlist is enabled for the org.

id

string

The unique identifier of the org.

type [required]

enum

Email domain allowlist allowlist type. Allowed enum values: domain_allowlist

default: domain_allowlist

{
  "data": {
    "attributes": {
      "domains": [],
      "enabled": false
    },
    "id": "string",
    "type": "domain_allowlist"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

コード例

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/domain_allowlist" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Sets Domain Allowlist

PATCH https://api.ap1.datadoghq.com/api/v2/domain_allowlisthttps://api.datadoghq.eu/api/v2/domain_allowlisthttps://api.ddog-gov.com/api/v2/domain_allowlisthttps://api.datadoghq.com/api/v2/domain_allowlisthttps://api.us3.datadoghq.com/api/v2/domain_allowlisthttps://api.us5.datadoghq.com/api/v2/domain_allowlist

概要

Update the domain allowlist for an organization. This endpoint requires the org_management permission.

OAuth apps require the org_management authorization scope to access this endpoint.

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data [required]

object

The email domain allowlist for an org.

attributes

object

The details of the email domain allowlist.

domains

[string]

The list of domains in the email domain allowlist.

enabled

boolean

Whether the email domain allowlist is enabled for the org.

id

string

The unique identifier of the org.

type [required]

enum

Email domain allowlist allowlist type. Allowed enum values: domain_allowlist

default: domain_allowlist

{
  "data": {
    "attributes": {
      "domains": [
        "@static-test-domain.test"
      ],
      "enabled": false
    },
    "type": "domain_allowlist"
  }
}

応答

OK

Response containing information about the email domain allowlist.

Expand All

フィールド

種類

説明

data

object

The email domain allowlist response for an org.

attributes

object

The details of the email domain allowlist.

domains

[string]

The list of domains in the email domain allowlist.

enabled

boolean

Whether the email domain allowlist is enabled for the org.

id

string

The unique identifier of the org.

type [required]

enum

Email domain allowlist allowlist type. Allowed enum values: domain_allowlist

default: domain_allowlist

{
  "data": {
    "attributes": {
      "domains": [],
      "enabled": false
    },
    "id": "string",
    "type": "domain_allowlist"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

コード例

                          # Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/domain_allowlist" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "domains": [
        "@static-test-domain.test"
      ],
      "enabled": false
    },
    "type": "domain_allowlist"
  }
}
EOF