Settings
Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.reloadServer"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanRedis"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.reloadRedis"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.reloadTraefik" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.toggleDashboard" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedImages" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanUnusedVolumes" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanStoppedContainers" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerBuilder" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanDockerPrune" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanAll" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanMonitoring"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.saveSSHPrivateKey" \ -H "Content-Type: application/json" \ -d '{ "sshPrivateKey": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
"letsencrypt" | "none" | "custom"Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.assignDomainServer" \ -H "Content-Type: application/json" \ -d '{ "host": "string", "certificateType": "letsencrypt" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.cleanSSHPrivateKey"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateDockerCleanup" \ -H "Content-Type: application/json" \ -d '{ "enableDockerCleanup": true }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikConfig"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
1 <= lengthResponse Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikConfig" \ -H "Content-Type: application/json" \ -d '{ "traefikConfig": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readWebServerTraefikConfig"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
1 <= lengthResponse Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateWebServerTraefikConfig" \ -H "Content-Type: application/json" \ -d '{ "traefikConfig": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readMiddlewareTraefikConfig"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
1 <= lengthResponse Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateMiddlewareTraefikConfig" \ -H "Content-Type: application/json" \ -d '{ "traefikConfig": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.getUpdateData"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateServer"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployVersion"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getReleaseTag"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readDirectories"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
1 <= length1 <= lengthResponse Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikFile" \ -H "Content-Type: application/json" \ -d '{ "path": "string", "traefikConfig": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikFile?path=string"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getIp"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getOpenApiDocument"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.readTraefikEnv"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.writeTraefikEnv" \ -H "Content-Type: application/json" \ -d '{ "env": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.haveTraefikDashboardPortEnabled"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.haveActivateRequests"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.toggleRequests" \ -H "Content-Type: application/json" \ -d '{ "enable": true }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.isCloud"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.isUserSubscribed"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.health"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.setupGPU" \ -H "Content-Type: application/json" \ -d '{}'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.checkGPUStatus"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateTraefikPorts" \ -H "Content-Type: application/json" \ -d '{ "additionalPorts": [ { "targetPort": 0, "publishedPort": 0, "protocol": "tcp" } ] }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getTraefikPorts"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/settings.updateLogCleanup" \ -H "Content-Type: application/json" \ -d '{ "cronExpression": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getLogCleanupStatus"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Response Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/settings.getDokployCloudIps"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}