API Examples

Practical examples of using our API for common tasks and workflows.

1. Token Authentication


// Get authentication token
POST /api/v1/auth/token
{
  "client_id": "your-client-id",
  "client_secret": "your-secret",
  "grant_type": "client_credentials"
}


// Response
{
  "access_token": "A1B2C3D4E5",
  "token_type": "Bearer",
  "expires_in": 3600
}

2. Project Management


POST /api/v1/projects
{
  "name": "My New App",
  "framework": "react",
  "region": "us-west-1"
}


GET /api/v1/projects
{
  "organizationId": "org_123"
}


DELETE /api/v1/projects/{id}
{
  "force": true
}

3. Deployment Operations


POST /api/v1/deployments
{
  "projectId": "proj_456",
  "environment": "staging"
}


GET /api/v1/deployments/{id}/status
{
  "deploymentId": "dep_789"
}

4. Health Monitoring


GET /api/v1/monitoring
{
  "projectId": "proj_123",
  "interval": "15m"
}

// Response
{
  "status": "healthy",
  "uptime": "98.5%",
  "lastIncident": "2024-08-10T14:30:00Z"
}

Try API Interactive

API-playground.html

Interact with live API endpoints using our interactive sandbox.

Open Playground →