Skip to Content

Applications

Applications are containerized workloads deployed to your servers. Launcher supports git-based builds, container images, and Docker Compose deployments.

Endpoints

MethodPathDescription
GET/api/v1/applicationsList applications (?projectId=)
GET/api/v1/applications/check-nameCheck name availability (?name=&projectId=)
POST/api/v1/applicationsCreate application
GET/api/v1/applications/:idGet application
PUT/api/v1/applications/:idUpdate application
DELETE/api/v1/applications/:idDelete application

Lifecycle

MethodPathDescription
POST/api/v1/applications/:id/deployTrigger a new deployment
POST/api/v1/applications/:id/startStart the application
POST/api/v1/applications/:id/stopStop the application
POST/api/v1/applications/:id/restartRestart the application
POST/api/v1/applications/:id/rollbackRollback to previous deployment

Scaling

MethodPathDescription
GET/api/v1/applications/:id/instancesList running instances
POST/api/v1/applications/:id/scaleScale replica count

Configuration

MethodPathDescription
GET/api/v1/applications/:id/dependenciesGet linked resources
GET/api/v1/applications/:id/envGet environment variables
PUT/api/v1/applications/:id/envReplace all environment variables
PATCH/api/v1/applications/:id/envMerge environment variables

Logs

MethodPathDescription
GET/api/v1/applications/:id/runtime-logsRuntime logs
GET/api/v1/applications/:id/build-logsBuild logs

POST /api/v1/applications

{ "project_id": "uuid", "environment_id": "uuid", "server_id": "uuid", "registry_id": "uuid", "name": "my-api", "app_type": "web", "source_type": "git", "repository_url": "https://github.com/user/repo", "branch": "main", "dockerfile_path": "Dockerfile", "build_context": ".", "build_args": { "NODE_ENV": "production" }, "env": { "PORT": "3000" }, "replicas": 2, "exposed_port": 3000, "autodeploy": true, "watch_paths": "src/**", "healthcheck_path": "/health", "restart_policy": "always", "start_command": "npm start" }

Source types:

source_typeRequired fields
gitrepository_url, branch, dockerfile_path
imageimage_url
composecompose_file or compose_path

App types: web (HTTP service), worker (background process), static (static files)


Application Object

{ "id": "uuid", "project_id": "uuid", "environment_id": "uuid", "server_id": "uuid", "name": "my-api", "internal_id": "string", "app_type": "web", "source_type": "git", "repository_url": "https://github.com/user/repo", "branch": "main", "dockerfile_path": "Dockerfile", "build_context": ".", "replicas": 2, "exposed_port": 3000, "autodeploy": true, "status": "running", "current_commit": "abc123", "current_deployment_id": "uuid", "healthcheck_path": "/health", "restart_policy": "always", "start_command": "npm start", "consecutive_failures": 0, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }

Status Values

running, stopped, deploying, failed, error, deleting

Last updated on