mirror of
https://github.com/LukeHagar/Dokploy-ts-sdk.git
synced 2025-12-06 20:37:44 +00:00
50 lines
13 KiB
Markdown
50 lines
13 KiB
Markdown
# ComposeUpdateRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { ComposeUpdateRequest } from "dokploy/models/operations";
|
|
|
|
let value: ComposeUpdateRequest = {
|
|
composeId: "<id>",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
| `composeId` | *string* | :heavy_check_mark: | N/A |
|
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
| `appName` | *string* | :heavy_minus_sign: | N/A |
|
|
| `description` | *string* | :heavy_minus_sign: | N/A |
|
|
| `env` | *string* | :heavy_minus_sign: | N/A |
|
|
| `composeFile` | *string* | :heavy_minus_sign: | N/A |
|
|
| `refreshToken` | *string* | :heavy_minus_sign: | N/A |
|
|
| `sourceType` | [operations.ComposeUpdateSourceType](../../models/operations/composeupdatesourcetype.md) | :heavy_minus_sign: | N/A |
|
|
| `composeType` | [operations.ComposeUpdateComposeType](../../models/operations/composeupdatecomposetype.md) | :heavy_minus_sign: | N/A |
|
|
| `repository` | *string* | :heavy_minus_sign: | N/A |
|
|
| `owner` | *string* | :heavy_minus_sign: | N/A |
|
|
| `branch` | *string* | :heavy_minus_sign: | N/A |
|
|
| `autoDeploy` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `gitlabProjectId` | *number* | :heavy_minus_sign: | N/A |
|
|
| `gitlabRepository` | *string* | :heavy_minus_sign: | N/A |
|
|
| `gitlabOwner` | *string* | :heavy_minus_sign: | N/A |
|
|
| `gitlabBranch` | *string* | :heavy_minus_sign: | N/A |
|
|
| `gitlabPathNamespace` | *string* | :heavy_minus_sign: | N/A |
|
|
| `bitbucketRepository` | *string* | :heavy_minus_sign: | N/A |
|
|
| `bitbucketOwner` | *string* | :heavy_minus_sign: | N/A |
|
|
| `bitbucketBranch` | *string* | :heavy_minus_sign: | N/A |
|
|
| `customGitUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
| `customGitBranch` | *string* | :heavy_minus_sign: | N/A |
|
|
| `customGitSSHKeyId` | *string* | :heavy_minus_sign: | N/A |
|
|
| `command` | *string* | :heavy_minus_sign: | N/A |
|
|
| `composePath` | *string* | :heavy_minus_sign: | N/A |
|
|
| `suffix` | *string* | :heavy_minus_sign: | N/A |
|
|
| `randomize` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `composeStatus` | [operations.ComposeStatus](../../models/operations/composestatus.md) | :heavy_minus_sign: | N/A |
|
|
| `projectId` | *string* | :heavy_minus_sign: | N/A |
|
|
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
|
|
| `githubId` | *string* | :heavy_minus_sign: | N/A |
|
|
| `gitlabId` | *string* | :heavy_minus_sign: | N/A |
|
|
| `bitbucketId` | *string* | :heavy_minus_sign: | N/A | |