Postwind Pre-release Download
Docs menu get_server_info

Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Server HTTP API

GET/api/v1/server

get_server_info

Describes the Postwind node that answered.

Call it
to check the connection, and before adding a sending domain, to choose its dns_provider and ip_pool.
Needs
any valid key, nothing else.
Returns
version, enabled_subservices, transports (direct, relay:<name>), default_transport, dns_providers and ip_pools (name, address_count, and addresses for an admin key only, null for a project key); the same as GET /api/v1/server.

Arguments

No arguments.

No other arguments are accepted.

Result

The result comes back as structuredContent, with the same JSON as a text block.

  • 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 (send_test_email fails with precondition_failed, transport_unavailable). Empty until the built-in direct and relay transports ship.

  • default_transportstring

    The transport a project without its own uses.

  • dns_providersarray of string

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

  • enabled_subservicesarray of string

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

  • ip_poolsarray of Pool

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

    3 fields
    • Pool object · all fields required
    • address_countinteger · uint

      ≥ 0

    • addressesarray of PoolAddress | null

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

      3 fields
      • PoolAddress object · all fields required
      • hostnamestring

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

      • ipstring | null

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

      • public_ipstring | null

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

    • namestring
  • transportsarray of string

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

  • versionstring

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

Definitions

Pool

An IP pool: a named set of outbound addresses.

  • object · all fields required
  • address_countinteger · uint

    ≥ 0

  • addressesarray of PoolAddress | null

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

    see PoolAddress

  • namestring

PoolAddress

One outbound address of an IP pool.

  • object · all fields required
  • hostnamestring

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

  • ipstring | null

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

  • public_ipstring | null

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

Errors

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors

HTTP API

The same operation over HTTP: GET /api/v1/server