dokploy_compose_update
dokploy_compose_updateUpdate Docker Compose configurations in Dokploy by modifying parameters like environment variables, source repositories, deployment settings, and container specifications.
Instructions
[compose] compose.update (POST)
Parameters:
composeId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
env (any, optional)
composeFile (string, optional)
refreshToken (any, optional)
sourceType (enum: git, github, gitlab, bitbucket, gitea, raw, optional)
composeType (enum: docker-compose, stack, optional)
repository (any, optional)
owner (any, optional)
branch (any, optional)
autoDeploy (any, optional)
gitlabProjectId (any, optional)
gitlabRepository (any, optional)
gitlabOwner (any, optional)
gitlabBranch (any, optional)
gitlabPathNamespace (any, optional)
bitbucketRepository (any, optional)
bitbucketRepositorySlug (any, optional)
bitbucketOwner (any, optional)
bitbucketBranch (any, optional)
giteaRepository (any, optional)
giteaOwner (any, optional)
giteaBranch (any, optional)
customGitUrl (any, optional)
customGitBranch (any, optional)
customGitSSHKeyId (any, optional)
command (string, optional)
enableSubmodules (boolean, optional)
composePath (string, optional)
suffix (string, optional)
randomize (boolean, optional)
isolatedDeployment (boolean, optional)
isolatedDeploymentsVolume (boolean, optional)
triggerType (any, optional)
composeStatus (enum: idle, running, done, error, optional)
environmentId (string, optional)
createdAt (string, optional)
watchPaths (any, optional)
githubId (any, optional)
gitlabId (any, optional)
bitbucketId (any, optional)
giteaId (any, optional)
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"composeId": "<composeId>"
},
"name": "dokploy_compose_update"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| composeId | Yes | ||
| name | No | ||
| appName | No | ||
| description | No | ||
| env | No | ||
| composeFile | No | ||
| refreshToken | No | ||
| sourceType | No | ||
| composeType | No | ||
| repository | No | ||
| owner | No | ||
| branch | No | ||
| autoDeploy | No | ||
| gitlabProjectId | No | ||
| gitlabRepository | No | ||
| gitlabOwner | No | ||
| gitlabBranch | No | ||
| gitlabPathNamespace | No | ||
| bitbucketRepository | No | ||
| bitbucketRepositorySlug | No | ||
| bitbucketOwner | No | ||
| bitbucketBranch | No | ||
| giteaRepository | No | ||
| giteaOwner | No | ||
| giteaBranch | No | ||
| customGitUrl | No | ||
| customGitBranch | No | ||
| customGitSSHKeyId | No | ||
| command | No | ||
| enableSubmodules | No | ||
| composePath | No | ||
| suffix | No | ||
| randomize | No | ||
| isolatedDeployment | No | ||
| isolatedDeploymentsVolume | No | ||
| triggerType | No | ||
| composeStatus | No | ||
| environmentId | No | ||
| createdAt | No | ||
| watchPaths | No | ||
| githubId | No | ||
| gitlabId | No | ||
| bitbucketId | No | ||
| giteaId | No |