Skip to main content

The Akuity API

The Akuity API allows you to manage the Akuity Platform resources using the REST API.

Getting an API Key

In order to use the API you will first need to create an API key. Copy the following values from your API key:


Accessing the API


The API Server address is

You can browse the current API Reference.

You can connect from your local workstation, with any tool that speaks HTTP (such as postman, httpie, curl, wget etc.).


The API allows you to authenticate two different ways. You can connect via basic http auth, or you can pass in the x-akuity-api-key-secret and x-akuity-api-key-id http headers. Pick the option that works best for you and your API client.

Basic Auth

Basic auth has been around for a long time, and is pretty simple. You will pass in a http header that looks like this.

Authorization: Basic <credentials>

where credentials is the Base64 encoding of AKUITY_API_KEY_ID and AKUITY_API_KEY_SECRET joined by a single colon :

export AKUITY_API_KEY_ID=mySecretKeyId
export AKUITY_API_KEY_SECRET=blahblahSecretValueBlahblah
echo -n $API_CRED

In zsh, a % symbol is placed at the end of a line where zsh inserted a newline for us.

It is important to include echo’s -n option when piping content to an encoder to avoid a newline character being included in the encoded output.

If the credentials are not working, check to make sure your base64 encoded value is correct

echo -n "$AKUITY_API_KEY_ID:$AKUITY_API_KEY_SECRET" | base64 | base64 -d

Using the KEY_ID and KEY_SECRET header values

Another way of authenticating is to pass in the x-akuity-api-key-secret and x-akuity-api-key-id header values with the request.

API Examples


This command will returns the organizations for this API KEY using the basic auth header.

curl -H "Authorization: Basic `echo -n $AKUITY_API_KEY_ID:$AKUITY_API_KEY_SECRET | base64`"

This is the same command, but we are using the basic auth -u flag in Curl. Which is a little easier since we don't need to Base64 encode the header ourselves.


This is the same command, but instead of using the -u flag we are going to be setting the x-akuity-api-key-secret and x-akuity-api-key-id headers.

curl -H "x-akuity-api-key-secret: $AKUITY_API_KEY_SECRET" -H "x-akuity-api-key-id: $AKUITY_API_KEY_ID"