Skip to main content
These tools provide fundamental application lifecycle management capabilities including CRUD operations, deployment, and state management.
applicationId
string
required
The ID of the application to retrieve.
Annotations: Read-only, IdempotentReturns: Complete application configuration including deployment settings, resource limits, networking, and monitoring configurations.

Example

{
  "applicationId": "app_clx1y2z3a0001"
}

Response

data
object
Application object with all configuration fields including:
  • Basic info (name, appName, description)
  • Source configuration (repository, branch, build path)
  • Build settings (buildType, dockerfile, buildArgs)
  • Runtime configuration (env, command, replicas)
  • Resource limits (memory, CPU)
  • Deployment status (applicationStatus)
name
string
required
The name of the application.
appName
string
The app name for the application (used in Docker containers and internal references).
description
string | null
An optional description for the application.
environmentId
string
required
The ID of the environment where the application will be created.
serverId
string | null
The ID of the server where the application will be deployed. If null, uses default server.
Annotations: Non-destructive, Non-idempotent

Example

{
  "name": "my-api",
  "appName": "my-api-prod",
  "description": "Production API service",
  "environmentId": "env_prod_123",
  "serverId": null
}

Response

data
object
Created application object with generated applicationId and default configuration.
applicationId
string
required
The ID of the application to update.
Annotations: Destructive, Non-idempotentThis tool accepts 60+ optional configuration fields organized into the following categories:

Basic Configuration

  • name (string) - Application name
  • appName (string) - App name for Docker
  • description (string | null) - Application description
  • title (string | null) - Display title
  • subtitle (string | null) - Display subtitle
  • enabled (boolean | null) - Whether application is enabled

Source & Build Settings

  • sourceType (enum) - github | docker | git | gitlab | bitbucket | gitea | drop
  • buildType (enum) - dockerfile | heroku_buildpacks | paketo_buildpacks | nixpacks | static | railpack
  • buildArgs (string | null) - Build arguments
  • env (string | null) - Environment variables
  • cleanCache (boolean | null) - Clean build cache
  • dockerfile (string | null) - Dockerfile content or path
  • dockerContextPath (string | null) - Docker build context
  • dockerBuildStage (string | null) - Multi-stage build target

Git Provider Fields

  • repository, owner, branch, buildPath - Generic Git fields
  • githubId, gitlabId, giteaId, bitbucketId - Provider IDs
  • gitlabProjectId, gitlabPathNamespace - GitLab specific
  • customGitUrl, customGitBranch, customGitBuildPath, customGitSSHKeyId - Custom Git
  • enableSubmodules (boolean) - Enable Git submodules
  • watchPaths (string[]) - Paths to watch for auto-deploy

Docker Configuration

  • dockerImage (string | null) - Docker image for deployment
  • registryUrl, registryId - Registry configuration
  • username, password - Registry authentication

Resource Limits

  • memoryReservation (string | null) - e.g., “512m”
  • memoryLimit (string | null) - e.g., “2g”
  • cpuReservation (string | null) - e.g., “0.5”
  • cpuLimit (string | null) - e.g., “2.0”
  • replicas (number) - Number of container replicas

Docker Swarm Configuration

  • healthCheckSwarm (object) - Health check settings
  • restartPolicySwarm (object) - Restart policy
  • placementSwarm (object) - Placement constraints
  • updateConfigSwarm (object) - Update strategy
  • rollbackConfigSwarm (object) - Rollback strategy
  • modeSwarm (object) - Service mode (replicated/global)
  • labelsSwarm (object) - Swarm labels
  • networkSwarm (array) - Network configuration
  • stopGracePeriodSwarm (number) - Graceful shutdown period

Preview Deployments

  • isPreviewDeploymentsActive (boolean | null)
  • previewEnv, previewBuildArgs, previewLabels
  • previewWildcard, previewPort, previewHttps, previewPath
  • previewCertificateType, previewCustomCertResolver
  • previewLimit (number | null) - Max concurrent previews
  • previewRequireCollaboratorPermissions (boolean | null)

