Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

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 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

Présentation

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.

Réponse

OK

Response containing information about the email domain allowlist.

Expand All

Champ

Type

Description

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

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # 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}"

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

Présentation

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.

Requête

Body Data (required)

Expand All

Champ

Type

Description

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"
  }
}

Réponse

OK

Response containing information about the email domain allowlist.

Expand All

Champ

Type

Description

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

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                          # 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

PREVIEWING: Cyril-Bouchiat/add-vm-package-explorer-doc