Discovery¶
Unauthenticated endpoints describing the server itself. These anchor the
DNS trust chain: a verifier reads _revoked.<domain> from DNS, fetches
the root key here, and checks that the two agree before believing
anything an identity signed.
GET /healthz¶
Liveness probe
Unauthenticated
Callable with no credential.
Returns ok when the process is serving. Used by the container healthcheck.
Responses
| Status | Meaning |
|---|---|
200 |
Serving. |
GET /api/server¶
Server identity and domain claim
Unauthenticated
Callable with no credential.
The server's domain claim, root public key and a freshly signed assertion, plus the TXT record an operator must publish.
A verifier compares fingerprint against the _revoked.<domain> TXT
record. They must agree; the served key alone proves nothing, since
whoever serves the response also chooses what it says.
Responses
| Status | Meaning |
|---|---|
200 |
The server's claim about itself. |
Response fields
| Field | Type | Notes |
|---|---|---|
domain |
string | The domain this server claims. |
version |
string | The backend build identifier. Release images and source builds can stamp a release or commit identifier; local builds without a stamp report dev. |
fingerprint |
string | SHA-256 fingerprint of the root public key. |
publicKey |
string | Root public key, PEM encoded. |
assertion |
object | A freshly signed statement of the above. |
txt |
object | The DNS record an operator publishes to complete the chain. |
mail |
object | Operator policy: how far this server will email a grant to a contact who has no account on it. A client reads it to say where a send will go before anyone sends. |
limits |
object | Operator policy a client should respect before uploading. |
attestations |
object | Operator policy on attestations. |
twoFactor |
object | Operator policy on two-factor authentication. |
signups |
object | Operator policy on new accounts. |
sealing |
object | What this server's API supports for end-to-end encrypted entries. |
GET /api/blocked-domains¶
The operator's list of impersonating domains
Unauthenticated
Callable with no credential.
The file BLOCKED_DOMAINS_FILE names, in the format of the
repository's blocked-domains.txt. The app refuses to switch to a
server listed here or in the project's own list; this list adds to
that one and cannot lift an entry from it. Empty when the variable is
unset.
Responses
| Status | Meaning |
|---|---|
200 |
The list, possibly empty. |
429 |
Too many attempts. Password gates, probes and challenges are limited per client, so a slug cannot be brute-forced. |
500 |
The configured file could not be read. |
GET /api/permissions¶
Permission catalogue
Unauthenticated
Callable with no credential.
The permissions a member or API key can hold, and the scopes each expands to. Grants are stored expanded, so this is what lets a stored grant be named back as the permissions that were picked.
Serving it means a client never has to hardcode scope strings and drift from what the server enforces.
Responses
| Status | Meaning |
|---|---|
200 |
The catalogue. |
Response fields
| Field | Type | Notes |
|---|---|---|
permissions |
array of Permission |
GET /api/features¶
Feature catalogue and invite presets
Unauthenticated
Callable with no credential.
The parts of the app a person can choose to see, and the presets an invite can start a member on. A feature is a display choice stored on the account, never an access boundary: a client shows a feature only where the account chose it and the member holds the permission it names, and the server enforces the permission regardless.
Served, like the permission catalogue, so a client never hardcodes the list and drifts from what the server knows.
Responses
| Status | Meaning |
|---|---|
200 |
The catalogue. |
Response fields
| Field | Type | Notes |
|---|---|---|
features |
array of Feature | |
presets |
array of FeaturePreset |
GET /api/certificate¶
Server certificate, public material only
Unauthenticated
Callable with no credential.
Public key material for this server's certificate authority. The private half is filtered out before serialization and is never served.
Responses
| Status | Meaning |
|---|---|
200 |
Public view of the server certificate. |
GET /api/me¶
Who the credential acts as
Auth: ApiKey, Connection, Session
Names the account, key or connected tool behind the credential, and
the workspace it acts in. A key or a tool names that workspace when it
creates records (workspace in the body), and learns it here.
The answer holds only what the credential carries itself, never the token.
Responses
| Status | Meaning |
|---|---|
200 |
The credential. |
401 |
not_authenticated, or a connection token that is not valid. |
403 |
not_authorized for a credential that is none of the three, or connection_paused. |
GET /api/health¶
PocketBase health check
Unauthenticated
Callable with no credential.
Answers 200 while the server runs. /healthz is the same without a body.
Responses
| Status | Meaning |
|---|---|
200 |
Healthy. |
Response fields
| Field | Type | Notes |
|---|---|---|
code |
integer | |
message |
string | |
data |
object |