Zappocity account API

Whether the account is to be deleted

• 200 The deletion state.

  {
    "confirmWith": "password",
    "deleteAfter": null
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Delete my Zappocity account

• 202 Scheduled.

  {
    "deleteAfter": "2026-10-23T12:00:00Z",
    "status": "active"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Wrong password or email
• 409 Refused, with the reason in detail: the only owner of an organization, or a mailbox under a legal hold or its team's last owner.

Keep my Zappocity account (and the mailboxes scheduled with it)

• 204 No longer to be deleted.
• 401 Not signed in, or the CSRF token is missing or wrong.

Make a supporto.city help desk

{
  "name": "Acme Support"
}

• 201 The desk.

  {
    "name": "Acme Support",
    "slug": "acme-support",
    "url": "https://acme-support.supporto.city/support"
  }

• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The email is not confirmed.
• 409 Too many desks.
• 422 A value is not acceptable, such as a password under 12 characters.

The person's invitation link and the invitations they sent

• 200 The link and invitations.

  {
    "items": [
      {
        "email": "bob@example.com",
        "joined": true,
        "sentAt": "2026-10-08T12:00:00Z"
      }
    ],
    "joined": 1,
    "link": "https://zappo.city/account#signup\u0026invite=k3j9m2xp4q"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Email an invitation

{
  "email": "bob@example.com"
}

• 204 Sent.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The person's own address is not confirmed.
• 409 That address already has an account.
• 422 Not an email address
• 429 Enough invitations for today.

Your mailboxes and where Mailocity is

• 200 The mailboxes.

  {
    "links": {
      "manage": "https://manage.example.com/",
      "signup": "https://join.example.com/",
      "webmail": "https://mail.example.com/"
    },
    "mailboxes": [
      {
        "address": "amy@acme.example",
        "orgId": "2f1c7d2e-58a4-4f0e-9d3c-2f1f8f3f0a11",
        "team": "Acme Inc"
      }
    ],
    "offered": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

The account and its organizations

• 200 The account.

  {
    "orgs": [
      {
        "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
        "orgKind": "company",
        "orgName": "Acme",
        "role": "owner",
        "subscriptions": [
          {
            "period": "year",
            "plan": "team",
            "product": "mailocity",
            "status": "active"
          }
        ]
      }
    ],
    "person": {
      "email": "amy@example.com",
      "emailVerifiedAt": "2026-10-08T12:00:00Z",
      "id": "6c1f0b7e-2d4a-4b8e-9f3c-1a2b3c4d5e6f",
      "name": "Amy",
      "number": 17,
      "timeZone": "Europe/London"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Change your name or time zone

{
  "timeZone": "America/Toronto"
}

• 200 The account.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 422 A value is not acceptable, such as a password under 12 characters.

Pay open invoices from credit

• 200 The invoices paid.

  {
    "items": [
      {
        "number": 7,
        "paymentMethod": "credit",
        "status": "paid"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle

An organization's balance, history and invoices

• 200 The billing.

  {
    "billing": {
      "address": {
        "city": "Berlin",
        "country": "DE",
        "line1": "Hauptstr. 1",
        "postalCode": "10115"
      },
      "autoPay": true,
      "balanceCents": 2500,
      "free": false,
      "taxId": {
        "type": "eu_vat",
        "value": "DE123456789"
      }
    },
    "creditNotes": [
      {
        "amountCents": 2500,
        "createdAt": "2026-11-05T13:20:49Z",
        "invoiceNumber": 7,
        "kind": "credit",
        "number": 12,
        "reason": "Outage on 3 November",
        "tag": "CN-12"
      }
    ],
    "disputes": [],
    "invoices": [],
    "ledger": [],
    "org": {
      "name": "Acme"
    },
    "payments": true,
    "paymentsTest": false,
    "taxEnabled": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle.

Pay invoices automatically or not; the billing address and tax number

{
  "address": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Hauptstr. 1",
    "postalCode": "10115"
  },
  "taxId": {
    "type": "eu_vat",
    "value": "DE123456789"
  }
}

• 200 The billing profile.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle.
• 422 The address or tax number is not valid.

The organization's coupons

• 200 The redemptions.

  {
    "items": [
      {
        "active": true,
        "by": "pat@acme.test",
        "coupon": {
          "code": "WELCOME20",
          "description": "20% off your first three months",
          "kind": "percent",
          "percentOff": 20
        },
        "discountCents": 200,
        "endReason": null,
        "endedAt": null,
        "endsAt": "2027-01-09T12:00:00Z",
        "id": "0b8e5f43-2d6c-4c55-8f1e-7c9a3e2d1b00",
        "invoices": 1,
        "invoicesLeft": null,
        "redeemedAt": "2026-10-09T12:00:00Z"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such organization

Redeem a code

{
  "code": "WELCOME20"
}

• 201 The redemption.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Missing or wrong X-CSRF-Token header.
• 404 No such code (or organization).
• 409 Refused, with the reason in detail (expired, used up, first order only...).
• 429 Too many wrong codes.

A credit note as a PDF file

• 200 The PDF file, shown in the browser (Content-Disposition inline, named after its number, such as ZI-12.pdf).
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such credit note of this organization

Add funds (buy credit ahead)

{
  "amountCents": 5000
}

• 200 Where to go to pay.

  {
    "url": "https://checkout.stripe.com/c/pay/cs_live_xxx"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Adding funds is not offered.
• 404 No such organization
• 422 The amount is outside the limits
• 503 Card payments are not set up.

One invoice with its lines

• 200 The invoice.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such invoice of this organization.

Pay an open invoice now

• 200 Where to go.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such invoice of this organization.
• 409 The invoice has nothing to pay.
• 503 Card payments are not set up.

An invoice as a PDF file

• 200 The PDF file, shown in the browser (Content-Disposition inline, named after its number, such as ZI-12.pdf).
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such invoice of this organization

Pay several invoices at once

{
  "invoices": [
    "0d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6",
    "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
  ]
}

• 200 The payment page.

  {
    "totalCents": 14500,
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle
• 422 No invoices
• 503 Payments are not set up.

Save a payment method

• 200 Where to go.

  {
    "url": "https://checkout.stripe.com/c/pay/cs_..."
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle.
• 503 Card payments are not set up.

Remove the saved payment method

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle.
• 503 Card payments are not set up.

Confirm a payment method saved on the provider's page

{
  "sessionId": "cs_test_a1B2c3D4"
}

• 200 Saved.

  {
    "paymentMethod": "Visa ending 4242 (test)"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose billing you handle.
• 422 Not a finished setup of this organization (another organization's or customer's
• 503 Card payments are not set up.

A quote sent to the organization as a PDF file (an estimate)

• 200 The PDF file, shown in the browser (Content-Disposition inline, named after its number, such as ZI-12.pdf).
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such quote sent to this organization

Subscribe an organization to a product's plan

{
  "period": "year",
  "plan": "tether_pro",
  "product": "tether"
}

• 201 The subscription.

  {
    "canceledAt": null,
    "createdAt": "2026-10-26T12:00:00Z",
    "id": "6f1c0d2e-5b7a-4c1e-9a3d-2b8e4f6a1c90",
    "orgId": "0b9a7c4e-2d1f-4e8a-b6c3-5a7d9e1f2b40",
    "orgName": "Acme",
    "period": "year",
    "plan": "tether_pro",
    "product": "tether",
    "renewsAt": "2026-10-26T12:00:00Z",
    "resourceRef": "org-0b9a7c4e",
    "seats": 1,
    "status": "active",
    "unpaidSuspendedAt": null,
    "updatedAt": "2026-10-26T12:00:00Z"
  }

• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Not an owner or billing member
• 404 No such organization
• 409 Refused

Change a self-serve subscription's plan, seats or billing period

• 200 The subscription.
• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Not an owner or billing member.
• 404 No such subscription here.
• 409 Refused

Change your password

• 204 Changed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The current password is not right (it counts as a failed sign-in).
• 422 A value is not acceptable, such as a password under 12 characters.

A product's plans and prices

• 200 Its active plans.

  {
    "currency": "USD",
    "plans": [
      {
        "active": true,
        "code": "team",
        "features": [
          "help_center",
          "sla"
        ],
        "limits": {
          "agents": -1,
          "agentsBySeats": 1,
          "queues": -1
        },
        "name": "Team",
        "perSeat": true,
        "prices": {
          "month": 2280,
          "year": 22800
        }
      }
    ]
  }

• 404 Not a self-serve product.

The person's points, their history and what the program gives

• 200 The points.

  {
    "items": [
      {
        "at": "2026-10-09T12:00:00Z",
        "balance": 520,
        "by": "Zappocity loyalty",
        "description": "Referral: bob@example.com became a customer",
        "id": 7,
        "kind": "referral",
        "points": 500,
        "reference": ""
      }
    ],
    "points": 520,
    "program": {
      "enabled": true,
      "invitations": true,
      "inviteCostPoints": 100,
      "inviteUsedPoints": 20,
      "minRedeemPoints": 500,
      "pointValue": 100,
      "pointsPerDollar": 1,
      "referralPoints": 500,
      "welcomePoints": 200
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Turn points into credit for an organization

{
  "orgId": "3c1d9a7e-55b2-4b8e-9e1f-0a2b3c4d5e6f",
  "points": 500
}

• 201 The points entry and the credit entry.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Missing or wrong X-CSRF-Token header.
• 404 No such organization
• 409 Refused, with the reason in detail: the program is off, fewer than minRedeemPoints, or not enough points.

Get more Mailocity invitations for points

{
  "count": 2
}

• 201 The points entry and how many invitations the mailbox now has.

  {
    "entry": {
      "balance": 320,
      "kind": "invitations",
      "points": -200
    },
    "invitationsLeft": 3
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Missing or wrong X-CSRF-Token header.
• 409 Refused, with the reason in detail: not offered, not enough points, or no Mailocity mailbox (the points are given back).

The person's profile and badges

• 200 The profile and badges.

  {
    "badges": [
      {
        "color": "success",
        "icon": "star",
        "key": "early-adopter",
        "name": "Early adopter",
        "rule": "early_adopter"
      }
    ],
    "profile": {
      "bio": "Support lead",
      "createdAt": "2026-10-09T12:00:00Z",
      "handle": "pat",
      "name": "Pat Lee",
      "personId": "19adb6dd-1eac-4d74-8134-2668d30e9561",
      "pronouns": "they/them",
      "visible": true,
      "website": "https://pat.example"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Change the profile

{
  "bio": "Support lead",
  "handle": "pat",
  "name": "Pat Lee",
  "pronouns": "they/them",
  "visible": true,
  "website": "https://pat.example"
}

• 200 The profile and badges.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Missing or wrong X-CSRF-Token header.
• 409 That handle is taken.
• 422 A value is not valid.

Someone's visible profile

• 200 The profile and the badges that show.

  {
    "badges": [
      {
        "color": "primary",
        "icon": "user",
        "key": "staff",
        "name": "Staff",
        "rule": "staff"
      }
    ],
    "bio": "Support lead",
    "handle": "pat",
    "name": "Pat Lee",
    "pronouns": "they/them",
    "visible": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such visible profile.

Whether sign-ins from new devices are emailed

• 200 The setting.

  {
    "newSignIn": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Turn sign-in alerts on or off

{
  "newSignIn": false
}

• 200 The setting.
• 401 Not signed in, or the CSRF token is missing or wrong.

The account's security keys and passkeys

• 200 The keys.

  {
    "items": [
      {
        "createdAt": "2026-10-08T12:00:00Z",
        "id": "q8V2...",
        "lastUsed": "2026-10-09T08:30:00Z",
        "name": "YubiKey 5C",
        "passkey": false
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Finish adding a key or passkey

{
  "challengeId": "5b0b4c1e-7d1a-4f5e-9a3b-1c2d3e4f5a6b",
  "credential": {
    "id": "q8V2...",
    "rawId": "q8V2...",
    "response": {
      "attestationObject": "o2Nm...",
      "clientDataJSON": "eyJ0..."
    },
    "type": "public-key"
  },
  "name": "YubiKey 5C"
}

• 201 Added.

  {
    "id": "q8V2...",
    "name": "YubiKey 5C",
    "passkey": false,
    "recoveryCodes": [
      "k3j9-2mxp",
      "..."
    ]
  }

• 400 The challenge expired or was used.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 409 The key is already registered
• 422 The key's answer did not check out.

Start adding a key or passkey

{
  "currentPassword": "correct horse battery",
  "passkey": true
}

• 200 The options.

  {
    "challengeId": "5b0b4c1e-7d1a-4f5e-9a3b-1c2d3e4f5a6b",
    "options": {
      "publicKey": {
        "challenge": "Wm9...",
        "pubKeyCredParams": [
          {
            "alg": -7,
            "type": "public-key"
          }
        ],
        "rp": {
          "id": "zappo.city",
          "name": "Zappocity"
        }
      }
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Wrong password.

Rename a key

{
  "name": "Backup YubiKey"
}

• 204 Renamed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such key.

Remove a key or passkey

{
  "currentPassword": "correct horse battery"
}

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Wrong password.
• 404 No such key.

Where you are signed in

• 200 Most recently used first.

  {
    "items": [
      {
        "createdAt": "2026-10-08T12:00:00Z",
        "current": true,
        "expiresAt": "2026-11-07T12:00:00Z",
        "id": 4,
        "ip": "203.0.113.9",
        "lastSeen": "2026-10-08T12:30:00Z",
        "userAgent": "Firefox"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Sign out everywhere else

• 204 Done.
• 401 Not signed in, or the CSRF token is missing or wrong.

Your recent sign-in attempts

• 200 Newest first, at most 100.

  {
    "items": [
      {
        "at": "2026-10-08T12:00:00Z",
        "email": "amy@example.com",
        "ip": "203.0.113.9",
        "reason": "password",
        "success": false,
        "userAgent": "Firefox"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Your SSH keys, and how to reach Hatch

• 200 The keys.

  {
    "hatch": {
      "enabled": true,
      "fingerprint": "SHA256:k3yF1ngerprintExampleExampleExampleExample0",
      "host": "hatch.example.com",
      "port": 2222,
      "user": "amy@example.com"
    },
    "items": [
      {
        "createdAt": "2026-11-08T12:00:00Z",
        "fingerprint": "SHA256:Hq3Y0exampleexampleexampleexampleexample0",
        "id": "4d5e6f70-8192-4a3b-9c4d-5e6f708192a3",
        "lastUsedAt": null,
        "name": "amy@laptop",
        "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleKeyOnly"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Add an SSH key

{
  "currentPassword": "your current password",
  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleKeyOnly amy@laptop"
}

• 201 Added.

  {
    "createdAt": "2026-11-08T12:00:00Z",
    "fingerprint": "SHA256:Hq3Y0exampleexampleexampleexampleexample0",
    "id": "4d5e6f70-8192-4a3b-9c4d-5e6f708192a3",
    "lastUsedAt": null,
    "name": "amy@laptop",
    "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleKeyOnly"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Your current password is not right.
• 409 That key is on an account already (this one or another; whose is not said).
• 422 Not a public key Hatch takes, no password on the account, or 20 keys already.

Remove an SSH key

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such key on your account.

Your organizations' object storage

• 200 The accounts and the endpoint.

  {
    "endpoint": {
      "enabled": true,
      "host": "s3.example.com",
      "pathStyle": true,
      "region": "us-east-1",
      "url": "https://s3.example.com"
    },
    "items": [
      {
        "buckets": 2,
        "bytesUsed": 1048576,
        "canManage": true,
        "id": "6f1d2c3b-4a5e-4f60-8172-839a4b5c6d7e",
        "limits": {
          "buckets": 10,
          "storageBytes": 250000000000
        },
        "name": "Acme Files",
        "orgId": "0a1b2c3d-4e5f-4061-8273-94a5b6c7d8e9",
        "orgName": "Acme Files",
        "plan": "starter",
        "status": "active"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

A storage account's buckets

• 200 The buckets, by name.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You are in the organization but don't manage its storage.
• 404 No such storage account of yours.

Make a bucket

{
  "name": "acme-backups"
}

• 201 Made.

  {
    "accountId": "6f1d2c3b-4a5e-4f60-8172-839a4b5c6d7e",
    "bytes": 0,
    "createdAt": "2026-11-08T12:00:00Z",
    "id": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
    "name": "acme-backups",
    "objects": 0
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You don't manage this account's storage.
• 404 No such storage account of yours.
• 409 The name is taken (by you or anyone), or the account is suspended.
• 422 Not a bucket name we take, or the plan's buckets are used.

Remove an empty bucket

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You don't manage this account's storage.
• 404 No such bucket in this account.
• 409 The bucket holds objects or unfinished uploads, or the account is suspended.

A storage account's access keys

• 200 The keys, oldest first.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You don't manage this account's storage.
• 404 No such storage account of yours.

Make an access key

{
  "bucketId": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
  "name": "backup server",
  "readOnly": false
}

• 201 Made; keep the secret now.

  {
    "key": {
      "accessKeyId": "ZKEXAMPLEEXAMPLEEXA",
      "accountId": "6f1d2c3b-4a5e-4f60-8172-839a4b5c6d7e",
      "bucketId": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
      "createdAt": "2026-11-08T12:00:00Z",
      "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f9a0",
      "lastUsedAt": null,
      "name": "backup server",
      "readOnly": false
    },
    "secretAccessKey": "your-secret-is-shown-here-once"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You don't manage this account's storage.
• 404 No such storage account of yours.
• 409 The account is suspended.
• 422 No name, a bucket that isn't this account's, or 50 keys already.

Remove an access key

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 You don't manage this account's storage.
• 404 No such key in this account.
• 409 The account is suspended.

Whether two-step sign-in is on

• 200 The state.

  {
    "enabled": true,
    "recoveryCodesLeft": 9
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Turn two-step sign-in off

• 204 Off.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The password or code is not right (it counts as a failed sign-in).

Turn it on with a first code

• 200 The recovery codes.

  {
    "recoveryCodes": [
      "abcd-efgh-jkmn"
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 409 Setup was not started.
• 422 The code is not right.

Replace the recovery codes

• 200 The new codes
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The password is not right.
• 409 Two-step sign-in is off.

Start setting up an authenticator app

• 200 The secret.

  {
    "qrCode": "data:image/png;base64,...",
    "secret": "JBSWY3DPEHPK3PXP",
    "uri": "otpauth://totp/Zappocity:amy@example.com?secret=..."
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The password is not right.
• 409 It is already on.

The quotes we sent an organization

• 200 The quotes.

  {
    "items": [
      {
        "answeredAt": null,
        "answeredBy": "",
        "declineReason": "",
        "expired": false,
        "firstCents": 27500,
        "id": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
        "invoiceId": null,
        "lines": [
          {
            "description": "Mailbox migration, hours",
            "period": "once",
            "quantity": 3,
            "unitCents": 7500
          },
          {
            "description": "Priority support",
            "period": "month",
            "quantity": 1,
            "unitCents": 5000
          }
        ],
        "monthlyCents": 5000,
        "notes": "",
        "number": 1001,
        "orgId": "9f8e7d6c-5b4a-4321-8fed-cba987654321",
        "orgName": "Acme Co",
        "sentAt": "2026-11-05T12:00:00Z",
        "status": "sent",
        "subject": "Migration and priority support",
        "tag": "ZQ-1001",
        "validUntil": "2026-12-05T23:59:59Z",
        "yearlyCents": 0
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such organization

Accept a quote

• 200 The quote, accepted, and its invoice.

  {
    "invoice": {
      "number": 1043,
      "status": "open",
      "totalCents": 27500
    },
    "quote": {
      "status": "accepted",
      "tag": "ZQ-1001"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such quote or organization
• 409 Already answered
• 410 Expired.

Decline a quote

{
  "reason": "Over budget this quarter."
}

• 200 The quote
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such quote or organization
• 409 Already answered
• 410 Expired.
• 422 The reason is too long.

Your DNS accounts

• 200 The accounts.

  {
    "items": [
      {
        "canEdit": true,
        "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6a7b",
        "name": "Acme",
        "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
        "orgName": "Acme",
        "plan": "free",
        "status": "active",
        "zones": 1
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Start a dnso.city DNS account

{
  "name": "Acme"
}

• 201 The DNS account.
• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 The email is not confirmed.
• 409 Not open yet
• 422 A value is not acceptable, such as a password under 12 characters.

A DNS account's zones

• 200 The zones.

  {
    "account": {
      "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6a7b",
      "name": "Acme",
      "plan": "personal",
      "status": "active"
    },
    "items": [
      {
        "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
        "name": "example.com",
        "records": 2,
        "serial": 2026100901,
        "status": "active"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such DNS account

Serve a zone

• 201 The zone.
• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account
• 409 The zone is served already, or the plan's limit is reached.
• 422 The record or zone is not valid

A zone and its records

• 200 The zone and its records.

  {
    "dnssec": {
      "algorithm": 13,
      "ds": "24680 13 2 9A1B...",
      "dsRecord": "example.com.\t3600\tIN\tDS\t24680 13 2 9A1B...",
      "keyTag": 24680,
      "ready": true
    },
    "records": [
      {
        "data": "10 mail.example.com.",
        "id": "3c4d5e6f-7081-4293-a4b5-c6d7e8f90123",
        "name": "@",
        "ttl": 3600,
        "type": "MX"
      }
    ],
    "transfers": {
      "addresses": [],
      "key": null
    },
    "zone": {
      "accountId": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6a7b",
      "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
      "name": "example.com",
      "records": 2,
      "serial": 2026100901,
      "status": "active"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such DNS account

Stop serving a zone

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account
• 409 The zone is served already, or the plan's limit is reached.
• 422 The record or zone is not valid

Check the zone's delegation

• 200 The parent's answer.

  {
    "delegation": {
      "checkedAt": "2026-10-09T12:00:00Z",
      "ds": "off",
      "missing": [
        "ns2.dnso.city"
      ],
      "nameServers": [
        "ns1.dnso.city",
        "ns1.oldhost.net"
      ],
      "parent": "com",
      "status": "partly"
    },
    "expected": [
      "ns1.dnso.city",
      "ns2.dnso.city"
    ],
    "zone": "example.com"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such DNS account or zone here.
• 503 Delegation is not checked by this server.

Set a secondary zone's primaries

{
  "addresses": [
    "192.0.2.53"
  ],
  "key": {
    "algorithm": "hmac-sha256",
    "name": "transfer.example.org",
    "secret": "c2VjcmV0LXNlY3JldC1zZWNyZXQtc2VjcmV0LTAxMjM="
  }
}

• 200 The zone
• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here.
• 409 The zone is not a secondary.
• 422 An address or the key is not valid.

The provider the zone is pushed to

• 200 Whether and where the zone is pushed, and how the last push went.

  {
    "changes": 3,
    "error": "",
    "inStep": true,
    "linked": true,
    "mode": "authoritative",
    "offered": true,
    "provider": "cloudflare",
    "pushedAt": "2026-11-07T12:00:00Z",
    "pushedSerial": 12,
    "secretsSet": [
      "apiToken"
    ],
    "settings": {},
    "unmanaged": [
      {
        "data": "1 . alpn=h2",
        "name": "@",
        "ttl": 300,
        "type": "HTTPS"
      }
    ],
    "updatedAt": "2026-11-07T11:59:00Z"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such DNS account or zone here.

Link the zone to the provider whose name servers answer for it

{
  "credentials": {
    "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
    "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "mode": "authoritative",
  "provider": "route53"
}

• 200 The link, with `imported` (records added to dnso.city), `leftAtProvider` and any `warning`.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here
• 409 The provider's records would pass the plan's limit.
• 422 Not a provider, missing or malformed credentials, a secondary zone, or the provider could not be read with them.

Stop pushing the zone

• 204 Unlinked.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here

Bring the provider's unmanaged records into dnso.city

{
  "sets": [
    "www A",
    "@ MX"
  ]
}

• 200 The link, with `adopted` (records added).
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here
• 409 The records would pass the plan's limit.
• 422 The provider could not be read.

Push the zone now

• 200 The link and how the push went.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here

Add a record

{
  "data": "10 mail.example.com.",
  "name": "@",
  "ttl": 3600,
  "type": "MX"
}

• 201 The zone and its records.

  {
    "dnssec": {
      "algorithm": 13,
      "ds": "24680 13 2 9A1B...",
      "dsRecord": "example.com.\t3600\tIN\tDS\t24680 13 2 9A1B...",
      "keyTag": 24680,
      "ready": true
    },
    "records": [
      {
        "data": "10 mail.example.com.",
        "id": "3c4d5e6f-7081-4293-a4b5-c6d7e8f90123",
        "name": "@",
        "ttl": 3600,
        "type": "MX"
      }
    ],
    "zone": {
      "accountId": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6a7b",
      "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
      "name": "example.com",
      "records": 2,
      "serial": 2026100901,
      "status": "active"
    }
  }

• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account
• 409 The zone is served already, or the plan's limit is reached.
• 422 The record or zone is not valid

Replace a record

{
  "data": "10 mail.example.com.",
  "name": "@",
  "ttl": 3600,
  "type": "MX"
}

• 200 The zone and its records.
• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account
• 409 The zone is served already, or the plan's limit is reached.
• 422 The record or zone is not valid

Remove a record

• 200 The zone and its records.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account
• 409 The zone is served already, or the plan's limit is reached.
• 422 The record or zone is not valid

Check a secondary zone now

• 200 The zone, its records and its secondary state.

  {
    "dnssec": {
      "ready": false,
      "secondary": true
    },
    "records": [
      {
        "data": "192.0.2.7",
        "name": "www",
        "ttl": 300,
        "type": "A"
      }
    ],
    "secondary": {
      "expire": 1209600,
      "keyName": "transfer.example.org.",
      "lastCheck": "2026-10-09T12:00:00Z",
      "lastError": "",
      "lastOk": "2026-10-09T12:00:00Z",
      "lastTransfer": "2026-10-09T12:00:00Z",
      "nextCheck": "2026-10-09T13:00:00Z",
      "primaries": [
        "192.0.2.53"
      ],
      "primarySerial": 7,
      "records": 3,
      "refresh": 3600,
      "retry": 600
    },
    "transfers": {
      "addresses": [],
      "key": null
    },
    "zone": {
      "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
      "kind": "secondary",
      "name": "example.org",
      "records": 3,
      "serial": 7,
      "status": "active"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones.
• 404 No such DNS account or zone here.
• 409 The zone is not a secondary.

Set the addresses the zone is transferred to

{
  "addresses": [
    "192.0.2.53",
    "2001:db8::53"
  ]
}

• 200 The zone's transfers; `key.secret` only when the key was just made.

  {
    "addresses": [
      "192.0.2.53",
      "2001:db8::53"
    ],
    "key": {
      "algorithm": "hmac-sha256",
      "createdAt": "2026-10-09T12:00:00Z",
      "name": "xfr.example.com.",
      "secret": "q2Lw...base64...="
    }
  }

• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones, or the plan does not include secondary DNS.
• 404 No such DNS account or zone here.
• 422 An address is not valid, not on the internet, or there are more than 10.

Replace the zone's TSIG key

• 200 The zone's transfers with the new key's secret.

  {
    "addresses": [
      "192.0.2.53"
    ],
    "key": {
      "algorithm": "hmac-sha256",
      "createdAt": "2026-10-09T12:00:00Z",
      "name": "xfr.example.com.",
      "secret": "b7Rk...base64...="
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change its zones, or the plan does not include secondary DNS.
• 404 No such DNS account or zone here.

Invitations to join organizations

• 200 The invitations.

  {
    "emailConfirmed": true,
    "items": [
      {
        "createdAt": "2026-10-18T09:00:00Z",
        "email": "sam@example.com",
        "expiresAt": "2026-11-01T09:00:00Z",
        "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
        "invitedBy": "Alice",
        "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
        "orgName": "Acme",
        "role": "member"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Decline the invitation

• 204 Declined.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Your email address is not confirmed yet.
• 404 No such invitation to your address

Join the organization

• 200 Your membership.

  {
    "createdAt": "2026-01-02T10:00:00Z",
    "email": "alice@example.com",
    "fromMailbox": false,
    "name": "Alice",
    "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
    "orgKind": "company",
    "orgName": "Acme",
    "personId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
    "role": "owner"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Your email address is not confirmed yet.
• 404 No such invitation to your address

Start an organization

{
  "name": "Acme"
}

• 201 The organization.

  {
    "id": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
    "kind": "company",
    "members": 1,
    "name": "Acme",
    "status": "active"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Your email address is not confirmed yet.
• 409 You own the most organizations one person can.
• 422 The name is missing or too long.

Invite someone to the organization

{
  "email": "sam@example.com",
  "role": "member"
}

• 201 The members and invitations
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Your email address is not confirmed
• 404 Not an organization whose members you manage.
• 409 The address is a member's already.
• 422 Not an email address
• 429 You sent the day's invitations.

Withdraw an invitation

• 204 Withdrawn.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such invitation

An organization's members and open invitations

• 200 The members, and invitations not yet answered or expired.

  {
    "invitations": [
      {
        "createdAt": "2026-10-18T09:00:00Z",
        "email": "sam@example.com",
        "expiresAt": "2026-11-01T09:00:00Z",
        "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
        "invitedBy": "Alice",
        "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
        "orgName": "Acme",
        "role": "member"
      }
    ],
    "members": [
      {
        "createdAt": "2026-01-02T10:00:00Z",
        "email": "alice@example.com",
        "fromMailbox": false,
        "name": "Alice",
        "orgId": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
        "orgKind": "company",
        "orgName": "Acme",
        "personId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
        "role": "owner"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 Not an organization whose members you manage.

Change a member's role

{
  "role": "billing"
}

• 200 The members and invitations
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only owners make or change owners.
• 404 No such member
• 409 The organization would have no owner.
• 422 Not one of the roles.

Remove a member, or leave

• 204 Removed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only owners remove owners.
• 404 No such member or organization.
• 409 The last owner

How the organization appears in ARIN's whois

• 200 The choice and the blocks registered.

  {
    "reassignments": [
      {
        "net": "2001:db8:1000:1::/64",
        "netHandle": "NET6-2001-DB8-1000-1-1",
        "status": "registered"
      }
    ],
    "whois": "private"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such organization

Change how the organization appears in ARIN's whois

{
  "whois": "organization"
}

• 200 The choice and the blocks registered.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only the organization's owners change it.
• 404 No such organization
• 422 Not private or organization.

The organization's servers

• 200 The servers.

  {
    "items": [
      {
        "createdAt": "2026-11-06T12:00:00Z",
        "features": [
          "power",
          "usage",
          "ipv6"
        ],
        "id": "1f0c2b9e-3a5d-4a8e-9c1b-7d2e4f6a8b0c",
        "kind": "qemu",
        "name": "Server 1",
        "network": {
          "ipv4": [
            {
              "address": "203.0.113.10",
              "bridge": "",
              "gateway": "",
              "prefix": 32,
              "routed": true
            }
          ],
          "ipv4Management": {
            "address": "10.255.0.10",
            "bridge": "vmbr0",
            "dhcp": true,
            "gateway": "10.255.0.1",
            "network": "10.255.0.0/24"
          },
          "ipv6": {
            "bridge": "vmbr1",
            "dhcp": false,
            "gateway": "2001:db8:ffff::1",
            "management": "2001:db8:ffff::100",
            "network": "2001:db8:ffff::/64",
            "nic": 1,
            "prefix": "2001:db8:1000:1::/64"
          },
          "mac": "bc:24:11:aa:bb:cc"
        },
        "plan": {
          "code": "vps-small",
          "diskGb": 40,
          "ipv4": 1,
          "memoryMb": 2048,
          "name": "Small",
          "snapshots": 3,
          "vcpus": 1
        },
        "setUp": true,
        "state": {
          "cpu": 0.04,
          "cpus": 1,
          "maxmem": 2147483648,
          "mem": 734003200,
          "netin": 1048576,
          "netout": 524288,
          "status": "running",
          "uptime": 86400
        },
        "status": "active",
        "unpaid": ""
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such organization

A server

• 200 The server
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server

Rename a server

{
  "name": "web1"
}

• 200 The server
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 422 The name is empty

A server's access settings

• 200 The access settings.

  {
    "cloudInit": true,
    "hostname": "web1.example.com",
    "passwordSet": true,
    "sshKeys": [
      "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExample amy@laptop"
    ],
    "user": "debian"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, no cloud-init drive, or a field not as described.
• 502 The server could not be reached just now.

Set a server's hostname, user, SSH keys or password

{
  "password": "",
  "reboot": true
}

• 200 The access settings now, the password made (only when one was), and whether it was rebooted.

  {
    "cloudInit": true,
    "hostname": "web1",
    "password": "x7Kp2mQr9TzVw4NcHb3E",
    "passwordSet": true,
    "rebooted": true,
    "sshKeys": [],
    "user": "root"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, no cloud-init drive, or a field not as described.
• 429 Another action was taken on the server a moment ago (reboot only).
• 502 The server could not be reached just now.

A server's backups

• 200 The backups.

  {
    "items": [
      {
        "ctime": 1793500000,
        "notes": "Zappocity: web1",
        "protected": false,
        "size": 1073741824,
        "vmid": 101,
        "volid": "backups:backup/vzdump-qemu-101-2026_11_01-02_00_00.vma.zst"
      }
    ],
    "keep": 7,
    "running": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 409 The server is still being set up.
• 422 Not allowed: the plan has no backups, the server is suspended, or backups are not set up for it yet.
• 429 A backup was taken or restored less than ten minutes ago.
• 502 The server could not be reached just now.

Back a server up now

• 202 Started; the backup appears in the list once Proxmox has finished.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 409 The server is still being set up.
• 422 Not allowed: the plan has no backups, the server is suspended, or backups are not set up for it yet.
• 429 A backup was taken or restored less than ten minutes ago.
• 502 The server could not be reached just now.

Delete one of a server's backups

{
  "volid": "backups:backup/vzdump-qemu-101-2026_11_01-02_00_00.vma.zst"
}

• 200 Deleted.

  {
    "deleted": "backups:backup/vzdump-qemu-101-2026_11_01-02_00_00.vma.zst"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server (or you do not manage the organization's servers), or no such backup of it.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no backups, the server is suspended, or backups are not set up for it yet.
• 429 A backup was taken or restored less than ten minutes ago.
• 502 The server could not be reached just now.

Restore a backup over a server

{
  "volid": "backups:backup/vzdump-qemu-101-2026_11_01-02_00_00.vma.zst"
}

• 202 Started.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server (or you do not manage the organization's servers), or no such backup of it.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no backups, the server is suspended, or backups are not set up for it yet.
• 429 A backup was taken or restored less than ten minutes ago.
• 502 The server could not be reached just now.

The server's text console (a websocket)

• 101 Switched to the websocket.
• 401 Not signed in
• 403 Opened from another site (the Origin is not this site).
• 404 No such server
• 409 The server is still being set up.
• 422 Suspended, the plan has no console, or three consoles are open on it already.
• 502 The console could not be reached.

A server's firewall

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Add a firewall alias

{
  "cidr": "198.51.100.0/24",
  "comment": "Our office",
  "name": "office"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Change a firewall alias

{
  "cidr": "198.51.100.0/25"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Remove a firewall alias

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Make a firewall IP set

{
  "name": "monitoring"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Remove a firewall IP set

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Add to a firewall IP set

{
  "cidr": "203.0.113.5"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Take an address out of a firewall IP set

{
  "cidr": "203.0.113.5"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Set a server's firewall policies and options

{
  "policyIn": "DROP",
  "policyOut": "ACCEPT"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Add a firewall rule

{
  "action": "ACCEPT",
  "comment": "Web",
  "dport": "443",
  "enable": true,
  "proto": "tcp",
  "type": "in"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Change a firewall rule

{
  "action": "ACCEPT",
  "enable": true,
  "macro": "SSH",
  "moveTo": 1,
  "source": "office",
  "type": "in"
}

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

Remove a firewall rule

• 200 The firewall as it is now.

  {
    "addresses": [
      "192.0.2.10",
      "2001:db8:ffff::100",
      "2001:db8:1000:1::/64"
    ],
    "aliases": [
      {
        "cidr": "198.51.100.0/24",
        "comment": "Our office",
        "name": "office"
      }
    ],
    "ipsets": [
      {
        "comment": "",
        "entries": [
          {
            "cidr": "203.0.113.5"
          }
        ],
        "name": "monitoring"
      }
    ],
    "options": {
      "dhcp": true,
      "logLevelIn": "nolog",
      "logLevelOut": "nolog",
      "ndp": true,
      "policyIn": "DROP",
      "policyOut": "ACCEPT"
    },
    "rules": [
      {
        "action": "REJECT",
        "comment": "zappocity: outgoing mail (port 25) is blocked; open a support ticket to have it opened",
        "dport": "25",
        "enable": true,
        "managed": true,
        "pos": 0,
        "proto": "tcp",
        "type": "out"
      },
      {
        "action": "ACCEPT",
        "comment": "SSH from anywhere",
        "enable": true,
        "macro": "SSH",
        "managed": false,
        "pos": 1,
        "type": "in"
      }
    ],
    "smtpOpen": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such rule, alias or IP set on it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a field not one Proxmox takes, or a change to our part (the port 25 rule says to open a support ticket; the IP filter and the firewall staying on are ours).
• 502 The server could not be reached just now.

A server's usage history

• 200 The history.

  {
    "points": [
      {
        "cpu": 0.12,
        "diskread": 4096,
        "diskwrite": 20480,
        "maxmem": 2147483648,
        "mem": 1073741824,
        "netin": 1520.5,
        "netout": 830.2,
        "time": 1793500200
      }
    ],
    "timeframe": "day",
    "vcpus": 2
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no usage graphs, the server is suspended, or the timeframe is not one of those listed.
• 502 The server could not be reached just now.

Start, shut down, stop, reboot or reset a server

{
  "action": "reboot"
}

• 202 Taken.

  {
    "action": "reboot"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 409 The server is still being set up.
• 422 Not allowed: the plan has no power controls, the server is suspended, or the action is unknown.
• 429 Another action was taken a moment ago.
• 502 The server could not be reached just now.

Name one of a server's addresses (reverse DNS)

{
  "address": "192.0.2.10",
  "hostname": "mail.example.com"
}

• 200 The server, with its network's names under reverseDns.

  {
    "network": {
      "reverseDns": {
        "delegation": null,
        "ipv4": [
          "192.0.2.10"
        ],
        "management": true,
        "names": {
          "192.0.2.10": "mail.example.com"
        },
        "prefix": true
      }
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 422 Not the server's address, reverse DNS not offered for it, a name that does not resolve to it, or the server is suspended.

Delegate a server's routed /64 to name servers (reverse DNS)

{
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ]
}

• 200 The server, with the delegation under reverseDns.

  {
    "network": {
      "reverseDns": {
        "delegation": {
          "ds": [],
          "nameservers": [
            "ns1.example.com",
            "ns2.example.com"
          ],
          "prefix": "2001:db8:1000:1::/64",
          "updatedAt": "2026-11-07T12:00:00Z"
        },
        "ipv4": [
          "192.0.2.10"
        ],
        "management": true,
        "names": {},
        "prefix": true
      }
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server
• 422 No routed /64, reverse DNS not offered for it, name servers that do not resolve, dnso.city's without the zone in a DNS account you own, or the server is suspended.

The images a server may be reinstalled from

• 200 The templates.

  {
    "templates": [
      {
        "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
        "name": "Debian 12"
      },
      {
        "id": "6c7d8e9f-0a1b-4c2d-9e3f-4a5b6c7d8e9f",
        "name": "Ubuntu 24.04"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, or a request not as described (the reason says which).
• 502 The server could not be reached just now.

Reinstall a server

{
  "confirm": "web1",
  "templateId": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e"
}

• 202 Erased; the build started.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, or a request not as described (the reason says which).
• 429 Another action was taken on the server a moment ago.
• 502 The server could not be reached just now.

A server's rescue state and images

• 200 The rescue state.

  {
    "active": true,
    "image": "SystemRescue 11",
    "images": [
      {
        "id": "3f1c2a9e-7b4d-4e1a-9c2f-5d6e7f8a9b0c",
        "name": "SystemRescue 11"
      },
      {
        "description": "Installs Debian 12 over the console, with an encrypted disk if wanted",
        "id": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
        "installer": true,
        "name": "Debian 12 installer"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, or a request not as described (the reason says which).
• 502 The server could not be reached just now.

Boot a server from an image

{
  "imageId": "3f1c2a9e-7b4d-4e1a-9c2f-5d6e7f8a9b0c"
}

• 200 In rescue.

  {
    "active": true,
    "image": "SystemRescue 11",
    "images": [
      {
        "id": "3f1c2a9e-7b4d-4e1a-9c2f-5d6e7f8a9b0c",
        "name": "SystemRescue 11"
      },
      {
        "description": "Installs Debian 12 over the console, with an encrypted disk if wanted",
        "id": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
        "installer": true,
        "name": "Debian 12 installer"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, or a request not as described (the reason says which).
• 429 Another action was taken on the server a moment ago.
• 502 The server could not be reached just now.

End rescue

• 200 Out of rescue.

  {
    "active": false,
    "image": "",
    "images": [
      {
        "id": "3f1c2a9e-7b4d-4e1a-9c2f-5d6e7f8a9b0c",
        "name": "SystemRescue 11"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Refused: not in the plan, the server suspended, a container, or a request not as described (the reason says which).
• 429 Another action was taken on the server a moment ago.
• 502 The server could not be reached just now.

A server's snapshots

• 200 The snapshots.

  {
    "items": [
      {
        "description": "Zappocity: web1",
        "name": "before-upgrade",
        "parent": "",
        "ram": false,
        "time": 1793500000
      }
    ],
    "limit": 3,
    "running": false
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such snapshot of it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no snapshots or keeps no more, the name is taken or not one Proxmox takes, the server is suspended, or Proxmox is busy with it.
• 429 A snapshot was taken or rolled back less than two minutes ago.
• 502 The server could not be reached just now.

Snapshot a server now

{
  "description": "Before the PHP upgrade",
  "name": "before-upgrade",
  "ram": false
}

• 202 Started; the snapshot appears in the list once Proxmox has finished.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such snapshot of it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no snapshots or keeps no more, the name is taken or not one Proxmox takes, the server is suspended, or Proxmox is busy with it.
• 429 A snapshot was taken or rolled back less than two minutes ago.
• 502 The server could not be reached just now.

Delete one of a server's snapshots

{
  "name": "before-upgrade"
}

• 202 Started.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such snapshot of it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no snapshots or keeps no more, the name is taken or not one Proxmox takes, the server is suspended, or Proxmox is busy with it.
• 429 A snapshot was taken or rolled back less than two minutes ago.
• 502 The server could not be reached just now.

Roll a server back to one of its snapshots

{
  "name": "before-upgrade"
}

• 202 Started.

  {
    "started": true
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such server, no such snapshot of it, or you do not manage the organization's servers.
• 409 The server is still being set up.
• 422 Not allowed: the plan has no snapshots or keeps no more, the name is taken or not one Proxmox takes, the server is suspended, or Proxmox is busy with it.
• 429 A snapshot was taken or rolled back less than two minutes ago.
• 502 The server could not be reached just now.

The DHCP subnets and reservations, for a Kea host (kea-sync)

• 200 The subnets.

  {
    "host": "kea1",
    "subnets4": [
      {
        "bridge": "vmbr0",
        "id": 1,
        "reservations": [
          {
            "hwAddress": "bc:24:11:aa:bb:01",
            "ipAddress": "192.0.2.2",
            "serverId": "1f0c2b9e-3a5d-4a8e-9c1b-7d2e4f6a8b0c"
          }
        ],
        "routers": "192.0.2.1",
        "subnet": "192.0.2.0/24"
      }
    ],
    "subnets6": [
      {
        "bridge": "vmbr1",
        "id": 6,
        "reservations": [
          {
            "hwAddress": "bc:24:11:aa:bb:61",
            "ipAddress": "2001:db8:ffff::100",
            "prefix": "2001:db8:1000:1::/64",
            "serverId": "1f0c2b9e-3a5d-4a8e-9c1b-7d2e4f6a8b0c"
          }
        ],
        "subnet": "2001:db8:ffff::/64"
      }
    ]
  }

• 401 No Kea host token

The routes, for a router (prefixd)

• 200 The routes.

  {
    "gateway": "2001:db8:ffff::1",
    "gateway4": "10.255.0.1",
    "management": "2001:db8:ffff::/64",
    "management4": "10.255.0.0/24",
    "metadata": "192.0.2.42",
    "pool": "2001:db8:1000::/40",
    "pools4": [
      "203.0.113.0/24"
    ],
    "router": "edge1",
    "routes": [
      {
        "prefix": "2001:db8:1000:1::/64",
        "serverId": "1f0c2b9e-3a5d-4a8e-9c1b-7d2e4f6a8b0c",
        "via": "2001:db8:ffff::100"
      }
    ],
    "routes4": [
      {
        "prefix": "203.0.113.10/32",
        "serverId": "1f0c2b9e-3a5d-4a8e-9c1b-7d2e4f6a8b0c",
        "via": "10.255.0.10"
      }
    ]
  }

• 401 No router token

Sign in with a passkey (start)

• 200 The options and a challengeId.

Sign in with a passkey (finish)

{
  "challengeId": "5b0b4c1e-7d1a-4f5e-9a3b-1c2d3e4f5a6b",
  "credential": {
    "id": "q8V2...",
    "response": {
      "authenticatorData": "SZYN...",
      "clientDataJSON": "eyJ0...",
      "signature": "MEUC...",
      "userHandle": "dXNl..."
    },
    "type": "public-key"
  }
}

• 201 Signed in; as POST /api/account/session.
• 400 The challenge expired or was used.
• 401 The passkey did not check out.

Sign in with a password and a security key (start)

{
  "email": "amy@example.com",
  "password": "correct horse battery"
}

• 200 The options and a challengeId.
• 401 Wrong email or password.
• 409 The account has no security key.
• 429 Too many failed sign-ins.

Sign in with a password and a security key (finish)

{
  "challengeId": "5b0b4c1e-7d1a-4f5e-9a3b-1c2d3e4f5a6b",
  "credential": {
    "id": "q8V2...",
    "response": {
      "authenticatorData": "SZYN...",
      "clientDataJSON": "eyJ0...",
      "signature": "MEUC..."
    },
    "type": "public-key"
  }
}

• 201 Signed in; as POST /api/account/session.
• 400 The challenge expired or was used.
• 401 The key did not check out.

A one-time code for a desk's host

{
  "host": "acme.supporto.city",
  "next": "/desk/acme",
  "state": "q1w2e3..."
}

• 200 Where to go.

  {
    "url": "https://acme.supporto.city/api/account/handoff/redeem?code=...\u0026next=%2Fdesk%2Facme"
  }

• 400 Not JSON, or unknown fields.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 422 A value is not acceptable, such as a password under 12 characters.

Use a handoff code

• 302 Signed in; to the desk.
• 400 The code cannot be used here.
• 403 The account is suspended.

Sign in on a supporto.city desk's host

• 302 To the account page.

Email a password reset link

• 202 If the address has an account
• 403 The captcha answer is missing or wrong (`captchaRequired` is true).
• 429 Too many attempts from this address, or too many recent links, or the account is locked.

Set a new password from a reset link

• 200 The password is set.
• 400 The link has expired or was already used.
• 422 A value is not acceptable, such as a password under 12 characters.

Who is signed in, and the CSRF token

• 200 Signed in.

  {
    "csrfToken": "Yk3...",
    "expiresAt": "2026-11-07T12:00:00Z",
    "person": {
      "email": "amy@example.com",
      "emailVerifiedAt": null,
      "id": "6c1f0b7e-2d4a-4b8e-9f3c-1a2b3c4d5e6f",
      "name": "Amy"
    }
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Sign in

• 201 Signed in.

  {
    "csrfToken": "Yk3...",
    "expiresAt": "2026-11-07T12:00:00Z",
    "person": {
      "email": "amy@example.com",
      "emailVerifiedAt": null,
      "id": "6c1f0b7e-2d4a-4b8e-9f3c-1a2b3c4d5e6f",
      "name": "Amy"
    }
  }

• 400 Not JSON, or unknown fields.
• 401 Wrong email or password.
• 403 The account is suspended (only said after the right password)
• 429 Too many attempts from this address, or too many recent links, or the account is locked.

Sign out

• 204 Signed out.

Prove who you are again

{
  "code": "123456",
  "password": "correct horse battery staple"
}

• 204 Confirmed.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Wrong password or code; twoFactorRequired is true when a code is needed.
• 429 Too many failed attempts.

Create an account

{
  "email": "amy@example.com",
  "name": "Amy",
  "password": "correct horse battery"
}

• 202 Check your email.
• 400 Not JSON, or unknown fields.
• 403 The captcha answer is missing or wrong (`captchaRequired` is true).
• 422 A value is not acceptable, such as a password under 12 characters.
• 429 Too many attempts from this address, or too many recent links, or the account is locked.

Confirm an email address from its link, and sign in

• 200 Confirmed and signed in (as Session), or, for an account with two-step sign-in, confirmed with signIn true: sign in the usual way.
• 400 The link has expired or was already used.

Send a new confirmation link

• 202 Sent.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 409 The address is already confirmed.
• 429 Too many attempts from this address, or too many recent links, or the account is locked.

Service status

• 200 The notices.

  {
    "items": [
      {
        "affectsYou": true,
        "createdAt": "2026-11-05T09:05:00Z",
        "endsAt": null,
        "id": "7d1e2f3a-4b5c-4d6e-8f90-a1b2c3d4e5f6",
        "kind": "incident",
        "productNames": [
          "Mailocity"
        ],
        "products": [
          "mailocity"
        ],
        "resolvedAt": null,
        "severity": "major",
        "startsAt": "2026-11-05T09:00:00Z",
        "status": "identified",
        "title": "Slow mail delivery",
        "updatedAt": "2026-11-05T09:40:00Z",
        "updates": [
          {
            "body": "A full disk on one relay; mail is queued, not lost.",
            "createdAt": "2026-11-05T09:40:00Z",
            "id": 2,
            "status": "identified"
          }
        ]
      }
    ]
  }

The desk this host is

• 200 The desk.

  {
    "name": "Acme Support",
    "slug": "acme",
    "status": "active"
  }

• 404 Not a desk's host.

The help center

• 200 The categories and articles.

  {
    "categories": [
      {
        "articles": 6,
        "name": "Billing",
        "slug": "billing"
      }
    ],
    "items": [
      {
        "category": "billing",
        "kind": "faq",
        "slug": "refund",
        "snippet": "Open a request under Billing within 30 days",
        "title": "How do I get a refund?"
      }
    ],
    "signedIn": false
  }

• 404 No such category.

A help article, rendered

• 200 The article.

  {
    "category": "billing",
    "html": "\u003cp\u003eOpen a request under \u003cstrong\u003eBilling\u003c/strong\u003e within 30 days.\u003c/p\u003e",
    "kind": "faq",
    "slug": "refund",
    "title": "How do I get a refund?",
    "updatedAt": "2026-10-09T12:00:00Z"
  }

• 404 No such article

Say whether an article helped

{
  "helpful": true
}

• 204 Counted.
• 404 No such article.
• 422 helpful is missing.

What a request can be about

• 200 The queues.

  {
    "items": [
      {
        "allowContacts": true,
        "description": "Invoices, payments, plans and refunds.",
        "fields": [
          {
            "help": "On your invoice, such as ZI-1042.",
            "key": "order_number",
            "kind": "text",
            "label": "Order number",
            "options": [],
            "required": true
          }
        ],
        "name": "Billing",
        "slug": "billing"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Your support requests

• 200 The tickets.

  {
    "items": [
      {
        "number": 41,
        "prefix": "BIL",
        "priority": "normal",
        "queue": "billing",
        "requesterEmail": "amy@example.com",
        "status": "pending",
        "subject": "Invoice question",
        "tag": "BIL-41",
        "updatedAt": "2026-10-08T12:00:00Z"
      }
    ]
  }

• 401 Not signed in, or the CSRF token is missing or wrong.

Open a support request

{
  "body": "Why was I charged twice?",
  "fields": {
    "order_number": "ZI-1042"
  },
  "queue": "billing",
  "subject": "Invoice question"
}

• 201 The ticket.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 422 A value is not acceptable, such as a password under 12 characters.

A request with its messages and contacts

• 200 OK.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such ticket

Close your request

• 200 OK.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Only staff close requests in this queue.
• 404 No such ticket

Add someone to the replies

• 200 OK.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such ticket
• 409 The queue does not take contacts

Take someone off the replies

• 200 OK.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such ticket

Reply

• 201 The ticket with its messages.
• 401 Not signed in, or the CSRF token is missing or wrong.
• 404 No such ticket
• 409 The request is closed.

Rate a resolved or closed request

{
  "comment": "Quick, thanks!",
  "rating": 5
}

• 200 The ticket with its messages
• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Not the requester
• 404 No such ticket
• 409 The request is not resolved or closed.
• 422 The rating is not 1 to 5

View the secure information in a reply, once

• 200 The data.

  {
    "afterView": "delete",
    "data": "c0rrect-h0rse",
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }

• 401 Not signed in, or the CSRF token is missing or wrong.
• 403 Not the ticket's requester.
• 404 No such ticket or secure information
• 410 Already viewed

Open a request from a notification link, without signing in

• 200 The ticket with its messages.
• 403 The queue needs signing in.
• 404 The link has expired.

Reply from a notification link

• 201 The ticket with its messages.
• 403 The queue needs signing in.
• 404 The link has expired.
• 409 The request is closed.

Rate a request from a notification link

{
  "rating": 4
}

• 200 The ticket with its messages
• 403 Not the requester's link
• 404 The link has expired.
• 409 The request is not resolved or closed.
• 422 The rating is not 1 to 5