Skip to main content
An API key lets a program act as you against the public REST API and the Userplay CLI. Create and manage keys in Account > Developer.
A key belongs to you, not to a studio, and carries your permissions across every studio you belong to. It can never do more than you can.

Create a key

1

Open Account > Developer

Click Create access key.
2

Name it

After whatever will use it, for example Data warehouse sync. The name is required.
3

Save the secret

You see the full secret once. Copy it into a secrets manager or an environment variable before you close it. After that you only ever see the masked up_... prefix.
Send it as a bearer token:

Key limits

Each key has its own rate-limit meter, so one integration cannot starve another.

Manage a key

A key is either Active or Disabled, and there are four things you can do to one. Rotate a key you still need but can no longer trust. Deactivate one you might want back. Delete one you are done with.

Keep a key safe

A key carries your full access. Never put one in client-side code, a public repository, or a browser request. If a key leaks, rotate or delete it immediately.
  • Give each integration its own key so that revoking one does not break the others.
  • Store the secret in a secrets manager or an environment variable. Never commit it to source control.
  • Rotate on a schedule, not only after an incident. If you need a cutover window, deactivate the old key first instead of rotating it.

API authentication

What the bearer token can reach.

CLI authentication

Sign the CLI in with the same key.

Automate with the API

First key to working script, in order.

Security

Two-factor and passkeys protect the account these keys inherit from.