Get a sending subdomain

client.emailSending.subdomains.get(, ?, ?): SubdomainGetResponse { enabled, name, tag, 4 more }

GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

Gets information for a specific sending subdomain.

Security

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

ParametersExpand Collapse

subdomainId: string

Sending subdomain identifier.

maxLength32

params: SubdomainGetParams { zone_id }

zone_id?: string

Identifier.

maxLength32

ReturnsExpand Collapse

SubdomainGetResponse { enabled, name, tag, 4 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

name: string

The subdomain domain name.

tag: string

Sending subdomain identifier.

maxLength32

created?: string

The date and time the destination address has been created.

formatdate-time

dkim_selector?: string

The DKIM selector used for email signing.

modified?: string

The date and time the destination address was last modified.

formatdate-time

return_path_domain?: string

The return-path domain used for bounce handling.

Get a sending subdomain

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const subdomain = await client.emailSending.subdomains.get('aabbccdd11223344aabbccdd11223344', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(subdomain.enabled);

{
  "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": {
    "enabled": true,
    "name": "sub.example.com",
    "tag": "aabbccdd11223344aabbccdd11223344",
    "created": "2014-01-02T02:20:00Z",
    "dkim_selector": "cf-bounce",
    "modified": "2014-01-02T02:20:00Z",
    "return_path_domain": "cf-bounce.sub.example.com"
  }
}

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": {
    "enabled": true,
    "name": "sub.example.com",
    "tag": "aabbccdd11223344aabbccdd11223344",
    "created": "2014-01-02T02:20:00Z",
    "dkim_selector": "cf-bounce",
    "modified": "2014-01-02T02:20:00Z",
    "return_path_domain": "cf-bounce.sub.example.com"
  }
}