API Key

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

Generate API key

Before you can make requests to the Data Mesh Manager API, you will need to generate an API key for your organization.

You find it under [My Organization » API Keys » Add API Key].

Set the scope of the API to organization. If you need an API for a specific team, you can create an API key scoped to a specific team.

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.datamesh-manager.com/api/dataproducts \
--header "x-api-key: $DMM_API_KEY"