# Settings (*settings*) ## Overview ### Available Operations * [reloadServer](#reloadserver) * [reloadTraefik](#reloadtraefik) * [toggleDashboard](#toggledashboard) * [cleanUnusedImages](#cleanunusedimages) * [cleanUnusedVolumes](#cleanunusedvolumes) * [cleanStoppedContainers](#cleanstoppedcontainers) * [cleanDockerBuilder](#cleandockerbuilder) * [cleanDockerPrune](#cleandockerprune) * [cleanAll](#cleanall) * [cleanMonitoring](#cleanmonitoring) * [saveSshPrivateKey](#savesshprivatekey) * [assignDomainServer](#assigndomainserver) * [cleanSshPrivateKey](#cleansshprivatekey) * [updateDockerCleanup](#updatedockercleanup) * [readTraefikConfig](#readtraefikconfig) * [updateTraefikConfig](#updatetraefikconfig) * [readWebServerTraefikConfig](#readwebservertraefikconfig) * [updateWebServerTraefikConfig](#updatewebservertraefikconfig) * [readMiddlewareTraefikConfig](#readmiddlewaretraefikconfig) * [updateMiddlewareTraefikConfig](#updatemiddlewaretraefikconfig) * [checkAndUpdateImage](#checkandupdateimage) * [updateServer](#updateserver) * [getDokployVersion](#getdokployversion) * [readDirectories](#readdirectories) * [updateTraefikFile](#updatetraefikfile) * [readTraefikFile](#readtraefikfile) * [getIp](#getip) * [getOpenApiDocument](#getopenapidocument) * [readTraefikEnv](#readtraefikenv) * [writeTraefikEnv](#writetraefikenv) * [haveTraefikDashboardPortEnabled](#havetraefikdashboardportenabled) * [readStats](#readstats) * [getLogRotateStatus](#getlogrotatestatus) * [toggleLogRotate](#togglelogrotate) * [haveActivateRequests](#haveactivaterequests) * [toggleRequests](#togglerequests) * [isCloud](#iscloud) * [health](#health) ## reloadServer ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.reloadServer(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReloadServer } from "dokploy/funcs/settingsReloadServer.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 settingsReloadServer(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReloadServer failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## reloadTraefik ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.reloadTraefik(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReloadTraefik } from "dokploy/funcs/settingsReloadTraefik.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 settingsReloadTraefik(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReloadTraefik failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsReloadTraefikRequest](../../models/operations/settingsreloadtraefikrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## toggleDashboard ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.toggleDashboard({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsToggleDashboard } from "dokploy/funcs/settingsToggleDashboard.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 settingsToggleDashboard(dokploy, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsToggleDashboard failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsToggleDashboardRequest](../../models/operations/settingstoggledashboardrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanUnusedImages ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanUnusedImages(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanUnusedImages } from "dokploy/funcs/settingsCleanUnusedImages.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 settingsCleanUnusedImages(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanUnusedImages failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanUnusedImagesRequest](../../models/operations/settingscleanunusedimagesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanUnusedVolumes ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanUnusedVolumes(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanUnusedVolumes } from "dokploy/funcs/settingsCleanUnusedVolumes.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 settingsCleanUnusedVolumes(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanUnusedVolumes failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanUnusedVolumesRequest](../../models/operations/settingscleanunusedvolumesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanStoppedContainers ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanStoppedContainers(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanStoppedContainers } from "dokploy/funcs/settingsCleanStoppedContainers.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 settingsCleanStoppedContainers(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanStoppedContainers failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanStoppedContainersRequest](../../models/operations/settingscleanstoppedcontainersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanDockerBuilder ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanDockerBuilder(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanDockerBuilder } from "dokploy/funcs/settingsCleanDockerBuilder.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 settingsCleanDockerBuilder(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanDockerBuilder failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanDockerBuilderRequest](../../models/operations/settingscleandockerbuilderrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanDockerPrune ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanDockerPrune(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanDockerPrune } from "dokploy/funcs/settingsCleanDockerPrune.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 settingsCleanDockerPrune(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanDockerPrune failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanDockerPruneRequest](../../models/operations/settingscleandockerprunerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanAll ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanAll(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanAll } from "dokploy/funcs/settingsCleanAll.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 settingsCleanAll(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanAll failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsCleanAllRequest](../../models/operations/settingscleanallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanMonitoring ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanMonitoring(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanMonitoring } from "dokploy/funcs/settingsCleanMonitoring.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 settingsCleanMonitoring(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanMonitoring failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## saveSshPrivateKey ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.saveSshPrivateKey({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsSaveSshPrivateKey } from "dokploy/funcs/settingsSaveSshPrivateKey.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 settingsSaveSshPrivateKey(dokploy, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsSaveSshPrivateKey failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsSaveSSHPrivateKeyRequest](../../models/operations/settingssavesshprivatekeyrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## assignDomainServer ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.assignDomainServer({ host: "pure-alb.biz", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsAssignDomainServer } from "dokploy/funcs/settingsAssignDomainServer.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 settingsAssignDomainServer(dokploy, { host: "pure-alb.biz", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsAssignDomainServer failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsAssignDomainServerRequest](../../models/operations/settingsassigndomainserverrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## cleanSshPrivateKey ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.cleanSshPrivateKey(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCleanSshPrivateKey } from "dokploy/funcs/settingsCleanSshPrivateKey.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 settingsCleanSshPrivateKey(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCleanSshPrivateKey failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateDockerCleanup ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateDockerCleanup({ enableDockerCleanup: true, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateDockerCleanup } from "dokploy/funcs/settingsUpdateDockerCleanup.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 settingsUpdateDockerCleanup(dokploy, { enableDockerCleanup: true, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateDockerCleanup failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsUpdateDockerCleanupRequest](../../models/operations/settingsupdatedockercleanuprequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readTraefikConfig(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadTraefikConfig } from "dokploy/funcs/settingsReadTraefikConfig.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 settingsReadTraefikConfig(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateTraefikConfig({ traefikConfig: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateTraefikConfig } from "dokploy/funcs/settingsUpdateTraefikConfig.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 settingsUpdateTraefikConfig(dokploy, { traefikConfig: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsUpdateTraefikConfigRequest](../../models/operations/settingsupdatetraefikconfigrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readWebServerTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readWebServerTraefikConfig(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadWebServerTraefikConfig } from "dokploy/funcs/settingsReadWebServerTraefikConfig.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 settingsReadWebServerTraefikConfig(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadWebServerTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateWebServerTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateWebServerTraefikConfig({ traefikConfig: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateWebServerTraefikConfig } from "dokploy/funcs/settingsUpdateWebServerTraefikConfig.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 settingsUpdateWebServerTraefikConfig(dokploy, { traefikConfig: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateWebServerTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsUpdateWebServerTraefikConfigRequest](../../models/operations/settingsupdatewebservertraefikconfigrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readMiddlewareTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readMiddlewareTraefikConfig(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadMiddlewareTraefikConfig } from "dokploy/funcs/settingsReadMiddlewareTraefikConfig.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 settingsReadMiddlewareTraefikConfig(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadMiddlewareTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateMiddlewareTraefikConfig ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateMiddlewareTraefikConfig({ traefikConfig: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateMiddlewareTraefikConfig } from "dokploy/funcs/settingsUpdateMiddlewareTraefikConfig.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 settingsUpdateMiddlewareTraefikConfig(dokploy, { traefikConfig: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateMiddlewareTraefikConfig failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsUpdateMiddlewareTraefikConfigRequest](../../models/operations/settingsupdatemiddlewaretraefikconfigrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## checkAndUpdateImage ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.checkAndUpdateImage(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsCheckAndUpdateImage } from "dokploy/funcs/settingsCheckAndUpdateImage.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 settingsCheckAndUpdateImage(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsCheckAndUpdateImage failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateServer ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateServer(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateServer } from "dokploy/funcs/settingsUpdateServer.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 settingsUpdateServer(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateServer failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getDokployVersion ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.getDokployVersion(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsGetDokployVersion } from "dokploy/funcs/settingsGetDokployVersion.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 settingsGetDokployVersion(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsGetDokployVersion failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readDirectories ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readDirectories(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadDirectories } from "dokploy/funcs/settingsReadDirectories.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 settingsReadDirectories(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadDirectories failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsReadDirectoriesRequest](../../models/operations/settingsreaddirectoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## updateTraefikFile ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.updateTraefikFile({ path: "/var/tmp", traefikConfig: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsUpdateTraefikFile } from "dokploy/funcs/settingsUpdateTraefikFile.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 settingsUpdateTraefikFile(dokploy, { path: "/var/tmp", traefikConfig: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsUpdateTraefikFile failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsUpdateTraefikFileRequest](../../models/operations/settingsupdatetraefikfilerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readTraefikFile ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readTraefikFile({ path: "/mnt", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadTraefikFile } from "dokploy/funcs/settingsReadTraefikFile.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 settingsReadTraefikFile(dokploy, { path: "/mnt", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadTraefikFile failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsReadTraefikFileRequest](../../models/operations/settingsreadtraefikfilerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getIp ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.getIp(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsGetIp } from "dokploy/funcs/settingsGetIp.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 settingsGetIp(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsGetIp failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getOpenApiDocument ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.getOpenApiDocument(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsGetOpenApiDocument } from "dokploy/funcs/settingsGetOpenApiDocument.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 settingsGetOpenApiDocument(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsGetOpenApiDocument failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readTraefikEnv ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readTraefikEnv(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadTraefikEnv } from "dokploy/funcs/settingsReadTraefikEnv.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 settingsReadTraefikEnv(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadTraefikEnv failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsReadTraefikEnvRequest](../../models/operations/settingsreadtraefikenvrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## writeTraefikEnv ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.writeTraefikEnv({ env: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsWriteTraefikEnv } from "dokploy/funcs/settingsWriteTraefikEnv.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 settingsWriteTraefikEnv(dokploy, { env: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsWriteTraefikEnv failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsWriteTraefikEnvRequest](../../models/operations/settingswritetraefikenvrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## haveTraefikDashboardPortEnabled ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.haveTraefikDashboardPortEnabled(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsHaveTraefikDashboardPortEnabled } from "dokploy/funcs/settingsHaveTraefikDashboardPortEnabled.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 settingsHaveTraefikDashboardPortEnabled(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsHaveTraefikDashboardPortEnabled failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsHaveTraefikDashboardPortEnabledRequest](../../models/operations/settingshavetraefikdashboardportenabledrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## readStats ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.readStats(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsReadStats } from "dokploy/funcs/settingsReadStats.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 settingsReadStats(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsReadStats failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getLogRotateStatus ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.getLogRotateStatus(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsGetLogRotateStatus } from "dokploy/funcs/settingsGetLogRotateStatus.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 settingsGetLogRotateStatus(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsGetLogRotateStatus failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## toggleLogRotate ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.toggleLogRotate({ enable: true, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsToggleLogRotate } from "dokploy/funcs/settingsToggleLogRotate.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 settingsToggleLogRotate(dokploy, { enable: true, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsToggleLogRotate failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsToggleLogRotateRequest](../../models/operations/settingstogglelogrotaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## haveActivateRequests ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.haveActivateRequests(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsHaveActivateRequests } from "dokploy/funcs/settingsHaveActivateRequests.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 settingsHaveActivateRequests(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsHaveActivateRequests failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## toggleRequests ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.toggleRequests({ enable: true, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsToggleRequests } from "dokploy/funcs/settingsToggleRequests.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 settingsToggleRequests(dokploy, { enable: true, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsToggleRequests failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SettingsToggleRequestsRequest](../../models/operations/settingstogglerequestsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## isCloud ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.isCloud(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsIsCloud } from "dokploy/funcs/settingsIsCloud.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 settingsIsCloud(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsIsCloud failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## health ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.settings.health(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { settingsHealth } from "dokploy/funcs/settingsHealth.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 settingsHealth(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("settingsHealth failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* |