Quickstart

This guide will get you all set up and ready to use the Data Mesh Manager API. We'll cover how to get started and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

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].

Save the Secret API key, it will not be displayed later.

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.

Verify your cURL installation

In this documentation, we will use cURL to make requests. Make sure that you have cURL installed.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

Now, it is time to make your first API request. In the cURL example, you retrieve all data products for your organization.

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

What's next?

Great, you're now set up and have made your first request to the API. Here are a few links that might be handy as you venture further into the Data Mesh Manager API: