API Keys

API keys provide programmatic access to the platform. They support scoped permissions.

Create API Key

POST /v1/api-keys

Creates a new API key with optional permission scopes.

Auth: Required

Request Body:

{
  "name": "CI/CD Key",
  "permissions": ["apps:read", "apps:write", "servers:read"]
}

Available Scopes:

Scope	Description
`servers:read`	List and view servers
`servers:write`	Create and delete servers
`apps:read`	List and view apps, logs, metrics
`apps:write`	Create, update, and delete apps
`domains:read`	List and view domains
`domains:write`	Register, migrate, and manage domains
`email:read`	View email domains and credentials
`email:write`	Create credentials, verify DNS, manage limits
`storage:read`	List buckets and registries
`storage:write`	Create and delete storage resources
`members:read`	List project members
`members:write`	Invite, remove, and update members
`support:read`	List and view support tickets
`support:write`	Create and reply to tickets
`webhooks:read`	List endpoints and their delivery history
`webhooks:write`	Create, update, test, and delete endpoints

PATCH /v1/api-keys/:id

Updates the API key name and/or permissions.

Auth: Required

Request Body:

{
  "name": "Updated Name",
  "permissions": ["apps:read"]
}