API Overview

Codemagic REST API API Overview

REST API enabling programmatic access to Codemagic service

The Codemagic REST API provides numerous possibilities for integrating your CI/CD builds with other tools or for managing advanced workflow chains.

⚠️ Note: We are transitioning to our new API. For up-to-date information, please refer to the Codemagic REST API documentation.

Authentication

Authentication with Codemagic APIs is performed using a Codemagic API token.

The Codemagic API token is a personal token that is unique to each Codemagic user. The actions permitted by the token are determined by the user’s role within the team.

You can find your API token by navigating to Teams > Personal Account > Integrations > Codemagic API > Show.

When making API calls, include the API token in the x-auth-token request header. For security reasons, we recommend storing the token as an environment variable and referencing it in your requests, rather than embedding the token value directly in your code or workflows. For example:

x-auth-token: $CM_API_TOKEN

Regenerating an API token

If you need to rotate your Codemagic API token, click Revoke next to the token in your account settings. This will disable the existing API token. Clicking Show afterward will automatically generate a new token.