Change a sending domain

200

The domain after the change

• UpdatedSendingDomain object · extends SendingDomain · all fields required
• bounce_subdomainstring

  example bounce.news.example.com

• checksarray of DomainCheck

  One entry per check that ran, in the canonical order; empty until the domain is first verified.

  3 fields

  • DomainCheck object · all fields required
  • detailstring | null

    What was found instead of what was expected; null when ok.

  • namestring

    spf_bounce, mx_bounce, dkim, dmarc, tracking_cname, tracking_tls or ptr.

    example dkim

  • statusCheckStatus

    How one verification check came out.

    • ok
    • missing
    • mismatch
    • warning
• created_atstring · date-time
• dkim_public_keystring

  The DKIM public key: base64 of its DER SubjectPublicKeyInfo, the p= of the DKIM record (RSA 2048).

• dkim_selectorstring

  example pw1

• dns_providerDnsProvider

  Who applies a domain’s DNS records.

  • porkbun
  • manual
• domainstring

  In punycode for an international name.

  example news.example.com

• idstring · uuid

  example 01900000-0000-7000-8000-000000000001

• ip_poolstring

  example default

• last_checked_atstring · date-time | null

  When the records were last checked (RFC 3339); null until then.

• project_idstring · uuid
• required_recordsarray of RequiredRecord | null

  The records to create after an ip_pool or tracking_host change; null when the change left the domain verified or failed.

  6 fields

  • RequiredRecord object · all fields required
  • contentstring

    The whole value; a TXT value over 255 characters is split into strings by the DNS provider, not here.

    example v=spf1 ip4:203.0.113.10 -all

  • create_only_if_absentboolean

    Create it only if the name has no record of this type, and never change one that is there (the DMARC record).

  • namestring

    The owner name, without a trailing dot.

    example bounce.news.example.com

  • priorityinteger · int32 | null

    The MX priority; null for other types.

    ≥ 0 · example 10

  • purposeRecordPurpose

    What a required record is for.

    • spf_bounce
    • mx_bounce
    • dkim
    • dmarc
    • tracking_cname
  • typeRecordType

    The type of a DNS record.

    • txt
    • mx
    • cname
• statusDomainStatus

  Where a sending domain stands.

  • pending
  • verified
  • failed
• tracking_hoststring | null

  null: none.

• updated_atstring · date-time

400

Not JSON (invalid_json)

Problem (application/problem+json)

401

No valid key

Problem (application/problem+json)

403

A project key without scope write (forbidden)

Problem (application/problem+json)

404

No such project or domain in it, or another project’s (not_found)

Problem (application/problem+json)

422

Invalid fields (validation_failed): an ip_pool the node does not declare is unknown_ip_pool, clearing ip_pool or dns_provider is invalid; or a new tracking_host needs web.public_url or the change’s records cannot be built (precondition_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)