Skip to main content
API Keys is only available for the Professional and Enterprise plans. Check the plans for more information.

​
Overview

api-key
  1. Click Settings in the top right corner session context menu.
  2. Click API Keys in the left sidebar.
  3. Click Create to create a new API key.
  4. Enter a name for the API key and click Create.
  5. Copy the API key with dz-xxxxxx format and store it in a secure place.

​
Usage

You can use the API key to authenticate requests to the Datazone API. You can pass the API key in the x-api-key header.

​
Access

Choose the key’s access when you create it:
  • Full access (default): the key can do everything you can.
  • Custom scopes: pick a resource type and tick the actions the key needs, such as View or Deploy. Each choice becomes a policy action like studio_app:read or pipeline:*. The key can only do what both you and its scopes allow; scopes never add access. A scoped key cannot create a key with more access than itself.
Create API Key dialog with an expiration and custom scopes

​
Expiration

Pick how long the key works: 1 hour, 1 day, 7 days (default), 30 days, 90 days, 180 days, 1 year, or No expiration. The time counts from when the key is created, and the key list shows when each key expires.

​
Use as database password

Tick Use as database password to sign in to the SQL interface with your email as the username and the key as the password. This is how users who sign in with SAML, and so have no password, connect a SQL client. Only full-access keys can be used this way, and the database still applies your own permissions.

​
Status

Each key is shown as Active, Expired, or Revoked. Create a new key to replace an expired or revoked one.

​
API Key Audit

Organisation managers (organisation:manage) can see every key in the organisation under Settings → Audit Logs → API Key: its owner, scopes, status, creation date and expiry, but never the key itself. Filter the list by Owner and sort by any column. An organisation manager can Revoke any active key there; a revoked key stops working at once and stays in the list, marked Revoked.