Skip to main content
All App Management API requests require authentication using a workspace API key. Each endpoint requires a specific scope on the key, described under Scopes.
The App Management API is available on Business and Enterprise plans. Workspace API keys are managed in the Secrets section of your workspace settings.

​
Required role

Only workspace owners and admins can create and manage workspace API keys. Regular workspace members do not have access to the Secrets page in workspace settings. To learn about workspace roles, see Managing your workspace members.

​
Workspace API key

Include your workspace API key in the api_key header with all requests:

​
Scopes

Each endpoint requires a specific scope on the key. Grant a key only the scopes it needs. When a scope requires app access, the key must be granted access to the apps it can act on, either all apps in your workspace or a selected set. A key can only act on apps within its grant.

​
Example request

The request body is optional. Omit checkpoint_id to deploy the most recent saved version of the app.

​
Get your workspace API key

  1. Click your workspace name at the top left and click Settings.
  2. Click Secrets in the sidebar.
  3. Click + Create API Key.
  4. Enter a name for the key and an optional description.
  5. Grant the scopes the key needs. For a scope that requires app access, choose whether the key can access all apps or only a selected set.
  6. Click Create Key, then copy the key immediately and store it securely.
For the full guide on creating and managing workspace API keys, see Managing workspace secrets.
Copy your API key immediately after creating it. You won’t be able to see it again. Treat it like a password and do not share it or commit it to version control.