Create an AuraDB instance in the terminal

This tutorial describes using the terminal to create an instance in the Aura Console.


Generate API credentials

  • Log in to the Aura Console.

  • Click your email address in the top right corner and select Account details.

  • In the API credentials section, select Create. Enter a descriptive name and save the generated Client ID and Client Secret.


  • Install cURL via your terminal

  • For macOS with Homebrew: use brew install curl.

  • Install cURL. See curl download wizard for more information.

  • Check cURL is available: Type curl -V in the terminal

Obtain a bearer token

Bearer tokens are valid for one hour.

In the terminal paste the snippet, replacing YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the values generated by the Aura Console. Keep the : between the values.

curl --location '' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'grant_type=client_credentials' -u 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' -v

Response body example

Save the access_token from the end of the returned code. This is your bearer token. It looks similar to this example:


Obtain the tenant ID

Use cURL to obtain the tenant ID with your token. Replace YOUR_BEARER_TOKEN with your token.

curl --location '' --header 'Accept: application/json' --header 'Authorization: Bearer YOUR_BEARER_TOKEN'

This returns something similar to:


In the example response above, two tenants are returned. If you’re a member of multiple tenants, select the one you wish to use.

Configure an AuraDB instance

Configure the instance values

Use the bearer token and Tenant ID to create the Aura instance. Replace YOUR_BEARER_TOKEN with your token. Replace YOUR_TENANT_ID with your tenant ID.

The following values are customizable version, region, memory, name, type, tenantid, and cloud provider.

curl --location '' --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer YOUR_BEARER_TOKEN' --data ' { "version": "5", "region": "europe-west1", "memory": "8GB", "name": "instance01", "type": "enterprise-db", "tenant_id": "YOUR_TENANT_ID", "cloud_provider": "gcp" }'

See Aura API documentation for more details.

At this point, an Aura instance is provisioned in the Aura Console. Optionally, use this code in the terminal to check the status:

curl --location '' --header 'Accept: application/json' --header 'Authorization: Bearer YOUR_BEARER_TOKEN'


curl --location '' --header 'Accept: application/json' --header 'Authorization: Bearer YOUR_BEARER_TOKEN'

If the value of status shows running, you can start using the new Aura instance.