Skip to main content
Version: Next

API Keys

This guide explains how to generate and manage API keys in Codesphere.

API keys are managed within your user settings.

  1. Click on your Profile Picture in the top-right corner.
  2. Select User Settings.
  3. Navigate to the API Keys tab in the left-hand sidebar.

Creating a New API Key​

API keys allow external applications to interact with Codesphere on your behalf.

  1. In the API Keys section, click the Add New Key button.
  2. Give your key a Name (e.g., "GitHub Actions" or "Local Development") to help you remember its purpose.
  3. Click Create.
  4. Copy your key immediately. For security reasons, the key will only be shown once. If you lose it, you will need to regenerate it.

Important Note About Access Levels
Currently, an API key granted to your account will have the same level of access and permissions as your user account itself. Support for fine-grained access tokens (scopes) is on our roadmap and will be added in the future.

Tip icon

Have a feature request? Help us shape the future of Codesphere. You can request new features or vote on the community roadmap at feedback.codesphere.com.

Regenerating an API Key​

  1. Find the specific key in your API Keys list.
  2. Click the Regenerate (circular arrow) icon next to the key name.
  3. Confirm the action in the pop-up window.
  4. Update your applications: The old key will be invalidated instantly, and you must replace it with the new key in your code or environment variables.

Frequently Asked Questions​

  1. How many keys can I have?
    You can generate as many keys as you want.

  2. What happens if I delete a key?
    Any application using that key will immediately receive a 401 Unauthorized error when attempting to connect.

  3. Can I restrict a key to Read-Only?
    Not yet. Currently, all keys inherit your full account permissions.