We're heading to KubeCon Mumbai·June 18–19

Let's meet

API Reference

Interactive API documentation for Archestra

1 min read

Explore the Archestra API using the interactive documentation below.

Authentication

Use a personal API key or service account token in the Authorization header.

Personal API Keys

Personal API keys are owned by one user. Create them from Settings → API Keys. They use the owner's current role, so permission changes to that user immediately affect the key.

Use personal keys for local scripts, development tools, and user-owned automation.

Service Accounts

Service accounts are organization-owned identities for automation. Create them
from Settings → Service Accounts, assign a role, and create a token.

Service account requests authorize from the service account's assigned role.
Disable or delete the service account to stop all of its tokens, or delete an
individual token when rotating credentials.

Use service accounts for CI, scheduled jobs, shared integrations, and production
automation that should not depend on an individual user remaining active.

Loading API documentation...