Domain Allowlist API

Domain Allowlist の利用を開始する

Domain Allowlist は Enterprise プランのお客様がご利用になれます。この機能にご興味がある場合は、アクセス権のリクエストについて Datadog サポートへお問い合わせください。

Request Access

Domain Allowlist は、通知を送信できるメール ドメインを制限します。

このドキュメントでは API を通じて Domain Allowlist にアクセスし、設定する方法を説明します。UI を使用する場合は、Domain Allowlist を参照してください。

Domain Allowlist の取得

Domain Allowlist と、その有効/無効状態を返します。

GET https://api.datadoghq.com/api/v2/domain_allowlist

リクエスト

例

curl -X GET "https://api.datadoghq.com/api/v2/domain_allowlist" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

レスポンス

    OK

    モデル

    フィールド型説明
    dataobjectDomain Allowlist のメール データ
    data.typeenumDomain Allowlist の種類。許可される enum 値: domain_allowlist。既定: domain_allowlist。
    data.attributesobjectDomain Allowlist の属性
    data.attributes.enabledBooleantrue の場合、Domain Allowlist は有効です
    data.attributes.domains[string]Domain Allowlist に含まれるドメインの一覧

    Forbidden

    モデル

    フィールド型説明
    errors [必須][string]エラーの一覧

    Not Found

    モデル

    フィールド型説明
    errors [必須][string]エラーの一覧

    Too many requests

    モデル

    フィールド型説明
    errors [必須][string]エラーの一覧

    例

    {
  "data": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@aol.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}

    Domain Allowlist の変更

    Domain Allowlist を有効化/無効化し、指定したメール ドメインの一覧で許可リスト全体を上書きします。

    PATCH https://api.datadoghq.com/api/v2/domain_allowlist

    リクエスト

    例

    curl -X PATCH "https://api.datadog.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": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@datadoghq.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}

EOF

    レスポンス

      OK

      モデル

      フィールド型説明
      dataobjectDomain Allowlist のメール データ
      data.typeenumDomain Allowlist の種類。許可される enum 値: domain_allowlist。既定: domain_allowlist。
      data.attributesobjectDomain Allowlist の属性
      data.attributes.enabledBooleantrue の場合、Domain Allowlist は有効です
      data.attributes.domains[string]Domain Allowlist に含まれるドメインの一覧

      Forbidden

      モデル

      フィールド型説明
      errors [必須][string]エラーの一覧

      Not Found

      モデル

      フィールド型説明
      errors [必須][string]エラーの一覧

      Too many requests

      モデル

      フィールド型説明
      errors [必須][string]エラーの一覧

      例

      {
  "data": {
    "type": "domain_allowlist",
    "attributes": {
      "enabled": true,
      "domains": [
        "@datadoghq.com",
        "@yahoo.com",
        "@gmail.com"
      ]
    }
  }
}

      関連資料

      お役に立つドキュメント、リンクや記事:

      Domain Allowlistアプリ内 more more Domain Allowlist UIドキュメント more more