Back to Documentation

API Reference

Integrate ExpoDeploy into your CI/CD pipelines, monitoring tools, or custom dashboards using our REST API. All endpoints return JSON and follow RESTful conventions.

Authentication

All API requests require authentication using a bearer token. Generate API tokens from your dashboard settings:

  1. 1. Navigate to Dashboard → Settings → API Tokens
  2. 2. Click "Create New Token"
  3. 3. Name your token (e.g., "CI/CD Pipeline")
  4. 4. Copy the token immediately - it won't be shown again
Authorization: Bearer YOUR_API_TOKEN

Include this header in all API requests. Tokens never expire but can be revoked at any time.

Base URL

All API requests should be made to:

https://expodeploy.me/api/v1

Use HTTPS for all requests. The API uses standard HTTP status codes to indicate success or failure.

Common Endpoints

GET/projects

Retrieve a list of all projects in your workspace

Response: Array of project objects with id, name, repository, status
POST/builds

Manually trigger a new build for a project

Body: { "projectId": "string", "branch": "string", "platform": "ios" | "android" }
GET/builds/:id

Get detailed information about a specific build

Response: Build object with status, logs, artifacts, duration, and metadata

Rate Limits & Best Practices

API requests are rate-limited to prevent abuse:

  • 100 requests per minute per API token
  • • Rate limit headers (X-RateLimit-Remaining) included in all responses
  • • HTTP 429 status code returned when limit is exceeded
  • • Implement exponential backoff for retry logic

For high-volume integrations, contact support to discuss custom rate limits.