List protected email domains

client.EmailSecurity.Settings.Domains.List(ctx, params) (*V4PagePaginationArray[SettingDomainListResponse], error)

GET/accounts/{account_id}/email-security/settings/domains

Returns a paginated list of email domains protected by Email Security. Includes domain configuration, delivery modes, and authorization status. Supports filtering by delivery mode and integration ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloud Email Security: WriteCloud Email Security: Read

ParametersExpand Collapse

params SettingDomainListParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

ActiveDeliveryMode param.Field[SettingDomainListParamsActiveDeliveryMode]Optional

Query param: Currently active delivery mode to filter by.

const SettingDomainListParamsActiveDeliveryModeDirect SettingDomainListParamsActiveDeliveryMode = "DIRECT"

const SettingDomainListParamsActiveDeliveryModeBcc SettingDomainListParamsActiveDeliveryMode = "BCC"

const SettingDomainListParamsActiveDeliveryModeJournal SettingDomainListParamsActiveDeliveryMode = "JOURNAL"

const SettingDomainListParamsActiveDeliveryModeAPI SettingDomainListParamsActiveDeliveryMode = "API"

const SettingDomainListParamsActiveDeliveryModeRetroScan SettingDomainListParamsActiveDeliveryMode = "RETRO_SCAN"

AllowedDeliveryMode param.Field[SettingDomainListParamsAllowedDeliveryMode]Optional

Query param: Delivery mode to filter by.

const SettingDomainListParamsAllowedDeliveryModeDirect SettingDomainListParamsAllowedDeliveryMode = "DIRECT"

const SettingDomainListParamsAllowedDeliveryModeBcc SettingDomainListParamsAllowedDeliveryMode = "BCC"

const SettingDomainListParamsAllowedDeliveryModeJournal SettingDomainListParamsAllowedDeliveryMode = "JOURNAL"

const SettingDomainListParamsAllowedDeliveryModeAPI SettingDomainListParamsAllowedDeliveryMode = "API"

const SettingDomainListParamsAllowedDeliveryModeRetroScan SettingDomainListParamsAllowedDeliveryMode = "RETRO_SCAN"

Direction param.Field[SettingDomainListParamsDirection]Optional

Query param: The sorting direction.

const SettingDomainListParamsDirectionAsc SettingDomainListParamsDirection = "asc"

const SettingDomainListParamsDirectionDesc SettingDomainListParamsDirection = "desc"

Domain param.Field[[]string]Optional

Query param: Domain names to filter by.

IntegrationID param.Field[string]Optional

Query param: Integration ID to filter by.

formatuuid

Order param.Field[SettingDomainListParamsOrder]Optional

Query param: Field to sort by.

const SettingDomainListParamsOrderDomain SettingDomainListParamsOrder = "domain"

const SettingDomainListParamsOrderCreatedAt SettingDomainListParamsOrder = "created_at"

Page param.Field[int64]Optional

Query param: Current page within paginated list of results.

minimum1

PerPage param.Field[int64]Optional

Query param: The number of results per page. Maximum value is 1000.

maximum1000

minimum1

Search param.Field[string]Optional

Query param: Search term for filtering records. Behavior may change.

Status param.Field[SettingDomainListParamsStatus]Optional

Query param: Filters response to domains with the provided status.

const SettingDomainListParamsStatusPending SettingDomainListParamsStatus = "pending"

const SettingDomainListParamsStatusActive SettingDomainListParamsStatus = "active"

const SettingDomainListParamsStatusFailed SettingDomainListParamsStatus = "failed"

const SettingDomainListParamsStatusTimeout SettingDomainListParamsStatus = "timeout"

ReturnsExpand Collapse

type SettingDomainListResponse struct{…}

ID stringOptional

Domain identifier

formatuuid

AllowedDeliveryModes []SettingDomainListResponseAllowedDeliveryModeOptional

One of the following:

