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

30
.devcontainer/README.md Normal file
View File

@@ -0,0 +1,30 @@
> **Remember to shutdown a GitHub Codespace when it is not in use!**
# Dev Containers Quick Start
The default location for usage snippets is the `samples` directory.
## Running a Usage Sample
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
```
ts-node root.ts
```
## Generating Additional Usage Samples
The speakeasy CLI allows you to generate more usage snippets. Here's how:
- To generate a sample for a specific operation by providing an operation ID, use:
```
speakeasy generate usage -s .speakeasy/out.openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
```
- To generate samples for an entire namespace (like a tag or group name), use:
```
speakeasy generate usage -s .speakeasy/out.openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
```

45
.devcontainer/devcontainer.json Normal file
View File

@@ -0,0 +1,45 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
{
"name": "TypeScript",
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
"customizations": {
"vscode": {
"extensions": [
"ms-vscode.vscode-typescript-tslint-plugin",
"esbenp.prettier-vscode",
"github.vscode-pull-request-github"
],
"settings": {
"files.eol": "\n",
"editor.formatOnSave": true,
"typescript.tsc.autoDetect": "on",
"typescript.updateImportsOnFileMove.enabled": "always",
"typescript.preferences.importModuleSpecifier": "relative",
"[typescript]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
},
"[typescriptreact]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
}
}
},
"codespaces": {
"openFiles": [
".devcontainer/README.md"
]
}
}
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}

30
.devcontainer/setup.sh Normal file
View File

@@ -0,0 +1,30 @@
#!/bin/bash
# Install the speakeasy CLI
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
# Setup samples directory
rmdir samples || true
mkdir samples
npm install --ignore-scripts
npm install -g ts-node --ignore-scripts
npm link
npm link dokploy
TS_CONFIG_CONTENT=$(cat <<EOL
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"openapi": ["../src/index"],
"openapi/*": ["../src/*"]
}
},
"include": ["./**/*.ts"]
}
EOL
)
echo "$TS_CONFIG_CONTENT" > samples/tsconfig.json
# Generate starter usage sample with speakeasy
speakeasy generate usage -s .speakeasy/out.openapi.yaml -l typescript -o samples/root.ts

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.ts linguist-generated=false

30
.gitignore vendored Normal file
View File

@@ -0,0 +1,30 @@
/models
/models/errors
/types
/node_modules
/examples/node_modules
/lib
/sdk
/funcs
/react-query
/mcp-server
/hooks
/index.*
/core.*
/bin
/cjs
/esm
/dist
/.tsbuildinfo
/.eslintcache
/.tshy
/.tshy-*
/__tests__
.DS_Store
**/.speakeasy/temp/
**/.speakeasy/logs/
.DS_Store
/.speakeasy/reports
.env
.env.local
.env.*.local

15
.npmignore Normal file
View File

@@ -0,0 +1,15 @@
**/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts
!/**/*.js
!/**/*.mjs
!/**/*.json
!/**/*.map
/eslint.config.mjs
/cjs
/.tshy
/.tshy-*
/__tests__

2794
.speakeasy/gen.lock Normal file
View File

File diff suppressed because it is too large Load Diff

69
.speakeasy/gen.yaml Normal file
View File

@@ -0,0 +1,69 @@
configVersion: 2.0.0
generation:
devContainers:
enabled: true
schemaPath: .speakeasy/out.openapi.yaml
sdkClassName: Dokploy
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
nameResolutionFeb2025: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: true
sharedErrorComponentsApr2025: true
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
hoistGlobalSecurity: true
inferSSEOverload: true
sdkHooksConfigAccess: true
tests:
generateTests: false
generateNewTests: true
skipResponseBodyAssertions: false
typescript:
version: 0.1.2
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
author: Speakeasy
baseErrorName: DokployError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: false
defaultErrorName: DokployDefaultError
enableCustomCodeRegions: false
enableMCPServer: false
enableReactQuery: false
enumFormat: union
envVarPrefix: DOKPLOY
flattenGlobalSecurity: true
flatteningOrder: parameters-first
generateExamples: true
imports:
option: openapi
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models
webhooks: models/webhooks
inputModelSuffix: input
jsonpath: rfc9535
maxMethodParams: 0
methodArguments: infer-optional-args
modelPropertyCasing: camel
moduleFormat: dual
outputModelSuffix: output
packageName: dokploy
responseFormat: flat
sseFlatResponse: true
templateVersion: v2
usageSDKInitImports: []
useIndexModules: true

8526
.speakeasy/out.openapi.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

2472
.speakeasy/speakeasy-modifications-overlay.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

39
.speakeasy/workflow.lock Normal file
View File

