The node

200

The node

• ServerResponse object · all fields required
• available_transportsarray of string

  The transports this node can send through now; a message whose transport is not here is not sent (test-send answers 422 transport_unavailable). Empty until the built-in direct and relay transports ship.

  example []

• default_transportstring

  The transport a project without its own uses.

  example direct

• dns_providersarray of string

  DNS providers a sending domain may name: manual always, porkbun when it is configured.

  example ["manual","porkbun"]

• enabled_subservicesarray of string

  Subservices enabled on this node, in start order: api, mcp, web, smtp.inbound, delivery.

  example ["api","mcp","web","smtp.inbound","delivery"]

• ip_poolsarray of IpPool

  IP pools by name, for a sending domain’s ip_pool.

  3 fields

  • IpPool object · all fields required
  • address_countinteger

    ≥ 0 · example 1

  • addressesarray of IpPoolAddress | null

    The addresses; shown to an admin key only, null for a project key.

    3 fields

    • IpPoolAddress object · all fields required
    • hostnamestring

      The EHLO name; the address’s PTR points to it.

      example mx1.example.com

    • ipstring | null

      The local address the node sends from; null: the system route behind NAT.

      example 203.0.113.10

    • public_ipstring | null

      The public address behind NAT; null when there is no NAT.

  • namestring

    example default

• transportsarray of string

  Delivery transports a project may use: direct (built in) and relay:<name> for each configured relay.

  example ["direct","relay:ses"]

• versionstring

  Postwind version and git commit, as postwind --version prints them.

  example 0.1.0 (abc1234)

401

No key (key_missing), not a valid key (key_invalid), a revoked key (key_revoked) or an expired one (key_expired)

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)