---
title: "POST /compose.update"
method: POST
path: "/compose.update"
tags: ["compose"]
---

# POST /compose.update

`POST /compose.update`

## Request body

- object
  - `composeId` string, required
  - `name` string
  - `appName` string
  - `description` string, nullable
  - `env` string, nullable
  - `composeFile` string
  - `refreshToken` string, nullable
  - `sourceType` 'git' | 'github' | 'gitlab' | 'bitbucket' | 'gitea' | 'raw'
  - `composeType` 'docker-compose' | 'stack'
  - `repository` string, nullable
  - `owner` string, nullable
  - `branch` string, nullable
  - `autoDeploy` boolean, nullable
  - `gitlabProjectId` number, nullable
  - `gitlabRepository` string, nullable
  - `gitlabOwner` string, nullable
  - `gitlabBranch` string, nullable
  - `gitlabPathNamespace` string, nullable
  - `bitbucketRepository` string, nullable
  - `bitbucketRepositorySlug` string, nullable
  - `bitbucketOwner` string, nullable
  - `bitbucketBranch` string, nullable
  - `giteaRepository` string, nullable
  - `giteaOwner` string, nullable
  - `giteaBranch` string, nullable
  - `customGitUrl` string, nullable
  - `customGitBranch` string, nullable
  - `customGitSSHKeyId` string, nullable
  - `command` string
  - `enableSubmodules` boolean
  - `composePath` string
  - `suffix` string
  - `randomize` boolean
  - `isolatedDeployment` boolean
  - `isolatedDeploymentsVolume` boolean
  - `triggerType` 'push' | 'tag', nullable
  - `composeStatus` 'idle' | 'running' | 'done' | 'error'
  - `environmentId` string
  - `createdAt` string
  - `watchPaths` string[], nullable
  - `githubId` string, nullable
  - `gitlabId` string, nullable
  - `bitbucketId` string, nullable
  - `giteaId` string, nullable

## Response `200`

Successful response

- object

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `500` — Internal server error

---

[API](https://skmtc.net/dokploy/apis/dokploy-api.md) · [All operations](https://skmtc.net/dokploy/apis/dokploy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dokploy/dokploy-api/versions/e43061d02faa/schema)