website/apps/docs-v2/content/docs/api/generated/reference-settings.mdx

---
title: Settings
full: true
_openapi:
  toc:
    - depth: 2
      title: Settings reload Server
      url: '#settings-reload-server'
    - depth: 2
      title: Settings reload Traefik
      url: '#settings-reload-traefik'
    - depth: 2
      title: Settings toggle Dashboard
      url: '#settings-toggle-dashboard'
    - depth: 2
      title: Settings clean Unused Images
      url: '#settings-clean-unused-images'
    - depth: 2
      title: Settings clean Unused Volumes
      url: '#settings-clean-unused-volumes'
    - depth: 2
      title: Settings clean Stopped Containers
      url: '#settings-clean-stopped-containers'
    - depth: 2
      title: Settings clean Docker Builder
      url: '#settings-clean-docker-builder'
    - depth: 2
      title: Settings clean Docker Prune
      url: '#settings-clean-docker-prune'
    - depth: 2
      title: Settings clean All
      url: '#settings-clean-all'
    - depth: 2
      title: Settings clean Monitoring
      url: '#settings-clean-monitoring'
    - depth: 2
      title: Settings save S S H Private Key
      url: '#settings-save-s-s-h-private-key'
    - depth: 2
      title: Settings assign Domain Server
      url: '#settings-assign-domain-server'
    - depth: 2
      title: Settings clean S S H Private Key
      url: '#settings-clean-s-s-h-private-key'
    - depth: 2
      title: Settings update Docker Cleanup
      url: '#settings-update-docker-cleanup'
    - depth: 2
      title: Settings read Traefik Config
      url: '#settings-read-traefik-config'
    - depth: 2
      title: Settings update Traefik Config
      url: '#settings-update-traefik-config'
    - depth: 2
      title: Settings read Web Server Traefik Config
      url: '#settings-read-web-server-traefik-config'
    - depth: 2
      title: Settings update Web Server Traefik Config
      url: '#settings-update-web-server-traefik-config'
    - depth: 2
      title: Settings read Middleware Traefik Config
      url: '#settings-read-middleware-traefik-config'
    - depth: 2
      title: Settings update Middleware Traefik Config
      url: '#settings-update-middleware-traefik-config'
    - depth: 2
      title: Settings check And Update Image
      url: '#settings-check-and-update-image'
    - depth: 2
      title: Settings update Server
      url: '#settings-update-server'
    - depth: 2
      title: Settings get Dokploy Version
      url: '#settings-get-dokploy-version'
    - depth: 2
      title: Settings read Directories
      url: '#settings-read-directories'
    - depth: 2
      title: Settings update Traefik File
      url: '#settings-update-traefik-file'
    - depth: 2
      title: Settings read Traefik File
      url: '#settings-read-traefik-file'
    - depth: 2
      title: Settings get Ip
      url: '#settings-get-ip'
    - depth: 2
      title: Settings get Open Api Document
      url: '#settings-get-open-api-document'
    - depth: 2
      title: Settings read Traefik Env
      url: '#settings-read-traefik-env'
    - depth: 2
      title: Settings write Traefik Env
      url: '#settings-write-traefik-env'
    - depth: 2
      title: Settings have Traefik Dashboard Port Enabled
      url: '#settings-have-traefik-dashboard-port-enabled'
    - depth: 2
      title: Settings read Stats
      url: '#settings-read-stats'
    - depth: 2
      title: Settings get Log Rotate Status
      url: '#settings-get-log-rotate-status'
    - depth: 2
      title: Settings toggle Log Rotate
      url: '#settings-toggle-log-rotate'
    - depth: 2
      title: Settings have Activate Requests
      url: '#settings-have-activate-requests'
    - depth: 2
      title: Settings toggle Requests
      url: '#settings-toggle-requests'
    - depth: 2
      title: Settings is Cloud
      url: '#settings-is-cloud'
    - depth: 2
      title: Settings health
      url: '#settings-health'
  structuredData:
    headings:
      - content: Settings reload Server
        id: settings-reload-server
      - content: Settings reload Traefik
        id: settings-reload-traefik
      - content: Settings toggle Dashboard
        id: settings-toggle-dashboard
      - content: Settings clean Unused Images
        id: settings-clean-unused-images
      - content: Settings clean Unused Volumes
        id: settings-clean-unused-volumes
      - content: Settings clean Stopped Containers
        id: settings-clean-stopped-containers
      - content: Settings clean Docker Builder
        id: settings-clean-docker-builder
      - content: Settings clean Docker Prune
        id: settings-clean-docker-prune
      - content: Settings clean All
        id: settings-clean-all
      - content: Settings clean Monitoring
        id: settings-clean-monitoring
      - content: Settings save S S H Private Key
        id: settings-save-s-s-h-private-key
      - content: Settings assign Domain Server
        id: settings-assign-domain-server
      - content: Settings clean S S H Private Key
        id: settings-clean-s-s-h-private-key
      - content: Settings update Docker Cleanup
        id: settings-update-docker-cleanup
      - content: Settings read Traefik Config
        id: settings-read-traefik-config
      - content: Settings update Traefik Config
        id: settings-update-traefik-config
      - content: Settings read Web Server Traefik Config
        id: settings-read-web-server-traefik-config
      - content: Settings update Web Server Traefik Config
        id: settings-update-web-server-traefik-config
      - content: Settings read Middleware Traefik Config
        id: settings-read-middleware-traefik-config
      - content: Settings update Middleware Traefik Config
        id: settings-update-middleware-traefik-config
      - content: Settings check And Update Image
        id: settings-check-and-update-image
      - content: Settings update Server
        id: settings-update-server
      - content: Settings get Dokploy Version
        id: settings-get-dokploy-version
      - content: Settings read Directories
        id: settings-read-directories
      - content: Settings update Traefik File
        id: settings-update-traefik-file
      - content: Settings read Traefik File
        id: settings-read-traefik-file
      - content: Settings get Ip
        id: settings-get-ip
      - content: Settings get Open Api Document
        id: settings-get-open-api-document
      - content: Settings read Traefik Env
        id: settings-read-traefik-env
      - content: Settings write Traefik Env
        id: settings-write-traefik-env
      - content: Settings have Traefik Dashboard Port Enabled
        id: settings-have-traefik-dashboard-port-enabled
      - content: Settings read Stats
        id: settings-read-stats
      - content: Settings get Log Rotate Status
        id: settings-get-log-rotate-status
      - content: Settings toggle Log Rotate
        id: settings-toggle-log-rotate
      - content: Settings have Activate Requests
        id: settings-have-activate-requests
      - content: Settings toggle Requests
        id: settings-toggle-requests
      - content: Settings is Cloud
        id: settings-is-cloud
      - content: Settings health
        id: settings-health
    contents: []
