dployr

Appearance

API Reference ​

The dployr API provides programmatic access to all platform functionality. For a more in-depth overview of the API, see the API documentation.

Authentication ​

All API requests require authentication using a bearer token.

Get Access Token ​

bash
POST /v1/auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "password"
}

Response:

json
{
  "access_token": "eyJhbGc...",
  "refresh_token": "eyJhbGc...",
  "expires_in": 3600
}

Use Token ​

Include the token in the Authorization header:

bash
Authorization: Bearer eyJhbGc...

Deployments ​

Create Deployment ​

bash
POST /v1/deployments
Content-Type: application/json
Authorization: Bearer <token>

{
  "name": "my-app",
  "source": "remote",
  "runtime": "nodejs",
  "version": "20",
  "remote": "https://github.com/user/repo",
  "branch": "main",
  "build_cmd": "npm install",
  "run_cmd": "npm start",
  "port": 3000
}

List Deployments ​

bash
GET /v1/deployments
Authorization: Bearer <token>

Get Deployment ​

bash
GET /v1/deployments/:id
Authorization: Bearer <token>

Update Deployment ​

bash
PUT /v1/deployments/:id
Content-Type: application/json
Authorization: Bearer <token>

{
  "version": "22",
  "env": {
    "NODE_ENV": "production"
  }
}

Delete Deployment ​

bash
DELETE /v1/deployments/:id
Authorization: Bearer <token>

Services ​

List Services ​

bash
GET /v1/services
Authorization: Bearer <token>

Get Service Status ​

bash
GET /v1/services/:id/status
Authorization: Bearer <token>

Start Service ​

bash
POST /v1/services/:id/start
Authorization: Bearer <token>

Stop Service ​

bash
POST /v1/services/:id/stop
Authorization: Bearer <token>

Restart Service ​

bash
POST /v1/services/:id/restart
Authorization: Bearer <token>

Get Service Logs ​

bash
GET /v1/services/:id/logs?tail=100&follow=true
Authorization: Bearer <token>

Instances ​

List Instances ​

bash
GET /v1/instances
Authorization: Bearer <token>

Get Instance ​

bash
GET /v1/instances/:id
Authorization: Bearer <token>

Get Instance Metrics ​

bash
GET /v1/instances/:id/metrics
Authorization: Bearer <token>

Proxy Routes ​

List Routes ​

bash
GET /v1/proxy/routes
Authorization: Bearer <token>

Create Route ​

bash
POST /v1/proxy/routes
Content-Type: application/json
Authorization: Bearer <token>

{
  "domain": "example.com",
  "service_id": "service-123",
  "port": 3000
}

Delete Route ​

bash
DELETE /v1/proxy/routes/:id
Authorization: Bearer <token>

Projects ​

List Projects ​

bash
GET /v1/projects
Authorization: Bearer <token>

Create Project ​

bash
POST /v1/projects
Content-Type: application/json
Authorization: Bearer <token>

{
  "name": "my-project",
  "description": "Project description"
}

Delete Project ​

bash
DELETE /v1/projects/:id
Authorization: Bearer <token>

Environment Variables ​

List Variables ​

bash
GET /v1/services/:id/env
Authorization: Bearer <token>

Set Variable ​

bash
POST /v1/services/:id/env
Content-Type: application/json
Authorization: Bearer <token>

{
  "key": "NODE_ENV",
  "value": "production"
}

Delete Variable ​

bash
DELETE /v1/services/:id/env/:key
Authorization: Bearer <token>

Webhooks ​

Create Webhook ​

bash
POST /v1/webhooks
Content-Type: application/json
Authorization: Bearer <token>

{
  "url": "https://example.com/webhook",
  "events": ["deployment.created", "deployment.failed"],
  "secret": "webhook-secret"
}

List Webhooks ​

bash
GET /v1/webhooks
Authorization: Bearer <token>

Rate Limits ​

  • Authenticated requests: 1000 requests per hour
  • Unauthenticated requests: 60 requests per hour

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

Error Responses ​

All errors follow this format:

json
{
  "error": {
    "code": "invalid_request",
    "message": "Invalid deployment configuration",
    "details": {
      "field": "runtime",
      "issue": "Unsupported runtime version"
    }
  }
}

Common Error Codes ​

  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Too Many Requests
  • 500 - Internal Server Error

Next Steps ​