API tokens · Developer tools

Create, renew and revoke the tokens the CLI, scripts and CI use. Open Settings → API tokens and choose Create token.

Create, renew and revoke the tokens the CLI, scripts and CI use.

Create a token

Open Settings → API tokens and choose Create token.

Name it after where it will be used, for example GitHub Actions.

Choose access: Full access (create, change and delete VMs, buckets, databases, apps and your registry) or Read only (list and view, for dashboards and monitoring).

Choose when it expires, then copy the token. It is shown only once.

A token acts as you on the public API only. It can never be used to sign in to the website.

Use it

Paste the token when bn auth login asks for it, or set the BN_TOKEN environment variable in CI. For the REST API, send it as a bearer token.

export BN_TOKEN=bnt_... bn vm list

Renew and revoke

The token list shows when each token was last used and when it expires. Renew extends a token that expires soon. Revoke stops a token straight away, and Revoke all stops every token. CLI sign-ins made with bn auth login are listed too.