API de listas de dominios permitidos
Comenzar con la lista de dominios permitidos
La lista de dominios permitidos está disponible para clientes con planes Enterprise. Si estás interesado en esta función, ponte en contacto con el servicio de soporte de Datadog para solicitar acceso.
Request AccessLa Lista de dominios permitidos permite restringir los dominios de correo electrónico a los que se puede enviar notificaciones.
Este documento describe cómo acceder y configurar la Lista de dominios permitidos a través de la API. Para utilizar la interfaz de usuario, consulta Lista de dominios permitidos.
Obtener lista de dominios permitidos
Devuelve la lista de dominios permitidos y su estado activado o desactivado.
GET
https://api.datadoghq.com/api/v2/domain_allowlist
Solicitud
Ejemplo
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}"
Respuesta
OK
Modelo
Campo | Tipo | Descripción |
---|
datos | objeto | Datos de correo electrónico de la Lista de dominios permitidos |
data.type | enum | Tipo de Lista de dominios permitidos. Valores de enum permitidos: domain_allowlist . Por defecto: domain_allowlist . |
data.attributes | objeto | Atributos de la lista de dominios permitidos |
data.attributes.enabled | Booleano | Si es true , la lista de dominios permitidos está activada |
data.attributes.domains | [cadena] | Lista de dominios en la Lista de dominios permitidos |
Prohibido
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
No se ha encontrado
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
Demasiadas solicitudes
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
Ejemplo
{
"data": {
"type": "domain_allowlist",
"attributes": {
"enabled": true,
"domains": [
"@aol.com",
"@yahoo.com",
"@gmail.com"
]
}
}
}
Modificar la lista de dominios permitidos
Activar/desactivar la lista de dominios permitidos y reescribir toda la lista de dominios permitidos con una determinada lista de dominios de correo electrónico.
PATCH
https://api.datadoghq.com/api/v2/domain_allowlist
Solicitud
Ejemplo
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
Respuesta
OK
Modelo
Campo | Tipo | Descripción |
---|
datos | objeto | Datos de correo electrónico de la Lista de dominios permitidos |
data.type | enum | Tipo de Lista de dominios permitidos. Valores de enum permitidos: domain_allowlist . Por defecto: domain_allowlist . |
data.attributes | objeto | Atributos de la lista de dominios permitidos |
data.attributes.enabled | Booleano | Si es true , la lista de dominios permitidos está activada |
data.attributes.domains | [cadena] | Lista de dominios en la Lista de dominios permitidos |
Prohibido
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
No se ha encontrado
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
Demasiadas solicitudes
Modelo
Campo | Tipo | Descripción |
---|
errors [required] | [cadena] | Lista de errores |
Ejemplo
{
"data": {
"type": "domain_allowlist",
"attributes": {
"enabled": true,
"domains": [
"@datadoghq.com",
"@yahoo.com",
"@gmail.com"
]
}
}
}
Para leer más
Más enlaces, artículos y documentación útiles: