API Reference
Complete REST API reference for LaserData Cloud - resource management, deployment operations, observability, and more.
Set variables to auto-fill all examples and run requests in-browser.
LaserData Cloud exposes three REST API layers. All share the same authentication model: an ld-api-key header bearing an API key scoped to a role with the required permissions.
Base URLs
| API | Base URL | Purpose |
|---|---|---|
| Main API | https://api.laserdata.cloud | Resource management: org, deployments, API keys, billing, notifications |
| Supervisor API | {supervisor_url} | Deployment operations: configs, networking, metrics, logs, diagnostic snapshots, data backups |
| Audit API | https://audit.laserdata.cloud | Immutable audit log and compliance exports |
The supervisor_url for each deployment is returned in the List Deployments and Get Deployment responses, for example https://supervisor-aws-us.laserdata.cloud.
Authentication
Every request must include the ld-api-key header:
curl https://api.laserdata.cloud/tenants/{tenant_id}/api_keys \
-H "ld-api-key: YOUR_API_KEY"See Authentication for the full security model, scopes, and error reference.
Pagination
List endpoints support cursor-based pagination via query parameters:
| Parameter | Default | Description |
|---|---|---|
page | 1 | Page number (1-indexed) |
results | 10 | Items per page (max 100) |
Paginated responses always include page, total_results, and total_pages fields alongside items.
Quick Start
Spin up a Free-tier deployment in seconds:
# 1. Create a starter deployment (Free tier, standalone)
curl -X POST https://api.laserdata.cloud/tenants/{tenant_id}/divisions/{division_id}/deployments/starter \
-H "ld-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"cloud": "aws",
"region": "us-west-1"
}'
# Response headers contain the created resource IDs:
# ld-environment: <environment_id>
# ld-deployment: <deployment_id># 2. Get the deployment (once provisioned)
curl https://api.laserdata.cloud/tenants/{tenant_id}/divisions/{division_id}/environments/{environment_id}/deployments/{deployment_id} \
-H "ld-api-key: YOUR_API_KEY"# 3. Get connection credentials
curl {supervisor_url}/deployments/{deployment_id}/credentials \
-H "ld-api-key: YOUR_API_KEY"HTTP Status Codes
| Code | Meaning |
|---|---|
200 OK | Request succeeded |
202 Accepted | Request accepted; operation will complete asynchronously |
400 Bad Request | Invalid parameters or request body |
401 Unauthorized | Missing or invalid API key |
403 Forbidden | API key valid but lacks required permission |
404 Not Found | Resource does not exist |
409 Conflict | Resource already exists or state conflict |
429 Too Many Requests | Rate limit exceeded |
500 Internal Server Error | Unexpected server error |
API Sections
Authentication
Headers, scopes, errors, and key rotation
Organization
Tenants, divisions, and environments
Members & Roles
Users, roles, and invitations
Deployments
Create, configure, and manage deployments
Configuration
Iggy configs, connector configs, and tasks
Connectors
Activate and manage connector instances
Networking
VPC peering, PrivateLink, PSC, and access rules
Observability
Metrics, heartbeats, and log streaming
Activities
Runtime actions: restart, reload
Snapshots
Diagnostic HTML reports per node
Backups
Point-in-time storage volume backups (experimental)
Notifications
Channels and event subscriptions
Audit
Immutable audit log and compliance exports
API Keys
Create and manage programmatic access keys
Cloud Accounts
BYOC cloud account registration
Billing
Billing info, invoices, and payment methods