Dokploy

Dokploy Settings API

The settings API from Dokploy — 51 operation(s) for settings.

GitHub OpenAPI
Business capability
IT Operations Management BC-600.40

Operations 51

GET /settings.getWebServerSettings Settings get web server settings #
POST /settings.reloadServer Settings reload server #
POST /settings.cleanRedis Settings clean redis #
POST /settings.reloadRedis Settings reload redis #
POST /settings.cleanAllDeploymentQueue Settings clean all deployment queue #
POST /settings.reloadTraefik Settings reload traefik #
POST /settings.toggleDashboard Settings toggle dashboard #
POST /settings.cleanUnusedImages Settings clean unused images #
POST /settings.cleanUnusedVolumes Settings clean unused volumes #
POST /settings.cleanStoppedContainers Settings clean stopped containers #
POST /settings.cleanDockerBuilder Settings clean docker builder #
POST /settings.cleanDockerPrune Settings clean docker prune #
POST /settings.cleanAll Settings clean all #
POST /settings.cleanMonitoring Settings clean monitoring #
GET /settings.getDockerDiskUsage Settings get docker disk usage #
POST /settings.saveSSHPrivateKey Settings save SSH private key #
POST /settings.assignDomainServer Settings assign domain server #
POST /settings.cleanSSHPrivateKey Settings clean SSH private key #
POST /settings.updateDockerCleanup Settings update docker cleanup #
GET /settings.readTraefikConfig Settings read traefik config #
POST /settings.updateTraefikConfig Settings update traefik config #
GET /settings.readWebServerTraefikConfig Settings read web server traefik config #
POST /settings.updateWebServerTraefikConfig Settings update web server traefik config #
GET /settings.readMiddlewareTraefikConfig Settings read middleware traefik config #
POST /settings.updateMiddlewareTraefikConfig Settings update middleware traefik config #
POST /settings.getUpdateData Settings get update data #
POST /settings.updateServer Settings update server #
GET /settings.getDokployVersion Settings get dokploy version #
GET /settings.getReleaseTag Settings get release tag #
GET /settings.readDirectories Settings read directories #
POST /settings.updateTraefikFile Settings update traefik file #
GET /settings.readTraefikFile Settings read traefik file #
GET /settings.getIp Settings get ip #
POST /settings.updateServerIp Settings update server ip #
GET /settings.getOpenApiDocument Settings get open api document #
GET /settings.readTraefikEnv Settings read traefik env #
POST /settings.writeTraefikEnv Settings write traefik env #
GET /settings.haveTraefikDashboardPortEnabled Settings have traefik dashboard port enabled #
GET /settings.haveActivateRequests Settings have activate requests #
POST /settings.toggleRequests Settings toggle requests #
GET /settings.isCloud Settings is cloud #
GET /settings.isUserSubscribed Settings is user subscribed #
GET /settings.health Settings health #
GET /settings.checkInfrastructureHealth Settings check infrastructure health #
POST /settings.setupGPU Settings setup GPU #
GET /settings.checkGPUStatus Settings check GPU status #
POST /settings.updateTraefikPorts Settings update traefik ports #
GET /settings.getTraefikPorts Settings get traefik ports #
POST /settings.updateLogCleanup Settings update log cleanup #
GET /settings.getLogCleanupStatus Settings get log cleanup status #
GET /settings.getDokployCloudIps Settings get dokploy cloud ips #

Documentation

📖
Documentation
https://docs.dokploy.com/
📖
APIReference
https://github.com/Dokploy/sdk/blob/main/openapi.json
📖
GettingStarted
https://docs.dokploy.com/docs/core
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/rate-limits/dokploy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/openapi/dokploy-settings-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/Dokploy/sdk
🔗
CLI
https://github.com/Dokploy/cli
🔗
MCPServer
https://github.com/Dokploy/mcp
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/plans/dokploy-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/finops/dokploy-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dokploy-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dokploy-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dokploy Settings API
  description: Complete API documentation for Dokploy - Deploy applications, manage databases, and orchestrate your infrastructure. This API allows you to programmatically manage all aspects of your Dokploy instance.
  version: 1.0.0
  contact:
    name: Dokploy Team
    url: https://dokploy.com
  license:
    name: Apache 2.0
    url: https://github.com/dokploy/dokploy/blob/canary/LICENSE
servers:
- url: https://your-dokploy-instance.com/api
security:
- apiKey: []
tags:


# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/openapi/dokploy-settings-api-openapi.yml