Skip to main content
Glama
Dokploy MCP Server

Dokploy MCP Server

by bravos2k5

Dokploy MCP Server

npm version

Dokploy MCP Server exposes all Dokploy API endpoints as tools consumable via the Model Context Protocol (MCP). It allows MCP-compatible clients (e.g., AI models, other applications) to interact with your Dokploy server programmatically.

With 508 tools across 49 categories, this server provides complete coverage of the Dokploy API — from project and application management to databases, notifications, SSO, Docker, backups, and more.

Getting Started

Requirements

  • Node.js >= v18.0.0 (or Docker)

  • Cursor, VS Code, Claude Desktop, or another MCP Client

  • A running Dokploy server instance

Install in Cursor

Go to: Settings -> Cursor Settings -> MCP -> Add new global MCP server

Add this to your Cursor ~/.cursor/mcp.json file. You may also install in a specific project by creating .cursor/mcp.json in your project folder. See Cursor MCP docs for more info.

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}
{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "bunx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}
{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "deno",
      "args": ["run", "--allow-env", "--allow-net", "npm:@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in Windsurf

Add this to your Windsurf MCP config file. See Windsurf MCP docs for more info.

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in VS Code

Add this to your VS Code MCP config file. See VS Code MCP docs for more info.

{
  "servers": {
    "dokploy-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in Claude Code

Add the MCP server to Claude Code using the CLI:

claude mcp add dokploy-mcp -- npx -y @dokploy/mcp

Then set the environment variables in your .claude/settings.json or pass them inline:

DOKPLOY_URL=https://your-dokploy-server.com DOKPLOY_API_KEY=your-token claude

Install in Zed

Add this to your Zed settings.json. See Zed Context Server docs for more info.

{
  "context_servers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in Claude Desktop

Add this to your Claude Desktop claude_desktop_config.json file. See Claude Desktop MCP docs for more info.

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in BoltAI

Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Using Docker

The Docker container supports both stdio and HTTP transport modes, making it flexible for different deployment scenarios.

  1. Build the Docker Image:

    git clone https://github.com/Dokploy/mcp.git
    cd mcp
    docker build -t dokploy-mcp .
  2. Manual Docker Commands:

    Stdio Mode (for MCP clients):

    docker run -it --rm \
      -e DOKPLOY_URL=https://your-dokploy-server.com \
      -e DOKPLOY_API_KEY=your_token_here \
      dokploy-mcp

    HTTP Mode (for web applications):

    docker run -it --rm \
      -p 8080:3000 \
      -e MCP_TRANSPORT=http \
      -e DOKPLOY_URL=https://your-dokploy-server.com \
      -e DOKPLOY_API_KEY=your_token_here \
      dokploy-mcp
  3. Docker Compose:

    Use the provided docker-compose.yml for production deployments:

    # Start HTTP service
    docker-compose up -d dokploy-mcp-http
    
    # View logs
    docker-compose logs -f dokploy-mcp-http
  4. MCP Client Configuration:

    For stdio mode (Claude Desktop, VS Code, etc.):

    {
      "mcpServers": {
        "dokploy-mcp": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "DOKPLOY_URL=https://your-dokploy-server.com",
            "-e",
            "DOKPLOY_API_KEY=your_token_here",
            "dokploy-mcp"
          ]
        }
      }
    }

    For HTTP mode (web applications):

    Start the HTTP server first, then configure your client to connect to http://localhost:3000/mcp.

Install in Windows

The configuration on Windows is slightly different compared to Linux or macOS. Use cmd as the command wrapper:

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Environment Variables

Variable

Required

Description

DOKPLOY_URL

Yes

Your Dokploy server URL (e.g., https://your-dokploy-server.com)

DOKPLOY_API_KEY

Yes

Your Dokploy API authentication token

DOKPLOY_ENABLED_TAGS

No

Comma-separated list of tags to filter which tools are loaded (e.g., project,application,postgres)

DOKPLOY_TIMEOUT

No

Request timeout in milliseconds (default: 30000)

DOKPLOY_RETRY_ATTEMPTS

No

Number of retry attempts (default: 3)

DOKPLOY_RETRY_DELAY

No

Delay between retries in milliseconds (default: 1000)

Related MCP server: Dokploy MCP Server

Transport Modes

This MCP server supports multiple transport modes to suit different use cases:

Stdio Mode (Default)

The default mode uses stdio for direct process communication, ideal for desktop applications and command-line usage.

# Run with stdio (default)
npx -y @dokploy/mcp

HTTP Mode (Streamable HTTP + Legacy SSE)

Modern HTTP mode exposes the server via HTTP/HTTPS supporting both modern and legacy protocols for maximum compatibility:

  • Streamable HTTP (MCP 2025-03-26) - Modern protocol with session management

  • Legacy SSE (MCP 2024-11-05) - Backwards compatibility for older clients

# Run with HTTP mode
npx -y @dokploy/mcp --http
# or via environment variable
MCP_TRANSPORT=http npx -y @dokploy/mcp

Modern Streamable HTTP Endpoints:

Endpoint

Method

Description

/mcp

POST

Client-to-server requests

/mcp

GET

Server-to-client notifications (SSE)

/mcp

DELETE

Session termination

/health

GET

Health check

Legacy SSE Endpoints (Backwards Compatibility):

Endpoint

Method

Description

/sse

GET

SSE stream initialization

/messages

POST

Client message posting

Available Tools (508)

This MCP server provides 508 tools covering the entire Dokploy API, organized into 49 categories:

Core Resources

Category

Tools

Description

Project

8

Create, list, update, duplicate, search, and delete projects

Application

30

Full application lifecycle — create, deploy, redeploy, start, stop, build types, git providers (GitHub, GitLab, Bitbucket, Gitea), environment, Traefik config

Compose

29

Docker Compose management — create, deploy, templates, services, environment, isolated deployments

Domain

9

Domain CRUD, DNS validation, Traefik.me generation

Environment

7

Multi-environment support per project

Deployment

8

Deployment history, queue management, centralized view

Databases

Category

Tools

Description

PostgreSQL

15

Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment

MySQL

15

Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment

MariaDB

15

Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment

MongoDB

15

Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment

Redis

15

Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment

LibSQL

13

Full lifecycle — create, deploy, start, stop, rebuild, external ports, environment

Infrastructure

Category

Tools

Description

Server

17

Multi-server management, metrics, security, monitoring setup

Docker

9

Container management — list, restart, remove, upload files, inspect config

Cluster / Swarm

8

Swarm node management, container stats, cluster operations

Settings

51

Server settings, Traefik config, Docker cleanup, GPU, monitoring, Redis, disk usage

Registry

7

Docker registry management and testing

Security & Auth

Category

Tools

Description

SSO

10

Single sign-on providers, trusted origins

SSH Keys

7

SSH key management — create, generate, list, update, remove

Certificates

5

SSL/TLS certificate management

Security

4

Basic auth and security rules per application

Custom Roles

6

Role-based access control with custom permissions

User

23

User management, permissions, API keys, invitations, metrics

Organization

11

Multi-org support, invitations, member roles

Operations

Category

Tools

Description

Backup

12

Database backups — Postgres, MySQL, MariaDB, MongoDB, LibSQL, Compose, WebServer

Volume Backups

6

Volume-level backup scheduling and management

Destination

6

S3-compatible backup destinations (AWS, Cloudflare R2, etc.)

Schedule

6

Scheduled tasks — cron-based automation

Notification

41

Multi-channel alerts — Slack, Discord, Telegram, Email, Teams, Gotify, Ntfy, Pushover, Lark, Mattermost, Resend, Custom webhooks

Rollback

2

Application rollback management

Other

Category

Tools

Description

AI

9

AI-powered suggestions, model management

Git Providers

27

GitHub, GitLab, Gitea, Bitbucket — branches, repos, connection testing

Tag

8

Project tagging and bulk assignment

Patch

12

File patching system for applications

Mounts

6

Volume and bind mount management

Port

4

Port mapping configuration

Redirects

4

URL redirect rules

Preview Deployments

4

PR preview deployment management

Stripe

7

Billing and subscription management

License Key

6

Enterprise license management

Whitelabeling

4

Custom branding for enterprise

Audit Log

1

Activity audit trail

Admin

1

Admin-level monitoring setup

Tool Filtering

You can limit which tools are loaded by setting the DOKPLOY_ENABLED_TAGS environment variable. This is useful when you only need a subset of tools:

# Only load project, application, and postgres tools
DOKPLOY_ENABLED_TAGS=project,application,postgres

All tools include semantic annotations (readOnlyHint, destructiveHint, idempotentHint) to help MCP clients understand their behavior and safety characteristics.

Environment Tool Data Format

The MCP server includes four environment helper tools with a normalized shape for AI agents:

  • projectEnvironment-get

  • projectEnvironment-save

  • serviceEnvironment-get

  • serviceEnvironment-save

*-get tools return both forms:

  • envMap: object map in KEY -> VALUE format for reliable agent parsing.

  • envText: reconstructed .env string format (KEY=VALUE per line).

*-save tools accept env in either format:

  • String: .env text (KEY=VALUE lines)

  • Object: map ({ "KEY": "VALUE" })

When a map is provided, the server automatically serializes it to .env text before calling Dokploy API endpoints.

Example request for serviceEnvironment-save (map input):

{
  "serviceType": "application",
  "serviceId": "app_123",
  "env": {
    "NODE_ENV": "production",
    "PORT": "3000"
  }
}

Example response payload for serviceEnvironment-get:

{
  "serviceType": "application",
  "serviceId": "app_123",
  "envMap": {
    "NODE_ENV": "production",
    "PORT": "3000"
  },
  "envText": "NODE_ENV=production\nPORT=3000"
}

Architecture

Built with @modelcontextprotocol/sdk, TypeScript, and Zod for type-safe schema validation:

  • 508 Tools covering the entire Dokploy API

  • Multiple Transports: Stdio (default) and HTTP (Streamable HTTP + legacy SSE)

  • Auto-generated Tools: Tools are generated from the Dokploy OpenAPI spec via pnpm generate:all

  • Tool Filtering: Load only the categories you need via DOKPLOY_ENABLED_TAGS

  • Robust Error Handling: Centralized API client with interceptors and retry logic

  • Type Safety: Full TypeScript with Zod schema validation

  • Tool Annotations: Semantic hints for MCP client behavior understanding

Development

Clone the project and install dependencies:

git clone https://github.com/Dokploy/mcp.git
cd mcp
pnpm install

Build:

pnpm build

Regenerate tools from the Dokploy OpenAPI spec:

pnpm generate:all

Local Configuration Example

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["tsx", "/path/to/mcp/src/index.ts"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Testing with MCP Inspector

npx -y @modelcontextprotocol/inspector npx @dokploy/mcp

Troubleshooting

MCP Client Errors

  1. Try adding @latest to the package name.

  2. Make sure you are using Node v18 or higher to have native fetch support with npx.

  3. Verify your DOKPLOY_URL and DOKPLOY_API_KEY environment variables are correctly set.

  4. If too many tools are loading, use DOKPLOY_ENABLED_TAGS to filter by category.

Contributing

We welcome contributions! If you'd like to contribute to the Dokploy MCP Server, please check out our Contributing Guide.

Support

If you encounter any issues, have questions, or want to suggest a feature, please open an issue in our GitHub repository.

License

This project is licensed under the Apache License.

Available Tools

523 tools
admin-setupMonitoringD
Idempotent

POST /admin.setupMonitoring

Inputs: metricsConfig (required).

ai-analyzeLogsD
Idempotent

POST /ai.analyzeLogs

Inputs: aiId (required), logs (required), context (required).

ai-createD

POST /ai.create

Inputs: name (required), apiUrl (required), apiKey (required), model (required), +1 more.

ai-deleteD
Destructive

POST /ai.delete

Inputs: aiId (required).

ai-deployD
Idempotent

POST /ai.deploy

Inputs: environmentId (required), id (required), dockerCompose (required), envVariables (required), +5 more.

ai-getD
Read-onlyIdempotent

GET /ai.get

Inputs: aiId (required).

ai-getAllC
Read-onlyIdempotent

GET /ai.getAll

Inputs: no named parameters.

ai-getEnabledProvidersD
Read-onlyIdempotent

GET /ai.getEnabledProviders

Inputs: no named parameters.

ai-getModelsD
Read-onlyIdempotent

GET /ai.getModels

Inputs: apiUrl (required), apiKey (required).

ai-oneD
Read-onlyIdempotent

GET /ai.one

Inputs: aiId (required).

ai-suggestD
Idempotent

POST /ai.suggest

Inputs: aiId (required), input (required), serverId.

ai-testConnectionD
Idempotent

POST /ai.testConnection

Inputs: apiUrl (required), apiKey (required), model (required).

ai-updateC
Idempotent

POST /ai.update

Inputs: aiId (required), name, apiUrl, apiKey, +3 more.

application-cancelDeploymentD
Idempotent

POST /application.cancelDeployment

Inputs: applicationId (required).

application-cleanQueuesD
Idempotent

POST /application.cleanQueues

Inputs: applicationId (required).

application-clearDeploymentsD
Idempotent

POST /application.clearDeployments

Inputs: applicationId (required).

application-createD

POST /application.create

Inputs: name (required), environmentId (required), appName, description, +1 more.

application-deleteD
Destructive

POST /application.delete

Inputs: applicationId (required).

application-deployD
Idempotent

POST /application.deploy

Inputs: applicationId (required), title, description.

application-disconnectGitProviderD
Idempotent

POST /application.disconnectGitProvider

Inputs: applicationId (required).

application-dropDeploymentD
Idempotent

POST /application.dropDeployment

Inputs: no named parameters.

application-killBuildD
Idempotent

POST /application.killBuild

Inputs: applicationId (required).

application-markRunningD
Idempotent

POST /application.markRunning

Inputs: applicationId (required).

application-moveD
Idempotent

POST /application.move

Inputs: applicationId (required), targetEnvironmentId (required).

application-oneD
Read-onlyIdempotent

GET /application.one

Inputs: applicationId (required).

application-readAppMonitoringD
Read-onlyIdempotent

GET /application.readAppMonitoring

Inputs: appName (required).

application-readLogsD
Read-onlyIdempotent

GET /application.readLogs

Inputs: applicationId (required), tail, since, search.

application-readTraefikConfigC
Read-onlyIdempotent

GET /application.readTraefikConfig

Inputs: applicationId (required).

application-redeployD
Idempotent

POST /application.redeploy

Inputs: applicationId (required), title, description.

application-refreshTokenD
Idempotent

POST /application.refreshToken

Inputs: applicationId (required).

application-reloadC
Idempotent

POST /application.reload

Inputs: appName (required), applicationId (required).

application-saveBitbucketProviderD
Idempotent

POST /application.saveBitbucketProvider

Inputs: bitbucketBranch (required), bitbucketBuildPath (required), bitbucketOwner (required), bitbucketRepository (required), +5 more.

application-saveBuildTypeD
Idempotent

POST /application.saveBuildType

Inputs: applicationId (required), buildType (required), dockerfile (required), dockerContextPath (required), +5 more.

application-saveDockerProviderD
Idempotent

POST /application.saveDockerProvider

Inputs: dockerImage (required), applicationId (required), username (required), password (required), +1 more.

application-saveEnvironmentD
Idempotent

POST /application.saveEnvironment

Inputs: applicationId (required), env (required), buildArgs (required), buildSecrets (required), +1 more.

application-saveGiteaProviderD
Idempotent

POST /application.saveGiteaProvider

Inputs: applicationId (required), giteaBranch (required), giteaBuildPath (required), giteaOwner (required), +4 more.

application-saveGithubProviderD
Idempotent

POST /application.saveGithubProvider

Inputs: applicationId (required), repository (required), branch (required), owner (required), +5 more.

application-saveGitlabProviderD
Idempotent

POST /application.saveGitlabProvider

Inputs: applicationId (required), gitlabBranch (required), gitlabBuildPath (required), gitlabOwner (required), +6 more.

application-saveGitProviderD
Idempotent

POST /application.saveGitProvider

Inputs: customGitBranch (required), applicationId (required), customGitBuildPath (required), customGitUrl (required), +3 more.

application-startD
Idempotent

POST /application.start

Inputs: applicationId (required).

application-stopD
Idempotent

POST /application.stop

Inputs: applicationId (required).

application-updateD
Idempotent

POST /application.update

Inputs: applicationId (required), name, appName, description, +94 more.

application-updateTraefikConfigD
Idempotent

POST /application.updateTraefikConfig

Inputs: applicationId (required), traefikConfig (required).

auditLog-allD
Read-onlyIdempotent

GET /auditLog.all

Inputs: userId, userEmail, resourceName, action, +5 more.

backup-createD

POST /backup.create

Inputs: schedule (required), prefix (required), destinationId (required), database (required), +13 more.

backup-listBackupFilesD
Read-onlyIdempotent

GET /backup.listBackupFiles

Inputs: destinationId (required), search (required), serverId.

backup-manualBackupComposeD
Idempotent

POST /backup.manualBackupCompose

Inputs: backupId (required).

backup-manualBackupLibsqlD
Idempotent

POST /backup.manualBackupLibsql

Inputs: backupId (required).

backup-manualBackupMariadbD
Idempotent

POST /backup.manualBackupMariadb

Inputs: backupId (required).

backup-manualBackupMongoD
Idempotent

POST /backup.manualBackupMongo

Inputs: backupId (required).

backup-manualBackupMySqlD
Idempotent

POST /backup.manualBackupMySql

Inputs: backupId (required).

backup-manualBackupPostgresD
Idempotent

POST /backup.manualBackupPostgres

Inputs: backupId (required).

backup-manualBackupWebServerC
Idempotent

POST /backup.manualBackupWebServer

Inputs: backupId (required).

backup-oneD
Read-onlyIdempotent

GET /backup.one

Inputs: backupId (required).

backup-removeD
Destructive

POST /backup.remove

Inputs: backupId (required).

backup-updateD
Idempotent

POST /backup.update

Inputs: schedule (required), enabled (required), prefix (required), backupId (required), +6 more.

bitbucket-bitbucketProvidersD
Read-onlyIdempotent

GET /bitbucket.bitbucketProviders

Inputs: no named parameters.

bitbucket-createD

POST /bitbucket.create

Inputs: authId (required), name (required), bitbucketId, bitbucketUsername, +5 more.

bitbucket-getBitbucketBranchesD
Read-onlyIdempotent

GET /bitbucket.getBitbucketBranches

Inputs: owner (required), repo (required), bitbucketId.

bitbucket-getBitbucketRepositoriesD
Read-onlyIdempotent

GET /bitbucket.getBitbucketRepositories

Inputs: bitbucketId (required).

bitbucket-oneD
Read-onlyIdempotent

GET /bitbucket.one

Inputs: bitbucketId (required).

bitbucket-testConnectionD
Idempotent

POST /bitbucket.testConnection

Inputs: bitbucketId (required), bitbucketUsername, bitbucketEmail, workspaceName, +2 more.

bitbucket-updateD
Idempotent

POST /bitbucket.update

Inputs: bitbucketId (required), gitProviderId (required), name (required), bitbucketUsername, +5 more.

certificates-allC
Read-onlyIdempotent

GET /certificates.all

Inputs: no named parameters.

certificates-createD

POST /certificates.create

Inputs: name (required), certificateData (required), privateKey (required), organizationId (required), +4 more.

certificates-oneD
Read-onlyIdempotent

GET /certificates.one

Inputs: certificateId (required).

certificates-removeD
Destructive

POST /certificates.remove

Inputs: certificateId (required).

certificates-updateD
Idempotent

POST /certificates.update

Inputs: certificateId (required), name, certificateData, privateKey.

cluster-addManagerD
Read-onlyIdempotent

GET /cluster.addManager

Inputs: serverId.

cluster-addWorkerD
Read-onlyIdempotent

GET /cluster.addWorker

Inputs: serverId.

cluster-getNodesD
Read-onlyIdempotent

GET /cluster.getNodes

Inputs: serverId.

cluster-removeWorkerD
Destructive

POST /cluster.removeWorker

Inputs: nodeId (required), serverId.

compose-cancelDeploymentD
Idempotent

POST /compose.cancelDeployment

Inputs: composeId (required).

compose-cleanQueuesD
Idempotent

POST /compose.cleanQueues

Inputs: composeId (required).

compose-clearDeploymentsD
Idempotent

POST /compose.clearDeployments

Inputs: composeId (required).

compose-createD

POST /compose.create

Inputs: name (required), environmentId (required), description, composeType, +3 more.

compose-deleteD
Destructive

POST /compose.delete

Inputs: composeId (required), deleteVolumes (required).

compose-deployD
Idempotent

POST /compose.deploy

Inputs: composeId (required), title, description.

compose-deployTemplateD
Idempotent

POST /compose.deployTemplate

Inputs: environmentId (required), id (required), serverId, baseUrl.

compose-disconnectGitProviderD
Idempotent

POST /compose.disconnectGitProvider

Inputs: composeId (required).

compose-fetchSourceTypeD
Idempotent

POST /compose.fetchSourceType

Inputs: composeId (required).

compose-getConvertedComposeD
Read-onlyIdempotent

GET /compose.getConvertedCompose

Inputs: composeId (required).

compose-getDefaultCommandD
Read-onlyIdempotent

GET /compose.getDefaultCommand

Inputs: composeId (required).

compose-getTagsD
Read-onlyIdempotent

GET /compose.getTags

Inputs: baseUrl.

compose-importD
Idempotent

POST /compose.import

Inputs: base64 (required), composeId (required).

compose-isolatedDeploymentD
Idempotent

POST /compose.isolatedDeployment

Inputs: composeId (required), suffix.

compose-killBuildD
Idempotent

POST /compose.killBuild

Inputs: composeId (required).

compose-loadMountsByServiceD
Read-onlyIdempotent

GET /compose.loadMountsByService

Inputs: composeId (required), serviceName (required).

compose-loadServicesD
Read-onlyIdempotent

GET /compose.loadServices

Inputs: composeId (required), type.

compose-moveD
Idempotent

POST /compose.move

Inputs: composeId (required), targetEnvironmentId (required).

compose-oneD
Read-onlyIdempotent

GET /compose.one

Inputs: composeId (required).

compose-processTemplateD
Idempotent

POST /compose.processTemplate

Inputs: base64 (required), composeId (required).

compose-randomizeComposeD
Idempotent

POST /compose.randomizeCompose

Inputs: composeId (required), suffix.

compose-readLogsD
Read-onlyIdempotent

GET /compose.readLogs

Inputs: composeId (required), containerId (required), tail, since, +1 more.

compose-redeployD
Idempotent

POST /compose.redeploy

Inputs: composeId (required), title, description.

compose-refreshTokenD
Idempotent

POST /compose.refreshToken

Inputs: composeId (required).

compose-saveEnvironmentD
Idempotent

POST /compose.saveEnvironment

Inputs: composeId (required), env (required).

compose-startD
Idempotent

POST /compose.start

Inputs: composeId (required).

compose-stopD
Idempotent

POST /compose.stop

Inputs: composeId (required).

compose-templatesD
Read-onlyIdempotent

GET /compose.templates

Inputs: baseUrl.

compose-updateD
Idempotent

POST /compose.update

Inputs: composeId (required), name, appName, description, +40 more.

customRole-allC
Read-onlyIdempotent

GET /customRole.all

Inputs: no named parameters.

customRole-createD

POST /customRole.create

Inputs: roleName (required), permissions (required).

customRole-getStatementsD
Read-onlyIdempotent

GET /customRole.getStatements

Inputs: no named parameters.

customRole-membersByRoleD
Read-onlyIdempotent

GET /customRole.membersByRole

Inputs: roleName (required).

customRole-removeD
Destructive

POST /customRole.remove

Inputs: roleName (required).

customRole-updateD
Idempotent

POST /customRole.update

Inputs: roleName (required), permissions (required), newRoleName.

deployment-allD
Read-onlyIdempotent

GET /deployment.all

Inputs: applicationId (required).

deployment-allByComposeC
Read-onlyIdempotent

GET /deployment.allByCompose

Inputs: composeId (required).

deployment-allByServerD
Read-onlyIdempotent

GET /deployment.allByServer

Inputs: serverId (required).

deployment-allByTypeD
Read-onlyIdempotent

GET /deployment.allByType

Inputs: id (required), type (required).

deployment-allCentralizedD
Read-onlyIdempotent

GET /deployment.allCentralized

Inputs: no named parameters.

deployment-killProcessD
Idempotent

POST /deployment.killProcess

Inputs: deploymentId (required).

deployment-queueListC
Read-onlyIdempotent

GET /deployment.queueList

Inputs: no named parameters.

deployment-removeDeploymentD
Destructive

POST /deployment.removeDeployment

Inputs: deploymentId (required).

destination-allB
Read-onlyIdempotent

GET /destination.all

Inputs: no named parameters.

destination-createD

POST /destination.create

Inputs: name (required), provider (required), accessKey (required), bucket (required), +5 more.

destination-oneC
Read-onlyIdempotent

GET /destination.one

Inputs: destinationId (required).

destination-removeD
Destructive

POST /destination.remove

Inputs: destinationId (required).

destination-testConnectionD
Idempotent

POST /destination.testConnection

Inputs: name (required), provider (required), accessKey (required), bucket (required), +5 more.

destination-updateD
Idempotent

POST /destination.update

Inputs: name (required), accessKey (required), bucket (required), region (required), +6 more.

docker-getConfigD
Read-onlyIdempotent

GET /docker.getConfig

Inputs: containerId (required), serverId.

docker-getContainersD
Read-onlyIdempotent

GET /docker.getContainers

Inputs: serverId.

docker-getContainersByAppLabelD
Read-onlyIdempotent

GET /docker.getContainersByAppLabel

Inputs: appName (required), type (required), serverId.

docker-getContainersByAppNameMatchD
Read-onlyIdempotent

GET /docker.getContainersByAppNameMatch

Inputs: appName (required), appType, serverId.

docker-getServiceContainersByAppNameD
Read-onlyIdempotent

GET /docker.getServiceContainersByAppName

Inputs: appName (required), serverId.

docker-getStackContainersByAppNameD
Read-onlyIdempotent

GET /docker.getStackContainersByAppName

Inputs: appName (required), serverId.

docker-removeContainerD
Destructive

POST /docker.removeContainer

Inputs: containerId (required), serverId.

docker-restartContainerD
Idempotent

POST /docker.restartContainer

Inputs: containerId (required).

docker-uploadFileToContainerD
Idempotent

POST /docker.uploadFileToContainer

Inputs: no named parameters.

domain-byApplicationIdD
Read-onlyIdempotent

GET /domain.byApplicationId

Inputs: applicationId (required).

domain-byComposeIdD
Read-onlyIdempotent

GET /domain.byComposeId

Inputs: composeId (required).

domain-canGenerateTraefikMeDomainsD
Read-onlyIdempotent

GET /domain.canGenerateTraefikMeDomains

Inputs: serverId (required).

domain-createD

POST /domain.create

Inputs: host (required), path, port, customEntrypoint, +11 more.

domain-deleteD
Destructive

POST /domain.delete

Inputs: domainId (required).

domain-generateDomainD
Idempotent

POST /domain.generateDomain

Inputs: appName (required), serverId.

domain-oneC
Read-onlyIdempotent

GET /domain.one

Inputs: domainId (required).

domain-updateD
Idempotent

POST /domain.update

Inputs: host (required), domainId (required), path, port, +9 more.

domain-validateDomainD
Idempotent

POST /domain.validateDomain

Inputs: domain (required), serverIp.

environment-byProjectIdC
Read-onlyIdempotent

GET /environment.byProjectId

Inputs: projectId (required).

environment-createD

POST /environment.create

Inputs: name (required), projectId (required), description.

environment-duplicateD
Idempotent

POST /environment.duplicate

Inputs: environmentId (required), name (required), description.

environment-oneD
Read-onlyIdempotent

GET /environment.one

Inputs: environmentId (required).

environment-removeD
Destructive

POST /environment.remove

Inputs: environmentId (required).

environment-updateD
Idempotent

POST /environment.update

Inputs: environmentId (required), name, description, projectId, +1 more.

gitea-createD

POST /gitea.create

Inputs: giteaUrl (required), name (required), giteaId, giteaInternalUrl, +11 more.

gitea-getGiteaBranchesD
Read-onlyIdempotent

GET /gitea.getGiteaBranches

Inputs: owner (required), repositoryName (required), giteaId.

gitea-getGiteaRepositoriesD
Read-onlyIdempotent

GET /gitea.getGiteaRepositories

Inputs: giteaId (required).

gitea-getGiteaUrlD
Read-onlyIdempotent

GET /gitea.getGiteaUrl

Inputs: giteaId (required).

gitea-giteaProvidersD
Read-onlyIdempotent

GET /gitea.giteaProviders

Inputs: no named parameters.

gitea-oneD
Read-onlyIdempotent

GET /gitea.one

Inputs: giteaId (required).

gitea-testConnectionD
Idempotent

POST /gitea.testConnection

Inputs: giteaId, organizationName.

gitea-updateD
Idempotent

POST /gitea.update

Inputs: giteaId (required), giteaUrl (required), gitProviderId (required), name (required), +11 more.

github-getGithubBranchesD
Read-onlyIdempotent

GET /github.getGithubBranches

Inputs: repo (required), owner (required), githubId.

github-getGithubRepositoriesC
Read-onlyIdempotent

GET /github.getGithubRepositories

Inputs: githubId (required).

github-githubProvidersC
Read-onlyIdempotent

GET /github.githubProviders

Inputs: no named parameters.

github-oneD
Read-onlyIdempotent

GET /github.one

Inputs: githubId (required).

github-testConnectionD
Idempotent

POST /github.testConnection

Inputs: githubId (required).

github-updateD
Idempotent

POST /github.update

Inputs: githubId (required), name (required), gitProviderId (required), githubAppName (required).

gitlab-createD

POST /gitlab.create

Inputs: authId (required), name (required), gitlabUrl (required), applicationId, +5 more.

gitlab-getGitlabBranchesD
Read-onlyIdempotent

GET /gitlab.getGitlabBranches

Inputs: owner (required), repo (required), id, gitlabId.

gitlab-getGitlabRepositoriesD
Read-onlyIdempotent

GET /gitlab.getGitlabRepositories

Inputs: gitlabId (required).

gitlab-gitlabProvidersC
Read-onlyIdempotent

GET /gitlab.gitlabProviders

Inputs: no named parameters.

gitlab-oneD
Read-onlyIdempotent

GET /gitlab.one

Inputs: gitlabId (required).

gitlab-testConnectionD
Idempotent

POST /gitlab.testConnection

Inputs: gitlabId (required), groupName.

gitlab-updateD
Idempotent

POST /gitlab.update

Inputs: name (required), gitlabId (required), gitlabUrl (required), gitProviderId (required), +5 more.

gitProvider-allForPermissionsD
Read-onlyIdempotent

GET /gitProvider.allForPermissions

Inputs: no named parameters.

gitProvider-getAllD
Read-onlyIdempotent

GET /gitProvider.getAll

Inputs: no named parameters.

gitProvider-removeD
Destructive

POST /gitProvider.remove

Inputs: gitProviderId (required).

gitProvider-toggleShareD
Idempotent

POST /gitProvider.toggleShare

Inputs: gitProviderId (required), sharedWithOrganization (required).

libsql-changeStatusD
Idempotent

POST /libsql.changeStatus

Inputs: libsqlId (required), applicationStatus (required).

libsql-createD

POST /libsql.create

Inputs: name (required), appName (required), environmentId (required), description (required), +7 more.

libsql-deployD
Idempotent

POST /libsql.deploy

Inputs: libsqlId (required).

libsql-moveD
Idempotent

POST /libsql.move

Inputs: libsqlId (required), targetEnvironmentId (required).

libsql-oneD
Read-onlyIdempotent

GET /libsql.one

Inputs: libsqlId (required).

libsql-readLogsD
Read-onlyIdempotent

GET /libsql.readLogs

Inputs: libsqlId (required), tail, since, search.

libsql-rebuildD
Idempotent

POST /libsql.rebuild

Inputs: libsqlId (required).

libsql-reloadD
Idempotent

POST /libsql.reload

Inputs: libsqlId (required), appName (required).

libsql-removeD
Destructive

POST /libsql.remove

Inputs: libsqlId (required).

libsql-saveEnvironmentD
Idempotent

POST /libsql.saveEnvironment

Inputs: libsqlId (required), env (required).

libsql-saveExternalPortsD
Idempotent

POST /libsql.saveExternalPorts

Inputs: libsqlId (required), externalPort, externalGRPCPort, externalAdminPort.

libsql-startD
Idempotent

POST /libsql.start

Inputs: libsqlId (required).

libsql-stopD
Idempotent

POST /libsql.stop

Inputs: libsqlId (required).

libsql-updateD
Idempotent

POST /libsql.update

Inputs: libsqlId (required), name, appName, description, +29 more.

licenseKey-activateD
Idempotent

POST /licenseKey.activate

Inputs: licenseKey (required).

licenseKey-deactivateC
Idempotent

POST /licenseKey.deactivate

Inputs: no named parameters.

licenseKey-getEnterpriseSettingsC
Read-onlyIdempotent

GET /licenseKey.getEnterpriseSettings

Inputs: no named parameters.

licenseKey-haveValidLicenseKeyD
Read-onlyIdempotent

GET /licenseKey.haveValidLicenseKey

Inputs: no named parameters.

licenseKey-updateEnterpriseSettingsD
Idempotent

POST /licenseKey.updateEnterpriseSettings

Inputs: enableEnterpriseFeatures.

licenseKey-validateD
Idempotent

POST /licenseKey.validate

Inputs: no named parameters.

mariadb-changePasswordD
Idempotent

POST /mariadb.changePassword

Inputs: mariadbId (required), password (required), type.

mariadb-changeStatusD
Idempotent

POST /mariadb.changeStatus

Inputs: mariadbId (required), applicationStatus (required).

mariadb-createD

POST /mariadb.create

Inputs: name (required), environmentId (required), databaseName (required), databaseUser (required), +6 more.

mariadb-deployD
Idempotent

POST /mariadb.deploy

Inputs: mariadbId (required).

mariadb-moveD
Idempotent

POST /mariadb.move

Inputs: mariadbId (required), targetEnvironmentId (required).

mariadb-oneD
Read-onlyIdempotent

GET /mariadb.one

Inputs: mariadbId (required).

mariadb-readLogsD
Read-onlyIdempotent

GET /mariadb.readLogs

Inputs: mariadbId (required), tail, since, search.

mariadb-rebuildD
Idempotent

POST /mariadb.rebuild

Inputs: mariadbId (required).

mariadb-reloadD
Idempotent

POST /mariadb.reload

Inputs: mariadbId (required), appName (required).

mariadb-removeD
Destructive

POST /mariadb.remove

Inputs: mariadbId (required).

mariadb-saveEnvironmentD
Idempotent

POST /mariadb.saveEnvironment

Inputs: mariadbId (required), env (required).

mariadb-saveExternalPortD
Idempotent

POST /mariadb.saveExternalPort

Inputs: mariadbId (required), externalPort (required).

mariadb-startD
Idempotent

POST /mariadb.start

Inputs: mariadbId (required).

mariadb-stopD
Idempotent

POST /mariadb.stop

Inputs: mariadbId (required).

mariadb-updateD
Idempotent

POST /mariadb.update

Inputs: mariadbId (required), name, appName, description, +28 more.

mongo-changePasswordD
Idempotent

POST /mongo.changePassword

Inputs: mongoId (required), password (required).

mongo-changeStatusD
Idempotent

POST /mongo.changeStatus

Inputs: mongoId (required), applicationStatus (required).

mongo-createD

POST /mongo.create

Inputs: name (required), environmentId (required), databaseUser (required), databasePassword (required), +5 more.

mongo-deployD
Idempotent

POST /mongo.deploy

Inputs: mongoId (required).

mongo-moveD
Idempotent

POST /mongo.move

Inputs: mongoId (required), targetEnvironmentId (required).

mongo-oneD
Read-onlyIdempotent

GET /mongo.one

Inputs: mongoId (required).

mongo-readLogsD
Read-onlyIdempotent

GET /mongo.readLogs

Inputs: mongoId (required), tail, since, search.

mongo-rebuildD
Idempotent

POST /mongo.rebuild

Inputs: mongoId (required).

mongo-reloadD
Idempotent

POST /mongo.reload

Inputs: mongoId (required), appName (required).

mongo-removeD
Destructive

POST /mongo.remove

Inputs: mongoId (required).

mongo-saveEnvironmentD
Idempotent

POST /mongo.saveEnvironment

Inputs: mongoId (required), env (required).

mongo-saveExternalPortD
Idempotent

POST /mongo.saveExternalPort

Inputs: mongoId (required), externalPort (required).

mongo-startD
Idempotent

POST /mongo.start

Inputs: mongoId (required).

mongo-stopD
Idempotent

POST /mongo.stop

Inputs: mongoId (required).

mongo-updateD
Idempotent

POST /mongo.update

Inputs: mongoId (required), name, appName, description, +27 more.

mounts-allNamedByApplicationIdD
Read-onlyIdempotent

GET /mounts.allNamedByApplicationId

Inputs: applicationId (required).

mounts-createD

POST /mounts.create

Inputs: type (required), mountPath (required), serviceId (required), hostPath, +4 more.

mounts-listByServiceIdD
Read-onlyIdempotent

GET /mounts.listByServiceId

Inputs: serviceType (required), serviceId (required).

mounts-oneD
Read-onlyIdempotent

GET /mounts.one

Inputs: mountId (required).

mounts-removeD
Destructive

POST /mounts.remove

Inputs: mountId (required).

mounts-updateD
Idempotent

POST /mounts.update

Inputs: mountId (required), type, hostPath, volumeName, +12 more.

mysql-changePasswordD
Idempotent

POST /mysql.changePassword

Inputs: mysqlId (required), password (required), type.

mysql-changeStatusD
Idempotent

POST /mysql.changeStatus

Inputs: mysqlId (required), applicationStatus (required).

mysql-createD

POST /mysql.create

Inputs: name (required), environmentId (required), databaseName (required), databaseUser (required), +6 more.

mysql-deployD
Idempotent

POST /mysql.deploy

Inputs: mysqlId (required).

mysql-moveD
Idempotent

POST /mysql.move

Inputs: mysqlId (required), targetEnvironmentId (required).

mysql-oneD
Read-onlyIdempotent

GET /mysql.one

Inputs: mysqlId (required).

mysql-readLogsD
Read-onlyIdempotent

GET /mysql.readLogs

Inputs: mysqlId (required), tail, since, search.

mysql-rebuildD
Idempotent

POST /mysql.rebuild

Inputs: mysqlId (required).

mysql-reloadD
Idempotent

POST /mysql.reload

Inputs: mysqlId (required), appName (required).

mysql-removeD
Destructive

POST /mysql.remove

Inputs: mysqlId (required).

mysql-saveEnvironmentD
Idempotent

POST /mysql.saveEnvironment

Inputs: mysqlId (required), env (required).

mysql-saveExternalPortD
Idempotent

POST /mysql.saveExternalPort

Inputs: mysqlId (required), externalPort (required).

mysql-startD
Idempotent

POST /mysql.start

Inputs: mysqlId (required).

mysql-stopD
Idempotent

POST /mysql.stop

Inputs: mysqlId (required).

mysql-updateD
Idempotent

POST /mysql.update

Inputs: mysqlId (required), name, appName, description, +28 more.

notification-allD
Read-onlyIdempotent

GET /notification.all

Inputs: no named parameters.

notification-createCustomD

POST /notification.createCustom

Inputs: name (required), endpoint (required), appBuildError, databaseBackup, +7 more.

notification-createDiscordD

POST /notification.createDiscord

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +7 more.

notification-createEmailD

POST /notification.createEmail

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +11 more.

notification-createGotifyD

POST /notification.createGotify

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +8 more.

notification-createLarkD

POST /notification.createLark

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +6 more.

notification-createMattermostD

POST /notification.createMattermost

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +8 more.

notification-createNtfyD

POST /notification.createNtfy

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +8 more.

notification-createPushoverD

POST /notification.createPushover

Inputs: name (required), userKey (required), apiToken (required), appBuildError, +10 more.

notification-createResendD

POST /notification.createResend

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +8 more.

notification-createSlackD

POST /notification.createSlack

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +7 more.

notification-createTeamsD

POST /notification.createTeams

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +6 more.

notification-createTelegramD

POST /notification.createTelegram

Inputs: appBuildError (required), databaseBackup (required), dokployBackup (required), volumeBackup (required), +8 more.

notification-getEmailProvidersD
Read-onlyIdempotent

GET /notification.getEmailProviders

Inputs: no named parameters.

notification-oneC
Read-onlyIdempotent

GET /notification.one

Inputs: notificationId (required).

notification-receiveNotificationD
Idempotent

POST /notification.receiveNotification

Inputs: Type (required), Value (required), Threshold (required), Message (required), +3 more.

notification-removeD
Destructive

POST /notification.remove

Inputs: notificationId (required).

notification-testCustomConnectionD
Idempotent

POST /notification.testCustomConnection

Inputs: endpoint (required), headers.

notification-testDiscordConnectionD
Idempotent

POST /notification.testDiscordConnection

Inputs: webhookUrl (required), decoration.

notification-testEmailConnectionD
Idempotent

POST /notification.testEmailConnection

Inputs: smtpServer (required), smtpPort (required), username (required), password (required), +2 more.

notification-testGotifyConnectionD
Idempotent

POST /notification.testGotifyConnection

Inputs: serverUrl (required), appToken (required), priority (required), decoration.

notification-testLarkConnectionD
Idempotent

POST /notification.testLarkConnection

Inputs: webhookUrl (required).

notification-testMattermostConnectionD
Idempotent

POST /notification.testMattermostConnection

Inputs: webhookUrl (required), channel, username.

notification-testNtfyConnectionD
Idempotent

POST /notification.testNtfyConnection

Inputs: serverUrl (required), topic (required), accessToken (required), priority (required).

notification-testPushoverConnectionD
Idempotent

POST /notification.testPushoverConnection

Inputs: userKey (required), apiToken (required), priority (required), retry, +1 more.

notification-testResendConnectionD
Idempotent

POST /notification.testResendConnection

Inputs: apiKey (required), fromAddress (required), toAddresses (required).

notification-testSlackConnectionD
Idempotent

POST /notification.testSlackConnection

Inputs: webhookUrl (required), channel (required).

notification-testTeamsConnectionD
Idempotent

POST /notification.testTeamsConnection

Inputs: webhookUrl (required).

notification-testTelegramConnectionD
Idempotent

POST /notification.testTelegramConnection

Inputs: botToken (required), chatId (required), messageThreadId (required).

notification-updateCustomD
Idempotent

POST /notification.updateCustom

Inputs: notificationId (required), customId (required), appBuildError, databaseBackup, +10 more.

notification-updateDiscordD
Idempotent

POST /notification.updateDiscord

Inputs: notificationId (required), discordId (required), appBuildError, databaseBackup, +10 more.

notification-updateEmailD
Idempotent

POST /notification.updateEmail

Inputs: notificationId (required), emailId (required), appBuildError, databaseBackup, +14 more.

notification-updateGotifyD
Idempotent

POST /notification.updateGotify

Inputs: notificationId (required), gotifyId (required), appBuildError, databaseBackup, +11 more.

notification-updateLarkD
Idempotent

POST /notification.updateLark

Inputs: notificationId (required), larkId (required), appBuildError, databaseBackup, +9 more.

notification-updateMattermostD
Idempotent

POST /notification.updateMattermost

Inputs: notificationId (required), mattermostId (required), appBuildError, databaseBackup, +11 more.

notification-updateNtfyD
Idempotent

POST /notification.updateNtfy

Inputs: notificationId (required), ntfyId (required), appBuildError, databaseBackup, +11 more.

notification-updatePushoverD
Idempotent

POST /notification.updatePushover

Inputs: notificationId (required), pushoverId (required), organizationId, userKey, +13 more.

notification-updateResendD
Idempotent

POST /notification.updateResend

Inputs: notificationId (required), resendId (required), appBuildError, databaseBackup, +11 more.

notification-updateSlackD
Idempotent

POST /notification.updateSlack

Inputs: notificationId (required), slackId (required), appBuildError, databaseBackup, +10 more.

notification-updateTeamsD
Idempotent

POST /notification.updateTeams

Inputs: notificationId (required), teamsId (required), appBuildError, databaseBackup, +9 more.

notification-updateTelegramD
Idempotent

POST /notification.updateTelegram

Inputs: notificationId (required), telegramId (required), appBuildError, databaseBackup, +11 more.

organization-activeD
Read-onlyIdempotent

GET /organization.active

Inputs: no named parameters.

organization-allC
Read-onlyIdempotent

GET /organization.all

Inputs: no named parameters.

organization-allInvitationsC
Read-onlyIdempotent

GET /organization.allInvitations

Inputs: no named parameters.

organization-createD

POST /organization.create

Inputs: name (required), logo.

organization-deleteD
Destructive

POST /organization.delete

Inputs: organizationId (required).

organization-inviteMemberD
Idempotent

POST /organization.inviteMember

Inputs: email (required), role (required).

organization-oneD
Read-onlyIdempotent

GET /organization.one

Inputs: organizationId (required).

organization-removeInvitationD
Destructive

POST /organization.removeInvitation

Inputs: invitationId (required).

organization-setDefaultD
Idempotent

POST /organization.setDefault

Inputs: organizationId (required).

organization-updateD
Idempotent

POST /organization.update

Inputs: organizationId (required), name (required), logo.

organization-updateMemberRoleD
Idempotent

POST /organization.updateMemberRole

Inputs: memberId (required), role (required).

patch-byEntityIdC
Read-onlyIdempotent

GET /patch.byEntityId

Inputs: id (required), type (required).

patch-cleanPatchReposD
Idempotent

POST /patch.cleanPatchRepos

Inputs: serverId.

patch-createD

POST /patch.create

Inputs: filePath (required), content (required), type, enabled, +2 more.

patch-deleteD
Destructive

POST /patch.delete

Inputs: patchId (required).

patch-ensureRepoD
Idempotent

POST /patch.ensureRepo

Inputs: id (required), type (required).

patch-markFileForDeletionD
Idempotent

POST /patch.markFileForDeletion

Inputs: id (required), type (required), filePath (required).

patch-oneD
Read-onlyIdempotent

GET /patch.one

Inputs: patchId (required).

patch-readRepoDirectoriesD
Read-onlyIdempotent

GET /patch.readRepoDirectories

Inputs: id (required), type (required), repoPath (required).

patch-readRepoFileD
Read-onlyIdempotent

GET /patch.readRepoFile

Inputs: id (required), type (required), filePath (required).

patch-saveFileAsPatchD
Idempotent

POST /patch.saveFileAsPatch

Inputs: id (required), type (required), filePath (required), content (required), +1 more.

patch-toggleEnabledD
Idempotent

POST /patch.toggleEnabled

Inputs: patchId (required), enabled (required).

patch-updateD
Idempotent

POST /patch.update

Inputs: patchId (required), type, filePath, enabled, +3 more.

port-createD

POST /port.create

Inputs: publishedPort (required), targetPort (required), applicationId (required), publishMode, +1 more.

port-deleteD
Destructive

POST /port.delete

Inputs: portId (required).

port-oneC
Read-onlyIdempotent

GET /port.one

Inputs: portId (required).

port-updateD
Idempotent

POST /port.update

Inputs: portId (required), publishedPort (required), targetPort (required), publishMode, +1 more.

postgres-changePasswordD
Idempotent

POST /postgres.changePassword

Inputs: postgresId (required), password (required).

postgres-changeStatusD
Idempotent

POST /postgres.changeStatus

Inputs: postgresId (required), applicationStatus (required).

postgres-createD

POST /postgres.create

Inputs: name (required), databaseName (required), databaseUser (required), databasePassword (required), +5 more.

postgres-deployD
Idempotent

POST /postgres.deploy

Inputs: postgresId (required).

postgres-moveD
Idempotent

POST /postgres.move

Inputs: postgresId (required), targetEnvironmentId (required).

postgres-oneC
Read-onlyIdempotent

GET /postgres.one

Inputs: postgresId (required).

postgres-readLogsD
Read-onlyIdempotent

GET /postgres.readLogs

Inputs: postgresId (required), tail, since, search.

postgres-rebuildD
Idempotent

POST /postgres.rebuild

Inputs: postgresId (required).

postgres-reloadD
Idempotent

POST /postgres.reload

Inputs: postgresId (required), appName (required).

postgres-removeD
Destructive

POST /postgres.remove

Inputs: postgresId (required).

postgres-saveEnvironmentD
Idempotent

POST /postgres.saveEnvironment

Inputs: postgresId (required), env (required).

postgres-saveExternalPortD
Idempotent

POST /postgres.saveExternalPort

Inputs: postgresId (required), externalPort (required).

postgres-startD
Idempotent

POST /postgres.start

Inputs: postgresId (required).

postgres-stopD
Idempotent

POST /postgres.stop

Inputs: postgresId (required).

postgres-updateD
Idempotent

POST /postgres.update

Inputs: postgresId (required), name, appName, databaseName, +27 more.

previewDeployment-allD
Read-onlyIdempotent

GET /previewDeployment.all

Inputs: applicationId (required).

previewDeployment-deleteD
Destructive

POST /previewDeployment.delete

Inputs: previewDeploymentId (required).

previewDeployment-oneC
Read-onlyIdempotent

GET /previewDeployment.one

Inputs: previewDeploymentId (required).

previewDeployment-redeployD
Idempotent

POST /previewDeployment.redeploy

Inputs: previewDeploymentId (required), title, description.

project-allB
Read-onlyIdempotent

GET /project.all

Inputs: no named parameters.

project-allForPermissionsC
Read-onlyIdempotent

GET /project.allForPermissions

Inputs: no named parameters.

project-createD

POST /project.create

Inputs: name (required), description, env.

project-duplicateD
Idempotent

POST /project.duplicate

Inputs: sourceEnvironmentId (required), name (required), description, includeServices, +2 more.

projectEnvironment-getA
Read-onlyIdempotent

Get environment variables for a project. Returns normalized envMap plus the reconstructed envText.

Inputs: projectId (required).

projectEnvironment-saveB
Idempotent

Save (update) environment variables for a project. The env parameter can be a string in KEY=VALUE format or an object map of env keys to values.

Inputs: projectId (required), env (required).

project-oneD
Read-onlyIdempotent

GET /project.one

Inputs: projectId (required).

project-removeD
Destructive

POST /project.remove

Inputs: projectId (required).

project-updateD
Idempotent

POST /project.update

Inputs: projectId (required), name, description, createdAt, +2 more.

redirects-createD

POST /redirects.create

Inputs: regex (required), replacement (required), permanent (required), applicationId (required).

redirects-deleteD
Destructive

POST /redirects.delete

Inputs: redirectId (required).

redirects-oneD
Read-onlyIdempotent

GET /redirects.one

Inputs: redirectId (required).

redirects-updateD
Idempotent

POST /redirects.update

Inputs: redirectId (required), regex (required), replacement (required), permanent (required).

redis-changePasswordC
Idempotent

POST /redis.changePassword

Inputs: redisId (required), password (required).

redis-changeStatusD
Idempotent

POST /redis.changeStatus

Inputs: redisId (required), applicationStatus (required).

redis-createD

POST /redis.create

Inputs: name (required), databasePassword (required), environmentId (required), appName, +3 more.

redis-deployD
Idempotent

POST /redis.deploy

Inputs: redisId (required).

redis-moveD
Idempotent

POST /redis.move

Inputs: redisId (required), targetEnvironmentId (required).

redis-oneD
Read-onlyIdempotent

GET /redis.one

Inputs: redisId (required).

redis-readLogsD
Read-onlyIdempotent

GET /redis.readLogs

Inputs: redisId (required), tail, since, search.

redis-rebuildD
Idempotent

POST /redis.rebuild

Inputs: redisId (required).

redis-reloadD
Idempotent

POST /redis.reload

Inputs: redisId (required), appName (required).

redis-removeD
Destructive

POST /redis.remove

Inputs: redisId (required).

redis-saveEnvironmentD
Idempotent

POST /redis.saveEnvironment

Inputs: redisId (required), env (required).

redis-saveExternalPortD
Idempotent

POST /redis.saveExternalPort

Inputs: redisId (required), externalPort (required).

redis-startD
Idempotent

POST /redis.start

Inputs: redisId (required).

redis-stopD
Idempotent

POST /redis.stop

Inputs: redisId (required).

redis-updateD
Idempotent

POST /redis.update

Inputs: redisId (required), name, appName, description, +25 more.

registry-allC
Read-onlyIdempotent

GET /registry.all

Inputs: no named parameters.

registry-createD

POST /registry.create

Inputs: registryName (required), username (required), password (required), registryUrl (required), +3 more.

registry-oneD
Read-onlyIdempotent

GET /registry.one

Inputs: registryId (required).

registry-removeD
Destructive

POST /registry.remove

Inputs: registryId (required).

registry-testRegistryD
Idempotent

POST /registry.testRegistry

Inputs: username (required), password (required), registryUrl (required), registryType (required), +3 more.

registry-testRegistryByIdD
Idempotent

POST /registry.testRegistryById

Inputs: registryId, serverId.

registry-updateD
Idempotent

POST /registry.update

Inputs: registryId (required), registryName, imagePrefix, username, +6 more.

rollback-deleteD
Destructive

POST /rollback.delete

Inputs: rollbackId (required).

rollback-rollbackD
Idempotent

POST /rollback.rollback

Inputs: rollbackId (required).

schedule-createD

POST /schedule.create

Inputs: name (required), cronExpression (required), command (required), scheduleId, +12 more.

schedule-deleteD
Destructive

POST /schedule.delete

Inputs: scheduleId (required).

schedule-listD
Read-onlyIdempotent

GET /schedule.list

Inputs: id (required), scheduleType (required).

schedule-oneD
Read-onlyIdempotent

GET /schedule.one

Inputs: scheduleId (required).

schedule-runManuallyD
Idempotent

POST /schedule.runManually

Inputs: scheduleId (required).

schedule-updateD
Idempotent

POST /schedule.update

Inputs: scheduleId (required), name (required), cronExpression (required), command (required), +12 more.

security-createD

POST /security.create

Inputs: applicationId (required), username (required), password (required).

security-deleteD
Destructive

POST /security.delete

Inputs: securityId (required).

security-oneC
Read-onlyIdempotent

GET /security.one

Inputs: securityId (required).

security-updateD
Idempotent

POST /security.update

Inputs: securityId (required), username (required), password (required).

server-allC
Read-onlyIdempotent

GET /server.all

Inputs: no named parameters.

server-allForPermissionsC
Read-onlyIdempotent

GET /server.allForPermissions

Inputs: no named parameters.

server-buildServersD
Read-onlyIdempotent

GET /server.buildServers

Inputs: no named parameters.

server-countD
Read-onlyIdempotent

GET /server.count

Inputs: no named parameters.

server-createD

POST /server.create

Inputs: name (required), description (required), ipAddress (required), port (required), +3 more.

server-getDefaultCommandD
Read-onlyIdempotent

GET /server.getDefaultCommand

Inputs: serverId (required).

server-getServerMetricsD
Read-onlyIdempotent

GET /server.getServerMetrics

Inputs: url (required), token (required), dataPoints (required).

server-getServerTimeC
Read-onlyIdempotent

GET /server.getServerTime

Inputs: no named parameters.

server-oneD
Read-onlyIdempotent

GET /server.one

Inputs: serverId (required).

server-publicIpC
Read-onlyIdempotent

GET /server.publicIp

Inputs: no named parameters.

server-removeD
Destructive

POST /server.remove

Inputs: serverId (required).

server-securityD
Read-onlyIdempotent

GET /server.security

Inputs: serverId (required).

server-setupD
Idempotent

POST /server.setup

Inputs: serverId (required).

server-setupMonitoringD
Idempotent

POST /server.setupMonitoring

Inputs: serverId (required), metricsConfig (required).

server-updateD
Idempotent

POST /server.update

Inputs: name (required), description (required), serverId (required), ipAddress (required), +5 more.

server-validateD
Read-onlyIdempotent

GET /server.validate

Inputs: serverId (required).

server-withSSHKeyD
Read-onlyIdempotent

GET /server.withSSHKey

Inputs: no named parameters.

serviceEnvironment-getA
Read-onlyIdempotent

Get environment variables for a service (application, compose, postgres, mysql, mongo, redis, mariadb, or libsql). Returns normalized envMap plus the reconstructed envText.

Inputs: serviceType (required), serviceId (required).

serviceEnvironment-saveB
Idempotent

Save (update) environment variables for a service. The env parameter can be a string in KEY=VALUE format or an object map of env keys to values.

Inputs: serviceType (required), serviceId (required), env (required).

settings-assignDomainServerD
Idempotent

POST /settings.assignDomainServer

Inputs: host (required), certificateType (required), letsEncryptEmail, https.

settings-checkGPUStatusD
Read-onlyIdempotent

GET /settings.checkGPUStatus

Inputs: serverId.

settings-checkInfrastructureHealthD
Read-onlyIdempotent

GET /settings.checkInfrastructureHealth

Inputs: no named parameters.

settings-cleanAllD
Idempotent

POST /settings.cleanAll

Inputs: serverId.

settings-cleanAllDeploymentQueueD
Idempotent

POST /settings.cleanAllDeploymentQueue

Inputs: no named parameters.

settings-cleanDockerBuilderD
Idempotent

POST /settings.cleanDockerBuilder

Inputs: serverId.

settings-cleanDockerPruneD
Idempotent

POST /settings.cleanDockerPrune

Inputs: serverId.

settings-cleanMonitoringD
Idempotent

POST /settings.cleanMonitoring

Inputs: no named parameters.

settings-cleanRedisD
Idempotent

POST /settings.cleanRedis

Inputs: no named parameters.

settings-cleanSSHPrivateKeyD
Idempotent

POST /settings.cleanSSHPrivateKey

Inputs: no named parameters.

settings-cleanStoppedContainersD
Idempotent

POST /settings.cleanStoppedContainers

Inputs: serverId.

settings-cleanUnusedImagesD
Idempotent

POST /settings.cleanUnusedImages

Inputs: serverId.

settings-cleanUnusedVolumesD
Idempotent

POST /settings.cleanUnusedVolumes

Inputs: serverId.

settings-getDockerDiskUsageD
Read-onlyIdempotent

GET /settings.getDockerDiskUsage

Inputs: no named parameters.

settings-getDokployCloudIpsC
Read-onlyIdempotent

GET /settings.getDokployCloudIps

Inputs: no named parameters.

settings-getDokployVersionC
Read-onlyIdempotent

GET /settings.getDokployVersion

Inputs: no named parameters.

settings-getIpC
Read-onlyIdempotent

GET /settings.getIp

Inputs: no named parameters.

settings-getLogCleanupStatusC
Read-onlyIdempotent

GET /settings.getLogCleanupStatus

Inputs: no named parameters.

settings-getOpenApiDocumentD
Read-onlyIdempotent

GET /settings.getOpenApiDocument

Inputs: no named parameters.

settings-getReleaseTagD
Read-onlyIdempotent

GET /settings.getReleaseTag

Inputs: no named parameters.

settings-getTraefikPortsD
Read-onlyIdempotent

GET /settings.getTraefikPorts

Inputs: serverId.

settings-getUpdateDataD
Idempotent

POST /settings.getUpdateData

Inputs: no named parameters.

settings-getWebServerSettingsC
Read-onlyIdempotent

GET /settings.getWebServerSettings

Inputs: no named parameters.

settings-haveActivateRequestsD
Read-onlyIdempotent

GET /settings.haveActivateRequests

Inputs: no named parameters.

settings-haveTraefikDashboardPortEnabledD
Read-onlyIdempotent

GET /settings.haveTraefikDashboardPortEnabled

Inputs: serverId.

settings-healthC
Read-onlyIdempotent

GET /settings.health

Inputs: no named parameters.

settings-isCloudD
Read-onlyIdempotent

GET /settings.isCloud

Inputs: no named parameters.

settings-isUserSubscribedC
Read-onlyIdempotent

GET /settings.isUserSubscribed

Inputs: no named parameters.

settings-readDirectoriesD
Read-onlyIdempotent

GET /settings.readDirectories

Inputs: serverId.

settings-readMiddlewareTraefikConfigC
Read-onlyIdempotent

GET /settings.readMiddlewareTraefikConfig

Inputs: no named parameters.

settings-readTraefikConfigD
Read-onlyIdempotent

GET /settings.readTraefikConfig

Inputs: no named parameters.

settings-readTraefikEnvD
Read-onlyIdempotent

GET /settings.readTraefikEnv

Inputs: serverId.

settings-readTraefikFileD
Read-onlyIdempotent

GET /settings.readTraefikFile

Inputs: path (required), serverId.

settings-readWebServerTraefikConfigD
Read-onlyIdempotent

GET /settings.readWebServerTraefikConfig

Inputs: no named parameters.

settings-reloadRedisD
Idempotent

POST /settings.reloadRedis

Inputs: no named parameters.

settings-reloadServerD
Idempotent

POST /settings.reloadServer

Inputs: no named parameters.

settings-reloadTraefikD
Idempotent

POST /settings.reloadTraefik

Inputs: serverId.

settings-saveSSHPrivateKeyD
Idempotent

POST /settings.saveSSHPrivateKey

Inputs: sshPrivateKey (required).

settings-setupGPUD
Idempotent

POST /settings.setupGPU

Inputs: serverId.

settings-toggleDashboardD
Idempotent

POST /settings.toggleDashboard

Inputs: enableDashboard, serverId.

settings-toggleRequestsD
Idempotent

POST /settings.toggleRequests

Inputs: enable (required).

settings-updateDockerCleanupD
Idempotent

POST /settings.updateDockerCleanup

Inputs: enableDockerCleanup (required), serverId.

settings-updateLogCleanupD
Idempotent

POST /settings.updateLogCleanup

Inputs: cronExpression (required).

settings-updateMiddlewareTraefikConfigD
Idempotent

POST /settings.updateMiddlewareTraefikConfig

Inputs: traefikConfig (required).

settings-updateServerD
Idempotent

POST /settings.updateServer

Inputs: no named parameters.

settings-updateServerIpD
Idempotent

POST /settings.updateServerIp

Inputs: serverIp (required).

settings-updateTraefikConfigD
Idempotent

POST /settings.updateTraefikConfig

Inputs: traefikConfig (required).

settings-updateTraefikFileD
Idempotent

POST /settings.updateTraefikFile

Inputs: path (required), traefikConfig (required), serverId.

settings-updateTraefikPortsD
Idempotent

POST /settings.updateTraefikPorts

Inputs: additionalPorts (required), serverId.

settings-updateWebServerTraefikConfigD
Idempotent

POST /settings.updateWebServerTraefikConfig

Inputs: traefikConfig (required).

settings-writeTraefikEnvD
Idempotent

POST /settings.writeTraefikEnv

Inputs: env (required), serverId.

sshKey-allD
Read-onlyIdempotent

GET /sshKey.all

Inputs: no named parameters.

sshKey-allForAppsD
Read-onlyIdempotent

GET /sshKey.allForApps

Inputs: no named parameters.

sshKey-createD

POST /sshKey.create

Inputs: name (required), privateKey (required), publicKey (required), organizationId (required), +1 more.

sshKey-generateD
Idempotent

POST /sshKey.generate

Inputs: type.

sshKey-oneD
Read-onlyIdempotent

GET /sshKey.one

Inputs: sshKeyId (required).

sshKey-removeD
Destructive

POST /sshKey.remove

Inputs: sshKeyId (required).

sshKey-updateD
Idempotent

POST /sshKey.update

Inputs: sshKeyId (required), name, description, lastUsedAt.

sso-addTrustedOriginD
Idempotent

POST /sso.addTrustedOrigin

Inputs: origin (required).

sso-deleteProviderD
Destructive

POST /sso.deleteProvider

Inputs: providerId (required).

sso-getTrustedOriginsC
Read-onlyIdempotent

GET /sso.getTrustedOrigins

Inputs: no named parameters.

sso-listProvidersD
Read-onlyIdempotent

GET /sso.listProviders

Inputs: no named parameters.

sso-oneD
Read-onlyIdempotent

GET /sso.one

Inputs: providerId (required).

sso-registerD
Idempotent

POST /sso.register

Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.

sso-removeTrustedOriginD
Destructive

POST /sso.removeTrustedOrigin

Inputs: origin (required).

sso-showSignInWithSSOD
Read-onlyIdempotent

GET /sso.showSignInWithSSO

Inputs: no named parameters.

sso-updateD
Idempotent

POST /sso.update

Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.

sso-updateTrustedOriginD
Idempotent

POST /sso.updateTrustedOrigin

Inputs: oldOrigin (required), newOrigin (required).

stripe-canCreateMoreServersC
Read-onlyIdempotent

GET /stripe.canCreateMoreServers

Inputs: no named parameters.

stripe-createCheckoutSessionD

POST /stripe.createCheckoutSession

Inputs: tier (required), productId (required), serverQuantity (required), isAnnual (required).

stripe-createCustomerPortalSessionD

POST /stripe.createCustomerPortalSession

Inputs: no named parameters.

stripe-getCurrentPlanC
Read-onlyIdempotent

GET /stripe.getCurrentPlan

Inputs: no named parameters.

stripe-getInvoicesD
Read-onlyIdempotent

GET /stripe.getInvoices

Inputs: no named parameters.

stripe-getProductsD
Read-onlyIdempotent

GET /stripe.getProducts

Inputs: no named parameters.

stripe-upgradeSubscriptionD
Idempotent

POST /stripe.upgradeSubscription

Inputs: tier (required), serverQuantity (required), isAnnual (required).

swarm-getContainerStatsD
Read-onlyIdempotent

GET /swarm.getContainerStats

Inputs: serverId.

swarm-getNodeAppsD
Read-onlyIdempotent

GET /swarm.getNodeApps

Inputs: serverId.

swarm-getNodeInfoD
Read-onlyIdempotent

GET /swarm.getNodeInfo

Inputs: nodeId (required), serverId.

swarm-getNodesD
Read-onlyIdempotent

GET /swarm.getNodes

Inputs: serverId.

tag-allD
Read-onlyIdempotent

GET /tag.all

Inputs: no named parameters.

tag-assignToProjectD
Idempotent

POST /tag.assignToProject

Inputs: projectId (required), tagId (required).

tag-bulkAssignD
Idempotent

POST /tag.bulkAssign

Inputs: projectId (required), tagIds (required).

tag-createD

POST /tag.create

Inputs: name (required), color.

tag-oneC
Read-onlyIdempotent

GET /tag.one

Inputs: tagId (required).

tag-removeD
Destructive

POST /tag.remove

Inputs: tagId (required).

tag-removeFromProjectD
Destructive

POST /tag.removeFromProject

Inputs: projectId (required), tagId (required).

tag-updateD
Idempotent

POST /tag.update

Inputs: tagId (required), name, color, createdAt, +1 more.

user-allC
Read-onlyIdempotent

GET /user.all

Inputs: no named parameters.

user-assignPermissionsD
Idempotent

POST /user.assignPermissions

Inputs: id (required), accessedProjects (required), accessedEnvironments (required), accessedServices (required), +13 more.

user-checkUserOrganizationsD
Read-onlyIdempotent

GET /user.checkUserOrganizations

Inputs: userId (required).

user-createApiKeyD

POST /user.createApiKey

Inputs: name (required), metadata (required), prefix, expiresIn, +6 more.

user-createUserWithCredentialsD

POST /user.createUserWithCredentials

Inputs: email (required), password (required), role (required).

user-deleteApiKeyD
Destructive

POST /user.deleteApiKey

Inputs: apiKeyId (required).

user-generateTokenD
Idempotent

POST /user.generateToken

Inputs: no named parameters.

user-getC
Read-onlyIdempotent

GET /user.get

Inputs: no named parameters.

user-getBackupsD
Read-onlyIdempotent

GET /user.getBackups

Inputs: no named parameters.

user-getBookmarkedTemplatesC
Read-onlyIdempotent

GET /user.getBookmarkedTemplates

Inputs: no named parameters.

user-getContainerMetricsD
Read-onlyIdempotent

GET /user.getContainerMetrics

Inputs: url (required), token (required), appName (required), dataPoints (required).

user-getInvitationsD
Read-onlyIdempotent

GET /user.getInvitations

Inputs: no named parameters.

user-getMetricsTokenC
Read-onlyIdempotent

GET /user.getMetricsToken

Inputs: no named parameters.

user-getPermissionsD
Read-onlyIdempotent

GET /user.getPermissions

Inputs: no named parameters.

user-getServerMetricsD
Read-onlyIdempotent

GET /user.getServerMetrics

Inputs: no named parameters.

user-getUserByTokenC
Read-onlyIdempotent

GET /user.getUserByToken

Inputs: token (required).

user-haveRootAccessD
Read-onlyIdempotent

GET /user.haveRootAccess

Inputs: no named parameters.

user-oneC
Read-onlyIdempotent

GET /user.one

Inputs: userId (required).

user-removeC
Destructive

POST /user.remove

Inputs: userId (required).

user-sendInvitationD
Idempotent

POST /user.sendInvitation

Inputs: invitationId (required), notificationId (required).

user-sessionC
Read-onlyIdempotent

GET /user.session

Inputs: no named parameters.

user-toggleTemplateBookmarkD
Idempotent

POST /user.toggleTemplateBookmark

Inputs: templateId (required).

user-updateD
Idempotent

POST /user.update

Inputs: id, firstName, lastName, isRegistered, +20 more.

volumeBackups-createD

POST /volumeBackups.create

Inputs: name (required), volumeName (required), prefix (required), cronExpression (required), +16 more.

volumeBackups-deleteD
Destructive

POST /volumeBackups.delete

Inputs: volumeBackupId (required).

volumeBackups-listD
Read-onlyIdempotent

GET /volumeBackups.list

Inputs: id (required), volumeBackupType (required).

volumeBackups-oneD
Read-onlyIdempotent

GET /volumeBackups.one

Inputs: volumeBackupId (required).

volumeBackups-runManuallyD
Idempotent

POST /volumeBackups.runManually

Inputs: volumeBackupId (required).

volumeBackups-updateD
Idempotent

POST /volumeBackups.update

Inputs: name (required), volumeName (required), prefix (required), cronExpression (required), +17 more.

whitelabeling-getC
Read-onlyIdempotent

GET /whitelabeling.get

Inputs: no named parameters.

whitelabeling-getPublicC
Read-onlyIdempotent

GET /whitelabeling.getPublic

Inputs: no named parameters.

whitelabeling-resetC
Idempotent

POST /whitelabeling.reset

Inputs: no named parameters.

whitelabeling-updateD
Idempotent

POST /whitelabeling.update

Inputs: whitelabelingConfig (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    D1.8/5.0

    Scored across 523 tools

    Disambiguation2/5

    Although tools are grouped by resource prefix, there are many near-duplicate operations such as application-cancelDeployment, application-dropDeployment, application-cleanQueues, and application-clearDeployments, which are nearly indistinguishable from their names alone. The environment variable tools are also split confusingly across environment, projectEnvironment, and serviceEnvironment with overlapping purposes.

    Naming Consistency4/5

    The dominant resource-action hyphenated pattern is fairly consistent across the huge surface, e.g. application-create, application-update, application-delete. Minor deviations like projectEnvironment-get vs environment-get, user-get vs user-one, and compound camelCase resource names prevent a perfect score.

    Tool Count1/5

    523 tools is far beyond a reasonable MCP tool surface and creates extreme cognitive load and selection risk for agents. Even if the full API is broad, exposing every endpoint as an individual tool is not an appropriately scoped server design.

    Completeness4/5

    The tool set is extremely comprehensive, covering CRUD and lifecycle operations for applications, databases, backups, deployments, domains, notifications, settings, users, and more. Minor gaps exist, such as no dedicated deployment-by-id tool and no docker start/stop container operation, but these are workable around.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      Exposes Dokploy functionalities as tools consumable via the Model Context Protocol, allowing AI models and other applications to programmatically manage projects and applications on a Dokploy server.
      232 npm
      18
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables AI models to interact programmatically with Dokploy servers to manage projects, applications, and deployment services. It provides 67 specialized tools for direct Dokploy API operations through the Model Context Protocol.
      232 npm
      Apache 2.0
    • F
      license
      Not graded
      quality
      D
      maintenance
      Wraps the Dokploy REST API to expose Dokploy operations as MCP tools for managing projects, applications, compose stacks, deployments, domains, and environment variables.
      10 npm
      1
      -