Other Settings

  • command (string | null) - Override container command
  • applicationStatus (enum) - idle | running | done | error
  • rollbackActive (boolean | null) - Enable rollback
  • autoDeploy (boolean | null) - Auto-deploy on push
  • triggerType (enum) - push | tag

Example

{
  "applicationId": "app_123",
  "name": "updated-api",
  "env": "NODE_ENV=production\nAPI_KEY=secret",
  "memoryLimit": "1g",
  "cpuLimit": "1.0",
  "replicas": 3,
  "autoDeploy": true
}

Response

data
object
Updated application object with all modified fields.
applicationId
string
required
The ID of the application to delete.
Annotations: Destructive, Non-idempotent
This operation permanently deletes the application and all associated resources. This action cannot be undone.

Example

{
  "applicationId": "app_123"
}

Response

success
boolean
Confirmation of deletion.
applicationId
string
required
The ID of the application to deploy.
title
string
Optional title for the deployment.
description
string
Optional description for the deployment.
Annotations: Non-destructive, Non-idempotentInitiates a new deployment of the application. This will:
  1. Pull latest code from configured source
  2. Build the application using configured build type
  3. Create and start new containers
  4. Update routing configuration

Example

{
  "applicationId": "app_123",
  "title": "v2.1.0 Release",
  "description": "Deploy new features and bug fixes"
}

Response

data
object
Deployment job information including deployment ID and status.
applicationId
string
required
The ID of the application to redeploy.
Annotations: Non-destructive, Non-idempotentRedeploys the application without pulling new code. Useful for applying configuration changes or restarting with the same code version.

Example

{
  "applicationId": "app_123"
}
applicationId
string
required
The ID of the application to start.
Annotations: Non-destructive, Non-idempotentStarts a stopped application. The application must have been previously deployed.

Example

{
  "applicationId": "app_123"
}
applicationId
string
required
The ID of the application to stop.
Annotations: Destructive, Non-idempotentStops all running containers for the application. The application can be restarted later without redeploying.

Example

{
  "applicationId": "app_123"
}
applicationId
string
required
The ID of the application to reload.
appName
string
required
The app name of the application.
Annotations: Non-destructive, Non-idempotentReloads the application configuration and restarts containers gracefully.

Example

{
  "applicationId": "app_123",
  "appName": "my-api-prod"
}
applicationId
string
required
The ID of the application to move.
targetProjectId
string
required
The ID of the project to move the application to.
Annotations: Destructive, Non-idempotentMoves an application from its current project to a different project. The application maintains its configuration but changes project association.

Example

{
  "applicationId": "app_123",
  "targetProjectId": "project_456"
}
applicationId
string
required
The ID of the application to mark as running.
Annotations: Destructive, Non-idempotentManually marks an application as running. Useful for fixing application state after manual interventions.

Example

{
  "applicationId": "app_123"
}
applicationId
string
required
The ID of the application with ongoing deployment to cancel.
Annotations: Destructive, Non-idempotentCancels an ongoing deployment. The application will remain in its previous state.

Example

{
  "applicationId": "app_123"
}

Common Workflows

Create and Deploy Application

// Step 1: Create application
{"tool": "application-create", "input": {"name": "api", "environmentId": "env_1"}}

// Step 2: Configure Git source (see Git Providers page)
{"tool": "application-saveGithubProvider", "input": {...}}

// Step 3: Configure build (see Configuration page)
{"tool": "application-saveBuildType", "input": {...}}

// Step 4: Deploy
{"tool": "application-deploy", "input": {"applicationId": "app_123"}}

Update and Redeploy

// Update configuration
{"tool": "application-update", "input": {"applicationId": "app_123", "env": "KEY=value"}}

// Apply changes
{"tool": "application-redeploy", "input": {"applicationId": "app_123"}}

Emergency Stop

// Cancel running deployment
{"tool": "application-cancelDeployment", "input": {"applicationId": "app_123"}}

// Stop application
{"tool": "application-stop", "input": {"applicationId": "app_123"}}

Build docs developers (and LLMs) love