API authentication

Ensemble uses API keys to authenticate API calls.

Create an API key

1. Log in to Ensemble.
2. Go to Settings > API.
3. Select Create an API key.

Delete an API key

1. Log in to Ensemble.
2. Go to Settings > API.
3. Select Delete next to the key you want to delete.

Call the API using your key

Send the API key in your API call as a header named X-ENSEMBLE-API-KEY.

For example, say you want to get all active pathways. Your curl request will look like this:

# For a self-hosted Ensemble instance
curl -X 'GET' \
  '<ENSEMBLE_HOST>:<ENSEMBLE_PORT>/<ENSEMBLE_PATH>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-ENSEMBLE-API-KEY: <your-api-key>'

# For Ensemble Cloud
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-ENSEMBLE-API-KEY: <your-api-key>'