API Keys

API keys let you access the Cosmoner API programmatically without a browser session. Use them for CI/CD pipelines, scripts, and integrations.

Create an API Key

POST /v1/api-keys

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

Each API key can be scoped to specific permissions:

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
`secrets:read`	List and view secret metadata
`secrets:write`	Create, update, and delete secrets
`variables:read`	List and view variables (values included)
`variables:write`	Create, update, and delete variables
`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

Omitting permissions creates a key with full access.

PATCH /v1/api-keys/:id

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

Include the API key in the Authorization header:

Authorization: Bearer <your-api-key>

API keys also work for authenticating docker push and docker pull against Cosmoner's container registry:

docker login api.cosmoner.com -u <api-key-id> -p <api-key-secret>
docker push api.cosmoner.com/<org>/<repo>:<tag>