API Keys

Our platform lets you create API keys that can be used to authenticate you from clients outside the Compute website. For example, with the CICD Collection Deploy Helper or the Compute Python SDK.

What’s an API Key?

An API key is a unique token that represents your user account. When you use an API key, it’s like logging in with your credentials, but without needing to log in to the platform. This way, you can interact with the different features of the platform and apps through external clients.

Managing Your API Keys

You can create, delete, and manage your API keys right from the Compute.build website. Open the sidebar and click on Settings to open the Settings page:

Once you're in the Settings page, click on API Keys on the left bar to open the API Keys Management page:

You should be presented with the following page (though without any API keys yet):

On this page you'll be able to manage your API keys—creating new API keys, viewing existing ones, and deleting them.

Creating a new API Key

To create a new API key, click on the Create API Key button in the top right corner of the page:

This will open a new dialog asking you to provide a name and a duration for the key:

If the action is successful, you'll see another dialog open with the newly created API key:

Danger

Important Note: You'll only be able to see this API key once, so make sure to save it in a secure location.
Remember that this key authenticates you, so anyone with access to it can perform actions on your behalf and has the same privileges as your user.

Warning

To help avoid security problems, it's highly recommended to rotate these keys frequently. You can choose API key durations of up to 1 year, but it's best to use a maximum of 6 months. If any of your API keys is compromised, immediately delete it!

You'll then be able to see the new API key next to your existing ones:

Viewing Existing API Keys

You can view your existing API keys on the management page:

For each key, you can see the following information:

• Name: The name you provided when creating the API key.
• Identifier: The first 5 characters of the API key to help you identify it.
• Creator: The user who created the API key (currently, you can only manage keys that you have created).
• Creation Date: When the API key was created.
• Expiration Date: When the API key expires.
• Status: Whether the API key is Active or Expired.

Deleting an API Key

To delete an API key, click on the delete button associated with the key:

This will open a confirmation dialog that you need to complete before the API key is deleted:

Finally, click Delete Key to remove the API key. If the action is successful, the selected API key will be removed from the list.