Dokploy MCP Server
Allows managing applications deployed from Bitbucket repositories, including triggering builds and deployments.
Provides tools for managing Docker containers, images, and deployments within the Dokploy environment.
Allows managing applications deployed from Gitea repositories, including triggering builds and deployments.
Allows managing applications deployed from GitHub repositories, including triggering builds and deployments.
Allows managing applications deployed from GitLab repositories, including triggering builds and deployments.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Dokploy MCP Server show me my recent deployments"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Dokploy MCP Server
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/mcpThen 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 claudeInstall 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.
Build the Docker Image:
git clone https://github.com/Dokploy/mcp.git cd mcp docker build -t dokploy-mcp .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-mcpHTTP 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-mcpDocker Compose:
Use the provided
docker-compose.ymlfor production deployments:# Start HTTP service docker-compose up -d dokploy-mcp-http # View logs docker-compose logs -f dokploy-mcp-httpMCP 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 |
| Yes | Your Dokploy server URL (e.g., |
| Yes | Your Dokploy API authentication token |
| No | Comma-separated list of tags to filter which tools are loaded (e.g., |
| No | Request timeout in milliseconds (default: |
| No | Number of retry attempts (default: |
| No | Delay between retries in milliseconds (default: |
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/mcpHTTP 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/mcpModern Streamable HTTP Endpoints:
Endpoint | Method | Description |
| POST | Client-to-server requests |
| GET | Server-to-client notifications (SSE) |
| DELETE | Session termination |
| GET | Health check |
Legacy SSE Endpoints (Backwards Compatibility):
Endpoint | Method | Description |
| GET | SSE stream initialization |
| 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,postgresAll 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-getprojectEnvironment-saveserviceEnvironment-getserviceEnvironment-save
*-get tools return both forms:
envMap: object map inKEY -> VALUEformat for reliable agent parsing.envText: reconstructed.envstring format (KEY=VALUEper line).
*-save tools accept env in either format:
String:
.envtext (KEY=VALUElines)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:allTool Filtering: Load only the categories you need via
DOKPLOY_ENABLED_TAGSRobust 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 installBuild:
pnpm buildRegenerate tools from the Dokploy OpenAPI spec:
pnpm generate:allLocal 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/mcpTroubleshooting
MCP Client Errors
Try adding
@latestto the package name.Make sure you are using Node v18 or higher to have native fetch support with
npx.Verify your
DOKPLOY_URLandDOKPLOY_API_KEYenvironment variables are correctly set.If too many tools are loading, use
DOKPLOY_ENABLED_TAGSto 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 toolsadmin-setupMonitoringDIdempotent
POST /admin.setupMonitoring
Inputs: metricsConfig (required).
ai-analyzeLogsDIdempotent
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-deleteDDestructive
POST /ai.delete
Inputs: aiId (required).
ai-deployDIdempotent
POST /ai.deploy
Inputs: environmentId (required), id (required), dockerCompose (required), envVariables (required), +5 more.
ai-getDRead-onlyIdempotent
GET /ai.get
Inputs: aiId (required).
ai-getAllCRead-onlyIdempotent
GET /ai.getAll
Inputs: no named parameters.
ai-getEnabledProvidersDRead-onlyIdempotent
GET /ai.getEnabledProviders
Inputs: no named parameters.
ai-getModelsDRead-onlyIdempotent
GET /ai.getModels
Inputs: apiUrl (required), apiKey (required).
ai-oneDRead-onlyIdempotent
GET /ai.one
Inputs: aiId (required).
ai-suggestDIdempotent
POST /ai.suggest
Inputs: aiId (required), input (required), serverId.
ai-testConnectionDIdempotent
POST /ai.testConnection
Inputs: apiUrl (required), apiKey (required), model (required).
ai-updateCIdempotent
POST /ai.update
Inputs: aiId (required), name, apiUrl, apiKey, +3 more.
application-cancelDeploymentDIdempotent
POST /application.cancelDeployment
Inputs: applicationId (required).
application-cleanQueuesDIdempotent
POST /application.cleanQueues
Inputs: applicationId (required).
application-clearDeploymentsDIdempotent
POST /application.clearDeployments
Inputs: applicationId (required).
application-createD
POST /application.create
Inputs: name (required), environmentId (required), appName, description, +1 more.
application-deleteDDestructive
POST /application.delete
Inputs: applicationId (required).
application-deployDIdempotent
POST /application.deploy
Inputs: applicationId (required), title, description.
application-disconnectGitProviderDIdempotent
POST /application.disconnectGitProvider
Inputs: applicationId (required).
application-dropDeploymentDIdempotent
POST /application.dropDeployment
Inputs: no named parameters.
application-killBuildDIdempotent
POST /application.killBuild
Inputs: applicationId (required).
application-markRunningDIdempotent
POST /application.markRunning
Inputs: applicationId (required).
application-moveDIdempotent
POST /application.move
Inputs: applicationId (required), targetEnvironmentId (required).
application-oneDRead-onlyIdempotent
GET /application.one
Inputs: applicationId (required).
application-readAppMonitoringDRead-onlyIdempotent
GET /application.readAppMonitoring
Inputs: appName (required).
application-readLogsDRead-onlyIdempotent
GET /application.readLogs
Inputs: applicationId (required), tail, since, search.
application-readTraefikConfigCRead-onlyIdempotent
GET /application.readTraefikConfig
Inputs: applicationId (required).
application-redeployDIdempotent
POST /application.redeploy
Inputs: applicationId (required), title, description.
application-refreshTokenDIdempotent
POST /application.refreshToken
Inputs: applicationId (required).
application-reloadCIdempotent
POST /application.reload
Inputs: appName (required), applicationId (required).
application-saveBitbucketProviderDIdempotent
POST /application.saveBitbucketProvider
Inputs: bitbucketBranch (required), bitbucketBuildPath (required), bitbucketOwner (required), bitbucketRepository (required), +5 more.
application-saveBuildTypeDIdempotent
POST /application.saveBuildType
Inputs: applicationId (required), buildType (required), dockerfile (required), dockerContextPath (required), +5 more.
application-saveDockerProviderDIdempotent
POST /application.saveDockerProvider
Inputs: dockerImage (required), applicationId (required), username (required), password (required), +1 more.
application-saveEnvironmentDIdempotent
POST /application.saveEnvironment
Inputs: applicationId (required), env (required), buildArgs (required), buildSecrets (required), +1 more.
application-saveGiteaProviderDIdempotent
POST /application.saveGiteaProvider
Inputs: applicationId (required), giteaBranch (required), giteaBuildPath (required), giteaOwner (required), +4 more.
application-saveGithubProviderDIdempotent
POST /application.saveGithubProvider
Inputs: applicationId (required), repository (required), branch (required), owner (required), +5 more.
application-saveGitlabProviderDIdempotent
POST /application.saveGitlabProvider
Inputs: applicationId (required), gitlabBranch (required), gitlabBuildPath (required), gitlabOwner (required), +6 more.
application-saveGitProviderDIdempotent
POST /application.saveGitProvider
Inputs: customGitBranch (required), applicationId (required), customGitBuildPath (required), customGitUrl (required), +3 more.
application-searchDRead-onlyIdempotent
GET /application.search
Inputs: q, name, appName, description, +7 more.
application-startDIdempotent
POST /application.start
Inputs: applicationId (required).
application-stopDIdempotent
POST /application.stop
Inputs: applicationId (required).
application-updateDIdempotent
POST /application.update
Inputs: applicationId (required), name, appName, description, +94 more.
application-updateTraefikConfigDIdempotent
POST /application.updateTraefikConfig
Inputs: applicationId (required), traefikConfig (required).
auditLog-allDRead-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-listBackupFilesDRead-onlyIdempotent
GET /backup.listBackupFiles
Inputs: destinationId (required), search (required), serverId.
backup-manualBackupComposeDIdempotent
POST /backup.manualBackupCompose
Inputs: backupId (required).
backup-manualBackupLibsqlDIdempotent
POST /backup.manualBackupLibsql
Inputs: backupId (required).
backup-manualBackupMariadbDIdempotent
POST /backup.manualBackupMariadb
Inputs: backupId (required).
backup-manualBackupMongoDIdempotent
POST /backup.manualBackupMongo
Inputs: backupId (required).
backup-manualBackupMySqlDIdempotent
POST /backup.manualBackupMySql
Inputs: backupId (required).
backup-manualBackupPostgresDIdempotent
POST /backup.manualBackupPostgres
Inputs: backupId (required).
backup-manualBackupWebServerCIdempotent
POST /backup.manualBackupWebServer
Inputs: backupId (required).
backup-oneDRead-onlyIdempotent
GET /backup.one
Inputs: backupId (required).
backup-removeDDestructive
POST /backup.remove
Inputs: backupId (required).
backup-updateDIdempotent
POST /backup.update
Inputs: schedule (required), enabled (required), prefix (required), backupId (required), +6 more.
bitbucket-bitbucketProvidersDRead-onlyIdempotent
GET /bitbucket.bitbucketProviders
Inputs: no named parameters.
bitbucket-createD
POST /bitbucket.create
Inputs: authId (required), name (required), bitbucketId, bitbucketUsername, +5 more.
bitbucket-getBitbucketBranchesDRead-onlyIdempotent
GET /bitbucket.getBitbucketBranches
Inputs: owner (required), repo (required), bitbucketId.
bitbucket-getBitbucketRepositoriesDRead-onlyIdempotent
GET /bitbucket.getBitbucketRepositories
Inputs: bitbucketId (required).
bitbucket-oneDRead-onlyIdempotent
GET /bitbucket.one
Inputs: bitbucketId (required).
bitbucket-testConnectionDIdempotent
POST /bitbucket.testConnection
Inputs: bitbucketId (required), bitbucketUsername, bitbucketEmail, workspaceName, +2 more.
bitbucket-updateDIdempotent
POST /bitbucket.update
Inputs: bitbucketId (required), gitProviderId (required), name (required), bitbucketUsername, +5 more.
certificates-allCRead-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-oneDRead-onlyIdempotent
GET /certificates.one
Inputs: certificateId (required).
certificates-removeDDestructive
POST /certificates.remove
Inputs: certificateId (required).
certificates-updateDIdempotent
POST /certificates.update
Inputs: certificateId (required), name, certificateData, privateKey.
cluster-addManagerDRead-onlyIdempotent
GET /cluster.addManager
Inputs: serverId.
cluster-addWorkerDRead-onlyIdempotent
GET /cluster.addWorker
Inputs: serverId.
cluster-getNodesDRead-onlyIdempotent
GET /cluster.getNodes
Inputs: serverId.
cluster-removeWorkerDDestructive
POST /cluster.removeWorker
Inputs: nodeId (required), serverId.
compose-cancelDeploymentDIdempotent
POST /compose.cancelDeployment
Inputs: composeId (required).
compose-cleanQueuesDIdempotent
POST /compose.cleanQueues
Inputs: composeId (required).
compose-clearDeploymentsDIdempotent
POST /compose.clearDeployments
Inputs: composeId (required).
compose-createD
POST /compose.create
Inputs: name (required), environmentId (required), description, composeType, +3 more.
compose-deleteDDestructive
POST /compose.delete
Inputs: composeId (required), deleteVolumes (required).
compose-deployDIdempotent
POST /compose.deploy
Inputs: composeId (required), title, description.
compose-deployTemplateDIdempotent
POST /compose.deployTemplate
Inputs: environmentId (required), id (required), serverId, baseUrl.
compose-disconnectGitProviderDIdempotent
POST /compose.disconnectGitProvider
Inputs: composeId (required).
compose-fetchSourceTypeDIdempotent
POST /compose.fetchSourceType
Inputs: composeId (required).
compose-getConvertedComposeDRead-onlyIdempotent
GET /compose.getConvertedCompose
Inputs: composeId (required).
compose-getDefaultCommandDRead-onlyIdempotent
GET /compose.getDefaultCommand
Inputs: composeId (required).
compose-getTagsDRead-onlyIdempotent
GET /compose.getTags
Inputs: baseUrl.
compose-importDIdempotent
POST /compose.import
Inputs: base64 (required), composeId (required).
compose-isolatedDeploymentDIdempotent
POST /compose.isolatedDeployment
Inputs: composeId (required), suffix.
compose-killBuildDIdempotent
POST /compose.killBuild
Inputs: composeId (required).
compose-loadMountsByServiceDRead-onlyIdempotent
GET /compose.loadMountsByService
Inputs: composeId (required), serviceName (required).
compose-loadServicesDRead-onlyIdempotent
GET /compose.loadServices
Inputs: composeId (required), type.
compose-moveDIdempotent
POST /compose.move
Inputs: composeId (required), targetEnvironmentId (required).
compose-oneDRead-onlyIdempotent
GET /compose.one
Inputs: composeId (required).
compose-processTemplateDIdempotent
POST /compose.processTemplate
Inputs: base64 (required), composeId (required).
compose-randomizeComposeDIdempotent
POST /compose.randomizeCompose
Inputs: composeId (required), suffix.
compose-readLogsDRead-onlyIdempotent
GET /compose.readLogs
Inputs: composeId (required), containerId (required), tail, since, +1 more.
compose-redeployDIdempotent
POST /compose.redeploy
Inputs: composeId (required), title, description.
compose-refreshTokenDIdempotent
POST /compose.refreshToken
Inputs: composeId (required).
compose-saveEnvironmentDIdempotent
POST /compose.saveEnvironment
Inputs: composeId (required), env (required).
compose-searchDRead-onlyIdempotent
GET /compose.search
Inputs: q, name, appName, description, +4 more.
compose-startDIdempotent
POST /compose.start
Inputs: composeId (required).
compose-stopDIdempotent
POST /compose.stop
Inputs: composeId (required).
compose-templatesDRead-onlyIdempotent
GET /compose.templates
Inputs: baseUrl.
compose-updateDIdempotent
POST /compose.update
Inputs: composeId (required), name, appName, description, +40 more.
customRole-allCRead-onlyIdempotent
GET /customRole.all
Inputs: no named parameters.
customRole-createD
POST /customRole.create
Inputs: roleName (required), permissions (required).
customRole-getStatementsDRead-onlyIdempotent
GET /customRole.getStatements
Inputs: no named parameters.
customRole-membersByRoleDRead-onlyIdempotent
GET /customRole.membersByRole
Inputs: roleName (required).
customRole-removeDDestructive
POST /customRole.remove
Inputs: roleName (required).
customRole-updateDIdempotent
POST /customRole.update
Inputs: roleName (required), permissions (required), newRoleName.
deployment-allDRead-onlyIdempotent
GET /deployment.all
Inputs: applicationId (required).
deployment-allByComposeCRead-onlyIdempotent
GET /deployment.allByCompose
Inputs: composeId (required).
deployment-allByServerDRead-onlyIdempotent
GET /deployment.allByServer
Inputs: serverId (required).
deployment-allByTypeDRead-onlyIdempotent
GET /deployment.allByType
Inputs: id (required), type (required).
deployment-allCentralizedDRead-onlyIdempotent
GET /deployment.allCentralized
Inputs: no named parameters.
deployment-killProcessDIdempotent
POST /deployment.killProcess
Inputs: deploymentId (required).
deployment-queueListCRead-onlyIdempotent
GET /deployment.queueList
Inputs: no named parameters.
deployment-removeDeploymentDDestructive
POST /deployment.removeDeployment
Inputs: deploymentId (required).
destination-allBRead-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-oneCRead-onlyIdempotent
GET /destination.one
Inputs: destinationId (required).
destination-removeDDestructive
POST /destination.remove
Inputs: destinationId (required).
destination-testConnectionDIdempotent
POST /destination.testConnection
Inputs: name (required), provider (required), accessKey (required), bucket (required), +5 more.
destination-updateDIdempotent
POST /destination.update
Inputs: name (required), accessKey (required), bucket (required), region (required), +6 more.
docker-getConfigDRead-onlyIdempotent
GET /docker.getConfig
Inputs: containerId (required), serverId.
docker-getContainersDRead-onlyIdempotent
GET /docker.getContainers
Inputs: serverId.
docker-getContainersByAppLabelDRead-onlyIdempotent
GET /docker.getContainersByAppLabel
Inputs: appName (required), type (required), serverId.
docker-getContainersByAppNameMatchDRead-onlyIdempotent
GET /docker.getContainersByAppNameMatch
Inputs: appName (required), appType, serverId.
docker-getServiceContainersByAppNameDRead-onlyIdempotent
GET /docker.getServiceContainersByAppName
Inputs: appName (required), serverId.
docker-getStackContainersByAppNameDRead-onlyIdempotent
GET /docker.getStackContainersByAppName
Inputs: appName (required), serverId.
docker-removeContainerDDestructive
POST /docker.removeContainer
Inputs: containerId (required), serverId.
docker-restartContainerDIdempotent
POST /docker.restartContainer
Inputs: containerId (required).
docker-uploadFileToContainerDIdempotent
POST /docker.uploadFileToContainer
Inputs: no named parameters.
domain-byApplicationIdDRead-onlyIdempotent
GET /domain.byApplicationId
Inputs: applicationId (required).
domain-byComposeIdDRead-onlyIdempotent
GET /domain.byComposeId
Inputs: composeId (required).
domain-canGenerateTraefikMeDomainsDRead-onlyIdempotent
GET /domain.canGenerateTraefikMeDomains
Inputs: serverId (required).
domain-createD
POST /domain.create
Inputs: host (required), path, port, customEntrypoint, +11 more.
domain-deleteDDestructive
POST /domain.delete
Inputs: domainId (required).
domain-generateDomainDIdempotent
POST /domain.generateDomain
Inputs: appName (required), serverId.
domain-oneCRead-onlyIdempotent
GET /domain.one
Inputs: domainId (required).
domain-updateDIdempotent
POST /domain.update
Inputs: host (required), domainId (required), path, port, +9 more.
domain-validateDomainDIdempotent
POST /domain.validateDomain
Inputs: domain (required), serverIp.
environment-byProjectIdCRead-onlyIdempotent
GET /environment.byProjectId
Inputs: projectId (required).
environment-createD
POST /environment.create
Inputs: name (required), projectId (required), description.
environment-duplicateDIdempotent
POST /environment.duplicate
Inputs: environmentId (required), name (required), description.
environment-oneDRead-onlyIdempotent
GET /environment.one
Inputs: environmentId (required).
environment-removeDDestructive
POST /environment.remove
Inputs: environmentId (required).
environment-searchDRead-onlyIdempotent
GET /environment.search
Inputs: q, name, description, projectId, +2 more.
environment-updateDIdempotent
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-getGiteaBranchesDRead-onlyIdempotent
GET /gitea.getGiteaBranches
Inputs: owner (required), repositoryName (required), giteaId.
gitea-getGiteaRepositoriesDRead-onlyIdempotent
GET /gitea.getGiteaRepositories
Inputs: giteaId (required).
gitea-getGiteaUrlDRead-onlyIdempotent
GET /gitea.getGiteaUrl
Inputs: giteaId (required).
gitea-giteaProvidersDRead-onlyIdempotent
GET /gitea.giteaProviders
Inputs: no named parameters.
gitea-oneDRead-onlyIdempotent
GET /gitea.one
Inputs: giteaId (required).
gitea-testConnectionDIdempotent
POST /gitea.testConnection
Inputs: giteaId, organizationName.
gitea-updateDIdempotent
POST /gitea.update
Inputs: giteaId (required), giteaUrl (required), gitProviderId (required), name (required), +11 more.
github-getGithubBranchesDRead-onlyIdempotent
GET /github.getGithubBranches
Inputs: repo (required), owner (required), githubId.
github-getGithubRepositoriesCRead-onlyIdempotent
GET /github.getGithubRepositories
Inputs: githubId (required).
github-githubProvidersCRead-onlyIdempotent
GET /github.githubProviders
Inputs: no named parameters.
github-oneDRead-onlyIdempotent
GET /github.one
Inputs: githubId (required).
github-testConnectionDIdempotent
POST /github.testConnection
Inputs: githubId (required).
github-updateDIdempotent
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-getGitlabBranchesDRead-onlyIdempotent
GET /gitlab.getGitlabBranches
Inputs: owner (required), repo (required), id, gitlabId.
gitlab-getGitlabRepositoriesDRead-onlyIdempotent
GET /gitlab.getGitlabRepositories
Inputs: gitlabId (required).
gitlab-gitlabProvidersCRead-onlyIdempotent
GET /gitlab.gitlabProviders
Inputs: no named parameters.
gitlab-oneDRead-onlyIdempotent
GET /gitlab.one
Inputs: gitlabId (required).
gitlab-testConnectionDIdempotent
POST /gitlab.testConnection
Inputs: gitlabId (required), groupName.
gitlab-updateDIdempotent
POST /gitlab.update
Inputs: name (required), gitlabId (required), gitlabUrl (required), gitProviderId (required), +5 more.
gitProvider-allForPermissionsDRead-onlyIdempotent
GET /gitProvider.allForPermissions
Inputs: no named parameters.
gitProvider-getAllDRead-onlyIdempotent
GET /gitProvider.getAll
Inputs: no named parameters.
gitProvider-removeDDestructive
POST /gitProvider.remove
Inputs: gitProviderId (required).
libsql-changeStatusDIdempotent
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-deployDIdempotent
POST /libsql.deploy
Inputs: libsqlId (required).
libsql-moveDIdempotent
POST /libsql.move
Inputs: libsqlId (required), targetEnvironmentId (required).
libsql-oneDRead-onlyIdempotent
GET /libsql.one
Inputs: libsqlId (required).
libsql-readLogsDRead-onlyIdempotent
GET /libsql.readLogs
Inputs: libsqlId (required), tail, since, search.
libsql-rebuildDIdempotent
POST /libsql.rebuild
Inputs: libsqlId (required).
libsql-reloadDIdempotent
POST /libsql.reload
Inputs: libsqlId (required), appName (required).
libsql-removeDDestructive
POST /libsql.remove
Inputs: libsqlId (required).
libsql-saveEnvironmentDIdempotent
POST /libsql.saveEnvironment
Inputs: libsqlId (required), env (required).
libsql-saveExternalPortsDIdempotent
POST /libsql.saveExternalPorts
Inputs: libsqlId (required), externalPort, externalGRPCPort, externalAdminPort.
libsql-startDIdempotent
POST /libsql.start
Inputs: libsqlId (required).
libsql-stopDIdempotent
POST /libsql.stop
Inputs: libsqlId (required).
libsql-updateDIdempotent
POST /libsql.update
Inputs: libsqlId (required), name, appName, description, +29 more.
licenseKey-activateDIdempotent
POST /licenseKey.activate
Inputs: licenseKey (required).
licenseKey-deactivateCIdempotent
POST /licenseKey.deactivate
Inputs: no named parameters.
licenseKey-getEnterpriseSettingsCRead-onlyIdempotent
GET /licenseKey.getEnterpriseSettings
Inputs: no named parameters.
licenseKey-haveValidLicenseKeyDRead-onlyIdempotent
GET /licenseKey.haveValidLicenseKey
Inputs: no named parameters.
licenseKey-updateEnterpriseSettingsDIdempotent
POST /licenseKey.updateEnterpriseSettings
Inputs: enableEnterpriseFeatures.
licenseKey-validateDIdempotent
POST /licenseKey.validate
Inputs: no named parameters.
mariadb-changePasswordDIdempotent
POST /mariadb.changePassword
Inputs: mariadbId (required), password (required), type.
mariadb-changeStatusDIdempotent
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-deployDIdempotent
POST /mariadb.deploy
Inputs: mariadbId (required).
mariadb-moveDIdempotent
POST /mariadb.move
Inputs: mariadbId (required), targetEnvironmentId (required).
mariadb-oneDRead-onlyIdempotent
GET /mariadb.one
Inputs: mariadbId (required).
mariadb-readLogsDRead-onlyIdempotent
GET /mariadb.readLogs
Inputs: mariadbId (required), tail, since, search.
mariadb-rebuildDIdempotent
POST /mariadb.rebuild
Inputs: mariadbId (required).
mariadb-reloadDIdempotent
POST /mariadb.reload
Inputs: mariadbId (required), appName (required).
mariadb-removeDDestructive
POST /mariadb.remove
Inputs: mariadbId (required).
mariadb-saveEnvironmentDIdempotent
POST /mariadb.saveEnvironment
Inputs: mariadbId (required), env (required).
mariadb-saveExternalPortDIdempotent
POST /mariadb.saveExternalPort
Inputs: mariadbId (required), externalPort (required).
mariadb-searchDRead-onlyIdempotent
GET /mariadb.search
Inputs: q, name, appName, description, +4 more.
mariadb-startDIdempotent
POST /mariadb.start
Inputs: mariadbId (required).
mariadb-stopDIdempotent
POST /mariadb.stop
Inputs: mariadbId (required).
mariadb-updateDIdempotent
POST /mariadb.update
Inputs: mariadbId (required), name, appName, description, +28 more.
mongo-changePasswordDIdempotent
POST /mongo.changePassword
Inputs: mongoId (required), password (required).
mongo-changeStatusDIdempotent
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-deployDIdempotent
POST /mongo.deploy
Inputs: mongoId (required).
mongo-moveDIdempotent
POST /mongo.move
Inputs: mongoId (required), targetEnvironmentId (required).
mongo-oneDRead-onlyIdempotent
GET /mongo.one
Inputs: mongoId (required).
mongo-readLogsDRead-onlyIdempotent
GET /mongo.readLogs
Inputs: mongoId (required), tail, since, search.
mongo-rebuildDIdempotent
POST /mongo.rebuild
Inputs: mongoId (required).
mongo-reloadDIdempotent
POST /mongo.reload
Inputs: mongoId (required), appName (required).
mongo-removeDDestructive
POST /mongo.remove
Inputs: mongoId (required).
mongo-saveEnvironmentDIdempotent
POST /mongo.saveEnvironment
Inputs: mongoId (required), env (required).
mongo-saveExternalPortDIdempotent
POST /mongo.saveExternalPort
Inputs: mongoId (required), externalPort (required).
mongo-searchDRead-onlyIdempotent
GET /mongo.search
Inputs: q, name, appName, description, +4 more.
mongo-startDIdempotent
POST /mongo.start
Inputs: mongoId (required).
mongo-stopDIdempotent
POST /mongo.stop
Inputs: mongoId (required).
mongo-updateDIdempotent
POST /mongo.update
Inputs: mongoId (required), name, appName, description, +27 more.
mounts-allNamedByApplicationIdDRead-onlyIdempotent
GET /mounts.allNamedByApplicationId
Inputs: applicationId (required).
mounts-createD
POST /mounts.create
Inputs: type (required), mountPath (required), serviceId (required), hostPath, +4 more.
mounts-listByServiceIdDRead-onlyIdempotent
GET /mounts.listByServiceId
Inputs: serviceType (required), serviceId (required).
mounts-oneDRead-onlyIdempotent
GET /mounts.one
Inputs: mountId (required).
mounts-removeDDestructive
POST /mounts.remove
Inputs: mountId (required).
mounts-updateDIdempotent
POST /mounts.update
Inputs: mountId (required), type, hostPath, volumeName, +12 more.
mysql-changePasswordDIdempotent
POST /mysql.changePassword
Inputs: mysqlId (required), password (required), type.
mysql-changeStatusDIdempotent
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-deployDIdempotent
POST /mysql.deploy
Inputs: mysqlId (required).
mysql-moveDIdempotent
POST /mysql.move
Inputs: mysqlId (required), targetEnvironmentId (required).
mysql-oneDRead-onlyIdempotent
GET /mysql.one
Inputs: mysqlId (required).
mysql-readLogsDRead-onlyIdempotent
GET /mysql.readLogs
Inputs: mysqlId (required), tail, since, search.
mysql-rebuildDIdempotent
POST /mysql.rebuild
Inputs: mysqlId (required).
mysql-reloadDIdempotent
POST /mysql.reload
Inputs: mysqlId (required), appName (required).
mysql-removeDDestructive
POST /mysql.remove
Inputs: mysqlId (required).
mysql-saveEnvironmentDIdempotent
POST /mysql.saveEnvironment
Inputs: mysqlId (required), env (required).
mysql-saveExternalPortDIdempotent
POST /mysql.saveExternalPort
Inputs: mysqlId (required), externalPort (required).
mysql-searchDRead-onlyIdempotent
GET /mysql.search
Inputs: q, name, appName, description, +4 more.
mysql-startDIdempotent
POST /mysql.start
Inputs: mysqlId (required).
mysql-stopDIdempotent
POST /mysql.stop
Inputs: mysqlId (required).
mysql-updateDIdempotent
POST /mysql.update
Inputs: mysqlId (required), name, appName, description, +28 more.
notification-allDRead-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-getEmailProvidersDRead-onlyIdempotent
GET /notification.getEmailProviders
Inputs: no named parameters.
notification-oneCRead-onlyIdempotent
GET /notification.one
Inputs: notificationId (required).
notification-receiveNotificationDIdempotent
POST /notification.receiveNotification
Inputs: Type (required), Value (required), Threshold (required), Message (required), +3 more.
notification-removeDDestructive
POST /notification.remove
Inputs: notificationId (required).
notification-testCustomConnectionDIdempotent
POST /notification.testCustomConnection
Inputs: endpoint (required), headers.
notification-testDiscordConnectionDIdempotent
POST /notification.testDiscordConnection
Inputs: webhookUrl (required), decoration.
notification-testEmailConnectionDIdempotent
POST /notification.testEmailConnection
Inputs: smtpServer (required), smtpPort (required), username (required), password (required), +2 more.
notification-testGotifyConnectionDIdempotent
POST /notification.testGotifyConnection
Inputs: serverUrl (required), appToken (required), priority (required), decoration.
notification-testLarkConnectionDIdempotent
POST /notification.testLarkConnection
Inputs: webhookUrl (required).
notification-testMattermostConnectionDIdempotent
POST /notification.testMattermostConnection
Inputs: webhookUrl (required), channel, username.
notification-testNtfyConnectionDIdempotent
POST /notification.testNtfyConnection
Inputs: serverUrl (required), topic (required), accessToken (required), priority (required).
notification-testPushoverConnectionDIdempotent
POST /notification.testPushoverConnection
Inputs: userKey (required), apiToken (required), priority (required), retry, +1 more.
notification-testResendConnectionDIdempotent
POST /notification.testResendConnection
Inputs: apiKey (required), fromAddress (required), toAddresses (required).
notification-testSlackConnectionDIdempotent
POST /notification.testSlackConnection
Inputs: webhookUrl (required), channel (required).
notification-testTeamsConnectionDIdempotent
POST /notification.testTeamsConnection
Inputs: webhookUrl (required).
notification-testTelegramConnectionDIdempotent
POST /notification.testTelegramConnection
Inputs: botToken (required), chatId (required), messageThreadId (required).
notification-updateCustomDIdempotent
POST /notification.updateCustom
Inputs: notificationId (required), customId (required), appBuildError, databaseBackup, +10 more.
notification-updateDiscordDIdempotent
POST /notification.updateDiscord
Inputs: notificationId (required), discordId (required), appBuildError, databaseBackup, +10 more.
notification-updateEmailDIdempotent
POST /notification.updateEmail
Inputs: notificationId (required), emailId (required), appBuildError, databaseBackup, +14 more.
notification-updateGotifyDIdempotent
POST /notification.updateGotify
Inputs: notificationId (required), gotifyId (required), appBuildError, databaseBackup, +11 more.
notification-updateLarkDIdempotent
POST /notification.updateLark
Inputs: notificationId (required), larkId (required), appBuildError, databaseBackup, +9 more.
notification-updateMattermostDIdempotent
POST /notification.updateMattermost
Inputs: notificationId (required), mattermostId (required), appBuildError, databaseBackup, +11 more.
notification-updateNtfyDIdempotent
POST /notification.updateNtfy
Inputs: notificationId (required), ntfyId (required), appBuildError, databaseBackup, +11 more.
notification-updatePushoverDIdempotent
POST /notification.updatePushover
Inputs: notificationId (required), pushoverId (required), organizationId, userKey, +13 more.
notification-updateResendDIdempotent
POST /notification.updateResend
Inputs: notificationId (required), resendId (required), appBuildError, databaseBackup, +11 more.
notification-updateSlackDIdempotent
POST /notification.updateSlack
Inputs: notificationId (required), slackId (required), appBuildError, databaseBackup, +10 more.
notification-updateTeamsDIdempotent
POST /notification.updateTeams
Inputs: notificationId (required), teamsId (required), appBuildError, databaseBackup, +9 more.
notification-updateTelegramDIdempotent
POST /notification.updateTelegram
Inputs: notificationId (required), telegramId (required), appBuildError, databaseBackup, +11 more.
organization-activeDRead-onlyIdempotent
GET /organization.active
Inputs: no named parameters.
organization-allCRead-onlyIdempotent
GET /organization.all
Inputs: no named parameters.
organization-allInvitationsCRead-onlyIdempotent
GET /organization.allInvitations
Inputs: no named parameters.
organization-createD
POST /organization.create
Inputs: name (required), logo.
organization-deleteDDestructive
POST /organization.delete
Inputs: organizationId (required).
organization-inviteMemberDIdempotent
POST /organization.inviteMember
Inputs: email (required), role (required).
organization-oneDRead-onlyIdempotent
GET /organization.one
Inputs: organizationId (required).
organization-removeInvitationDDestructive
POST /organization.removeInvitation
Inputs: invitationId (required).
organization-setDefaultDIdempotent
POST /organization.setDefault
Inputs: organizationId (required).
organization-updateDIdempotent
POST /organization.update
Inputs: organizationId (required), name (required), logo.
organization-updateMemberRoleDIdempotent
POST /organization.updateMemberRole
Inputs: memberId (required), role (required).
patch-byEntityIdCRead-onlyIdempotent
GET /patch.byEntityId
Inputs: id (required), type (required).
patch-cleanPatchReposDIdempotent
POST /patch.cleanPatchRepos
Inputs: serverId.
patch-createD
POST /patch.create
Inputs: filePath (required), content (required), type, enabled, +2 more.
patch-deleteDDestructive
POST /patch.delete
Inputs: patchId (required).
patch-ensureRepoDIdempotent
POST /patch.ensureRepo
Inputs: id (required), type (required).
patch-markFileForDeletionDIdempotent
POST /patch.markFileForDeletion
Inputs: id (required), type (required), filePath (required).
patch-oneDRead-onlyIdempotent
GET /patch.one
Inputs: patchId (required).
patch-readRepoDirectoriesDRead-onlyIdempotent
GET /patch.readRepoDirectories
Inputs: id (required), type (required), repoPath (required).
patch-readRepoFileDRead-onlyIdempotent
GET /patch.readRepoFile
Inputs: id (required), type (required), filePath (required).
patch-saveFileAsPatchDIdempotent
POST /patch.saveFileAsPatch
Inputs: id (required), type (required), filePath (required), content (required), +1 more.
patch-toggleEnabledDIdempotent
POST /patch.toggleEnabled
Inputs: patchId (required), enabled (required).
patch-updateDIdempotent
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-deleteDDestructive
POST /port.delete
Inputs: portId (required).
port-oneCRead-onlyIdempotent
GET /port.one
Inputs: portId (required).
port-updateDIdempotent
POST /port.update
Inputs: portId (required), publishedPort (required), targetPort (required), publishMode, +1 more.
postgres-changePasswordDIdempotent
POST /postgres.changePassword
Inputs: postgresId (required), password (required).
postgres-changeStatusDIdempotent
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-deployDIdempotent
POST /postgres.deploy
Inputs: postgresId (required).
postgres-moveDIdempotent
POST /postgres.move
Inputs: postgresId (required), targetEnvironmentId (required).
postgres-oneCRead-onlyIdempotent
GET /postgres.one
Inputs: postgresId (required).
postgres-readLogsDRead-onlyIdempotent
GET /postgres.readLogs
Inputs: postgresId (required), tail, since, search.
postgres-rebuildDIdempotent
POST /postgres.rebuild
Inputs: postgresId (required).
postgres-reloadDIdempotent
POST /postgres.reload
Inputs: postgresId (required), appName (required).
postgres-removeDDestructive
POST /postgres.remove
Inputs: postgresId (required).
postgres-saveEnvironmentDIdempotent
POST /postgres.saveEnvironment
Inputs: postgresId (required), env (required).
postgres-saveExternalPortDIdempotent
POST /postgres.saveExternalPort
Inputs: postgresId (required), externalPort (required).
postgres-searchDRead-onlyIdempotent
GET /postgres.search
Inputs: q, name, appName, description, +4 more.
postgres-startDIdempotent
POST /postgres.start
Inputs: postgresId (required).
postgres-stopDIdempotent
POST /postgres.stop
Inputs: postgresId (required).
postgres-updateDIdempotent
POST /postgres.update
Inputs: postgresId (required), name, appName, databaseName, +27 more.
previewDeployment-allDRead-onlyIdempotent
GET /previewDeployment.all
Inputs: applicationId (required).
previewDeployment-deleteDDestructive
POST /previewDeployment.delete
Inputs: previewDeploymentId (required).
previewDeployment-oneCRead-onlyIdempotent
GET /previewDeployment.one
Inputs: previewDeploymentId (required).
previewDeployment-redeployDIdempotent
POST /previewDeployment.redeploy
Inputs: previewDeploymentId (required), title, description.
project-allBRead-onlyIdempotent
GET /project.all
Inputs: no named parameters.
project-allForPermissionsCRead-onlyIdempotent
GET /project.allForPermissions
Inputs: no named parameters.
project-createD
POST /project.create
Inputs: name (required), description, env.
project-duplicateDIdempotent
POST /project.duplicate
Inputs: sourceEnvironmentId (required), name (required), description, includeServices, +2 more.
projectEnvironment-getARead-onlyIdempotent
Get environment variables for a project. Returns normalized envMap plus the reconstructed envText.
Inputs: projectId (required).
projectEnvironment-saveBIdempotent
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-oneDRead-onlyIdempotent
GET /project.one
Inputs: projectId (required).
project-removeDDestructive
POST /project.remove
Inputs: projectId (required).
project-searchDRead-onlyIdempotent
GET /project.search
Inputs: q, name, description, limit, +1 more.
project-updateDIdempotent
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-deleteDDestructive
POST /redirects.delete
Inputs: redirectId (required).
redirects-oneDRead-onlyIdempotent
GET /redirects.one
Inputs: redirectId (required).
redirects-updateDIdempotent
POST /redirects.update
Inputs: redirectId (required), regex (required), replacement (required), permanent (required).
redis-changePasswordCIdempotent
POST /redis.changePassword
Inputs: redisId (required), password (required).
redis-changeStatusDIdempotent
POST /redis.changeStatus
Inputs: redisId (required), applicationStatus (required).
redis-createD
POST /redis.create
Inputs: name (required), databasePassword (required), environmentId (required), appName, +3 more.
redis-deployDIdempotent
POST /redis.deploy
Inputs: redisId (required).
redis-moveDIdempotent
POST /redis.move
Inputs: redisId (required), targetEnvironmentId (required).
redis-oneDRead-onlyIdempotent
GET /redis.one
Inputs: redisId (required).
redis-readLogsDRead-onlyIdempotent
GET /redis.readLogs
Inputs: redisId (required), tail, since, search.
redis-rebuildDIdempotent
POST /redis.rebuild
Inputs: redisId (required).
redis-reloadDIdempotent
POST /redis.reload
Inputs: redisId (required), appName (required).
redis-removeDDestructive
POST /redis.remove
Inputs: redisId (required).
redis-saveEnvironmentDIdempotent
POST /redis.saveEnvironment
Inputs: redisId (required), env (required).
redis-saveExternalPortDIdempotent
POST /redis.saveExternalPort
Inputs: redisId (required), externalPort (required).
redis-searchDRead-onlyIdempotent
GET /redis.search
Inputs: q, name, appName, description, +4 more.
redis-startDIdempotent
POST /redis.start
Inputs: redisId (required).
redis-stopDIdempotent
POST /redis.stop
Inputs: redisId (required).
redis-updateDIdempotent
POST /redis.update
Inputs: redisId (required), name, appName, description, +25 more.
registry-allCRead-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-oneDRead-onlyIdempotent
GET /registry.one
Inputs: registryId (required).
registry-removeDDestructive
POST /registry.remove
Inputs: registryId (required).
registry-testRegistryDIdempotent
POST /registry.testRegistry
Inputs: username (required), password (required), registryUrl (required), registryType (required), +3 more.
registry-testRegistryByIdDIdempotent
POST /registry.testRegistryById
Inputs: registryId, serverId.
registry-updateDIdempotent
POST /registry.update
Inputs: registryId (required), registryName, imagePrefix, username, +6 more.
rollback-deleteDDestructive
POST /rollback.delete
Inputs: rollbackId (required).
rollback-rollbackDIdempotent
POST /rollback.rollback
Inputs: rollbackId (required).
schedule-createD
POST /schedule.create
Inputs: name (required), cronExpression (required), command (required), scheduleId, +12 more.
schedule-deleteDDestructive
POST /schedule.delete
Inputs: scheduleId (required).
schedule-listDRead-onlyIdempotent
GET /schedule.list
Inputs: id (required), scheduleType (required).
schedule-oneDRead-onlyIdempotent
GET /schedule.one
Inputs: scheduleId (required).
schedule-runManuallyDIdempotent
POST /schedule.runManually
Inputs: scheduleId (required).
schedule-updateDIdempotent
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-deleteDDestructive
POST /security.delete
Inputs: securityId (required).
security-oneCRead-onlyIdempotent
GET /security.one
Inputs: securityId (required).
security-updateDIdempotent
POST /security.update
Inputs: securityId (required), username (required), password (required).
server-allCRead-onlyIdempotent
GET /server.all
Inputs: no named parameters.
server-allForPermissionsCRead-onlyIdempotent
GET /server.allForPermissions
Inputs: no named parameters.
server-buildServersDRead-onlyIdempotent
GET /server.buildServers
Inputs: no named parameters.
server-countDRead-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-getDefaultCommandDRead-onlyIdempotent
GET /server.getDefaultCommand
Inputs: serverId (required).
server-getServerMetricsDRead-onlyIdempotent
GET /server.getServerMetrics
Inputs: url (required), token (required), dataPoints (required).
server-getServerTimeCRead-onlyIdempotent
GET /server.getServerTime
Inputs: no named parameters.
server-oneDRead-onlyIdempotent
GET /server.one
Inputs: serverId (required).
server-publicIpCRead-onlyIdempotent
GET /server.publicIp
Inputs: no named parameters.
server-removeDDestructive
POST /server.remove
Inputs: serverId (required).
server-securityDRead-onlyIdempotent
GET /server.security
Inputs: serverId (required).
server-setupDIdempotent
POST /server.setup
Inputs: serverId (required).
server-setupMonitoringDIdempotent
POST /server.setupMonitoring
Inputs: serverId (required), metricsConfig (required).
server-updateDIdempotent
POST /server.update
Inputs: name (required), description (required), serverId (required), ipAddress (required), +5 more.
server-validateDRead-onlyIdempotent
GET /server.validate
Inputs: serverId (required).
server-withSSHKeyDRead-onlyIdempotent
GET /server.withSSHKey
Inputs: no named parameters.
serviceEnvironment-getARead-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-saveBIdempotent
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-assignDomainServerDIdempotent
POST /settings.assignDomainServer
Inputs: host (required), certificateType (required), letsEncryptEmail, https.
settings-checkGPUStatusDRead-onlyIdempotent
GET /settings.checkGPUStatus
Inputs: serverId.
settings-checkInfrastructureHealthDRead-onlyIdempotent
GET /settings.checkInfrastructureHealth
Inputs: no named parameters.
settings-cleanAllDIdempotent
POST /settings.cleanAll
Inputs: serverId.
settings-cleanAllDeploymentQueueDIdempotent
POST /settings.cleanAllDeploymentQueue
Inputs: no named parameters.
settings-cleanDockerBuilderDIdempotent
POST /settings.cleanDockerBuilder
Inputs: serverId.
settings-cleanDockerPruneDIdempotent
POST /settings.cleanDockerPrune
Inputs: serverId.
settings-cleanMonitoringDIdempotent
POST /settings.cleanMonitoring
Inputs: no named parameters.
settings-cleanRedisDIdempotent
POST /settings.cleanRedis
Inputs: no named parameters.
settings-cleanSSHPrivateKeyDIdempotent
POST /settings.cleanSSHPrivateKey
Inputs: no named parameters.
settings-cleanStoppedContainersDIdempotent
POST /settings.cleanStoppedContainers
Inputs: serverId.
settings-cleanUnusedImagesDIdempotent
POST /settings.cleanUnusedImages
Inputs: serverId.
settings-cleanUnusedVolumesDIdempotent
POST /settings.cleanUnusedVolumes
Inputs: serverId.
settings-getDockerDiskUsageDRead-onlyIdempotent
GET /settings.getDockerDiskUsage
Inputs: no named parameters.
settings-getDokployCloudIpsCRead-onlyIdempotent
GET /settings.getDokployCloudIps
Inputs: no named parameters.
settings-getDokployVersionCRead-onlyIdempotent
GET /settings.getDokployVersion
Inputs: no named parameters.
settings-getIpCRead-onlyIdempotent
GET /settings.getIp
Inputs: no named parameters.
settings-getLogCleanupStatusCRead-onlyIdempotent
GET /settings.getLogCleanupStatus
Inputs: no named parameters.
settings-getOpenApiDocumentDRead-onlyIdempotent
GET /settings.getOpenApiDocument
Inputs: no named parameters.
settings-getReleaseTagDRead-onlyIdempotent
GET /settings.getReleaseTag
Inputs: no named parameters.
settings-getTraefikPortsDRead-onlyIdempotent
GET /settings.getTraefikPorts
Inputs: serverId.
settings-getUpdateDataDIdempotent
POST /settings.getUpdateData
Inputs: no named parameters.
settings-getWebServerSettingsCRead-onlyIdempotent
GET /settings.getWebServerSettings
Inputs: no named parameters.
settings-haveActivateRequestsDRead-onlyIdempotent
GET /settings.haveActivateRequests
Inputs: no named parameters.
settings-haveTraefikDashboardPortEnabledDRead-onlyIdempotent
GET /settings.haveTraefikDashboardPortEnabled
Inputs: serverId.
settings-healthCRead-onlyIdempotent
GET /settings.health
Inputs: no named parameters.
settings-isCloudDRead-onlyIdempotent
GET /settings.isCloud
Inputs: no named parameters.
settings-isUserSubscribedCRead-onlyIdempotent
GET /settings.isUserSubscribed
Inputs: no named parameters.
settings-readDirectoriesDRead-onlyIdempotent
GET /settings.readDirectories
Inputs: serverId.
settings-readMiddlewareTraefikConfigCRead-onlyIdempotent
GET /settings.readMiddlewareTraefikConfig
Inputs: no named parameters.
settings-readTraefikConfigDRead-onlyIdempotent
GET /settings.readTraefikConfig
Inputs: no named parameters.
settings-readTraefikEnvDRead-onlyIdempotent
GET /settings.readTraefikEnv
Inputs: serverId.
settings-readTraefikFileDRead-onlyIdempotent
GET /settings.readTraefikFile
Inputs: path (required), serverId.
settings-readWebServerTraefikConfigDRead-onlyIdempotent
GET /settings.readWebServerTraefikConfig
Inputs: no named parameters.
settings-reloadRedisDIdempotent
POST /settings.reloadRedis
Inputs: no named parameters.
settings-reloadServerDIdempotent
POST /settings.reloadServer
Inputs: no named parameters.
settings-reloadTraefikDIdempotent
POST /settings.reloadTraefik
Inputs: serverId.
settings-saveSSHPrivateKeyDIdempotent
POST /settings.saveSSHPrivateKey
Inputs: sshPrivateKey (required).
settings-setupGPUDIdempotent
POST /settings.setupGPU
Inputs: serverId.
settings-toggleDashboardDIdempotent
POST /settings.toggleDashboard
Inputs: enableDashboard, serverId.
settings-toggleRequestsDIdempotent
POST /settings.toggleRequests
Inputs: enable (required).
settings-updateDockerCleanupDIdempotent
POST /settings.updateDockerCleanup
Inputs: enableDockerCleanup (required), serverId.
settings-updateLogCleanupDIdempotent
POST /settings.updateLogCleanup
Inputs: cronExpression (required).
settings-updateMiddlewareTraefikConfigDIdempotent
POST /settings.updateMiddlewareTraefikConfig
Inputs: traefikConfig (required).
settings-updateServerDIdempotent
POST /settings.updateServer
Inputs: no named parameters.
settings-updateServerIpDIdempotent
POST /settings.updateServerIp
Inputs: serverIp (required).
settings-updateTraefikConfigDIdempotent
POST /settings.updateTraefikConfig
Inputs: traefikConfig (required).
settings-updateTraefikFileDIdempotent
POST /settings.updateTraefikFile
Inputs: path (required), traefikConfig (required), serverId.
settings-updateTraefikPortsDIdempotent
POST /settings.updateTraefikPorts
Inputs: additionalPorts (required), serverId.
settings-updateWebServerTraefikConfigDIdempotent
POST /settings.updateWebServerTraefikConfig
Inputs: traefikConfig (required).
settings-writeTraefikEnvDIdempotent
POST /settings.writeTraefikEnv
Inputs: env (required), serverId.
sshKey-allDRead-onlyIdempotent
GET /sshKey.all
Inputs: no named parameters.
sshKey-allForAppsDRead-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-generateDIdempotent
POST /sshKey.generate
Inputs: type.
sshKey-oneDRead-onlyIdempotent
GET /sshKey.one
Inputs: sshKeyId (required).
sshKey-removeDDestructive
POST /sshKey.remove
Inputs: sshKeyId (required).
sshKey-updateDIdempotent
POST /sshKey.update
Inputs: sshKeyId (required), name, description, lastUsedAt.
sso-addTrustedOriginDIdempotent
POST /sso.addTrustedOrigin
Inputs: origin (required).
sso-deleteProviderDDestructive
POST /sso.deleteProvider
Inputs: providerId (required).
sso-getTrustedOriginsCRead-onlyIdempotent
GET /sso.getTrustedOrigins
Inputs: no named parameters.
sso-listProvidersDRead-onlyIdempotent
GET /sso.listProviders
Inputs: no named parameters.
sso-oneDRead-onlyIdempotent
GET /sso.one
Inputs: providerId (required).
sso-registerDIdempotent
POST /sso.register
Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.
sso-removeTrustedOriginDDestructive
POST /sso.removeTrustedOrigin
Inputs: origin (required).
sso-showSignInWithSSODRead-onlyIdempotent
GET /sso.showSignInWithSSO
Inputs: no named parameters.
sso-updateDIdempotent
POST /sso.update
Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.
sso-updateTrustedOriginDIdempotent
POST /sso.updateTrustedOrigin
Inputs: oldOrigin (required), newOrigin (required).
stripe-canCreateMoreServersCRead-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-getCurrentPlanCRead-onlyIdempotent
GET /stripe.getCurrentPlan
Inputs: no named parameters.
stripe-getInvoicesDRead-onlyIdempotent
GET /stripe.getInvoices
Inputs: no named parameters.
stripe-getProductsDRead-onlyIdempotent
GET /stripe.getProducts
Inputs: no named parameters.
stripe-upgradeSubscriptionDIdempotent
POST /stripe.upgradeSubscription
Inputs: tier (required), serverQuantity (required), isAnnual (required).
swarm-getContainerStatsDRead-onlyIdempotent
GET /swarm.getContainerStats
Inputs: serverId.
swarm-getNodeAppsDRead-onlyIdempotent
GET /swarm.getNodeApps
Inputs: serverId.
swarm-getNodeInfoDRead-onlyIdempotent
GET /swarm.getNodeInfo
Inputs: nodeId (required), serverId.
swarm-getNodesDRead-onlyIdempotent
GET /swarm.getNodes
Inputs: serverId.
tag-allDRead-onlyIdempotent
GET /tag.all
Inputs: no named parameters.
tag-assignToProjectDIdempotent
POST /tag.assignToProject
Inputs: projectId (required), tagId (required).
tag-bulkAssignDIdempotent
POST /tag.bulkAssign
Inputs: projectId (required), tagIds (required).
tag-createD
POST /tag.create
Inputs: name (required), color.
tag-oneCRead-onlyIdempotent
GET /tag.one
Inputs: tagId (required).
tag-removeDDestructive
POST /tag.remove
Inputs: tagId (required).
tag-removeFromProjectDDestructive
POST /tag.removeFromProject
Inputs: projectId (required), tagId (required).
tag-updateDIdempotent
POST /tag.update
Inputs: tagId (required), name, color, createdAt, +1 more.
user-allCRead-onlyIdempotent
GET /user.all
Inputs: no named parameters.
user-assignPermissionsDIdempotent
POST /user.assignPermissions
Inputs: id (required), accessedProjects (required), accessedEnvironments (required), accessedServices (required), +13 more.
user-checkUserOrganizationsDRead-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-deleteApiKeyDDestructive
POST /user.deleteApiKey
Inputs: apiKeyId (required).
user-generateTokenDIdempotent
POST /user.generateToken
Inputs: no named parameters.
user-getCRead-onlyIdempotent
GET /user.get
Inputs: no named parameters.
user-getBackupsDRead-onlyIdempotent
GET /user.getBackups
Inputs: no named parameters.
user-getBookmarkedTemplatesCRead-onlyIdempotent
GET /user.getBookmarkedTemplates
Inputs: no named parameters.
user-getContainerMetricsDRead-onlyIdempotent
GET /user.getContainerMetrics
Inputs: url (required), token (required), appName (required), dataPoints (required).
user-getInvitationsDRead-onlyIdempotent
GET /user.getInvitations
Inputs: no named parameters.
user-getMetricsTokenCRead-onlyIdempotent
GET /user.getMetricsToken
Inputs: no named parameters.
user-getPermissionsDRead-onlyIdempotent
GET /user.getPermissions
Inputs: no named parameters.
user-getServerMetricsDRead-onlyIdempotent
GET /user.getServerMetrics
Inputs: no named parameters.
user-getUserByTokenCRead-onlyIdempotent
GET /user.getUserByToken
Inputs: token (required).
user-haveRootAccessDRead-onlyIdempotent
GET /user.haveRootAccess
Inputs: no named parameters.
user-oneCRead-onlyIdempotent
GET /user.one
Inputs: userId (required).
user-removeCDestructive
POST /user.remove
Inputs: userId (required).
user-sendInvitationDIdempotent
POST /user.sendInvitation
Inputs: invitationId (required), notificationId (required).
user-sessionCRead-onlyIdempotent
GET /user.session
Inputs: no named parameters.
user-toggleTemplateBookmarkDIdempotent
POST /user.toggleTemplateBookmark
Inputs: templateId (required).
user-updateDIdempotent
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-deleteDDestructive
POST /volumeBackups.delete
Inputs: volumeBackupId (required).
volumeBackups-listDRead-onlyIdempotent
GET /volumeBackups.list
Inputs: id (required), volumeBackupType (required).
volumeBackups-oneDRead-onlyIdempotent
GET /volumeBackups.one
Inputs: volumeBackupId (required).
volumeBackups-runManuallyDIdempotent
POST /volumeBackups.runManually
Inputs: volumeBackupId (required).
volumeBackups-updateDIdempotent
POST /volumeBackups.update
Inputs: name (required), volumeName (required), prefix (required), cronExpression (required), +17 more.
whitelabeling-getCRead-onlyIdempotent
GET /whitelabeling.get
Inputs: no named parameters.
whitelabeling-getPublicCRead-onlyIdempotent
GET /whitelabeling.getPublic
Inputs: no named parameters.
whitelabeling-resetCIdempotent
POST /whitelabeling.reset
Inputs: no named parameters.
whitelabeling-updateDIdempotent
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
Scored across 523 tools
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.
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.
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.
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
Related MCP Connectors
The OpenRouter for tools. One MCP connection gives any AI agent 254 hosted tools, pay per call.
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
Build, validate, deploy — HTTP APIs, cron jobs, webhooks and MCP tools — from your AI client.
214 tools for AI agents over one MCP endpoint: image, video, audio, 3D, data, storage, mail, GPUs.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceExposes 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 npm18MIT
- AlicenseNot gradedqualityDmaintenanceEnables 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 npmApache 2.0
- AlicenseNot gradedqualityDmaintenanceComprehensive, type-safe MCP server providing 380 tools to manage Dokploy deployments, applications, and infrastructure via natural language.31 npm5MIT
- FlicenseNot gradedqualityDmaintenanceWraps the Dokploy REST API to expose Dokploy operations as MCP tools for managing projects, applications, compose stacks, deployments, domains, and environment variables.10 npm1-