Entropy Data

API Key

You'll need to authenticate your requests to access any of the endpoints in the Entropy Data API. Entropy Data uses API keys to authenticate requests.

Generate API key

Before you can make requests to the Entropy Data API, you will need to generate an API key for your organization. You can create up to 100 API keys per organization.

You find it under [Profile Picture » Organization » Settings » API Keys » Add API Key].

Add an API key:

Set the scope of the API to organization, team, or user (personal token), as required. Only organization owners can create organization-scoped API keys.

See API Key Scopes for details on what each scope can do.

Save the Secret API key, it will not be displayed later. However, you can create new API keys at any time.

You can set an environment variable to use the API key in the examples:

export DMM_API_KEY=your-secret-api-key

The API key and all requests that you perform with this API key are bound to your organization. If you have multiple organizations, e.g., for dev and test environments, you may need to generate an API key for each organization.

Header x-api-key

To make an authenticated request, provide the API key as x-api-key header value.

GET
/api/dataproducts
curl --get https://api.entropy-data.com/api/dataproducts \
--header "x-api-key: $DMM_API_KEY"

API Key Scopes

There are three types of scopes for API keys:

  • User (Personal Access Token, PAT): The API key has the same permissions as the user who created it. It can perform any action that the user can do, such as managing their own data products, accessing teams they belong to, and viewing resources they have access to.

  • Team: The API key has owner-level permissions for the specified team. It can perform any action that an owner of that team can do, including managing the team's data products, members, and settings.

  • Organization: The API key has owner-level permissions for the entire organization. It can perform any action that an owner of the organization can do, including managing all teams, data products, members, and organization settings.