const SettingDomainListResponseAllowedDeliveryModeDirect SettingDomainListResponseAllowedDeliveryMode = "DIRECT"

const SettingDomainListResponseAllowedDeliveryModeBcc SettingDomainListResponseAllowedDeliveryMode = "BCC"

const SettingDomainListResponseAllowedDeliveryModeJournal SettingDomainListResponseAllowedDeliveryMode = "JOURNAL"

const SettingDomainListResponseAllowedDeliveryModeAPI SettingDomainListResponseAllowedDeliveryMode = "API"

const SettingDomainListResponseAllowedDeliveryModeRetroScan SettingDomainListResponseAllowedDeliveryMode = "RETRO_SCAN"

Authorization SettingDomainListResponseAuthorizationOptional

Authorized bool

Timestamp Time

formatdate-time

StatusMessage stringOptional

CreatedAt TimeOptional

formatdate-time

DMARCStatus SettingDomainListResponseDMARCStatusOptional

One of the following:

const SettingDomainListResponseDMARCStatusNone SettingDomainListResponseDMARCStatus = "none"

const SettingDomainListResponseDMARCStatusGood SettingDomainListResponseDMARCStatus = "good"

const SettingDomainListResponseDMARCStatusInvalid SettingDomainListResponseDMARCStatus = "invalid"

Domain stringOptional

DropDispositions []SettingDomainListResponseDropDispositionOptional

One of the following:

const SettingDomainListResponseDropDispositionMalicious SettingDomainListResponseDropDisposition = "MALICIOUS"

const SettingDomainListResponseDropDispositionMaliciousBec SettingDomainListResponseDropDisposition = "MALICIOUS-BEC"

const SettingDomainListResponseDropDispositionSuspicious SettingDomainListResponseDropDisposition = "SUSPICIOUS"

const SettingDomainListResponseDropDispositionSpoof SettingDomainListResponseDropDisposition = "SPOOF"

const SettingDomainListResponseDropDispositionSpam SettingDomainListResponseDropDisposition = "SPAM"

const SettingDomainListResponseDropDispositionBulk SettingDomainListResponseDropDisposition = "BULK"

const SettingDomainListResponseDropDispositionEncrypted SettingDomainListResponseDropDisposition = "ENCRYPTED"

const SettingDomainListResponseDropDispositionExternal SettingDomainListResponseDropDisposition = "EXTERNAL"

const SettingDomainListResponseDropDispositionUnknown SettingDomainListResponseDropDisposition = "UNKNOWN"

const SettingDomainListResponseDropDispositionNone SettingDomainListResponseDropDisposition = "NONE"

EmailsProcessed SettingDomainListResponseEmailsProcessedOptional

Timestamp Time

formatdate-time

TotalEmailsProcessed int64

minimum0

TotalEmailsProcessedPrevious int64

minimum0

Folder SettingDomainListResponseFolderOptional

One of the following:

const SettingDomainListResponseFolderAllItems SettingDomainListResponseFolder = "AllItems"

const SettingDomainListResponseFolderInbox SettingDomainListResponseFolder = "Inbox"

InboxProvider SettingDomainListResponseInboxProviderOptional

One of the following:

const SettingDomainListResponseInboxProviderMicrosoft SettingDomainListResponseInboxProvider = "Microsoft"

const SettingDomainListResponseInboxProviderGoogle SettingDomainListResponseInboxProvider = "Google"

IntegrationID stringOptional

formatuuid

IPRestrictions []stringOptional

DeprecatedLastModified TimeOptional

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

LookbackHops int64Optional

ModifiedAt TimeOptional

formatdate-time

O365TenantID stringOptional

Regions []SettingDomainListResponseRegionOptional

One of the following:

const SettingDomainListResponseRegionGlobal SettingDomainListResponseRegion = "GLOBAL"

const SettingDomainListResponseRegionAu SettingDomainListResponseRegion = "AU"

