API authentication

Send your API key as a Bearer token from a trusted server.

Authorization: Bearer pxxl_your_key
Accept: application/json

string

required

Bearer followed by your Pxxl API key.

string

Team used for a scoped request.

Check the active identity

curl https://server.pxxl.app/api/v3/cli/whoami \
  --header "Authorization: Bearer $PXXL_API_KEY"

{
  "success": true,
  "user": { "id": "user_123", "email": "developer@example.com" },
  "authMethod": "api_key",
  "apiKeyId": "key_123",
  "apiKeyScope": "deploy,storage",
  "apiKeyPermission": "read_write",
  "teamId": "team_123"
}

Identity endpoints

Method	Path	Parameters	Returns
`GET`	`/cli/whoami`	None	Identity and API key permissions
`GET`	`/cli/stats`	`teamId?`	Account or team resource totals
`GET`	`/cli/usage`	`teamId?`	Build, runtime, database, and storage usage

Scopes and permissions

The API checks both scope and permission.

Setting	Examples	Effect
Scope	`deploy`, `domains`, `storage`, `databases`, `cronjobs`, `analytics`, `teams`, `all`	Limits accessible modules
Permission	`read`, `read_write`	Controls whether mutations are allowed
Team	`teamId`	Limits resources to a team you can access

Do not expose API keys in browser code, public repositories, screenshots, logs, or client-side environment variables.

SDK

CLI

API

API authentication

Check the active identity

Identity endpoints

Scopes and permissions

​Check the active identity

​Identity endpoints

​Scopes and permissions

Check the active identity

Identity endpoints

Scopes and permissions