---

<APIPage document={"./api.json"} operations={[{"method":"post","path":"/settings.reloadServer"},{"method":"post","path":"/settings.reloadTraefik"},{"method":"post","path":"/settings.toggleDashboard"},{"method":"post","path":"/settings.cleanUnusedImages"},{"method":"post","path":"/settings.cleanUnusedVolumes"},{"method":"post","path":"/settings.cleanStoppedContainers"},{"method":"post","path":"/settings.cleanDockerBuilder"},{"method":"post","path":"/settings.cleanDockerPrune"},{"method":"post","path":"/settings.cleanAll"},{"method":"post","path":"/settings.cleanMonitoring"},{"method":"post","path":"/settings.saveSSHPrivateKey"},{"method":"post","path":"/settings.assignDomainServer"},{"method":"post","path":"/settings.cleanSSHPrivateKey"},{"method":"post","path":"/settings.updateDockerCleanup"},{"method":"get","path":"/settings.readTraefikConfig"},{"method":"post","path":"/settings.updateTraefikConfig"},{"method":"get","path":"/settings.readWebServerTraefikConfig"},{"method":"post","path":"/settings.updateWebServerTraefikConfig"},{"method":"get","path":"/settings.readMiddlewareTraefikConfig"},{"method":"post","path":"/settings.updateMiddlewareTraefikConfig"},{"method":"post","path":"/settings.checkAndUpdateImage"},{"method":"post","path":"/settings.updateServer"},{"method":"get","path":"/settings.getDokployVersion"},{"method":"get","path":"/settings.readDirectories"},{"method":"post","path":"/settings.updateTraefikFile"},{"method":"get","path":"/settings.readTraefikFile"},{"method":"get","path":"/settings.getIp"},{"method":"get","path":"/settings.getOpenApiDocument"},{"method":"get","path":"/settings.readTraefikEnv"},{"method":"post","path":"/settings.writeTraefikEnv"},{"method":"get","path":"/settings.haveTraefikDashboardPortEnabled"},{"method":"get","path":"/settings.readStats"},{"method":"get","path":"/settings.getLogRotateStatus"},{"method":"post","path":"/settings.toggleLogRotate"},{"method":"get","path":"/settings.haveActivateRequests"},{"method":"post","path":"/settings.toggleRequests"},{"method":"get","path":"/settings.isCloud"},{"method":"get","path":"/settings.health"}]} hasHead={true} />