peskybird
API reference › Server

Server info

GEThttps://peskybird.app/api/push/.well-known/peskybird
Auth None

Describes the server: its name, the protocol versions it speaks and what it exposes. No token needed; useful as a health check.

Response 200

Server descriptor.

  • namestringRequired

    Display name of the server.

    at most 128 characters
  • versionstringRequired

    Server software version, for diagnostics.

    at most 64 characters
  • protocolintegerRequired

    Protocol version this server speaks by default. Clients store it per server profile.

    more than 0
  • supportedProtocolsobjectRequired

    Inclusive range of protocol versions the server can serve.

    Fields (2)
    • minintegerRequired

      Oldest protocol version served.

      more than 0
    • maxintegerRequired

      Newest protocol version served.

      more than 0
  • groupspairing | device | sync | publish | admin[]Required

    Groups the host exposed on this mount; meta is implied.

Show 2 more optional fields
  • timedate-time

    Server clock, so the app can detect gross skew.

  • multiTenantboolean

    True on a server that hosts several accounts at one address: pairing then calls POST /pair/preview to show the account, and the app keeps one profile per account.

Errors

429rate_limited: The account reached its daily limit, or the token sent too fast.

Every error uses the same envelope. Error format and codes