Skip to Content

Ship

Create a data app API token

Make the key your backend uses to create guest tokens for a data app's embeds.

Before you start

  • You have a data app.
  • You are an Admin, or your role has the API Tokens Create permission. Of the default roles, only Developer has it.

Steps

  1. Go to Data Studio > Data Apps and open the data app.

  2. Select API tokens, then Generate API token.

    API tokens tab of the Customer Portal data app with the Generate API token button highlighted and one token, Production backend, in the table.
    The API tokens tab lists each token by name with its last 4 characters.
  3. Enter a Name, for example Production backend, and an optional Description.

    Generate API token dialog with the Name field highlighted, filled with Production backend, and a Description field.
    Name the token after the backend that uses it.
  4. Select Generate API token.

  5. Select Copy token and store it in your backend’s secret store.

  6. Select Done.

You see the full token only once. After you close the window, the table shows only its last 4 characters. Keep it on your backend. Never put it in browser code.

The token can read metrics and dashboards (Access Metrics, Access Dashboards). Next, use it to create a guest token.

Rotate a token

  1. On the token’s row, select Rotate token.

    Token row actions menu open with Rotate token highlighted above Revoke token.
    Rotate keeps the old value working for 24 hours.
  2. Confirm.

  3. Select Copy new token, then Done.

The old value keeps working for 24 hours, so you can update your backend without downtime.

Revoke a token

On the token’s row, select Revoke token and confirm. It stops working at once and cannot be undone. To replace a token without downtime, rotate it instead.

Other tokens

Settings > Tokens holds organization-wide service tokens for server-to-server API and MCP access. They are not data app tokens. See API token.

On this page