const SettingDomainListResponseRegionDe SettingDomainListResponseRegion = "DE"

const SettingDomainListResponseRegionIn SettingDomainListResponseRegion = "IN"

const SettingDomainListResponseRegionUs SettingDomainListResponseRegion = "US"

RequireTLSInbound boolOptional

RequireTLSOutbound boolOptional

SPFStatus SettingDomainListResponseSPFStatusOptional

One of the following:

const SettingDomainListResponseSPFStatusNone SettingDomainListResponseSPFStatus = "none"

const SettingDomainListResponseSPFStatusGood SettingDomainListResponseSPFStatus = "good"

const SettingDomainListResponseSPFStatusNeutral SettingDomainListResponseSPFStatus = "neutral"

const SettingDomainListResponseSPFStatusOpen SettingDomainListResponseSPFStatus = "open"

const SettingDomainListResponseSPFStatusInvalid SettingDomainListResponseSPFStatus = "invalid"

Status SettingDomainListResponseStatusOptional

One of the following:

const SettingDomainListResponseStatusPending SettingDomainListResponseStatus = "pending"

const SettingDomainListResponseStatusActive SettingDomainListResponseStatus = "active"

const SettingDomainListResponseStatusFailed SettingDomainListResponseStatus = "failed"

const SettingDomainListResponseStatusTimeout SettingDomainListResponseStatus = "timeout"

Transport stringOptional

List protected email domains

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/email_security"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.EmailSecurity.Settings.Domains.List(context.TODO(), email_security.SettingDomainListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "allowed_delivery_modes": [
        "DIRECT"
      ],
      "authorization": {
        "authorized": true,
        "timestamp": "2019-12-27T18:11:19.117Z",
        "status_message": "status_message"
      },
      "created_at": "2014-01-01T05:20:00.12345Z",
      "dmarc_status": "none",
      "domain": "example.com",
      "drop_dispositions": [
        "MALICIOUS"
      ],
      "emails_processed": {
        "timestamp": "2019-12-27T18:11:19.117Z",
        "total_emails_processed": 0,
        "total_emails_processed_previous": 0
      },
      "folder": "AllItems",
      "inbox_provider": "Microsoft",
      "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "ip_restrictions": [
        "192.0.2.0/24",
        "2001:db8::/32"
      ],
      "last_modified": "2014-01-01T05:20:00.12345Z",
      "lookback_hops": 0,
      "modified_at": "2014-01-01T05:20:00.12345Z",
      "o365_tenant_id": "o365_tenant_id",
      "regions": [
        "GLOBAL"
      ],
      "require_tls_inbound": true,
      "require_tls_outbound": true,
      "spf_status": "none",
      "status": "pending",
      "transport": "transport"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "allowed_delivery_modes": [
        "DIRECT"
      ],
      "authorization": {
        "authorized": true,
        "timestamp": "2019-12-27T18:11:19.117Z",
        "status_message": "status_message"
      },
      "created_at": "2014-01-01T05:20:00.12345Z",
      "dmarc_status": "none",
      "domain": "example.com",
      "drop_dispositions": [
        "MALICIOUS"
      ],
      "emails_processed": {
        "timestamp": "2019-12-27T18:11:19.117Z",
        "total_emails_processed": 0,
        "total_emails_processed_previous": 0
      },
      "folder": "AllItems",
      "inbox_provider": "Microsoft",
      "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "ip_restrictions": [
        "192.0.2.0/24",
        "2001:db8::/32"
      ],
      "last_modified": "2014-01-01T05:20:00.12345Z",
      "lookback_hops": 0,
      "modified_at": "2014-01-01T05:20:00.12345Z",
      "o365_tenant_id": "o365_tenant_id",
      "regions": [
        "GLOBAL"
      ],
      "require_tls_inbound": true,
      "require_tls_outbound": true,
      "spf_status": "none",
      "status": "pending",
      "transport": "transport"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}