Authentication - Stackone

The Platform API authenticates with a StackOne API key. Generate one in the dashboard.

How requests authenticate

Every request uses two values:

Authorization: Basic auth with your API key as the username, no password. Keys have the format v1.{region}.xxxxx.
x-account-id: identifies the end user’s linked account, for endpoints that act on a specific account’s data.

Pass these when calling any endpoint, such as the List Accounts endpoint. An API key’s scopes control which endpoints it can access. See API Keys for the scope reference and key management.

Encoding the Authorization header

The header value is base64 of {api_key}:, the key followed by a colon, since Basic auth expects a password half even when it is empty. curl -u "$STACKONE_API_KEY:" builds it for you. To encode it yourself:

macOS / Linux
Windows (PowerShell)
Windows (Command Prompt)

echo -n "{stackone_api_key}:" | base64

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("{stackone_api_key}:"))

powershell -Command "[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes(\"{stackone_api_key}:\"))"