application-one
application-one
The ID of the application to retrieve.
Example
Response
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)
application-create
application-create
The name of the application.
The app name for the application (used in Docker containers and internal references).
An optional description for the application.
The ID of the environment where the application will be created.
The ID of the server where the application will be deployed. If null, uses default server.
Example
Response
Created application object with generated applicationId and default configuration.
application-update
application-update
The ID of the application to update.
Basic Configuration
name(string) - Application nameappName(string) - App name for Dockerdescription(string | null) - Application descriptiontitle(string | null) - Display titlesubtitle(string | null) - Display subtitleenabled(boolean | null) - Whether application is enabled
Source & Build Settings
sourceType(enum) -github | docker | git | gitlab | bitbucket | gitea | dropbuildType(enum) -dockerfile | heroku_buildpacks | paketo_buildpacks | nixpacks | static | railpackbuildArgs(string | null) - Build argumentsenv(string | null) - Environment variablescleanCache(boolean | null) - Clean build cachedockerfile(string | null) - Dockerfile content or pathdockerContextPath(string | null) - Docker build contextdockerBuildStage(string | null) - Multi-stage build target
Git Provider Fields
repository,owner,branch,buildPath- Generic Git fieldsgithubId,gitlabId,giteaId,bitbucketId- Provider IDsgitlabProjectId,gitlabPathNamespace- GitLab specificcustomGitUrl,customGitBranch,customGitBuildPath,customGitSSHKeyId- Custom GitenableSubmodules(boolean) - Enable Git submoduleswatchPaths(string[]) - Paths to watch for auto-deploy
Docker Configuration
dockerImage(string | null) - Docker image for deploymentregistryUrl,registryId- Registry configurationusername,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 settingsrestartPolicySwarm(object) - Restart policyplacementSwarm(object) - Placement constraintsupdateConfigSwarm(object) - Update strategyrollbackConfigSwarm(object) - Rollback strategymodeSwarm(object) - Service mode (replicated/global)labelsSwarm(object) - Swarm labelsnetworkSwarm(array) - Network configurationstopGracePeriodSwarm(number) - Graceful shutdown period
Preview Deployments
isPreviewDeploymentsActive(boolean | null)previewEnv,previewBuildArgs,previewLabelspreviewWildcard,previewPort,previewHttps,previewPathpreviewCertificateType,previewCustomCertResolverpreviewLimit(number | null) - Max concurrent previewspreviewRequireCollaboratorPermissions(boolean | null)
Other Settings
command(string | null) - Override container commandapplicationStatus(enum) -idle | running | done | errorrollbackActive(boolean | null) - Enable rollbackautoDeploy(boolean | null) - Auto-deploy on pushtriggerType(enum) -push | tag
Example
Response
Updated application object with all modified fields.
application-delete
application-delete
application-deploy
application-deploy
The ID of the application to deploy.
Optional title for the deployment.
Optional description for the deployment.
- Pull latest code from configured source
- Build the application using configured build type
- Create and start new containers
- Update routing configuration
Example
Response
Deployment job information including deployment ID and status.
application-redeploy
application-redeploy
application-start
application-start
application-stop
application-stop
application-reload
application-reload
application-move
application-move
The ID of the application to move.
The ID of the project to move the application to.
Example
application-markRunning
application-markRunning
application-cancelDeployment
application-cancelDeployment