LukeParke/Dokploy-ts-sdk
1
0
Fork 0
mirror of https://github.com/LukeHagar/Dokploy-ts-sdk.git synced 2025-12-06 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
Luke Hagar
2025-09-26 02:33:10 +00:00
commit f7b542efbf
928 changed files with 113882 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/lib/utils/retryconfig.md Normal file
View File

@@ -0,0 +1,24 @@
# RetryConfig
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
## Fields
| Name | Type | Description | Example |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
## BackoffStrategy
The backoff strategy allows retrying a request with an exponential backoff between each retry.
### Fields
| Name | Type | Description | Example |
| ------------------ | ------------ | ----------------------------------------- | -------- |
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |

22
docs/models/errort.md Normal file
View File

@@ -0,0 +1,22 @@
# ErrorT
Error response
## Example Usage
```typescript
import { ErrorT } from "dokploy/models";
let value: ErrorT = {
message: "<value>",
code: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |
| `code` | *string* | :heavy_check_mark: | N/A |
| `issues` | [models.Issue](../models/issue.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/issue.md Normal file
View File

@@ -0,0 +1,17 @@
# Issue
## Example Usage
```typescript
import { Issue } from "dokploy/models";
let value: Issue = {
message: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *string* | :heavy_check_mark: | N/A |

41
docs/models/operations/adminassignpermissionsrequest.md Normal file
View File

@@ -0,0 +1,41 @@
# AdminAssignPermissionsRequest
## Example Usage
```typescript
import { AdminAssignPermissionsRequest } from "dokploy/models/operations";
let value: AdminAssignPermissionsRequest = {
userId: "<id>",
canCreateProjects: true,
canCreateServices: false,
canDeleteProjects: false,
canDeleteServices: false,
accesedProjects: [
"<value 1>",
],
accesedServices: [],
canAccessToTraefikFiles: true,
canAccessToDocker: false,
canAccessToAPI: false,
canAccessToSSHKeys: false,
canAccessToGitProviders: true,
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `userId` | *string* | :heavy_check_mark: | N/A |
| `canCreateProjects` | *boolean* | :heavy_check_mark: | N/A |
| `canCreateServices` | *boolean* | :heavy_check_mark: | N/A |
| `canDeleteProjects` | *boolean* | :heavy_check_mark: | N/A |
| `canDeleteServices` | *boolean* | :heavy_check_mark: | N/A |
| `accesedProjects` | *string*[] | :heavy_check_mark: | N/A |
| `accesedServices` | *string*[] | :heavy_check_mark: | N/A |
| `canAccessToTraefikFiles` | *boolean* | :heavy_check_mark: | N/A |
| `canAccessToDocker` | *boolean* | :heavy_check_mark: | N/A |
| `canAccessToAPI` | *boolean* | :heavy_check_mark: | N/A |
| `canAccessToSSHKeys` | *boolean* | :heavy_check_mark: | N/A |
| `canAccessToGitProviders` | *boolean* | :heavy_check_mark: | N/A |

17
docs/models/operations/admincreateuserinvitationrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AdminCreateUserInvitationRequest
## Example Usage
```typescript
import { AdminCreateUserInvitationRequest } from "dokploy/models/operations";
let value: AdminCreateUserInvitationRequest = {
email: "Boris.Wilderman33@gmail.com",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `email` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/admingetuserbytokenrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AdminGetUserByTokenRequest
## Example Usage
```typescript
import { AdminGetUserByTokenRequest } from "dokploy/models/operations";
let value: AdminGetUserByTokenRequest = {
token: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/adminremoveuserrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AdminRemoveUserRequest
## Example Usage
```typescript
import { AdminRemoveUserRequest } from "dokploy/models/operations";
let value: AdminRemoveUserRequest = {
authId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `authId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationcleanqueuesrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationCleanQueuesRequest
## Example Usage
```typescript
import { ApplicationCleanQueuesRequest } from "dokploy/models/operations";
let value: ApplicationCleanQueuesRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

22
docs/models/operations/applicationcreaterequest.md Normal file
View File

@@ -0,0 +1,22 @@
# ApplicationCreateRequest
## Example Usage
```typescript
import { ApplicationCreateRequest } from "dokploy/models/operations";
let value: ApplicationCreateRequest = {
name: "<value>",
projectId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `appName` | *string* | :heavy_minus_sign: | N/A |
| `description` | *string* | :heavy_minus_sign: | N/A |
| `projectId` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/applicationdeleterequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationDeleteRequest
## Example Usage
```typescript
import { ApplicationDeleteRequest } from "dokploy/models/operations";
let value: ApplicationDeleteRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationdeployrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationDeployRequest
## Example Usage
```typescript
import { ApplicationDeployRequest } from "dokploy/models/operations";
let value: ApplicationDeployRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationmarkrunningrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationMarkRunningRequest
## Example Usage
```typescript
import { ApplicationMarkRunningRequest } from "dokploy/models/operations";
let value: ApplicationMarkRunningRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationOneRequest
## Example Usage
```typescript
import { ApplicationOneRequest } from "dokploy/models/operations";
let value: ApplicationOneRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationreadappmonitoringrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationReadAppMonitoringRequest
## Example Usage
```typescript
import { ApplicationReadAppMonitoringRequest } from "dokploy/models/operations";
let value: ApplicationReadAppMonitoringRequest = {
appName: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `appName` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationreadtraefikconfigrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationReadTraefikConfigRequest
## Example Usage
```typescript
import { ApplicationReadTraefikConfigRequest } from "dokploy/models/operations";
let value: ApplicationReadTraefikConfigRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationredeployrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationRedeployRequest
## Example Usage
```typescript
import { ApplicationRedeployRequest } from "dokploy/models/operations";
let value: ApplicationRedeployRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationrefreshtokenrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationRefreshTokenRequest
## Example Usage
```typescript
import { ApplicationRefreshTokenRequest } from "dokploy/models/operations";
let value: ApplicationRefreshTokenRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/applicationreloadrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# ApplicationReloadRequest
## Example Usage
```typescript
import { ApplicationReloadRequest } from "dokploy/models/operations";
let value: ApplicationReloadRequest = {
appName: "<value>",
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `appName` | *string* | :heavy_check_mark: | N/A |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

27
docs/models/operations/applicationsavebitbucketproviderrequest.md Normal file
View File

@@ -0,0 +1,27 @@
# ApplicationSaveBitbucketProviderRequest
## Example Usage
```typescript
import { ApplicationSaveBitbucketProviderRequest } from "dokploy/models/operations";
let value: ApplicationSaveBitbucketProviderRequest = {
bitbucketBranch: "<value>",
bitbucketBuildPath: null,
bitbucketOwner: "<value>",
bitbucketRepository: "<value>",
bitbucketId: "<id>",
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| --------------------- | --------------------- | --------------------- | --------------------- |
| `bitbucketBranch` | *string* | :heavy_check_mark: | N/A |
| `bitbucketBuildPath` | *string* | :heavy_check_mark: | N/A |
| `bitbucketOwner` | *string* | :heavy_check_mark: | N/A |
| `bitbucketRepository` | *string* | :heavy_check_mark: | N/A |
| `bitbucketId` | *string* | :heavy_check_mark: | N/A |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/applicationsavebuildtypebuildtype.md Normal file
View File

@@ -0,0 +1,15 @@
# ApplicationSaveBuildTypeBuildType
## Example Usage
```typescript
import { ApplicationSaveBuildTypeBuildType } from "dokploy/models/operations";
let value: ApplicationSaveBuildTypeBuildType = "static";
```
## Values
```typescript
"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"
```

25
docs/models/operations/applicationsavebuildtyperequest.md Normal file
View File

@@ -0,0 +1,25 @@
# ApplicationSaveBuildTypeRequest
## Example Usage
```typescript
import { ApplicationSaveBuildTypeRequest } from "dokploy/models/operations";
let value: ApplicationSaveBuildTypeRequest = {
applicationId: "<id>",
buildType: "nixpacks",
dockerContextPath: "<value>",
dockerBuildStage: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `buildType` | [operations.ApplicationSaveBuildTypeBuildType](../../models/operations/applicationsavebuildtypebuildtype.md) | :heavy_check_mark: | N/A |
| `dockerfile` | *string* | :heavy_minus_sign: | N/A |
| `dockerContextPath` | *string* | :heavy_check_mark: | N/A |
| `dockerBuildStage` | *string* | :heavy_check_mark: | N/A |
| `publishDirectory` | *string* | :heavy_minus_sign: | N/A |

20
docs/models/operations/applicationsavedockerproviderrequest.md Normal file
View File

@@ -0,0 +1,20 @@
# ApplicationSaveDockerProviderRequest
## Example Usage
```typescript
import { ApplicationSaveDockerProviderRequest } from "dokploy/models/operations";
let value: ApplicationSaveDockerProviderRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `dockerImage` | *string* | :heavy_minus_sign: | N/A |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_minus_sign: | N/A |
| `password` | *string* | :heavy_minus_sign: | N/A |

19
docs/models/operations/applicationsaveenvironmentrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# ApplicationSaveEnvironmentRequest
## Example Usage
```typescript
import { ApplicationSaveEnvironmentRequest } from "dokploy/models/operations";
let value: ApplicationSaveEnvironmentRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `env` | *string* | :heavy_minus_sign: | N/A |
| `buildArgs` | *string* | :heavy_minus_sign: | N/A |

24
docs/models/operations/applicationsavegithubproviderrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# ApplicationSaveGithubProviderRequest
## Example Usage
```typescript
import { ApplicationSaveGithubProviderRequest } from "dokploy/models/operations";
let value: ApplicationSaveGithubProviderRequest = {
applicationId: "<id>",
owner: "<value>",
githubId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `repository` | *string* | :heavy_minus_sign: | N/A |
| `branch` | *string* | :heavy_minus_sign: | N/A |
| `owner` | *string* | :heavy_check_mark: | N/A |
| `buildPath` | *string* | :heavy_minus_sign: | N/A |
| `githubId` | *string* | :heavy_check_mark: | N/A |

31
docs/models/operations/applicationsavegitlabproviderrequest.md Normal file
View File

@@ -0,0 +1,31 @@
# ApplicationSaveGitlabProviderRequest
## Example Usage
```typescript
import { ApplicationSaveGitlabProviderRequest } from "dokploy/models/operations";
let value: ApplicationSaveGitlabProviderRequest = {
applicationId: "<id>",
gitlabBranch: "<value>",
gitlabBuildPath: "<value>",
gitlabOwner: "<value>",
gitlabRepository: "<value>",
gitlabId: "<id>",
gitlabProjectId: 9227.42,
gitlabPathNamespace: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| --------------------- | --------------------- | --------------------- | --------------------- |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `gitlabBranch` | *string* | :heavy_check_mark: | N/A |
| `gitlabBuildPath` | *string* | :heavy_check_mark: | N/A |
| `gitlabOwner` | *string* | :heavy_check_mark: | N/A |
| `gitlabRepository` | *string* | :heavy_check_mark: | N/A |
| `gitlabId` | *string* | :heavy_check_mark: | N/A |
| `gitlabProjectId` | *number* | :heavy_check_mark: | N/A |
| `gitlabPathNamespace` | *string* | :heavy_check_mark: | N/A |

21
docs/models/operations/applicationsavegitprodiverrequest.md Normal file
View File

@@ -0,0 +1,21 @@
# ApplicationSaveGitProdiverRequest
## Example Usage
```typescript
import { ApplicationSaveGitProdiverRequest } from "dokploy/models/operations";
let value: ApplicationSaveGitProdiverRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `customGitBranch` | *string* | :heavy_minus_sign: | N/A |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `customGitBuildPath` | *string* | :heavy_minus_sign: | N/A |
| `customGitUrl` | *string* | :heavy_minus_sign: | N/A |
| `customGitSSHKeyId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/applicationstartrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationStartRequest
## Example Usage
```typescript
import { ApplicationStartRequest } from "dokploy/models/operations";
let value: ApplicationStartRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/applicationstoprequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ApplicationStopRequest
## Example Usage
```typescript
import { ApplicationStopRequest } from "dokploy/models/operations";
let value: ApplicationStopRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/applicationupdateapplicationstatus.md Normal file
View File

@@ -0,0 +1,15 @@
# ApplicationUpdateApplicationStatus
## Example Usage
```typescript
import { ApplicationUpdateApplicationStatus } from "dokploy/models/operations";
let value: ApplicationUpdateApplicationStatus = "error";
```
## Values
```typescript
"idle" | "running" | "done" | "error"
```

15
docs/models/operations/applicationupdatebuildtype.md Normal file
View File

@@ -0,0 +1,15 @@
# ApplicationUpdateBuildType
## Example Usage
```typescript
import { ApplicationUpdateBuildType } from "dokploy/models/operations";
let value: ApplicationUpdateBuildType = "heroku_buildpacks";
```
## Values
```typescript
"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"
```

76
docs/models/operations/applicationupdaterequest.md Normal file
View File

@@ -0,0 +1,76 @@
# ApplicationUpdateRequest
## Example Usage
```typescript
import { ApplicationUpdateRequest } from "dokploy/models/operations";
let value: ApplicationUpdateRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `applicationId` | *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 |
| `buildArgs` | *string* | :heavy_minus_sign: | N/A |
| `memoryReservation` | *number* | :heavy_minus_sign: | N/A |
| `memoryLimit` | *number* | :heavy_minus_sign: | N/A |
| `cpuReservation` | *number* | :heavy_minus_sign: | N/A |
| `cpuLimit` | *number* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |
| `enabled` | *boolean* | :heavy_minus_sign: | N/A |
| `subtitle` | *string* | :heavy_minus_sign: | N/A |
| `command` | *string* | :heavy_minus_sign: | N/A |
| `refreshToken` | *string* | :heavy_minus_sign: | N/A |
| `sourceType` | [operations.ApplicationUpdateSourceType](../../models/operations/applicationupdatesourcetype.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 |
| `buildPath` | *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 |
| `gitlabBuildPath` | *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 |
| `bitbucketBuildPath` | *string* | :heavy_minus_sign: | N/A |
| `username` | *string* | :heavy_minus_sign: | N/A |
| `password` | *string* | :heavy_minus_sign: | N/A |
| `dockerImage` | *string* | :heavy_minus_sign: | N/A |
| `customGitUrl` | *string* | :heavy_minus_sign: | N/A |
| `customGitBranch` | *string* | :heavy_minus_sign: | N/A |
| `customGitBuildPath` | *string* | :heavy_minus_sign: | N/A |
| `customGitSSHKeyId` | *string* | :heavy_minus_sign: | N/A |
| `dockerfile` | *string* | :heavy_minus_sign: | N/A |
| `dockerContextPath` | *string* | :heavy_minus_sign: | N/A |
| `dockerBuildStage` | *string* | :heavy_minus_sign: | N/A |
| `dropBuildPath` | *string* | :heavy_minus_sign: | N/A |
| `healthCheckSwarm` | [operations.HealthCheckSwarm](../../models/operations/healthcheckswarm.md) | :heavy_minus_sign: | N/A |
| `restartPolicySwarm` | [operations.RestartPolicySwarm](../../models/operations/restartpolicyswarm.md) | :heavy_minus_sign: | N/A |
| `placementSwarm` | [operations.PlacementSwarm](../../models/operations/placementswarm.md) | :heavy_minus_sign: | N/A |
| `updateConfigSwarm` | [operations.UpdateConfigSwarm](../../models/operations/updateconfigswarm.md) | :heavy_minus_sign: | N/A |
| `rollbackConfigSwarm` | [operations.RollbackConfigSwarm](../../models/operations/rollbackconfigswarm.md) | :heavy_minus_sign: | N/A |
| `modeSwarm` | [operations.ModeSwarm](../../models/operations/modeswarm.md) | :heavy_minus_sign: | N/A |
| `labelsSwarm` | Record<string, *string*> | :heavy_minus_sign: | N/A |
| `networkSwarm` | [operations.NetworkSwarm](../../models/operations/networkswarm.md)[] | :heavy_minus_sign: | N/A |
| `replicas` | *number* | :heavy_minus_sign: | N/A |
| `applicationStatus` | [operations.ApplicationUpdateApplicationStatus](../../models/operations/applicationupdateapplicationstatus.md) | :heavy_minus_sign: | N/A |
| `buildType` | [operations.ApplicationUpdateBuildType](../../models/operations/applicationupdatebuildtype.md) | :heavy_minus_sign: | N/A |
| `publishDirectory` | *string* | :heavy_minus_sign: | N/A |
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
| `registryId` | *string* | :heavy_minus_sign: | N/A |
| `projectId` | *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 |

15
docs/models/operations/applicationupdatesourcetype.md Normal file
View File

@@ -0,0 +1,15 @@
# ApplicationUpdateSourceType
## Example Usage
```typescript
import { ApplicationUpdateSourceType } from "dokploy/models/operations";
let value: ApplicationUpdateSourceType = "git";
```
## Values
```typescript
"github" | "docker" | "git"
```

19
docs/models/operations/applicationupdatetraefikconfigrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# ApplicationUpdateTraefikConfigRequest
## Example Usage
```typescript
import { ApplicationUpdateTraefikConfigRequest } from "dokploy/models/operations";
let value: ApplicationUpdateTraefikConfigRequest = {
applicationId: "<id>",
traefikConfig: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |
| `traefikConfig` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/apptype.md Normal file
View File

@@ -0,0 +1,17 @@
# AppType
## Supported Types
### `operations.AppTypeStack`
```typescript
const value: operations.AppTypeStack = "stack";
```
### `operations.AppTypeDockerCompose`
```typescript
const value: operations.AppTypeDockerCompose = "docker-compose";
```

15
docs/models/operations/apptypedockercompose.md Normal file
View File

@@ -0,0 +1,15 @@
# AppTypeDockerCompose
## Example Usage
```typescript
import { AppTypeDockerCompose } from "dokploy/models/operations";
let value: AppTypeDockerCompose = "docker-compose";
```
## Values
```typescript
"docker-compose"
```

15
docs/models/operations/apptypestack.md Normal file
View File

@@ -0,0 +1,15 @@
# AppTypeStack
## Example Usage
```typescript
import { AppTypeStack } from "dokploy/models/operations";
let value: AppTypeStack = "stack";
```
## Values
```typescript
"stack"
```

17
docs/models/operations/authconfirmemailrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AuthConfirmEmailRequest
## Example Usage
```typescript
import { AuthConfirmEmailRequest } from "dokploy/models/operations";
let value: AuthConfirmEmailRequest = {
confirmationToken: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------- | ------------------- | ------------------- | ------------------- |
| `confirmationToken` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/authcreateadminrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# AuthCreateAdminRequest
## Example Usage
```typescript
import { AuthCreateAdminRequest } from "dokploy/models/operations";
let value: AuthCreateAdminRequest = {
email: "Cruz49@hotmail.com",
password: "LeMKZZnr6bCDRt7",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `email` | *string* | :heavy_check_mark: | N/A |
| `password` | *string* | :heavy_check_mark: | N/A |

21
docs/models/operations/authcreateuserrequest.md Normal file
View File

@@ -0,0 +1,21 @@
# AuthCreateUserRequest
## Example Usage
```typescript
import { AuthCreateUserRequest } from "dokploy/models/operations";
let value: AuthCreateUserRequest = {
password: "gE2NX4q7ofEYUc1",
id: "<id>",
token: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `password` | *string* | :heavy_check_mark: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |
| `token` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/authloginrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# AuthLoginRequest
## Example Usage
```typescript
import { AuthLoginRequest } from "dokploy/models/operations";
let value: AuthLoginRequest = {
email: "Morton_Hodkiewicz@gmail.com",
password: "sXMNet8beVnapnS",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `email` | *string* | :heavy_check_mark: | N/A |
| `password` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/authonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AuthOneRequest
## Example Usage
```typescript
import { AuthOneRequest } from "dokploy/models/operations";
let value: AuthOneRequest = {
id: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/authresetpasswordrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# AuthResetPasswordRequest
## Example Usage
```typescript
import { AuthResetPasswordRequest } from "dokploy/models/operations";
let value: AuthResetPasswordRequest = {
resetPasswordToken: "<value>",
password: "CIXB8RGJr2fxQBu",
};
```
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `resetPasswordToken` | *string* | :heavy_check_mark: | N/A |
| `password` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/authsendresetpasswordemailrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# AuthSendResetPasswordEmailRequest
## Example Usage
```typescript
import { AuthSendResetPasswordEmailRequest } from "dokploy/models/operations";
let value: AuthSendResetPasswordEmailRequest = {
email: "Alexandra_McCullough@hotmail.com",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `email` | *string* | :heavy_check_mark: | N/A |

30
docs/models/operations/authupdaterequest.md Normal file
View File

@@ -0,0 +1,30 @@
# AuthUpdateRequest
## Example Usage
```typescript
import { AuthUpdateRequest } from "dokploy/models/operations";
let value: AuthUpdateRequest = {
email: "Sam56@yahoo.com",
password: "J5mRzNG9iBEmeW3",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `id` | *string* | :heavy_minus_sign: | N/A |
| `email` | *string* | :heavy_check_mark: | N/A |
| `password` | *string* | :heavy_check_mark: | N/A |
| `rol` | [operations.Rol](../../models/operations/rol.md) | :heavy_minus_sign: | N/A |
| `image` | *string* | :heavy_minus_sign: | N/A |
| `secret` | *string* | :heavy_minus_sign: | N/A |
| `token` | *string* | :heavy_minus_sign: | N/A |
| `is2FAEnabled` | *boolean* | :heavy_minus_sign: | N/A |
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
| `resetPasswordToken` | *string* | :heavy_minus_sign: | N/A |
| `resetPasswordExpiresAt` | *string* | :heavy_minus_sign: | N/A |
| `confirmationToken` | *string* | :heavy_minus_sign: | N/A |
| `confirmationExpiresAt` | *string* | :heavy_minus_sign: | N/A |

19
docs/models/operations/authverify2fasetuprequest.md Normal file
View File

@@ -0,0 +1,19 @@
# AuthVerify2FASetupRequest
## Example Usage
```typescript
import { AuthVerify2FASetupRequest } from "dokploy/models/operations";
let value: AuthVerify2FASetupRequest = {
pin: "7573",
secret: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `pin` | *string* | :heavy_check_mark: | N/A |
| `secret` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/authverifylogin2farequest.md Normal file
View File

@@ -0,0 +1,19 @@
# AuthVerifyLogin2FARequest
## Example Usage
```typescript
import { AuthVerifyLogin2FARequest } from "dokploy/models/operations";
let value: AuthVerifyLogin2FARequest = {
pin: "3713",
id: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `pin` | *string* | :heavy_check_mark: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |

30
docs/models/operations/backupcreaterequest.md Normal file
View File

@@ -0,0 +1,30 @@
# BackupCreateRequest
## Example Usage
```typescript
import { BackupCreateRequest } from "dokploy/models/operations";
let value: BackupCreateRequest = {
schedule: "<value>",
prefix: "<value>",
destinationId: "<id>",
database: "<value>",
databaseType: "mysql",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `schedule` | *string* | :heavy_check_mark: | N/A |
| `enabled` | *boolean* | :heavy_minus_sign: | N/A |
| `prefix` | *string* | :heavy_check_mark: | N/A |
| `destinationId` | *string* | :heavy_check_mark: | N/A |
| `database` | *string* | :heavy_check_mark: | N/A |
| `mariadbId` | *string* | :heavy_minus_sign: | N/A |
| `mysqlId` | *string* | :heavy_minus_sign: | N/A |
| `postgresId` | *string* | :heavy_minus_sign: | N/A |
| `mongoId` | *string* | :heavy_minus_sign: | N/A |
| `databaseType` | [operations.DatabaseType](../../models/operations/databasetype.md) | :heavy_check_mark: | N/A |

17
docs/models/operations/backupmanualbackupmariadbrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupManualBackupMariadbRequest
## Example Usage
```typescript
import { BackupManualBackupMariadbRequest } from "dokploy/models/operations";
let value: BackupManualBackupMariadbRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/backupmanualbackupmongorequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupManualBackupMongoRequest
## Example Usage
```typescript
import { BackupManualBackupMongoRequest } from "dokploy/models/operations";
let value: BackupManualBackupMongoRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/backupmanualbackupmysqlrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupManualBackupMySqlRequest
## Example Usage
```typescript
import { BackupManualBackupMySqlRequest } from "dokploy/models/operations";
let value: BackupManualBackupMySqlRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/backupmanualbackuppostgresrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupManualBackupPostgresRequest
## Example Usage
```typescript
import { BackupManualBackupPostgresRequest } from "dokploy/models/operations";
let value: BackupManualBackupPostgresRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/backuponerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupOneRequest
## Example Usage
```typescript
import { BackupOneRequest } from "dokploy/models/operations";
let value: BackupOneRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/backupremoverequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BackupRemoveRequest
## Example Usage
```typescript
import { BackupRemoveRequest } from "dokploy/models/operations";
let value: BackupRemoveRequest = {
backupId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `backupId` | *string* | :heavy_check_mark: | N/A |

26
docs/models/operations/backupupdaterequest.md Normal file
View File

@@ -0,0 +1,26 @@
# BackupUpdateRequest
## Example Usage
```typescript
import { BackupUpdateRequest } from "dokploy/models/operations";
let value: BackupUpdateRequest = {
schedule: "<value>",
prefix: "<value>",
backupId: "<id>",
destinationId: "<id>",
database: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `schedule` | *string* | :heavy_check_mark: | N/A |
| `enabled` | *boolean* | :heavy_minus_sign: | N/A |
| `prefix` | *string* | :heavy_check_mark: | N/A |
| `backupId` | *string* | :heavy_check_mark: | N/A |
| `destinationId` | *string* | :heavy_check_mark: | N/A |
| `database` | *string* | :heavy_check_mark: | N/A |

24
docs/models/operations/bitbucketcreaterequest.md Normal file
View File

@@ -0,0 +1,24 @@
# BitbucketCreateRequest
## Example Usage
```typescript
import { BitbucketCreateRequest } from "dokploy/models/operations";
let value: BitbucketCreateRequest = {
authId: "<id>",
name: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `bitbucketId` | *string* | :heavy_minus_sign: | N/A |
| `bitbucketUsername` | *string* | :heavy_minus_sign: | N/A |
| `appPassword` | *string* | :heavy_minus_sign: | N/A |
| `bitbucketWorkspaceName` | *string* | :heavy_minus_sign: | N/A |
| `gitProviderId` | *string* | :heavy_minus_sign: | N/A |
| `authId` | *string* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |

20
docs/models/operations/bitbucketgetbitbucketbranchesrequest.md Normal file
View File

@@ -0,0 +1,20 @@
# BitbucketGetBitbucketBranchesRequest
## Example Usage
```typescript
import { BitbucketGetBitbucketBranchesRequest } from "dokploy/models/operations";
let value: BitbucketGetBitbucketBranchesRequest = {
owner: "<value>",
repo: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `owner` | *string* | :heavy_check_mark: | N/A |
| `repo` | *string* | :heavy_check_mark: | N/A |
| `bitbucketId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/bitbucketgetbitbucketrepositoriesrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BitbucketGetBitbucketRepositoriesRequest
## Example Usage
```typescript
import { BitbucketGetBitbucketRepositoriesRequest } from "dokploy/models/operations";
let value: BitbucketGetBitbucketRepositoriesRequest = {
bitbucketId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `bitbucketId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/bitbucketonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# BitbucketOneRequest
## Example Usage
```typescript
import { BitbucketOneRequest } from "dokploy/models/operations";
let value: BitbucketOneRequest = {
bitbucketId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `bitbucketId` | *string* | :heavy_check_mark: | N/A |

19
docs/models/operations/bitbuckettestconnectionrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# BitbucketTestConnectionRequest
## Example Usage
```typescript
import { BitbucketTestConnectionRequest } from "dokploy/models/operations";
let value: BitbucketTestConnectionRequest = {
bitbucketId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------- | ------------------- | ------------------- | ------------------- |
| `bitbucketId` | *string* | :heavy_check_mark: | N/A |
| `bitbucketUsername` | *string* | :heavy_minus_sign: | N/A |
| `workspaceName` | *string* | :heavy_minus_sign: | N/A |

25
docs/models/operations/bitbucketupdaterequest.md Normal file
View File

@@ -0,0 +1,25 @@
# BitbucketUpdateRequest
## Example Usage
```typescript
import { BitbucketUpdateRequest } from "dokploy/models/operations";
let value: BitbucketUpdateRequest = {
bitbucketId: "<id>",
gitProviderId: "<id>",
name: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `bitbucketId` | *string* | :heavy_check_mark: | N/A |
| `bitbucketUsername` | *string* | :heavy_minus_sign: | N/A |
| `appPassword` | *string* | :heavy_minus_sign: | N/A |
| `bitbucketWorkspaceName` | *string* | :heavy_minus_sign: | N/A |
| `gitProviderId` | *string* | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `adminId` | *string* | :heavy_minus_sign: | N/A |

26
docs/models/operations/certificatescreaterequest.md Normal file
View File

@@ -0,0 +1,26 @@
# CertificatesCreateRequest
## Example Usage
```typescript
import { CertificatesCreateRequest } from "dokploy/models/operations";
let value: CertificatesCreateRequest = {
name: "<value>",
certificateData: "<value>",
privateKey: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `certificateId` | *string* | :heavy_minus_sign: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `certificateData` | *string* | :heavy_check_mark: | N/A |
| `privateKey` | *string* | :heavy_check_mark: | N/A |
| `certificatePath` | *string* | :heavy_minus_sign: | N/A |
| `autoRenew` | *boolean* | :heavy_minus_sign: | N/A |
| `adminId` | *string* | :heavy_minus_sign: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/certificatesonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# CertificatesOneRequest
## Example Usage
```typescript
import { CertificatesOneRequest } from "dokploy/models/operations";
let value: CertificatesOneRequest = {
certificateId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `certificateId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/certificatesremoverequest.md Normal file
View File

@@ -0,0 +1,17 @@
# CertificatesRemoveRequest
## Example Usage
```typescript
import { CertificatesRemoveRequest } from "dokploy/models/operations";
let value: CertificatesRemoveRequest = {
certificateId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `certificateId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/clusterremoveworkerrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ClusterRemoveWorkerRequest
## Example Usage
```typescript
import { ClusterRemoveWorkerRequest } from "dokploy/models/operations";
let value: ClusterRemoveWorkerRequest = {
nodeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `nodeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composecleanqueuesrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeCleanQueuesRequest
## Example Usage
```typescript
import { ComposeCleanQueuesRequest } from "dokploy/models/operations";
let value: ComposeCleanQueuesRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/composecreatecomposetype.md Normal file
View File

@@ -0,0 +1,15 @@
# ComposeCreateComposeType
## Example Usage
```typescript
import { ComposeCreateComposeType } from "dokploy/models/operations";
let value: ComposeCreateComposeType = "docker-compose";
```
## Values
```typescript
"docker-compose" | "stack"
```

23
docs/models/operations/composecreaterequest.md Normal file
View File

@@ -0,0 +1,23 @@
# ComposeCreateRequest
## Example Usage
```typescript
import { ComposeCreateRequest } from "dokploy/models/operations";
let value: ComposeCreateRequest = {
name: "<value>",
projectId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `description` | *string* | :heavy_minus_sign: | N/A |
| `projectId` | *string* | :heavy_check_mark: | N/A |
| `composeType` | [operations.ComposeCreateComposeType](../../models/operations/composecreatecomposetype.md) | :heavy_minus_sign: | N/A |
| `appName` | *string* | :heavy_minus_sign: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/composedeleterequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeDeleteRequest
## Example Usage
```typescript
import { ComposeDeleteRequest } from "dokploy/models/operations";
let value: ComposeDeleteRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composedeployrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeDeployRequest
## Example Usage
```typescript
import { ComposeDeployRequest } from "dokploy/models/operations";
let value: ComposeDeployRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

20
docs/models/operations/composedeploytemplaterequest.md Normal file
View File

@@ -0,0 +1,20 @@
# ComposeDeployTemplateRequest
## Example Usage
```typescript
import { ComposeDeployTemplateRequest } from "dokploy/models/operations";
let value: ComposeDeployTemplateRequest = {
projectId: "<id>",
id: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `projectId` | *string* | :heavy_check_mark: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/composefetchsourcetyperequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeFetchSourceTypeRequest
## Example Usage
```typescript
import { ComposeFetchSourceTypeRequest } from "dokploy/models/operations";
let value: ComposeFetchSourceTypeRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composegetconvertedcomposerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeGetConvertedComposeRequest
## Example Usage
```typescript
import { ComposeGetConvertedComposeRequest } from "dokploy/models/operations";
let value: ComposeGetConvertedComposeRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composegetdefaultcommandrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeGetDefaultCommandRequest
## Example Usage
```typescript
import { ComposeGetDefaultCommandRequest } from "dokploy/models/operations";
let value: ComposeGetDefaultCommandRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composeonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeOneRequest
## Example Usage
```typescript
import { ComposeOneRequest } from "dokploy/models/operations";
let value: ComposeOneRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

18
docs/models/operations/composerandomizecomposerequest.md Normal file
View File

@@ -0,0 +1,18 @@
# ComposeRandomizeComposeRequest
## Example Usage
```typescript
import { ComposeRandomizeComposeRequest } from "dokploy/models/operations";
let value: ComposeRandomizeComposeRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |
| `suffix` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/composeredeployrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeRedeployRequest
## Example Usage
```typescript
import { ComposeRedeployRequest } from "dokploy/models/operations";
let value: ComposeRedeployRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/composerefreshtokenrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeRefreshTokenRequest
## Example Usage
```typescript
import { ComposeRefreshTokenRequest } from "dokploy/models/operations";
let value: ComposeRefreshTokenRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/composestatus.md Normal file
View File

@@ -0,0 +1,15 @@
# ComposeStatus
## Example Usage
```typescript
import { ComposeStatus } from "dokploy/models/operations";
let value: ComposeStatus = "idle";
```
## Values
```typescript
"idle" | "running" | "done" | "error"
```

17
docs/models/operations/composestoprequest.md Normal file
View File

@@ -0,0 +1,17 @@
# ComposeStopRequest
## Example Usage
```typescript
import { ComposeStopRequest } from "dokploy/models/operations";
let value: ComposeStopRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/composeupdatecomposetype.md Normal file
View File

@@ -0,0 +1,15 @@
# ComposeUpdateComposeType
## Example Usage
```typescript
import { ComposeUpdateComposeType } from "dokploy/models/operations";
let value: ComposeUpdateComposeType = "stack";
```
## Values
```typescript
"docker-compose" | "stack"
```

50
docs/models/operations/composeupdaterequest.md Normal file
View File

@@ -0,0 +1,50 @@
# 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 |

15
docs/models/operations/composeupdatesourcetype.md Normal file
View File

@@ -0,0 +1,15 @@
# ComposeUpdateSourceType
## Example Usage
```typescript
import { ComposeUpdateSourceType } from "dokploy/models/operations";
let value: ComposeUpdateSourceType = "git";
```
## Values
```typescript
"git" | "github" | "gitlab" | "bitbucket" | "raw"
```

15
docs/models/operations/databasetype.md Normal file
View File

@@ -0,0 +1,15 @@
# DatabaseType
## Example Usage
```typescript
import { DatabaseType } from "dokploy/models/operations";
let value: DatabaseType = "postgres";
```
## Values
```typescript
"postgres" | "mariadb" | "mysql" | "mongo"
```

17
docs/models/operations/deploymentallbycomposerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DeploymentAllByComposeRequest
## Example Usage
```typescript
import { DeploymentAllByComposeRequest } from "dokploy/models/operations";
let value: DeploymentAllByComposeRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/deploymentallbyserverrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DeploymentAllByServerRequest
## Example Usage
```typescript
import { DeploymentAllByServerRequest } from "dokploy/models/operations";
let value: DeploymentAllByServerRequest = {
serverId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `serverId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/deploymentallrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DeploymentAllRequest
## Example Usage
```typescript
import { DeploymentAllRequest } from "dokploy/models/operations";
let value: DeploymentAllRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

28
docs/models/operations/destinationcreaterequest.md Normal file
View File

@@ -0,0 +1,28 @@
# DestinationCreateRequest
## Example Usage
```typescript
import { DestinationCreateRequest } from "dokploy/models/operations";
let value: DestinationCreateRequest = {
name: "<value>",
accessKey: "<value>",
bucket: "<value>",
region: "<value>",
endpoint: "<value>",
secretAccessKey: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `accessKey` | *string* | :heavy_check_mark: | N/A |
| `bucket` | *string* | :heavy_check_mark: | N/A |
| `region` | *string* | :heavy_check_mark: | N/A |
| `endpoint` | *string* | :heavy_check_mark: | N/A |
| `secretAccessKey` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/destinationonerequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DestinationOneRequest
## Example Usage
```typescript
import { DestinationOneRequest } from "dokploy/models/operations";
let value: DestinationOneRequest = {
destinationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `destinationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/destinationremoverequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DestinationRemoveRequest
## Example Usage
```typescript
import { DestinationRemoveRequest } from "dokploy/models/operations";
let value: DestinationRemoveRequest = {
destinationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `destinationId` | *string* | :heavy_check_mark: | N/A |

28
docs/models/operations/destinationtestconnectionrequest.md Normal file
View File

@@ -0,0 +1,28 @@
# DestinationTestConnectionRequest
## Example Usage
```typescript
import { DestinationTestConnectionRequest } from "dokploy/models/operations";
let value: DestinationTestConnectionRequest = {
name: "<value>",
accessKey: "<value>",
bucket: "<value>",
region: "<value>",
endpoint: "<value>",
secretAccessKey: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `accessKey` | *string* | :heavy_check_mark: | N/A |
| `bucket` | *string* | :heavy_check_mark: | N/A |
| `region` | *string* | :heavy_check_mark: | N/A |
| `endpoint` | *string* | :heavy_check_mark: | N/A |
| `secretAccessKey` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

30
docs/models/operations/destinationupdaterequest.md Normal file
View File

@@ -0,0 +1,30 @@
# DestinationUpdateRequest
## Example Usage
```typescript
import { DestinationUpdateRequest } from "dokploy/models/operations";
let value: DestinationUpdateRequest = {
name: "<value>",
accessKey: "<value>",
bucket: "<value>",
region: "<value>",
endpoint: "<value>",
secretAccessKey: "<value>",
destinationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `accessKey` | *string* | :heavy_check_mark: | N/A |
| `bucket` | *string* | :heavy_check_mark: | N/A |
| `region` | *string* | :heavy_check_mark: | N/A |
| `endpoint` | *string* | :heavy_check_mark: | N/A |
| `secretAccessKey` | *string* | :heavy_check_mark: | N/A |
| `destinationId` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

18
docs/models/operations/dockergetconfigrequest.md Normal file
View File

@@ -0,0 +1,18 @@
# DockerGetConfigRequest
## Example Usage
```typescript
import { DockerGetConfigRequest } from "dokploy/models/operations";
let value: DockerGetConfigRequest = {
containerId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `containerId` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

18
docs/models/operations/dockergetcontainersbyapplabelrequest.md Normal file
View File

@@ -0,0 +1,18 @@
# DockerGetContainersByAppLabelRequest
## Example Usage
```typescript
import { DockerGetContainersByAppLabelRequest } from "dokploy/models/operations";
let value: DockerGetContainersByAppLabelRequest = {
appName: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `appName` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

19
docs/models/operations/dockergetcontainersbyappnamematchrequest.md Normal file
View File

@@ -0,0 +1,19 @@
# DockerGetContainersByAppNameMatchRequest
## Example Usage
```typescript
import { DockerGetContainersByAppNameMatchRequest } from "dokploy/models/operations";
let value: DockerGetContainersByAppNameMatchRequest = {
appName: "<value>",
};
```
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `appType` | *operations.AppType* | :heavy_minus_sign: | N/A |
| `appName` | *string* | :heavy_check_mark: | N/A |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

15
docs/models/operations/dockergetcontainersrequest.md Normal file
View File

@@ -0,0 +1,15 @@
# DockerGetContainersRequest
## Example Usage
```typescript
import { DockerGetContainersRequest } from "dokploy/models/operations";
let value: DockerGetContainersRequest = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `serverId` | *string* | :heavy_minus_sign: | N/A |

17
docs/models/operations/dockerrestartcontainerrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DockerRestartContainerRequest
## Example Usage
```typescript
import { DockerRestartContainerRequest } from "dokploy/models/operations";
let value: DockerRestartContainerRequest = {
containerId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `containerId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/domainbyapplicationidrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DomainByApplicationIdRequest
## Example Usage
```typescript
import { DomainByApplicationIdRequest } from "dokploy/models/operations";
let value: DomainByApplicationIdRequest = {
applicationId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `applicationId` | *string* | :heavy_check_mark: | N/A |

17
docs/models/operations/domainbycomposeidrequest.md Normal file
View File

@@ -0,0 +1,17 @@
# DomainByComposeIdRequest
## Example Usage
```typescript
import { DomainByComposeIdRequest } from "dokploy/models/operations";
let value: DomainByComposeIdRequest = {
composeId: "<id>",
};
```
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `composeId` | *string* | :heavy_check_mark: | N/A |

15
docs/models/operations/domaincreatecertificatetype.md Normal file
View File

@@ -0,0 +1,15 @@
# DomainCreateCertificateType
## Example Usage
```typescript
import { DomainCreateCertificateType } from "dokploy/models/operations";
let value: DomainCreateCertificateType = "none";
```
## Values
```typescript
"letsencrypt" | "none"
```

15
docs/models/operations/domaincreatedomaintype.md Normal file
View File

@@ -0,0 +1,15 @@
# DomainCreateDomainType
## Example Usage
```typescript
import { DomainCreateDomainType } from "dokploy/models/operations";
let value: DomainCreateDomainType = "compose";
```
## Values
```typescript
"compose" | "application"
```

Some files were not shown because too many files have changed in this diff Show More