API Reference

The Launcher API is a RESTful HTTP API that provides programmatic access to all platform resources.

Base URL


https://plane.lnchr.cloud/<tenant-id>/api/v1

Authentication

All endpoints require authentication unless otherwise noted. Two methods are supported:

Method	Header	Use Case
Bearer Token	`Authorization: Bearer <jwt>`	Dashboard, interactive sessions
Service Key	`x-lnchr-key: <key>`	CI/CD, Terraform, automation, AI agents

Service keys are recommended for programmatic access. Create one via Settings > Service Keys in the dashboard or the Authentication API.

Response Format

All responses use a standard JSON envelope:


// Success (200, 201)
{
  "success": true,
  "data": { ... }
}
 
// Error (4xx, 5xx)
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "application not found"
  }
}
 
// No Content (204) — empty body

Error Codes

HTTP Status	Code	Description
400	`BAD_REQUEST`	Invalid request body or parameters
401	`UNAUTHORIZED`	Missing or invalid authentication
403	`FORBIDDEN`	Insufficient permissions
404	`NOT_FOUND`	Resource does not exist
409	`CONFLICT`	Resource already exists or state conflict
429	`TOO_MANY_REQUESTS`	Rate limit exceeded
500	`INTERNAL_ERROR`	Unexpected server error
503	`SERVICE_UNAVAILABLE`	Server temporarily unavailable

Conventions

All resource IDs are UUIDs (e.g., 550e8400-e29b-41d4-a716-446655440000)
All timestamps are RFC 3339 UTC (e.g., 2024-01-15T10:30:00Z)
List endpoints support ?projectId= to filter by project
Every response includes the x-plane-version header with the server version

Quick Example


# Create a service key
curl -X POST https://plane.lnchr.cloud/<tenant>/api/v1/settings/service-keys \
  -H "Authorization: Bearer <jwt>" \
  -H "Content-Type: application/json" \
  -d '{"name": "ci-cd"}'
 
# Use the service key to list applications
curl https://plane.lnchr.cloud/<tenant>/api/v1/applications \
  -H "x-lnchr-key: <service-key>"
 
# Deploy an application
curl -X POST https://plane.lnchr.cloud/<tenant>/api/v1/applications/<id>/deploy \
  -H "x-lnchr-key: <service-key>"

Sections

Section	Description
Authentication	Login, registration, service keys, user profile
Projects	Projects, members, invites, environments
Servers	Server management, status, diagnostics
Applications	App lifecycle, deploy, scale, env vars
Databases	Managed databases (Postgres, MySQL, Redis, MongoDB)
Buckets	S3-compatible object storage (MinIO)
Functions	Serverless functions with HTTP/cron triggers
Volumes	Persistent storage volumes
Environment Variables	Encrypted env vars with reference resolution
Domains	Custom domain management and DNS verification
Deployments	Deployment history and logs
Backups	Backup destinations, schedules, PITR
Templates	Infrastructure-as-code templates
Registries	Container registry credentials
Git Providers	GitHub, GitLab, Bitbucket integrations
Monitoring	Server metrics and application traffic
Issues	Error tracking and issue management
Alerts	Alert channels (Slack, Discord, email, webhooks)
Notifications	In-app notification management
Search	Global resource search
Webhooks	Git webhook endpoints for auto-deploy
WebSocket Endpoints	Real-time logs, metrics, terminal
MCP Integration	AI agent integration via Model Context Protocol