Skip to main content

Akuity Platform API Keys

Creating an API Key​

  1. Select the Organization you want to create a key for, from the pull down menu.

  2. Switch to the API Keys tab.

  3. Click + New Key button on the lower right side of the page.

  4. Enter a Description for the key.

  5. In the Expires In field, set an expiry for the key or select No expiration. Valid time units are "s", "m", "h", "d", "w" or put 0 for no expiry.

  6. Assign a Role (Owner, Member) that you want to assign to the key.

  7. Optionally add entries to the IP Allowlist to restrict where the key can be used from. See Restricting a key by IP address.

  8. Click the Create button.

  9. Copy the values for AKUITY_API_KEY_ID and AKUITY_API_KEY_SECRET

Restricting a key by IP address​

An API key can carry an IP allowlist, a list of IPv4 or IPv6 addresses and CIDR ranges the key can be used from. Requests made with the key from any other address are rejected, whether they come through the CLI, the API, or the Terraform provider. Leave the list empty to allow any address.

You can set the allowlist when you create the key, or edit an existing key to change it. Changing the allowlist does not rotate the key, so the ID and secret stay the same. The same setting is available on workspace API keys.

With the Terraform provider, set ip_allowlist on the akp_api_key resource.

note

IP allowlists for API keys are not available on self-hosted installations.

Using your API key​

You can use your API key with the akuity CLI or the Akuity API.