---
title: Settings
full: true
_openapi:
  toc:
    - depth: 2
      title: Settings get Web Server Settings
      url: '#settings-get-web-server-settings'
    - depth: 2
      title: Settings reload Server
      url: '#settings-reload-server'
    - depth: 2
      title: Settings clean Redis
      url: '#settings-clean-redis'
    - depth: 2
      title: Settings reload Redis
      url: '#settings-reload-redis'
    - 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 get Update Data
      url: '#settings-get-update-data'
    - 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 get Release Tag
      url: '#settings-get-release-tag'
    - 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 update Server Ip
      url: '#settings-update-server-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 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 is User Subscribed
      url: '#settings-is-user-subscribed'
    - depth: 2
      title: Settings health
      url: '#settings-health'
    - depth: 2
      title: Settings setup G P U
      url: '#settings-setup-g-p-u'
    - depth: 2
      title: Settings check G P U Status
      url: '#settings-check-g-p-u-status'
    - depth: 2
      title: Settings update Traefik Ports
      url: '#settings-update-traefik-ports'
    - depth: 2
      title: Settings get Traefik Ports
      url: '#settings-get-traefik-ports'
    - depth: 2
      title: Settings update Log Cleanup
      url: '#settings-update-log-cleanup'
    - depth: 2
      title: Settings get Log Cleanup Status
      url: '#settings-get-log-cleanup-status'
    - depth: 2
      title: Settings get Dokploy Cloud Ips
      url: '#settings-get-dokploy-cloud-ips'
  structuredData:
    headings:
      - content: Settings get Web Server Settings
        id: settings-get-web-server-settings
      - content: Settings reload Server
        id: settings-reload-server
      - content: Settings clean Redis
        id: settings-clean-redis
      - content: Settings reload Redis
        id: settings-reload-redis
      - 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 get Update Data
        id: settings-get-update-data
      - content: Settings update Server
        id: settings-update-server
      - content: Settings get Dokploy Version
        id: settings-get-dokploy-version
      - content: Settings get Release Tag
        id: settings-get-release-tag
      - 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 update Server Ip
        id: settings-update-server-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 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 is User Subscribed
        id: settings-is-user-subscribed
      - content: Settings health
        id: settings-health
      - content: Settings setup G P U
        id: settings-setup-g-p-u
      - content: Settings check G P U Status
        id: settings-check-g-p-u-status
      - content: Settings update Traefik Ports
        id: settings-update-traefik-ports
      - content: Settings get Traefik Ports
        id: settings-get-traefik-ports
      - content: Settings update Log Cleanup
        id: settings-update-log-cleanup
      - content: Settings get Log Cleanup Status
        id: settings-get-log-cleanup-status
      - content: Settings get Dokploy Cloud Ips
        id: settings-get-dokploy-cloud-ips
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./public/openapi.json"} webhooks={[]} operations={[{"path":"/settings.getWebServerSettings","method":"get"},{"path":"/settings.reloadServer","method":"post"},{"path":"/settings.cleanRedis","method":"post"},{"path":"/settings.reloadRedis","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":"post"},{"path":"/settings.readTraefikConfig","method":"get"},{"path":"/settings.updateTraefikConfig","method":"post"},{"path":"/settings.readWebServerTraefikConfig","method":"get"},{"path":"/settings.updateWebServerTraefikConfig","method":"post"},{"path":"/settings.readMiddlewareTraefikConfig","method":"get"},{"path":"/settings.updateMiddlewareTraefikConfig","method":"post"},{"path":"/settings.getUpdateData","method":"post"},{"path":"/settings.updateServer","method":"post"},{"path":"/settings.getDokployVersion","method":"get"},{"path":"/settings.getReleaseTag","method":"get"},{"path":"/settings.readDirectories","method":"get"},{"path":"/settings.updateTraefikFile","method":"post"},{"path":"/settings.readTraefikFile","method":"get"},{"path":"/settings.getIp","method":"get"},{"path":"/settings.updateServerIp","method":"post"},{"path":"/settings.getOpenApiDocument","method":"get"},{"path":"/settings.readTraefikEnv","method":"get"},{"path":"/settings.writeTraefikEnv","method":"post"},{"path":"/settings.haveTraefikDashboardPortEnabled","method":"get"},{"path":"/settings.haveActivateRequests","method":"get"},{"path":"/settings.toggleRequests","method":"post"},{"path":"/settings.isCloud","method":"get"},{"path":"/settings.isUserSubscribed","method":"get"},{"path":"/settings.health","method":"get"},{"path":"/settings.setupGPU","method":"post"},{"path":"/settings.checkGPUStatus","method":"get"},{"path":"/settings.updateTraefikPorts","method":"post"},{"path":"/settings.getTraefikPorts","method":"get"},{"path":"/settings.updateLogCleanup","method":"post"},{"path":"/settings.getLogCleanupStatus","method":"get"},{"path":"/settings.getDokployCloudIps","method":"get"}]} showTitle={true} />