Hoppa till innehållet

Read this key's server

GET/v1/server

TypeScript sendora.server.get()

Python sendora.server.get()

Key sk_… a server key

The server the key belongs to, whether it is live or a test server, every limit a send on it is held to with how much of it this minute and this month have used, and the sending domains a from address on it may use.

Responses

200The server this key belongs to, its mode, its limits with their use and the domains it may send from.

  • 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
  • limitsarray of objectrequired

    Every limit a single send is held to: on a live server the account's per-minute limit and monthly cap, and the server's own where Sendora set them; on a test server the test cap its account's test servers share.

    • scope"account" | "server" | "test"required

      Whose limit it is: account for the account's, server for the server's own, test for the cap the account's test servers share.

    • period"minute" | "month"required

      The UTC minute or the calendar month in UTC the limit counts over.

    • limitintegerrequired

      Emails allowed in the period, one per recipient.

    • usedintegerrequired

      Emails the period has taken so far.

    • resetsAtstring (date-time)required

      When the period ends and the count starts again.

  • sendingDomainsarray of objectrequired

    The account's sending domains a from address on this server may use now: every verified one, one in its 24-hour warning with failingSince set. Sending domains are the account's; an account key or the dashboard adds one.

    • domainstringrequired

      The domain, as the part of a from address after the @.

    • failingSincestring (date-time) or nullrequired

      When a check first found one of its records missing or wrong; mail keeps going out, and the first check 24 hours after this that still misses one ends the verification. Null while every record is in place.

Example (28 lines)
{
  "serverId": "7c1e4d2a-0b9f-4a3e-8d6c-5e2f1a9b8c70",
  "name": "Invoicing",
  "mode": "live",
  "createdAt": "2026-09-20T12:00:00.000Z",
  "limits": [
    {
      "scope": "account",
      "period": "minute",
      "limit": 300,
      "used": 4,
      "resetsAt": "2026-09-24T10:01:00.000Z"
    },
    {
      "scope": "account",
      "period": "month",
      "limit": 10000,
      "used": 812,
      "resetsAt": "2026-10-01T00:00:00.000Z"
    }
  ],
  "sendingDomains": [
    {
      "domain": "example.se",
      "failingSince": null
    }
  ]
}

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.