API Overview

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

Codemagic API can be accessed at https://api.codemagic.io.

API uses the HTTPS protocol and all data is sent and received in JSON format.

Authentication

All API methods require that access token be included in HTTP headers in every call.

x-auth-token: <API Token>

The access token is available in the Codemagic UI under User settings > Integrations > Codemagic API > Show.

Rate Limiting

All API requests are limited to 5,000 requests per hour and per authenticated user.

Checking your rate limit status

The response’s HTTP headers are authoritative sources for the current number of API calls available to you or your app at any given time.

HeaderDescription
X-RateLimit-LimitThe maximum number of requests you’re permitted to make per hour.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.