API Reference

Build on DeployTitan.

A REST API with consistent JSON payloads, bearer token auth, and Server-Sent Events for real-time deployment streaming. Build internal tooling, custom dashboards, or integrate with any orchestration system.

Browse endpoints CLI Reference

Authentication

Bearer token auth

All API requests require an Authorization: Bearer header. Generate tokens from your workspace settings. Tokens are scoped — you can restrict them to read-only, deploy-only, or admin.

Request

POST /v1/deployments

curl -X POST https://api.deploytitan.com/v1/deployments \
  -H "Authorization: Bearer dt_live_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "api-gateway",
    "environment": "production",
    "strategy": "canary",
    "image": "ghcr.io/acme/api-gateway:v2.1.0"
  }'

Response

200 OK

{
  "id": "dep_01J7XZ9R3T6QMVN8KCWF4PYDE",
  "service": "api-gateway",
  "environment": "production",
  "strategy": "canary",
  "status": "in_progress",
  "created_at": "2026-04-30T10:22:11Z",
  "steps": [
    { "name": "preflight", "status": "success" },
    { "name": "canary_10pct", "status": "in_progress" },
    { "name": "canary_50pct", "status": "pending" },
    { "name": "full_rollout", "status": "pending" }
  ]
}

Endpoints

REST endpoints

POST/v1/deploymentsTrigger a new deployment for a serviceDeployments

GET/v1/deployments/:idGet deployment status and health metricsDeployments

POST/v1/deployments/:id/rollbackInstant rollback to the previous stable releaseDeployments

GET/v1/servicesList all services in your workspaceServices

GET/v1/services/:slug/healthReal-time SLO and error-budget health snapshotServices

GET/v1/eventsStream deployment events (SSE)Events

POST/v1/webhooksRegister a webhook endpoint for deployment eventsWebhooks

Webhooks

Real-time events

Register a webhook URL and DeployTitan will POST signed JSON payloads to your endpoint on every deployment lifecycle event — started, completed, failed, or rolled back.

Webhook payload

// Payload delivered to your endpoint on deployment events
{
  "event": "deployment.completed",
  "deployment_id": "dep_01J7XZ9R3T6QMVN8KCWF4PYDE",
  "service": "api-gateway",
  "environment": "production",
  "status": "success",
  "duration_ms": 142500,
  "timestamp": "2026-04-30T10:24:33Z"
}

Base URL

https://api.deploytitan.com

Rate limit

2 000 req / min

API version

v1 (stable)