@@ -0,0 +1,39 @@
speakeasyVersion: 1.630.0
sources:
Dokploy API:
sourceNamespace: dokploy-api
sourceRevisionDigest: sha256:7ac5274bd5509dd1006ed9ace9e17bce4c557b8e89d82fa048dfc86226fa95b5
sourceBlobDigest: sha256:8c1ea93c1f069744eb7f61c88e56dc9762a1d46f01af0945c14e88c895cebc5f
tags:
- latest
- 1.0.0
targets:
dokploy:
source: Dokploy API
sourceNamespace: dokploy-api
sourceRevisionDigest: sha256:7ac5274bd5509dd1006ed9ace9e17bce4c557b8e89d82fa048dfc86226fa95b5
sourceBlobDigest: sha256:8c1ea93c1f069744eb7f61c88e56dc9762a1d46f01af0945c14e88c895cebc5f
codeSamplesNamespace: dokploy-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:c4530b7e7d63959fa0f5c119c30d6eef3d93f8512ff3e3182f50827b59d9e883
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
Dokploy API:
inputs:
- location: https://raw.githubusercontent.com/Dokploy/website/refs/heads/main/apps/docs/api.json
overlays:
- location: .speakeasy/speakeasy-modifications-overlay.yaml
output: .speakeasy/out.openapi.yaml
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/dokploy-api
targets:
dokploy:
target: typescript
source: Dokploy API
codeSamples:
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/dokploy-api-typescript-code-samples
labelOverride:
fixedValue: Typescript (SDK)
blocking: false

21
.speakeasy/workflow.yaml Normal file
View File

@@ -0,0 +1,21 @@
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
Dokploy API:
inputs:
- location: https://raw.githubusercontent.com/Dokploy/website/refs/heads/main/apps/docs/api.json
overlays:
- location: .speakeasy/speakeasy-modifications-overlay.yaml
output: .speakeasy/out.openapi.yaml
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/dokploy-api
targets:
dokploy:
target: typescript
source: Dokploy API
codeSamples:
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/dokploy-api-typescript-code-samples
labelOverride:
fixedValue: Typescript (SDK)
blocking: false

26
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,26 @@
# Contributing to This Repository
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
## How to Report Issues
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
## Issue Triage and Upstream Fixes
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
## Contact
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
Thank you for your understanding and cooperation!
The Maintainers

87
FUNCTIONS.md Normal file
View File

@@ -0,0 +1,87 @@
# Standalone Functions
> [!NOTE]
> This section is useful if you are using a bundler and targetting browsers and
> runtimes where the size of an application affects performance and load times.
Every method in this SDK is also available as a standalone function. This
alternative API is suitable when targetting the browser or serverless runtimes
and using a bundler to build your application since all unused functionality
will be tree-shaken away. This includes code for unused methods, Zod schemas,
encoding helpers and response handlers. The result is dramatically smaller
impact on the application's final bundle size which grows very slowly as you use
more and more functionality from this SDK.
Calling methods through the main SDK class remains a valid and generally more
more ergonomic option. Standalone functions represent an optimisation for a
specific category of applications.
## Example
```typescript
import { DokployCore } from "dokploy/core.js";
import { adminGetOne } from "dokploy/funcs/adminGetOne.js";
// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});
async function run() {
const res = await adminGetOne(dokploy);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("adminGetOne failed:", res.error);
}
}
run();
```
## Result types
Standalone functions differ from SDK methods in that they return a
`Result<Value, Error>` type to capture _known errors_ and document them using
the type system. By avoiding throwing errors, application code maintains clear
control flow and error-handling become part of the regular flow of application
code.
> We use the term "known errors" because standalone functions, and JavaScript
> code in general, can still throw unexpected errors such as `TypeError`s,
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
> something this SDK addresses in the future. Nevertheless, there is still a lot
> of benefit from capturing most errors and turning them into values.
The second reason for this style of programming is because these functions will
typically be used in front-end applications where exception throwing is
sometimes discouraged or considered unidiomatic. React and similar ecosystems
and libraries tend to promote this style of programming so that components
render useful content under all states (loading, success, error and so on).
The general pattern when calling standalone functions looks like this:
```typescript
import { Core } from "<sdk-package-name>";
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
const client = new Core();
async function run() {
const result = await fetchSomething(client, { id: "123" });
if (!result.ok) {
// You can throw the error or handle it. It's your choice now.
throw result.error;
}
console.log(result.value);
}
run();
```
Notably, `result.error` above will have an explicit type compared to a try-catch
variation where the error in the catch block can only be of type `unknown` (or
`any` depending on your TypeScript settings).

1054
README.md Normal file
View File

File diff suppressed because it is too large Load Diff

48
RUNTIMES.md Normal file
View File

@@ -0,0 +1,48 @@
# Supported JavaScript runtimes
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
Runtime environments that are explicitly supported are:
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
- Node.js active and maintenance LTS releases
- Currently, this is v18 and v20
- Bun v1 and above
- Deno v1.39
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
## Recommended TypeScript compiler options
The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
```jsonc
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
}
}
```
While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.

18
USAGE.md Normal file
View File

@@ -0,0 +1,18 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { Dokploy } from "dokploy";
const dokploy = new Dokploy({
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});
async function run() {
const result = await dokploy.admin.getOne();
console.log(result);
}
run();
```
<!-- End SDK Example Usage [usage] -->

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"
```

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