Skip to content
PL

Organisations, team and keys

Organisation operations and required roles.

{org} is an organisation UUID. User roles are member for reading, admin for configuration and owner for role management. API keys have admin access to their own organisation.

Organisations and infrastructure

Method Path Permission / result
GET /v1/orgs Accessible organisations; a key sees only its own.
POST /v1/orgs User account; {"name":"Hosting"}; 201.
GET /v1/orgs/{org} member; includes id, name, txtRecordValue.
PATCH /v1/orgs/{org} admin; {"name":"New name"}.
GET /v1/pools Authenticated user or key; ingress addresses.
GET /v1/orgs/{org}/instances member; own active dedicated instances.

Members

Method Path Body / role
GET /v1/orgs/{org}/members member
POST /v1/orgs/{org}/members admin; {"email":"ops@example.com","role":"member"}; the account must exist.
PATCH /v1/orgs/{org}/members/{user} owner; {"role":"admin"}.
DELETE /v1/orgs/{org}/members/{user} Leave or authorised member removal; 204.

The last owner cannot be removed, and a member cannot remove someone who outranks them.

Keys

Method Path Body / result
GET /v1/orgs/{org}/api-keys admin; list without secrets.
POST /v1/orgs/{org}/api-keys admin; {"name":"Hosting panel"}; secret shown once.
DELETE /v1/orgs/{org}/api-keys/{id} admin; revoke key, 204.

Do not log key-creation responses. Store the secret in a server-side secret manager.