Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

GET/api/v1/projects/{project_id}/domains

Needs scope: readMCP tool: list_sending_domains operationId list_sending_domains

List sending domains

The project’s domains in creation order, a page at a time. Needs scope read.

Parameters

NameInTypeDescription
project_idrequired path string · uuid The project’s id
limit query integer · int64

1–500

Page size, 1 to 500; default 50
cursor query string next_cursor of the previous page

Request body

None.

Responses

200

One page

  • SendingDomainList object · all fields required
  • itemsarray of SendingDomain

    In creation order.

    14 fields
    • SendingDomain object · 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

      • 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
    • Where a sending domain stands.

      • pending
      • verified
      • failed
    • tracking_hoststring | null

      null: none.

    • updated_atstring · date-time
  • next_cursorstring | null

    Pass as cursor for the next page; null on the last page.

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such project, or another project’s (not_found)

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)

HeaderTypeDescription
Retry-AfterintegerSeconds until the key’s next request passes; rounded up.

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)