Requesting an API Key

Overview

The Capella API uses API Keys to validate a user’s identity.

You must have an active Capella Console account to successfully request an API Key.

Creating an API Key

Create a new API key, by submitting a POST request to the /keys endpoint providing a description in the query string and Authorization header as shown below:

POST "https://api.capellaspace.com/keys?description=My%20API%20Key"
Authorization: Bearer <token> | ApiKey <apiKey>

A successful request will result in the following response:

{
    "id":"cj7...",
    "description":"My API Key",
    "key_value":"AWIj...",
    "user_id":"12345678-1234-5678-1234-567812345678",
    "created_at":"2025-02-05T16:18:42.000000Z"
}

The API Key will be returned in the key_value field. This is the only time that the API Key can be viewed. If you lose or forget your API key, you cannot retrieve it again. Instead, create a new API Key and delete the old one.

Using the API Key

To use the API key you have requested, include it in the Authorization header of requests to other endpoints

Authorization: ApiKey {{apiKey}}

API Key Best Practices

Never store your API Keys in plain text, in a code repository, or in code.
Delete API Keys when no longer needed.
Rotate API Keys regularly.

Additional Information