Authentication and teams

Create an API key in Pxxl, then store it as PXXL_API_KEY.

string

required

Secret API key used for bearer authentication.

string

Default team for resources that support team ownership.

Create a client

Node.js
Go
Python
Rust

import { Pxxl } from "@pxxlapp/pxxl";

const pxxl = new Pxxl({
  apiKey: process.env.PXXL_API_KEY,
  teamId: "team_123",
});

client := pxxl.NewClient(os.Getenv("PXXL_API_KEY"))

client = PxxlClient(api_key=os.environ["PXXL_API_KEY"], team_id="team_123")

let client = PxxlClient::new(std::env::var("PXXL_API_KEY")?)
    .with_team_id("team_123");

Identity operations

Operation	Node.js	Parameters	Returns
Active identity	`identity.whoami()`	None	User, auth method, API key permissions, and team context
Account stats	`identity.stats(teamId?)`	`teamId?`	Resource totals and account summary
Platform usage	`identity.usage(teamId?)`	`teamId?`	Build, runtime, storage, and plan usage

const identity = await pxxl.identity.whoami();

{
  "success": true,
  "user": {
    "id": "user_123",
    "email": "developer@example.com",
    "name": "Developer"
  },
  "authMethod": "api_key",
  "apiKey": {
    "name": "production automation",
    "permission": "read_write",
    "scopes": ["deploy", "domain", "storage"]
  },
  "teamId": "team_123"
}

const stats = await pxxl.identity.stats();
const usage = await pxxl.identity.usage();

{
  "success": true,
  "data": {
    "summary": {
      "totalProjects": 4,
      "totalDeployments": 18,
      "totalDomains": 3,
      "totalDatabases": 2
    }
  }
}

API keys can be read-only or read-write. Scopes can limit access to deployments, domains, environment variables, CDN, storage, databases, cron jobs, analytics, or teams.

Use SDK keys only in trusted servers, workers, and CI. Do not expose them in browser bundles.

​Create a client

​Identity operations

Create a client

Identity operations