Hoppa till innehållet

Read a server

GET/v1/servers/{id}

TypeScript account.servers.get(serverId)

Python account.servers.get(server_id)

Key ak_… an account key

Parameters

  • idin pathstring (uuid)required

    The server id.

Responses

200A server of the account: an isolation boundary with its own keys, streams, log, suppressions and webhooks.

  • serverIdstring (uuid)required

    The id every server key, stream and message of the server refers to.

  • namestring (at least 1, at most 100 characters)required

    The name given at creation, unique within the account.

  • mode"live" | "test"required

    live delivers; test goes through everything but delivery, so nothing reaches a recipient. Fixed when the server is created.

  • createdAtstring (date-time)required

Example

{
  "serverId": "7c1e4d2a-0b9f-4a3e-8d6c-5e2f1a9b8c70",
  "name": "Invoicing",
  "mode": "live",
  "createdAt": "2026-09-20T12:00:00.000Z"
}

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

CodeStatusMeaning
unauthorized401The key is missing, malformed or revoked.
wrong_token_kind403The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.
not_found404No such server of this account.