API Reference

Easy Deploy provides a comprehensive REST API for automation and integration with your existing workflows.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.easydeploy.com/v1/applications

Applications

Create Application

Deploy a new application from a repository:

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-app",
    "repository": "https://github.com/user/repo",
    "branch": "main",
    "environment": "production"
  }' \
  https://api.easydeploy.com/v1/applications

Get Applications

List all your applications:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.easydeploy.com/v1/applications

Get Application Details

Get details about a specific application:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.easydeploy.com/v1/applications/APP_ID

Deployments

Get Deployment Status

Check the status of a deployment:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.easydeploy.com/v1/applications/APP_ID/deployments

Trigger Deployment

Manually trigger a new deployment:

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.easydeploy.com/v1/applications/APP_ID/deploy

Environment Variables

Set Environment Variable

curl -X PUT \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "DATABASE_URL",
    "value": "postgresql://...",
    "environment": "production"
  }' \
  https://api.easydeploy.com/v1/applications/APP_ID/env

Rate Limits

Free Plan: 100 requests per hour
Pro Plan: 1,000 requests per hour
Enterprise: Custom limits

Error Codes

400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
429 - Rate Limit Exceeded
500 - Internal Server Error

SDKs

Official SDKs are available for:

Need help? Visit our troubleshooting guide or contact support.