API Tokens
Create API tokens that let scripts, CI pipelines, and your own tools call the Out Plane API for a team, choose when they expire, and revoke them.
API tokens authenticate programmatic access to the Out Plane API on behalf of a team. Use them from scripts, CI, or your own tools.
Create a Token
On the API tokens page under Settings, select Create token:
| Field | Notes |
|---|---|
| Name | A label, up to 60 characters. |
| Expiration | 1 day, 7 days, 30 days (the default), 180 days, or no expiration. |
The token is shown once, at creation. Copy it then and store it safely. If you lose it, revoke it and create a new one.
Use a Token
Send the token as a bearer token, and name the team it acts on:
curl -H "Authorization: Bearer YOUR_TOKEN" \
-H "X-Team-Id: YOUR_TEAM_ID" \
...A token has full API access for its team, so treat it like a password. There are no per token scopes, and a token cannot sign in to the console.
Revoking
Revoke a token at any time. Revocation is immediate, and anything using it loses access right away.
Related
Registry Credentials
Store a login for Docker Hub, GHCR, GitLab, Quay, Amazon ECR, or Azure once per team so Out Plane can pull your private container images.
Members & Roles
Create a team, invite teammates by email, and see what the Owner and Member roles can do with the team's applications, databases, and domains.