Dokploy MCP Server
Enables integration with Bitbucket for managing repositories and application deployments.
Allows for the configuration and management of Discord notifications for server events and deployment updates.
Provides comprehensive tools for managing Docker containers, images, and Docker Compose stacks.
Supports generic Git provider integrations for repository management and application deployment.
Enables integration with Gitea for self-hosted Git repository management and deployment workflows.
Supports GitHub integration for managing repositories and automated application deployments.
Enables GitLab integration for repository management and deployment automation.
Provides management tools for MariaDB database instances, including configuration and deployment.
Provides management tools for MongoDB database instances, including configuration and deployment.
Provides management tools for MySQL database instances, including configuration and deployment.
Provides management tools for PostgreSQL database instances, including configuration and deployment.
Provides management tools for Redis cache instances, including configuration and deployment.
Allows for the configuration and management of Slack notifications for server events and deployment updates.
Supports management of Stripe billing and subscription settings for the platform.
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 list all my projects and their current deployment status"
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
MCP server that provides 100% coverage of the Dokploy API — 463 tools auto-generated from the Dokploy OpenAPI specification. Manage projects, applications, databases, Docker Compose stacks, and more directly from Claude.
Requirements
Node.js 18+ (check with
node -v)A Dokploy account with API access
API key from Settings → API Keys in your Dokploy dashboard
Related MCP server: Dokploy MCP Server
Quick Start
1. Install
npm install -g @jarciahdz111/dokploy-mcpOr run without installing:
npx @jarciahdz111/dokploy-mcp2. Configure Claude Desktop
Create or edit your Claude Desktop config file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonLinux:
~/.config/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.jsonAdd this configuration:
{
"mcpServers": {
"dokploy": {
"command": "dokploy-mcp",
"env": {
"DOKPLOY_URL": "https://your-dokploy.com/api",
"DOKPLOY_API_KEY": "your-api-key"
}
}
}
}3. Configure Claude Code CLI (optional)
If you use the Claude Code CLI, add this to ~/.claude.json:
{
"mcpServers": {
"dokploy": {
"command": "dokploy-mcp",
"env": {
"DOKPLOY_URL": "https://your-dokploy.com/api",
"DOKPLOY_API_KEY": "your-api-key"
}
}
}
}4. Restart Claude
Restart Claude Desktop or your terminal. The 463 Dokploy tools will be available.
Environment Variables
Variable | Description | Required | Default |
| Your Dokploy API URL (e.g., | Yes | — |
| API key from Dokploy Settings → API Keys | Yes | — |
| HTTP request timeout in milliseconds | No |
|
| Set to | No | — |
Available Tools
463 tools across 42 categories. Tool names follow the pattern dokploy_{category}_{action}.
Category | Tools | Description |
| 1 | Admin operations |
| 9 | AI-powered features |
| 29 | Application deployment and management |
| 1 | Audit log access |
| 11 | Backup configuration and execution |
| 7 | Bitbucket integration |
| 4 | SSL certificate management |
| 4 | Cluster management |
| 28 | Docker Compose stack operations |
| 6 | Custom role permissions |
| 8 | Deployment operations |
| 6 | Deployment destinations |
| 7 | Container and image management |
| 9 | Domain management |
| 7 | Environment variables |
| 8 | Gitea integration |
| 2 | Generic Git provider |
| 6 | GitHub integration |
| 7 | GitLab integration |
| 6 | License management |
| 14 | MariaDB database management |
| 14 | MongoDB database management |
| 6 | Volume mounts |
| 14 | MySQL database management |
| 38 | Slack, email, Discord notifications |
| 11 | Organization management |
| 12 | Patch management |
| 4 | Port configuration |
| 14 | PostgreSQL database management |
| 4 | Preview deployments |
| 8 | Project and environment management |
| 14 | Redis cache management |
| 4 | Redirect rules |
| 7 | Docker registry management |
| 2 | Deployment rollback |
| 6 | Scheduled tasks |
| 4 | Security settings |
| 16 | Server provisioning and management |
| 49 | Server and application settings |
| 10 | SSO/OIDC/SAML configuration |
| 6 | SSH key management |
| 7 | Stripe billing |
| 3 | Docker Swarm mode |
| 20 | User and session management |
| 6 | Volume backup management |
| 4 | Whitelabel configuration |
Usage Examples
List all projects
dokploy_project_allGet Docker containers
dokploy_docker_getContainersGet application details
dokploy_application_one
// arguments: { applicationId: "your-application-id" }Deploy an application
dokploy_application_deploy
// arguments: { applicationId: "your-application-id", to: "production" }List PostgreSQL databases
dokploy_postgres_allGet server status
dokploy_settings_getDokployVersionRestart a Docker container
dokploy_docker_restartContainer
// arguments: { containerId: "your-container-id" }Local Development
# Clone the repository
git clone https://github.com/jarciahdz111/dokploy-mcp.git
cd dokploy-mcp
# Install dependencies
npm install
# Build
npm run build
# Run in development mode
npm run dev
# Test
node test-mcp.jsTroubleshooting
"Unauthorized" Error
Your DOKPLOY_API_KEY is invalid or expired.
Go to Settings → API Keys in your Dokploy dashboard
Generate a new API key
Update the
DOKPLOY_API_KEYin your Claude Desktop configRestart Claude
"Connection Refused" Error
The server cannot reach your Dokploy instance.
Verify
DOKPLOY_URLis correct (must include/apiat the end)Check your Dokploy server is running and accessible
If behind a corporate firewall, set proxy environment variables:
export HTTP_PROXY=http://proxy.company.com:8080
export HTTPS_PROXY=http://proxy.company.com:8080Request Timeout Error
The request took too long and was aborted.
Increase the timeout by setting REQUEST_TIMEOUT_MS:
{
"mcpServers": {
"dokploy": {
"env": {
"DOKPLOY_URL": "https://your-dokploy.com/api",
"DOKPLOY_API_KEY": "your-api-key",
"REQUEST_TIMEOUT_MS": "60000"
}
}
}
}Enable Debug Logging
To see detailed request/response logs:
{
"mcpServers": {
"dokploy": {
"env": {
"DOKPLOY_URL": "https://your-dokploy.com/api",
"DOKPLOY_API_KEY": "your-api-key",
"DEBUG": "1"
}
}
}
}Debug output is written to stderr as JSON.
How It Works
This MCP server is auto-generated from the Dokploy OpenAPI specification. When Dokploy releases an API update, a new version of this package can be published with updated tool coverage — no manual tool writing required.
The server:
Loads the embedded OpenAPI spec (1.4 MB, 463 endpoints)
Converts each endpoint to an MCP tool with Zod-validated input schema
Routes GET requests as tRPC queries and POST requests as tRPC mutations
Handles tRPC response wrapping and error parsing automatically
API Coverage
100% of Dokploy API v0.28.8 endpoints
463 MCP tools
42 functional categories
Auto-generated and auto-synced with API spec
Contributing
Want to modify or extend this MCP server? See CLAUDE.md for the development workflow, architecture overview, and contribution guidelines.
License
MIT
Available Tools
463 toolsdokploy_admin_setupMonitoringdokploy_admin_setupMonitoringCIdempotent
[admin] admin.setupMonitoring (POST)
Parameters:
metricsConfig (object, required)
Inputs: metricsConfig (required).
dokploy_ai_createdokploy_ai_createC
[ai] ai.create (POST)
Parameters:
name (string, required)
apiUrl (string, required)
apiKey (string, required)
model (string, required)
isEnabled (boolean, required)
Inputs: name (required), apiUrl (required), apiKey (required), model (required), +1 more.
dokploy_ai_deletedokploy_ai_deleteCDestructive
[ai] ai.delete (POST)
Parameters:
aiId (string, required)
Inputs: aiId (required).
dokploy_ai_deploydokploy_ai_deployD
[ai] ai.deploy (POST)
Parameters:
environmentId (string, required)
id (string, required)
dockerCompose (string, required)
envVariables (string, required)
serverId (string, optional)
name (string, required)
description (string, required)
domains (array, optional)
configFiles (array, optional)
Inputs: environmentId (required), id (required), dockerCompose (required), envVariables (required), +5 more.
dokploy_ai_getdokploy_ai_getCRead-onlyIdempotent
[ai] ai.get (GET)
Parameters:
aiId (string, required)
Inputs: aiId (required).
dokploy_ai_getAlldokploy_ai_getAllCRead-onlyIdempotent
[ai] ai.getAll (GET)
Inputs: no named parameters.
dokploy_ai_getModelsdokploy_ai_getModelsCRead-onlyIdempotent
[ai] ai.getModels (GET)
Parameters:
apiUrl (string, required)
apiKey (string, required)
Inputs: apiUrl (required), apiKey (required).
dokploy_ai_onedokploy_ai_oneCRead-onlyIdempotent
[ai] ai.one (GET)
Parameters:
aiId (string, required)
Inputs: aiId (required).
dokploy_ai_suggestdokploy_ai_suggestC
[ai] ai.suggest (POST)
Parameters:
aiId (string, required)
input (string, required)
serverId (string, optional)
Inputs: aiId (required), input (required), serverId.
dokploy_ai_updatedokploy_ai_updateCIdempotent
[ai] ai.update (POST)
Parameters:
aiId (string, required)
name (string, optional)
apiUrl (string, optional)
apiKey (string, optional)
model (string, optional)
isEnabled (boolean, optional)
createdAt (string, optional)
Inputs: aiId (required), name, apiUrl, apiKey, +3 more.
dokploy_application_cancelDeploymentdokploy_application_cancelDeploymentDRead-only
[application] application.cancelDeployment (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_cleanQueuesdokploy_application_cleanQueuesCDestructive
[application] application.cleanQueues (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_clearDeploymentsdokploy_application_clearDeploymentsD
[application] application.clearDeployments (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_createdokploy_application_createC
[application] application.create (POST)
Parameters:
name (string, required)
appName (string, optional)
description (any, optional)
environmentId (string, required)
serverId (any, optional)
Inputs: name (required), environmentId (required), appName, description, +1 more.
dokploy_application_deletedokploy_application_deleteCDestructive
[application] application.delete (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_deploydokploy_application_deployC
[application] application.deploy (POST)
Parameters:
applicationId (string, required)
title (string, optional)
description (string, optional)
Inputs: applicationId (required), title, description.
dokploy_application_disconnectGitProviderdokploy_application_disconnectGitProviderC
[application] application.disconnectGitProvider (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_killBuilddokploy_application_killBuildCDestructive
[application] application.killBuild (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_markRunningdokploy_application_markRunningC
[application] application.markRunning (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_movedokploy_application_moveC
[application] application.move (POST)
Parameters:
applicationId (string, required)
targetEnvironmentId (string, required)
Inputs: applicationId (required), targetEnvironmentId (required).
dokploy_application_onedokploy_application_oneCRead-onlyIdempotent
[application] application.one (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_readAppMonitoringdokploy_application_readAppMonitoringCRead-onlyIdempotent
[application] application.readAppMonitoring (GET)
Parameters:
appName (string, required)
Inputs: appName (required).
dokploy_application_readTraefikConfigdokploy_application_readTraefikConfigBRead-onlyIdempotent
[application] application.readTraefikConfig (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_redeploydokploy_application_redeployC
[application] application.redeploy (POST)
Parameters:
applicationId (string, required)
title (string, optional)
description (string, optional)
Inputs: applicationId (required), title, description.
dokploy_application_refreshTokendokploy_application_refreshTokenD
[application] application.refreshToken (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_reloaddokploy_application_reloadC
[application] application.reload (POST)
Parameters:
appName (string, required)
applicationId (string, required)
Inputs: appName (required), applicationId (required).
dokploy_application_saveBitbucketProviderdokploy_application_saveBitbucketProviderC
[application] application.saveBitbucketProvider (POST)
Parameters:
bitbucketBranch (any, required)
bitbucketBuildPath (any, required)
bitbucketOwner (any, required)
bitbucketRepository (any, required)
bitbucketRepositorySlug (any, required)
bitbucketId (any, required)
applicationId (string, required)
enableSubmodules (boolean, optional)
watchPaths (any, optional)
Inputs: bitbucketBranch (required), bitbucketBuildPath (required), bitbucketOwner (required), bitbucketRepository (required), +5 more.
dokploy_application_saveBuildTypedokploy_application_saveBuildTypeD
[application] application.saveBuildType (POST)
Parameters:
applicationId (string, required)
buildType (enum: dockerfile, heroku_buildpacks, paketo_buildpacks, nixpacks, static, railpack, required)
dockerfile (any, required)
dockerContextPath (any, required)
dockerBuildStage (any, required)
herokuVersion (any, required)
railpackVersion (any, required)
publishDirectory (any, optional)
isStaticSpa (any, optional)
Inputs: applicationId (required), buildType (required), dockerfile (required), dockerContextPath (required), +5 more.
dokploy_application_saveDockerProviderdokploy_application_saveDockerProviderC
[application] application.saveDockerProvider (POST)
Parameters:
dockerImage (any, required)
applicationId (string, required)
username (any, required)
password (any, required)
registryUrl (any, required)
Inputs: dockerImage (required), applicationId (required), username (required), password (required), +1 more.
dokploy_application_saveEnvironmentdokploy_application_saveEnvironmentD
[application] application.saveEnvironment (POST)
Parameters:
applicationId (string, required)
env (any, required)
buildArgs (any, required)
buildSecrets (any, required)
createEnvFile (boolean, required)
Inputs: applicationId (required), env (required), buildArgs (required), buildSecrets (required), +1 more.
dokploy_application_saveGiteaProviderdokploy_application_saveGiteaProviderD
[application] application.saveGiteaProvider (POST)
Parameters:
applicationId (string, required)
giteaBranch (any, required)
giteaBuildPath (any, required)
giteaOwner (any, required)
giteaRepository (any, required)
giteaId (any, required)
enableSubmodules (boolean, optional)
watchPaths (any, optional)
Inputs: applicationId (required), giteaBranch (required), giteaBuildPath (required), giteaOwner (required), +4 more.
dokploy_application_saveGithubProviderdokploy_application_saveGithubProviderC
[application] application.saveGithubProvider (POST)
Parameters:
applicationId (string, required)
repository (any, required)
branch (any, required)
owner (any, required)
buildPath (any, required)
githubId (any, required)
triggerType (enum: push, tag, required)
enableSubmodules (boolean, optional)
watchPaths (any, optional)
Inputs: applicationId (required), repository (required), branch (required), owner (required), +5 more.
dokploy_application_saveGitlabProviderdokploy_application_saveGitlabProviderD
[application] application.saveGitlabProvider (POST)
Parameters:
applicationId (string, required)
gitlabBranch (any, required)
gitlabBuildPath (any, required)
gitlabOwner (any, required)
gitlabRepository (any, required)
gitlabId (any, required)
gitlabProjectId (any, required)
gitlabPathNamespace (any, required)
enableSubmodules (boolean, optional)
watchPaths (any, optional)
Inputs: applicationId (required), gitlabBranch (required), gitlabBuildPath (required), gitlabOwner (required), +6 more.
dokploy_application_saveGitProviderdokploy_application_saveGitProviderC
[application] application.saveGitProvider (POST)
Parameters:
customGitBranch (any, required)
applicationId (string, required)
customGitBuildPath (any, required)
customGitUrl (any, required)
watchPaths (any, required)
enableSubmodules (boolean, optional)
customGitSSHKeyId (any, optional)
Inputs: customGitBranch (required), applicationId (required), customGitBuildPath (required), customGitUrl (required), +3 more.
dokploy_application_searchdokploy_application_searchCRead-onlyIdempotent
[application] application.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
repository (string, optional)
owner (string, optional)
dockerImage (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +7 more.
dokploy_application_startdokploy_application_startD
[application] application.start (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_stopdokploy_application_stopC
[application] application.stop (POST)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_application_updatedokploy_application_updateDIdempotent
[application] application.update (POST)
Parameters:
applicationId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
env (any, optional)
previewEnv (any, optional)
watchPaths (any, optional)
previewBuildArgs (any, optional)
previewBuildSecrets (any, optional)
previewLabels (any, optional)
previewWildcard (any, optional)
previewPort (any, optional)
previewHttps (boolean, optional)
previewPath (any, optional)
previewCertificateType (enum: letsencrypt, none, custom, optional)
previewCustomCertResolver (any, optional)
previewLimit (any, optional)
isPreviewDeploymentsActive (any, optional)
previewRequireCollaboratorPermissions (any, optional)
rollbackActive (any, optional)
buildArgs (any, optional)
buildSecrets (any, optional)
memoryReservation (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
title (any, optional)
enabled (any, optional)
subtitle (any, optional)
command (any, optional)
args (any, optional)
refreshToken (any, optional)
sourceType (enum: github, docker, git, gitlab, bitbucket, gitea, drop, optional)
cleanCache (any, optional)
repository (any, optional)
owner (any, optional)
branch (any, optional)
buildPath (any, optional)
triggerType (any, optional)
autoDeploy (any, optional)
gitlabProjectId (any, optional)
gitlabRepository (any, optional)
gitlabOwner (any, optional)
gitlabBranch (any, optional)
gitlabBuildPath (any, optional)
gitlabPathNamespace (any, optional)
giteaRepository (any, optional)
giteaOwner (any, optional)
giteaBranch (any, optional)
giteaBuildPath (any, optional)
bitbucketRepository (any, optional)
bitbucketRepositorySlug (any, optional)
bitbucketOwner (any, optional)
bitbucketBranch (any, optional)
bitbucketBuildPath (any, optional)
username (any, optional)
password (any, optional)
dockerImage (any, optional)
registryUrl (any, optional)
customGitUrl (any, optional)
customGitBranch (any, optional)
customGitBuildPath (any, optional)
customGitSSHKeyId (any, optional)
enableSubmodules (boolean, optional)
dockerfile (any, optional)
dockerContextPath (any, optional)
dockerBuildStage (any, optional)
dropBuildPath (any, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
applicationStatus (enum: idle, running, done, error, optional)
buildType (enum: dockerfile, heroku_buildpacks, paketo_buildpacks, nixpacks, static, railpack, optional)
railpackVersion (any, optional)
herokuVersion (any, optional)
publishDirectory (any, optional)
isStaticSpa (any, optional)
createEnvFile (boolean, optional)
createdAt (string, optional)
registryId (any, optional)
rollbackRegistryId (any, optional)
environmentId (string, optional)
githubId (any, optional)
gitlabId (any, optional)
giteaId (any, optional)
bitbucketId (any, optional)
buildServerId (any, optional)
buildRegistryId (any, optional)
Inputs: applicationId (required), name, appName, description, +93 more.
dokploy_application_updateTraefikConfigdokploy_application_updateTraefikConfigCIdempotent
[application] application.updateTraefikConfig (POST)
Parameters:
applicationId (string, required)
traefikConfig (string, required)
Inputs: applicationId (required), traefikConfig (required).
dokploy_auditLog_alldokploy_auditLog_allCRead-onlyIdempotent
[auditLog] auditLog.all (GET)
Parameters:
userId (string, optional)
userEmail (string, optional)
resourceName (string, optional)
action (enum: create, update, delete, deploy, cancel, redeploy, login, logout, optional)
resourceType (enum: project, service, environment, deployment, user, customRole, domain, certificate, registry, server, sshKey, gitProvider, notification, settings, session, optional)
from (string, optional)
to (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: userId, userEmail, resourceName, action, +5 more.
dokploy_backup_createdokploy_backup_createC
[backup] backup.create (POST)
Parameters:
schedule (string, required)
enabled (any, optional)
prefix (string, required)
destinationId (string, required)
keepLatestCount (any, optional)
database (string, required)
mariadbId (any, optional)
mysqlId (any, optional)
postgresId (any, optional)
mongoId (any, optional)
databaseType (enum: postgres, mariadb, mysql, mongo, web-server, required)
userId (any, optional)
backupType (enum: database, compose, optional)
composeId (any, optional)
serviceName (any, optional)
metadata (any, optional)
Inputs: schedule (required), prefix (required), destinationId (required), database (required), +12 more.
dokploy_backup_listBackupFilesdokploy_backup_listBackupFilesCRead-onlyIdempotent
[backup] backup.listBackupFiles (GET)
Parameters:
destinationId (string, required)
search (string, required)
serverId (string, optional)
Inputs: destinationId (required), search (required), serverId.
dokploy_backup_manualBackupComposedokploy_backup_manualBackupComposeC
[backup] backup.manualBackupCompose (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_manualBackupMariadbdokploy_backup_manualBackupMariadbC
[backup] backup.manualBackupMariadb (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_manualBackupMongodokploy_backup_manualBackupMongoC
[backup] backup.manualBackupMongo (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_manualBackupMySqldokploy_backup_manualBackupMySqlC
[backup] backup.manualBackupMySql (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_manualBackupPostgresdokploy_backup_manualBackupPostgresC
[backup] backup.manualBackupPostgres (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_manualBackupWebServerdokploy_backup_manualBackupWebServerC
[backup] backup.manualBackupWebServer (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_onedokploy_backup_oneCRead-onlyIdempotent
[backup] backup.one (GET)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_removedokploy_backup_removeBDestructive
[backup] backup.remove (POST)
Parameters:
backupId (string, required)
Inputs: backupId (required).
dokploy_backup_updatedokploy_backup_updateCIdempotent
[backup] backup.update (POST)
Parameters:
schedule (string, required)
enabled (any, required)
prefix (string, required)
backupId (string, required)
destinationId (string, required)
database (string, required)
keepLatestCount (any, required)
serviceName (any, required)
metadata (any, required)
databaseType (enum: postgres, mariadb, mysql, mongo, web-server, required)
Inputs: schedule (required), enabled (required), prefix (required), backupId (required), +6 more.
dokploy_bitbucket_bitbucketProvidersdokploy_bitbucket_bitbucketProvidersCRead-onlyIdempotent
[bitbucket] bitbucket.bitbucketProviders (GET)
Inputs: no named parameters.
dokploy_bitbucket_createdokploy_bitbucket_createC
[bitbucket] bitbucket.create (POST)
Parameters:
bitbucketId (string, optional)
bitbucketUsername (string, optional)
bitbucketEmail (string, optional)
appPassword (string, optional)
apiToken (string, optional)
bitbucketWorkspaceName (string, optional)
gitProviderId (string, optional)
authId (string, required)
name (string, required)
Inputs: authId (required), name (required), bitbucketId, bitbucketUsername, +5 more.
dokploy_bitbucket_getBitbucketBranchesdokploy_bitbucket_getBitbucketBranchesCRead-onlyIdempotent
[bitbucket] bitbucket.getBitbucketBranches (GET)
Parameters:
owner (string, required)
repo (string, required)
bitbucketId (string, optional)
Inputs: owner (required), repo (required), bitbucketId.
dokploy_bitbucket_getBitbucketRepositoriesdokploy_bitbucket_getBitbucketRepositoriesCRead-onlyIdempotent
[bitbucket] bitbucket.getBitbucketRepositories (GET)
Parameters:
bitbucketId (string, required)
Inputs: bitbucketId (required).
dokploy_bitbucket_onedokploy_bitbucket_oneCRead-onlyIdempotent
[bitbucket] bitbucket.one (GET)
Parameters:
bitbucketId (string, required)
Inputs: bitbucketId (required).
dokploy_bitbucket_testConnectiondokploy_bitbucket_testConnectionC
[bitbucket] bitbucket.testConnection (POST)
Parameters:
bitbucketId (string, required)
bitbucketUsername (string, optional)
bitbucketEmail (string, optional)
workspaceName (string, optional)
apiToken (string, optional)
appPassword (string, optional)
Inputs: bitbucketId (required), bitbucketUsername, bitbucketEmail, workspaceName, +2 more.
dokploy_bitbucket_updatedokploy_bitbucket_updateCIdempotent
[bitbucket] bitbucket.update (POST)
Parameters:
bitbucketId (string, required)
bitbucketUsername (string, optional)
bitbucketEmail (string, optional)
appPassword (string, optional)
apiToken (string, optional)
bitbucketWorkspaceName (string, optional)
gitProviderId (string, required)
name (string, required)
organizationId (string, optional)
Inputs: bitbucketId (required), gitProviderId (required), name (required), bitbucketUsername, +5 more.
dokploy_certificates_alldokploy_certificates_allCRead-onlyIdempotent
[certificates] certificates.all (GET)
Inputs: no named parameters.
dokploy_certificates_createdokploy_certificates_createC
[certificates] certificates.create (POST)
Parameters:
certificateId (string, optional)
name (string, required)
certificateData (string, required)
privateKey (string, required)
certificatePath (string, optional)
autoRenew (any, optional)
organizationId (string, required)
serverId (any, optional)
Inputs: name (required), certificateData (required), privateKey (required), organizationId (required), +4 more.
dokploy_certificates_onedokploy_certificates_oneCRead-onlyIdempotent
[certificates] certificates.one (GET)
Parameters:
certificateId (string, required)
Inputs: certificateId (required).
dokploy_certificates_removedokploy_certificates_removeCDestructive
[certificates] certificates.remove (POST)
Parameters:
certificateId (string, required)
Inputs: certificateId (required).
dokploy_cluster_addManagerdokploy_cluster_addManagerCRead-onlyIdempotent
[cluster] cluster.addManager (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_cluster_addWorkerdokploy_cluster_addWorkerCRead-onlyIdempotent
[cluster] cluster.addWorker (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_cluster_getNodesdokploy_cluster_getNodesCRead-onlyIdempotent
[cluster] cluster.getNodes (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_cluster_removeWorkerdokploy_cluster_removeWorkerCDestructive
[cluster] cluster.removeWorker (POST)
Parameters:
nodeId (string, required)
serverId (string, optional)
Inputs: nodeId (required), serverId.
dokploy_compose_cancelDeploymentdokploy_compose_cancelDeploymentCRead-only
[compose] compose.cancelDeployment (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_cleanQueuesdokploy_compose_cleanQueuesCDestructive
[compose] compose.cleanQueues (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_clearDeploymentsdokploy_compose_clearDeploymentsC
[compose] compose.clearDeployments (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_createdokploy_compose_createC
[compose] compose.create (POST)
Parameters:
name (string, required)
description (any, optional)
environmentId (string, required)
composeType (enum: docker-compose, stack, optional)
appName (string, optional)
serverId (any, optional)
composeFile (string, optional)
Inputs: name (required), environmentId (required), description, composeType, +3 more.
dokploy_compose_deletedokploy_compose_deleteBDestructive
[compose] compose.delete (POST)
Parameters:
composeId (string, required)
deleteVolumes (boolean, required)
Inputs: composeId (required), deleteVolumes (required).
dokploy_compose_deploydokploy_compose_deployC
[compose] compose.deploy (POST)
Parameters:
composeId (string, required)
title (string, optional)
description (string, optional)
Inputs: composeId (required), title, description.
dokploy_compose_deployTemplatedokploy_compose_deployTemplateD
[compose] compose.deployTemplate (POST)
Parameters:
environmentId (string, required)
serverId (string, optional)
id (string, required)
baseUrl (string, optional)
Inputs: environmentId (required), id (required), serverId, baseUrl.
dokploy_compose_disconnectGitProviderdokploy_compose_disconnectGitProviderD
[compose] compose.disconnectGitProvider (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_fetchSourceTypedokploy_compose_fetchSourceTypeD
[compose] compose.fetchSourceType (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_getConvertedComposedokploy_compose_getConvertedComposeCRead-onlyIdempotent
[compose] compose.getConvertedCompose (GET)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_getDefaultCommanddokploy_compose_getDefaultCommandCRead-onlyIdempotent
[compose] compose.getDefaultCommand (GET)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_getTagsdokploy_compose_getTagsCRead-onlyIdempotent
[compose] compose.getTags (GET)
Parameters:
baseUrl (string, optional)
Inputs: baseUrl.
dokploy_compose_importdokploy_compose_importD
[compose] compose.import (POST)
Parameters:
base64 (string, required)
composeId (string, required)
Inputs: base64 (required), composeId (required).
dokploy_compose_isolatedDeploymentdokploy_compose_isolatedDeploymentCRead-only
[compose] compose.isolatedDeployment (POST)
Parameters:
composeId (string, required)
suffix (string, optional)
Inputs: composeId (required), suffix.
dokploy_compose_killBuilddokploy_compose_killBuildCDestructive
[compose] compose.killBuild (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_loadMountsByServicedokploy_compose_loadMountsByServiceCRead-onlyIdempotent
[compose] compose.loadMountsByService (GET)
Parameters:
composeId (string, required)
serviceName (string, required)
Inputs: composeId (required), serviceName (required).
dokploy_compose_loadServicesdokploy_compose_loadServicesCRead-onlyIdempotent
[compose] compose.loadServices (GET)
Parameters:
composeId (string, required)
type (enum: fetch, cache, optional)
Inputs: composeId (required), type.
dokploy_compose_movedokploy_compose_moveD
[compose] compose.move (POST)
Parameters:
composeId (string, required)
targetEnvironmentId (string, required)
Inputs: composeId (required), targetEnvironmentId (required).
dokploy_compose_onedokploy_compose_oneCRead-onlyIdempotent
[compose] compose.one (GET)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_processTemplatedokploy_compose_processTemplateD
[compose] compose.processTemplate (POST)
Parameters:
base64 (string, required)
composeId (string, required)
Inputs: base64 (required), composeId (required).
dokploy_compose_randomizeComposedokploy_compose_randomizeComposeC
[compose] compose.randomizeCompose (POST)
Parameters:
composeId (string, required)
suffix (string, optional)
Inputs: composeId (required), suffix.
dokploy_compose_redeploydokploy_compose_redeployC
[compose] compose.redeploy (POST)
Parameters:
composeId (string, required)
title (string, optional)
description (string, optional)
Inputs: composeId (required), title, description.
dokploy_compose_refreshTokendokploy_compose_refreshTokenD
[compose] compose.refreshToken (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_searchdokploy_compose_searchCRead-onlyIdempotent
[compose] compose.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_compose_startdokploy_compose_startD
[compose] compose.start (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_stopdokploy_compose_stopD
[compose] compose.stop (POST)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_compose_templatesdokploy_compose_templatesCRead-onlyIdempotent
[compose] compose.templates (GET)
Parameters:
baseUrl (string, optional)
Inputs: baseUrl.
dokploy_compose_updatedokploy_compose_updateDIdempotent
[compose] compose.update (POST)
Parameters:
composeId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
env (any, optional)
composeFile (string, optional)
refreshToken (any, optional)
sourceType (enum: git, github, gitlab, bitbucket, gitea, raw, optional)
composeType (enum: docker-compose, stack, optional)
repository (any, optional)
owner (any, optional)
branch (any, optional)
autoDeploy (any, optional)
gitlabProjectId (any, optional)
gitlabRepository (any, optional)
gitlabOwner (any, optional)
gitlabBranch (any, optional)
gitlabPathNamespace (any, optional)
bitbucketRepository (any, optional)
bitbucketRepositorySlug (any, optional)
bitbucketOwner (any, optional)
bitbucketBranch (any, optional)
giteaRepository (any, optional)
giteaOwner (any, optional)
giteaBranch (any, optional)
customGitUrl (any, optional)
customGitBranch (any, optional)
customGitSSHKeyId (any, optional)
command (string, optional)
enableSubmodules (boolean, optional)
composePath (string, optional)
suffix (string, optional)
randomize (boolean, optional)
isolatedDeployment (boolean, optional)
isolatedDeploymentsVolume (boolean, optional)
triggerType (any, optional)
composeStatus (enum: idle, running, done, error, optional)
environmentId (string, optional)
createdAt (string, optional)
watchPaths (any, optional)
githubId (any, optional)
gitlabId (any, optional)
bitbucketId (any, optional)
giteaId (any, optional)
Inputs: composeId (required), name, appName, description, +40 more.
dokploy_customRole_alldokploy_customRole_allCRead-onlyIdempotent
[customRole] customRole.all (GET)
Inputs: no named parameters.
dokploy_customRole_createdokploy_customRole_createC
[customRole] customRole.create (POST)
Parameters:
roleName (string, required)
permissions (object, required)
Inputs: roleName (required), permissions (required).
dokploy_customRole_getStatementsdokploy_customRole_getStatementsCRead-onlyIdempotent
[customRole] customRole.getStatements (GET)
Inputs: no named parameters.
dokploy_customRole_membersByRoledokploy_customRole_membersByRoleCRead-onlyIdempotent
[customRole] customRole.membersByRole (GET)
Parameters:
roleName (string, required)
Inputs: roleName (required).
dokploy_customRole_removedokploy_customRole_removeCDestructive
[customRole] customRole.remove (POST)
Parameters:
roleName (string, required)
Inputs: roleName (required).
dokploy_customRole_updatedokploy_customRole_updateBIdempotent
[customRole] customRole.update (POST)
Parameters:
roleName (string, required)
newRoleName (string, optional)
permissions (object, required)
Inputs: roleName (required), permissions (required), newRoleName.
dokploy_deployment_alldokploy_deployment_allCRead-onlyIdempotent
[deployment] deployment.all (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_deployment_allByComposedokploy_deployment_allByComposeCRead-onlyIdempotent
[deployment] deployment.allByCompose (GET)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_deployment_allByServerdokploy_deployment_allByServerCRead-onlyIdempotent
[deployment] deployment.allByServer (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_deployment_allByTypedokploy_deployment_allByTypeCRead-onlyIdempotent
[deployment] deployment.allByType (GET)
Parameters:
id (string, required)
type (enum: application, compose, server, schedule, previewDeployment, backup, volumeBackup, required)
Inputs: id (required), type (required).
dokploy_deployment_allCentralizeddokploy_deployment_allCentralizedCRead-onlyIdempotent
[deployment] deployment.allCentralized (GET)
Inputs: no named parameters.
dokploy_deployment_killProcessdokploy_deployment_killProcessCDestructive
[deployment] deployment.killProcess (POST)
Parameters:
deploymentId (string, required)
Inputs: deploymentId (required).
dokploy_deployment_queueListdokploy_deployment_queueListCRead-onlyIdempotent
[deployment] deployment.queueList (GET)
Inputs: no named parameters.
dokploy_deployment_removeDeploymentdokploy_deployment_removeDeploymentCDestructive
[deployment] deployment.removeDeployment (POST)
Parameters:
deploymentId (string, required)
Inputs: deploymentId (required).
dokploy_destination_alldokploy_destination_allCRead-onlyIdempotent
[destination] destination.all (GET)
Inputs: no named parameters.
dokploy_destination_createdokploy_destination_createC
[destination] destination.create (POST)
Parameters:
name (string, required)
provider (any, required)
accessKey (string, required)
bucket (string, required)
region (string, required)
endpoint (string, required)
secretAccessKey (string, required)
serverId (string, optional)
Inputs: name (required), provider (required), accessKey (required), bucket (required), +4 more.
dokploy_destination_onedokploy_destination_oneCRead-onlyIdempotent
[destination] destination.one (GET)
Parameters:
destinationId (string, required)
Inputs: destinationId (required).
dokploy_destination_removedokploy_destination_removeCDestructive
[destination] destination.remove (POST)
Parameters:
destinationId (string, required)
Inputs: destinationId (required).
dokploy_destination_testConnectiondokploy_destination_testConnectionC
[destination] destination.testConnection (POST)
Parameters:
name (string, required)
provider (any, required)
accessKey (string, required)
bucket (string, required)
region (string, required)
endpoint (string, required)
secretAccessKey (string, required)
serverId (string, optional)
Inputs: name (required), provider (required), accessKey (required), bucket (required), +4 more.
dokploy_destination_updatedokploy_destination_updateCIdempotent
[destination] destination.update (POST)
Parameters:
name (string, required)
accessKey (string, required)
bucket (string, required)
region (string, required)
endpoint (string, required)
secretAccessKey (string, required)
destinationId (string, required)
provider (any, required)
serverId (string, optional)
Inputs: name (required), accessKey (required), bucket (required), region (required), +5 more.
dokploy_docker_getConfigdokploy_docker_getConfigCRead-onlyIdempotent
[docker] docker.getConfig (GET)
Parameters:
containerId (string, required)
serverId (string, optional)
Inputs: containerId (required), serverId.
dokploy_docker_getContainersdokploy_docker_getContainersCRead-onlyIdempotent
[docker] docker.getContainers (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_docker_getContainersByAppLabeldokploy_docker_getContainersByAppLabelCRead-onlyIdempotent
[docker] docker.getContainersByAppLabel (GET)
Parameters:
appName (string, required)
serverId (string, optional)
type (enum: standalone, swarm, required)
Inputs: appName (required), type (required), serverId.
dokploy_docker_getContainersByAppNameMatchdokploy_docker_getContainersByAppNameMatchCRead-onlyIdempotent
[docker] docker.getContainersByAppNameMatch (GET)
Parameters:
appType (enum: stack, docker-compose, optional)
appName (string, required)
serverId (string, optional)
Inputs: appName (required), appType, serverId.
dokploy_docker_getServiceContainersByAppNamedokploy_docker_getServiceContainersByAppNameCRead-onlyIdempotent
[docker] docker.getServiceContainersByAppName (GET)
Parameters:
appName (string, required)
serverId (string, optional)
Inputs: appName (required), serverId.
dokploy_docker_getStackContainersByAppNamedokploy_docker_getStackContainersByAppNameCRead-onlyIdempotent
[docker] docker.getStackContainersByAppName (GET)
Parameters:
appName (string, required)
serverId (string, optional)
Inputs: appName (required), serverId.
dokploy_docker_restartContainerdokploy_docker_restartContainerB
[docker] docker.restartContainer (POST)
Parameters:
containerId (string, required)
Inputs: containerId (required).
dokploy_domain_byApplicationIddokploy_domain_byApplicationIdCRead-onlyIdempotent
[domain] domain.byApplicationId (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_domain_byComposeIddokploy_domain_byComposeIdCRead-onlyIdempotent
[domain] domain.byComposeId (GET)
Parameters:
composeId (string, required)
Inputs: composeId (required).
dokploy_domain_canGenerateTraefikMeDomainsdokploy_domain_canGenerateTraefikMeDomainsCRead-onlyIdempotent
[domain] domain.canGenerateTraefikMeDomains (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_domain_createdokploy_domain_createD
[domain] domain.create (POST)
Parameters:
host (string, required)
path (any, optional)
port (any, optional)
https (boolean, optional)
applicationId (any, optional)
certificateType (enum: letsencrypt, none, custom, optional)
customCertResolver (any, optional)
composeId (any, optional)
serviceName (any, optional)
domainType (any, optional)
previewDeploymentId (any, optional)
internalPath (any, optional)
stripPath (boolean, optional)
Inputs: host (required), path, port, https, +9 more.
dokploy_domain_deletedokploy_domain_deleteCDestructive
[domain] domain.delete (POST)
Parameters:
domainId (string, required)
Inputs: domainId (required).
dokploy_domain_generateDomaindokploy_domain_generateDomainC
[domain] domain.generateDomain (POST)
Parameters:
appName (string, required)
serverId (string, optional)
Inputs: appName (required), serverId.
dokploy_domain_onedokploy_domain_oneCRead-onlyIdempotent
[domain] domain.one (GET)
Parameters:
domainId (string, required)
Inputs: domainId (required).
dokploy_domain_updatedokploy_domain_updateCIdempotent
[domain] domain.update (POST)
Parameters:
host (string, required)
path (any, optional)
port (any, optional)
https (boolean, optional)
certificateType (enum: letsencrypt, none, custom, optional)
customCertResolver (any, optional)
serviceName (any, optional)
domainType (any, optional)
internalPath (any, optional)
stripPath (boolean, optional)
domainId (string, required)
Inputs: host (required), domainId (required), path, port, +7 more.
dokploy_domain_validateDomaindokploy_domain_validateDomainCRead-only
[domain] domain.validateDomain (POST)
Parameters:
domain (string, required)
serverIp (string, optional)
Inputs: domain (required), serverIp.
dokploy_environment_byProjectIddokploy_environment_byProjectIdCRead-onlyIdempotent
[environment] environment.byProjectId (GET)
Parameters:
projectId (string, required)
Inputs: projectId (required).
dokploy_environment_createdokploy_environment_createD
[environment] environment.create (POST)
Parameters:
name (string, required)
description (string, optional)
projectId (string, required)
Inputs: name (required), projectId (required), description.
dokploy_environment_duplicatedokploy_environment_duplicateC
[environment] environment.duplicate (POST)
Parameters:
environmentId (string, required)
name (string, required)
description (string, optional)
Inputs: environmentId (required), name (required), description.
dokploy_environment_onedokploy_environment_oneCRead-onlyIdempotent
[environment] environment.one (GET)
Parameters:
environmentId (string, required)
Inputs: environmentId (required).
dokploy_environment_removedokploy_environment_removeCDestructive
[environment] environment.remove (POST)
Parameters:
environmentId (string, required)
Inputs: environmentId (required).
dokploy_environment_searchdokploy_environment_searchCRead-onlyIdempotent
[environment] environment.search (GET)
Parameters:
q (string, optional)
name (string, optional)
description (string, optional)
projectId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, description, projectId, +2 more.
dokploy_environment_updatedokploy_environment_updateCIdempotent
[environment] environment.update (POST)
Parameters:
environmentId (string, required)
name (string, optional)
description (string, optional)
projectId (string, optional)
env (string, optional)
Inputs: environmentId (required), name, description, projectId, +1 more.
dokploy_gitea_createdokploy_gitea_createD
[gitea] gitea.create (POST)
Parameters:
giteaId (string, optional)
giteaUrl (string, required)
giteaInternalUrl (any, optional)
redirectUri (string, optional)
clientId (string, optional)
clientSecret (string, optional)
gitProviderId (string, optional)
accessToken (string, optional)
refreshToken (string, optional)
expiresAt (number, optional)
scopes (string, optional)
lastAuthenticatedAt (number, optional)
name (string, required)
giteaUsername (string, optional)
organizationName (string, optional)
Inputs: giteaUrl (required), name (required), giteaId, giteaInternalUrl, +11 more.
dokploy_gitea_getGiteaBranchesdokploy_gitea_getGiteaBranchesBRead-onlyIdempotent
[gitea] gitea.getGiteaBranches (GET)
Parameters:
owner (string, required)
repositoryName (string, required)
giteaId (string, optional)
Inputs: owner (required), repositoryName (required), giteaId.
dokploy_gitea_getGiteaRepositoriesdokploy_gitea_getGiteaRepositoriesCRead-onlyIdempotent
[gitea] gitea.getGiteaRepositories (GET)
Parameters:
giteaId (string, required)
Inputs: giteaId (required).
dokploy_gitea_getGiteaUrldokploy_gitea_getGiteaUrlCRead-onlyIdempotent
[gitea] gitea.getGiteaUrl (GET)
Parameters:
giteaId (string, required)
Inputs: giteaId (required).
dokploy_gitea_giteaProvidersdokploy_gitea_giteaProvidersCRead-onlyIdempotent
[gitea] gitea.giteaProviders (GET)
Inputs: no named parameters.
dokploy_gitea_onedokploy_gitea_oneCRead-onlyIdempotent
[gitea] gitea.one (GET)
Parameters:
giteaId (string, required)
Inputs: giteaId (required).
dokploy_gitea_testConnectiondokploy_gitea_testConnectionC
[gitea] gitea.testConnection (POST)
Parameters:
giteaId (string, optional)
organizationName (string, optional)
Inputs: giteaId, organizationName.
dokploy_gitea_updatedokploy_gitea_updateCIdempotent
[gitea] gitea.update (POST)
Parameters:
giteaId (string, required)
giteaUrl (string, required)
giteaInternalUrl (any, optional)
redirectUri (string, optional)
clientId (string, optional)
clientSecret (string, optional)
gitProviderId (string, required)
accessToken (string, optional)
refreshToken (string, optional)
expiresAt (number, optional)
scopes (string, optional)
lastAuthenticatedAt (number, optional)
name (string, required)
giteaUsername (string, optional)
organizationName (string, optional)
Inputs: giteaId (required), giteaUrl (required), gitProviderId (required), name (required), +11 more.
dokploy_github_getGithubBranchesdokploy_github_getGithubBranchesCRead-onlyIdempotent
[github] github.getGithubBranches (GET)
Parameters:
repo (string, required)
owner (string, required)
githubId (string, optional)
Inputs: repo (required), owner (required), githubId.
dokploy_github_getGithubRepositoriesdokploy_github_getGithubRepositoriesCRead-onlyIdempotent
[github] github.getGithubRepositories (GET)
Parameters:
githubId (string, required)
Inputs: githubId (required).
dokploy_github_githubProvidersdokploy_github_githubProvidersCRead-onlyIdempotent
[github] github.githubProviders (GET)
Inputs: no named parameters.
dokploy_github_onedokploy_github_oneCRead-onlyIdempotent
[github] github.one (GET)
Parameters:
githubId (string, required)
Inputs: githubId (required).
dokploy_github_testConnectiondokploy_github_testConnectionC
[github] github.testConnection (POST)
Parameters:
githubId (string, required)
Inputs: githubId (required).
dokploy_github_updatedokploy_github_updateCIdempotent
[github] github.update (POST)
Parameters:
githubId (string, required)
name (string, required)
gitProviderId (string, required)
githubAppName (string, required)
Inputs: githubId (required), name (required), gitProviderId (required), githubAppName (required).
dokploy_gitlab_createdokploy_gitlab_createC
[gitlab] gitlab.create (POST)
Parameters:
applicationId (string, optional)
secret (string, optional)
groupName (string, optional)
gitProviderId (string, optional)
redirectUri (string, optional)
authId (string, required)
name (string, required)
gitlabUrl (string, required)
gitlabInternalUrl (any, optional)
Inputs: authId (required), name (required), gitlabUrl (required), applicationId, +5 more.
dokploy_gitlab_getGitlabBranchesdokploy_gitlab_getGitlabBranchesCRead-onlyIdempotent
[gitlab] gitlab.getGitlabBranches (GET)
Parameters:
id (number, optional)
owner (string, required)
repo (string, required)
gitlabId (string, optional)
Inputs: owner (required), repo (required), id, gitlabId.
dokploy_gitlab_getGitlabRepositoriesdokploy_gitlab_getGitlabRepositoriesCRead-onlyIdempotent
[gitlab] gitlab.getGitlabRepositories (GET)
Parameters:
gitlabId (string, required)
Inputs: gitlabId (required).
dokploy_gitlab_gitlabProvidersdokploy_gitlab_gitlabProvidersCRead-onlyIdempotent
[gitlab] gitlab.gitlabProviders (GET)
Inputs: no named parameters.
dokploy_gitlab_onedokploy_gitlab_oneCRead-onlyIdempotent
[gitlab] gitlab.one (GET)
Parameters:
gitlabId (string, required)
Inputs: gitlabId (required).
dokploy_gitlab_testConnectiondokploy_gitlab_testConnectionD
[gitlab] gitlab.testConnection (POST)
Parameters:
gitlabId (string, required)
groupName (string, optional)
Inputs: gitlabId (required), groupName.
dokploy_gitlab_updatedokploy_gitlab_updateCIdempotent
[gitlab] gitlab.update (POST)
Parameters:
applicationId (string, optional)
secret (string, optional)
groupName (string, optional)
redirectUri (string, optional)
name (string, required)
gitlabId (string, required)
gitlabUrl (string, required)
gitProviderId (string, required)
gitlabInternalUrl (any, optional)
Inputs: name (required), gitlabId (required), gitlabUrl (required), gitProviderId (required), +5 more.
dokploy_gitProvider_getAlldokploy_gitProvider_getAllCRead-onlyIdempotent
[gitProvider] gitProvider.getAll (GET)
Inputs: no named parameters.
dokploy_gitProvider_removedokploy_gitProvider_removeCDestructive
[gitProvider] gitProvider.remove (POST)
Parameters:
gitProviderId (string, required)
Inputs: gitProviderId (required).
dokploy_licenseKey_activatedokploy_licenseKey_activateC
[licenseKey] licenseKey.activate (POST)
Parameters:
licenseKey (string, required)
Inputs: licenseKey (required).
dokploy_licenseKey_deactivatedokploy_licenseKey_deactivateC
[licenseKey] licenseKey.deactivate (POST)
Inputs: no named parameters.
dokploy_licenseKey_getEnterpriseSettingsdokploy_licenseKey_getEnterpriseSettingsCRead-onlyIdempotent
[licenseKey] licenseKey.getEnterpriseSettings (GET)
Inputs: no named parameters.
dokploy_licenseKey_haveValidLicenseKeydokploy_licenseKey_haveValidLicenseKeyCRead-onlyIdempotent
[licenseKey] licenseKey.haveValidLicenseKey (GET)
Inputs: no named parameters.
dokploy_licenseKey_updateEnterpriseSettingsdokploy_licenseKey_updateEnterpriseSettingsCIdempotent
[licenseKey] licenseKey.updateEnterpriseSettings (POST)
Parameters:
enableEnterpriseFeatures (boolean, optional)
Inputs: enableEnterpriseFeatures.
dokploy_licenseKey_validatedokploy_licenseKey_validateCRead-only
[licenseKey] licenseKey.validate (POST)
Inputs: no named parameters.
dokploy_mariadb_changeStatusdokploy_mariadb_changeStatusC
[mariadb] mariadb.changeStatus (POST)
Parameters:
mariadbId (string, required)
applicationStatus (enum: idle, running, done, error, required)
Inputs: mariadbId (required), applicationStatus (required).
dokploy_mariadb_createdokploy_mariadb_createC
[mariadb] mariadb.create (POST)
Parameters:
name (string, required)
appName (string, optional)
dockerImage (string, optional)
databaseRootPassword (string, optional)
environmentId (string, required)
description (any, optional)
databaseName (string, required)
databaseUser (string, required)
databasePassword (string, required)
serverId (any, optional)
Inputs: name (required), environmentId (required), databaseName (required), databaseUser (required), +6 more.
dokploy_mariadb_deploydokploy_mariadb_deployC
[mariadb] mariadb.deploy (POST)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_movedokploy_mariadb_moveD
[mariadb] mariadb.move (POST)
Parameters:
mariadbId (string, required)
targetEnvironmentId (string, required)
Inputs: mariadbId (required), targetEnvironmentId (required).
dokploy_mariadb_onedokploy_mariadb_oneCRead-onlyIdempotent
[mariadb] mariadb.one (GET)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_rebuilddokploy_mariadb_rebuildC
[mariadb] mariadb.rebuild (POST)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_reloaddokploy_mariadb_reloadD
[mariadb] mariadb.reload (POST)
Parameters:
mariadbId (string, required)
appName (string, required)
Inputs: mariadbId (required), appName (required).
dokploy_mariadb_removedokploy_mariadb_removeCDestructive
[mariadb] mariadb.remove (POST)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_saveEnvironmentdokploy_mariadb_saveEnvironmentC
[mariadb] mariadb.saveEnvironment (POST)
Parameters:
mariadbId (string, required)
env (any, required)
Inputs: mariadbId (required), env (required).
dokploy_mariadb_saveExternalPortdokploy_mariadb_saveExternalPortC
[mariadb] mariadb.saveExternalPort (POST)
Parameters:
mariadbId (string, required)
externalPort (any, required)
Inputs: mariadbId (required), externalPort (required).
dokploy_mariadb_searchdokploy_mariadb_searchCRead-onlyIdempotent
[mariadb] mariadb.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_mariadb_startdokploy_mariadb_startC
[mariadb] mariadb.start (POST)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_stopdokploy_mariadb_stopC
[mariadb] mariadb.stop (POST)
Parameters:
mariadbId (string, required)
Inputs: mariadbId (required).
dokploy_mariadb_updatedokploy_mariadb_updateCIdempotent
[mariadb] mariadb.update (POST)
Parameters:
mariadbId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
databaseName (string, optional)
databaseUser (string, optional)
databasePassword (string, optional)
databaseRootPassword (string, optional)
dockerImage (string, optional)
command (any, optional)
args (any, optional)
env (any, optional)
memoryReservation (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
externalPort (any, optional)
applicationStatus (enum: idle, running, done, error, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
createdAt (string, optional)
environmentId (string, optional)
Inputs: mariadbId (required), name, appName, description, +28 more.
dokploy_mongo_changeStatusdokploy_mongo_changeStatusC
[mongo] mongo.changeStatus (POST)
Parameters:
mongoId (string, required)
applicationStatus (enum: idle, running, done, error, required)
Inputs: mongoId (required), applicationStatus (required).
dokploy_mongo_createdokploy_mongo_createC
[mongo] mongo.create (POST)
Parameters:
name (string, required)
appName (string, optional)
dockerImage (string, optional)
environmentId (string, required)
description (any, optional)
databaseUser (string, required)
databasePassword (string, required)
serverId (any, optional)
replicaSets (any, optional)
Inputs: name (required), environmentId (required), databaseUser (required), databasePassword (required), +5 more.
dokploy_mongo_deploydokploy_mongo_deployC
[mongo] mongo.deploy (POST)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_movedokploy_mongo_moveD
[mongo] mongo.move (POST)
Parameters:
mongoId (string, required)
targetEnvironmentId (string, required)
Inputs: mongoId (required), targetEnvironmentId (required).
dokploy_mongo_onedokploy_mongo_oneCRead-onlyIdempotent
[mongo] mongo.one (GET)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_rebuilddokploy_mongo_rebuildC
[mongo] mongo.rebuild (POST)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_reloaddokploy_mongo_reloadC
[mongo] mongo.reload (POST)
Parameters:
mongoId (string, required)
appName (string, required)
Inputs: mongoId (required), appName (required).
dokploy_mongo_removedokploy_mongo_removeCDestructive
[mongo] mongo.remove (POST)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_saveEnvironmentdokploy_mongo_saveEnvironmentC
[mongo] mongo.saveEnvironment (POST)
Parameters:
mongoId (string, required)
env (any, required)
Inputs: mongoId (required), env (required).
dokploy_mongo_saveExternalPortdokploy_mongo_saveExternalPortD
[mongo] mongo.saveExternalPort (POST)
Parameters:
mongoId (string, required)
externalPort (any, required)
Inputs: mongoId (required), externalPort (required).
dokploy_mongo_searchdokploy_mongo_searchCRead-onlyIdempotent
[mongo] mongo.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_mongo_startdokploy_mongo_startD
[mongo] mongo.start (POST)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_stopdokploy_mongo_stopC
[mongo] mongo.stop (POST)
Parameters:
mongoId (string, required)
Inputs: mongoId (required).
dokploy_mongo_updatedokploy_mongo_updateDIdempotent
[mongo] mongo.update (POST)
Parameters:
mongoId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
databaseUser (string, optional)
databasePassword (string, optional)
dockerImage (string, optional)
command (any, optional)
args (any, optional)
env (any, optional)
memoryReservation (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
externalPort (any, optional)
applicationStatus (enum: idle, running, done, error, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
createdAt (string, optional)
environmentId (string, optional)
replicaSets (any, optional)
Inputs: mongoId (required), name, appName, description, +27 more.
dokploy_mounts_allNamedByApplicationIddokploy_mounts_allNamedByApplicationIdCRead-onlyIdempotent
[mounts] mounts.allNamedByApplicationId (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_mounts_createdokploy_mounts_createD
[mounts] mounts.create (POST)
Parameters:
type (enum: bind, volume, file, required)
hostPath (any, optional)
volumeName (any, optional)
content (any, optional)
mountPath (string, required)
serviceType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, optional)
filePath (any, optional)
serviceId (string, required)
Inputs: type (required), mountPath (required), serviceId (required), hostPath, +4 more.
dokploy_mounts_listByServiceIddokploy_mounts_listByServiceIdCRead-onlyIdempotent
[mounts] mounts.listByServiceId (GET)
Parameters:
serviceId (string, required)
serviceType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, required)
Inputs: serviceId (required), serviceType (required).
dokploy_mounts_onedokploy_mounts_oneCRead-onlyIdempotent
[mounts] mounts.one (GET)
Parameters:
mountId (string, required)
Inputs: mountId (required).
dokploy_mounts_removedokploy_mounts_removeCDestructive
[mounts] mounts.remove (POST)
Parameters:
mountId (string, required)
Inputs: mountId (required).
dokploy_mounts_updatedokploy_mounts_updateCIdempotent
[mounts] mounts.update (POST)
Parameters:
mountId (string, required)
type (enum: bind, volume, file, optional)
hostPath (any, optional)
volumeName (any, optional)
filePath (any, optional)
content (any, optional)
serviceType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, optional)
mountPath (string, optional)
applicationId (any, optional)
postgresId (any, optional)
mariadbId (any, optional)
mongoId (any, optional)
mysqlId (any, optional)
redisId (any, optional)
composeId (any, optional)
Inputs: mountId (required), type, hostPath, volumeName, +11 more.
dokploy_mysql_changeStatusdokploy_mysql_changeStatusC
[mysql] mysql.changeStatus (POST)
Parameters:
mysqlId (string, required)
applicationStatus (enum: idle, running, done, error, required)
Inputs: mysqlId (required), applicationStatus (required).
dokploy_mysql_createdokploy_mysql_createD
[mysql] mysql.create (POST)
Parameters:
name (string, required)
appName (string, optional)
dockerImage (string, optional)
environmentId (string, required)
description (any, optional)
databaseName (string, required)
databaseUser (string, required)
databasePassword (string, required)
databaseRootPassword (string, optional)
serverId (any, optional)
Inputs: name (required), environmentId (required), databaseName (required), databaseUser (required), +6 more.
dokploy_mysql_deploydokploy_mysql_deployC
[mysql] mysql.deploy (POST)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_movedokploy_mysql_moveD
[mysql] mysql.move (POST)
Parameters:
mysqlId (string, required)
targetEnvironmentId (string, required)
Inputs: mysqlId (required), targetEnvironmentId (required).
dokploy_mysql_onedokploy_mysql_oneCRead-onlyIdempotent
[mysql] mysql.one (GET)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_rebuilddokploy_mysql_rebuildD
[mysql] mysql.rebuild (POST)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_reloaddokploy_mysql_reloadD
[mysql] mysql.reload (POST)
Parameters:
mysqlId (string, required)
appName (string, required)
Inputs: mysqlId (required), appName (required).
dokploy_mysql_removedokploy_mysql_removeCDestructive
[mysql] mysql.remove (POST)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_saveEnvironmentdokploy_mysql_saveEnvironmentC
[mysql] mysql.saveEnvironment (POST)
Parameters:
mysqlId (string, required)
env (any, required)
Inputs: mysqlId (required), env (required).
dokploy_mysql_saveExternalPortdokploy_mysql_saveExternalPortC
[mysql] mysql.saveExternalPort (POST)
Parameters:
mysqlId (string, required)
externalPort (any, required)
Inputs: mysqlId (required), externalPort (required).
dokploy_mysql_searchdokploy_mysql_searchCRead-onlyIdempotent
[mysql] mysql.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_mysql_startdokploy_mysql_startD
[mysql] mysql.start (POST)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_stopdokploy_mysql_stopC
[mysql] mysql.stop (POST)
Parameters:
mysqlId (string, required)
Inputs: mysqlId (required).
dokploy_mysql_updatedokploy_mysql_updateDIdempotent
[mysql] mysql.update (POST)
Parameters:
mysqlId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
databaseName (string, optional)
databaseUser (string, optional)
databasePassword (string, optional)
databaseRootPassword (string, optional)
dockerImage (string, optional)
command (any, optional)
args (any, optional)
env (any, optional)
memoryReservation (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
externalPort (any, optional)
applicationStatus (enum: idle, running, done, error, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
createdAt (string, optional)
environmentId (string, optional)
Inputs: mysqlId (required), name, appName, description, +28 more.
dokploy_notification_alldokploy_notification_allCRead-onlyIdempotent
[notification] notification.all (GET)
Inputs: no named parameters.
dokploy_notification_createCustomdokploy_notification_createCustomC
[notification] notification.createCustom (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, required)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
endpoint (string, required)
headers (object, optional)
Inputs: name (required), endpoint (required), appBuildError, databaseBackup, +6 more.
dokploy_notification_createDiscorddokploy_notification_createDiscordD
[notification] notification.createDiscord (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
webhookUrl (string, required)
decoration (boolean, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +6 more.
dokploy_notification_createEmaildokploy_notification_createEmailC
[notification] notification.createEmail (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
smtpServer (string, required)
smtpPort (number, required)
username (string, required)
password (string, required)
fromAddress (string, required)
toAddresses (array, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +10 more.
dokploy_notification_createGotifydokploy_notification_createGotifyD
[notification] notification.createGotify (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverUrl (string, required)
appToken (string, required)
priority (number, required)
decoration (boolean, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +7 more.
dokploy_notification_createLarkdokploy_notification_createLarkC
[notification] notification.createLark (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
webhookUrl (string, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +5 more.
dokploy_notification_createNtfydokploy_notification_createNtfyC
[notification] notification.createNtfy (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverUrl (string, required)
topic (string, required)
accessToken (string, required)
priority (number, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +7 more.
dokploy_notification_createPushoverdokploy_notification_createPushoverD
[notification] notification.createPushover (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, required)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
userKey (string, required)
apiToken (string, required)
priority (number, optional)
retry (any, optional)
expire (any, optional)
Inputs: name (required), userKey (required), apiToken (required), appBuildError, +9 more.
dokploy_notification_createResenddokploy_notification_createResendD
[notification] notification.createResend (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
apiKey (string, required)
fromAddress (string, required)
toAddresses (array, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +7 more.
dokploy_notification_createSlackdokploy_notification_createSlackD
[notification] notification.createSlack (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
webhookUrl (string, required)
channel (string, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +6 more.
dokploy_notification_createTeamsdokploy_notification_createTeamsC
[notification] notification.createTeams (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
webhookUrl (string, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +5 more.
dokploy_notification_createTelegramdokploy_notification_createTelegramD
[notification] notification.createTelegram (POST)
Parameters:
appBuildError (boolean, required)
databaseBackup (boolean, required)
volumeBackup (boolean, required)
dokployRestart (boolean, required)
name (string, required)
appDeploy (boolean, required)
dockerCleanup (boolean, required)
serverThreshold (boolean, required)
botToken (string, required)
chatId (string, required)
messageThreadId (string, required)
Inputs: appBuildError (required), databaseBackup (required), volumeBackup (required), dokployRestart (required), +7 more.
dokploy_notification_getEmailProvidersdokploy_notification_getEmailProvidersCRead-onlyIdempotent
[notification] notification.getEmailProviders (GET)
Inputs: no named parameters.
dokploy_notification_onedokploy_notification_oneCRead-onlyIdempotent
[notification] notification.one (GET)
Parameters:
notificationId (string, required)
Inputs: notificationId (required).
dokploy_notification_receiveNotificationdokploy_notification_receiveNotificationC
[notification] notification.receiveNotification (POST)
Parameters:
ServerType (enum: Dokploy, Remote, optional)
Type (enum: Memory, CPU, required)
Value (number, required)
Threshold (number, required)
Message (string, required)
Timestamp (string, required)
Token (string, required)
Inputs: Type (required), Value (required), Threshold (required), Message (required), +3 more.
dokploy_notification_removedokploy_notification_removeCDestructive
[notification] notification.remove (POST)
Parameters:
notificationId (string, required)
Inputs: notificationId (required).
dokploy_notification_testCustomConnectiondokploy_notification_testCustomConnectionD
[notification] notification.testCustomConnection (POST)
Parameters:
endpoint (string, required)
headers (object, optional)
Inputs: endpoint (required), headers.
dokploy_notification_testDiscordConnectiondokploy_notification_testDiscordConnectionC
[notification] notification.testDiscordConnection (POST)
Parameters:
webhookUrl (string, required)
decoration (boolean, optional)
Inputs: webhookUrl (required), decoration.
dokploy_notification_testEmailConnectiondokploy_notification_testEmailConnectionC
[notification] notification.testEmailConnection (POST)
Parameters:
smtpServer (string, required)
smtpPort (number, required)
username (string, required)
password (string, required)
toAddresses (array, required)
fromAddress (string, required)
Inputs: smtpServer (required), smtpPort (required), username (required), password (required), +2 more.
dokploy_notification_testGotifyConnectiondokploy_notification_testGotifyConnectionD
[notification] notification.testGotifyConnection (POST)
Parameters:
serverUrl (string, required)
appToken (string, required)
priority (number, required)
decoration (boolean, optional)
Inputs: serverUrl (required), appToken (required), priority (required), decoration.
dokploy_notification_testLarkConnectiondokploy_notification_testLarkConnectionC
[notification] notification.testLarkConnection (POST)
Parameters:
webhookUrl (string, required)
Inputs: webhookUrl (required).
dokploy_notification_testNtfyConnectiondokploy_notification_testNtfyConnectionC
[notification] notification.testNtfyConnection (POST)
Parameters:
serverUrl (string, required)
topic (string, required)
accessToken (string, required)
priority (number, required)
Inputs: serverUrl (required), topic (required), accessToken (required), priority (required).
dokploy_notification_testPushoverConnectiondokploy_notification_testPushoverConnectionD
[notification] notification.testPushoverConnection (POST)
Parameters:
userKey (string, required)
apiToken (string, required)
priority (number, required)
retry (any, optional)
expire (any, optional)
Inputs: userKey (required), apiToken (required), priority (required), retry, +1 more.
dokploy_notification_testResendConnectiondokploy_notification_testResendConnectionD
[notification] notification.testResendConnection (POST)
Parameters:
apiKey (string, required)
fromAddress (string, required)
toAddresses (array, required)
Inputs: apiKey (required), fromAddress (required), toAddresses (required).
dokploy_notification_testSlackConnectiondokploy_notification_testSlackConnectionC
[notification] notification.testSlackConnection (POST)
Parameters:
webhookUrl (string, required)
channel (string, required)
Inputs: webhookUrl (required), channel (required).
dokploy_notification_testTeamsConnectiondokploy_notification_testTeamsConnectionC
[notification] notification.testTeamsConnection (POST)
Parameters:
webhookUrl (string, required)
Inputs: webhookUrl (required).
dokploy_notification_testTelegramConnectiondokploy_notification_testTelegramConnectionC
[notification] notification.testTelegramConnection (POST)
Parameters:
botToken (string, required)
chatId (string, required)
messageThreadId (string, required)
Inputs: botToken (required), chatId (required), messageThreadId (required).
dokploy_notification_updateCustomdokploy_notification_updateCustomCIdempotent
[notification] notification.updateCustom (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
endpoint (string, optional)
headers (object, optional)
notificationId (string, required)
customId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), customId (required), appBuildError, databaseBackup, +9 more.
dokploy_notification_updateDiscorddokploy_notification_updateDiscordCIdempotent
[notification] notification.updateDiscord (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
webhookUrl (string, optional)
decoration (boolean, optional)
notificationId (string, required)
discordId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), discordId (required), appBuildError, databaseBackup, +9 more.
dokploy_notification_updateEmaildokploy_notification_updateEmailDIdempotent
[notification] notification.updateEmail (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
smtpServer (string, optional)
smtpPort (number, optional)
username (string, optional)
password (string, optional)
fromAddress (string, optional)
toAddresses (array, optional)
notificationId (string, required)
emailId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), emailId (required), appBuildError, databaseBackup, +13 more.
dokploy_notification_updateGotifydokploy_notification_updateGotifyDIdempotent
[notification] notification.updateGotify (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverUrl (string, optional)
appToken (string, optional)
priority (number, optional)
decoration (boolean, optional)
notificationId (string, required)
gotifyId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), gotifyId (required), appBuildError, databaseBackup, +10 more.
dokploy_notification_updateLarkdokploy_notification_updateLarkCIdempotent
[notification] notification.updateLark (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
webhookUrl (string, optional)
notificationId (string, required)
larkId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), larkId (required), appBuildError, databaseBackup, +8 more.
dokploy_notification_updateNtfydokploy_notification_updateNtfyDIdempotent
[notification] notification.updateNtfy (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverUrl (string, optional)
topic (string, optional)
accessToken (string, optional)
priority (number, optional)
notificationId (string, required)
ntfyId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), ntfyId (required), appBuildError, databaseBackup, +10 more.
dokploy_notification_updatePushoverdokploy_notification_updatePushoverCIdempotent
[notification] notification.updatePushover (POST)
Parameters:
notificationId (string, required)
pushoverId (string, required)
organizationId (string, optional)
userKey (string, optional)
apiToken (string, optional)
priority (number, optional)
retry (any, optional)
expire (any, optional)
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
Inputs: notificationId (required), pushoverId (required), organizationId, userKey, +12 more.
dokploy_notification_updateResenddokploy_notification_updateResendCIdempotent
[notification] notification.updateResend (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
apiKey (string, optional)
fromAddress (string, optional)
toAddresses (array, optional)
notificationId (string, required)
resendId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), resendId (required), appBuildError, databaseBackup, +10 more.
dokploy_notification_updateSlackdokploy_notification_updateSlackCIdempotent
[notification] notification.updateSlack (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
webhookUrl (string, optional)
channel (string, optional)
notificationId (string, required)
slackId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), slackId (required), appBuildError, databaseBackup, +9 more.
dokploy_notification_updateTeamsdokploy_notification_updateTeamsCIdempotent
[notification] notification.updateTeams (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
webhookUrl (string, optional)
notificationId (string, required)
teamsId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), teamsId (required), appBuildError, databaseBackup, +8 more.
dokploy_notification_updateTelegramdokploy_notification_updateTelegramCIdempotent
[notification] notification.updateTelegram (POST)
Parameters:
appBuildError (boolean, optional)
databaseBackup (boolean, optional)
volumeBackup (boolean, optional)
dokployRestart (boolean, optional)
name (string, optional)
appDeploy (boolean, optional)
dockerCleanup (boolean, optional)
serverThreshold (boolean, optional)
botToken (string, optional)
chatId (string, optional)
messageThreadId (string, optional)
notificationId (string, required)
telegramId (string, required)
organizationId (string, optional)
Inputs: notificationId (required), telegramId (required), appBuildError, databaseBackup, +10 more.
dokploy_organization_activedokploy_organization_activeCRead-onlyIdempotent
[organization] organization.active (GET)
Inputs: no named parameters.
dokploy_organization_alldokploy_organization_allCRead-onlyIdempotent
[organization] organization.all (GET)
Inputs: no named parameters.
dokploy_organization_allInvitationsdokploy_organization_allInvitationsCRead-onlyIdempotent
[organization] organization.allInvitations (GET)
Inputs: no named parameters.
dokploy_organization_createdokploy_organization_createC
[organization] organization.create (POST)
Parameters:
name (string, required)
logo (string, optional)
Inputs: name (required), logo.
dokploy_organization_deletedokploy_organization_deleteCDestructive
[organization] organization.delete (POST)
Parameters:
organizationId (string, required)
Inputs: organizationId (required).
dokploy_organization_inviteMemberdokploy_organization_inviteMemberC
[organization] organization.inviteMember (POST)
Parameters:
email (string, required)
role (string, required)
Inputs: email (required), role (required).
dokploy_organization_onedokploy_organization_oneCRead-onlyIdempotent
[organization] organization.one (GET)
Parameters:
organizationId (string, required)
Inputs: organizationId (required).
dokploy_organization_removeInvitationdokploy_organization_removeInvitationCDestructive
[organization] organization.removeInvitation (POST)
Parameters:
invitationId (string, required)
Inputs: invitationId (required).
dokploy_organization_setDefaultdokploy_organization_setDefaultCIdempotent
[organization] organization.setDefault (POST)
Parameters:
organizationId (string, required)
Inputs: organizationId (required).
dokploy_organization_updatedokploy_organization_updateCIdempotent
[organization] organization.update (POST)
Parameters:
organizationId (string, required)
name (string, required)
logo (string, optional)
Inputs: organizationId (required), name (required), logo.
dokploy_organization_updateMemberRoledokploy_organization_updateMemberRoleCIdempotent
[organization] organization.updateMemberRole (POST)
Parameters:
memberId (string, required)
role (string, required)
Inputs: memberId (required), role (required).
dokploy_patch_byEntityIddokploy_patch_byEntityIdDRead-onlyIdempotent
[patch] patch.byEntityId (GET)
Parameters:
id (string, required)
type (enum: application, compose, required)
Inputs: id (required), type (required).
dokploy_patch_cleanPatchReposdokploy_patch_cleanPatchReposCDestructive
[patch] patch.cleanPatchRepos (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_patch_createdokploy_patch_createC
[patch] patch.create (POST)
Parameters:
filePath (string, required)
content (string, required)
type (enum: create, update, delete, optional)
enabled (boolean, optional)
applicationId (any, optional)
composeId (any, optional)
Inputs: filePath (required), content (required), type, enabled, +2 more.
dokploy_patch_deletedokploy_patch_deleteCDestructive
[patch] patch.delete (POST)
Parameters:
patchId (string, required)
Inputs: patchId (required).
dokploy_patch_ensureRepodokploy_patch_ensureRepoC
[patch] patch.ensureRepo (POST)
Parameters:
id (string, required)
type (enum: application, compose, required)
Inputs: id (required), type (required).
dokploy_patch_markFileForDeletiondokploy_patch_markFileForDeletionC
[patch] patch.markFileForDeletion (POST)
Parameters:
id (string, required)
type (enum: application, compose, required)
filePath (string, required)
Inputs: id (required), type (required), filePath (required).
dokploy_patch_onedokploy_patch_oneCRead-onlyIdempotent
[patch] patch.one (GET)
Parameters:
patchId (string, required)
Inputs: patchId (required).
dokploy_patch_readRepoDirectoriesdokploy_patch_readRepoDirectoriesCRead-onlyIdempotent
[patch] patch.readRepoDirectories (GET)
Parameters:
id (string, required)
type (enum: application, compose, required)
repoPath (string, required)
Inputs: id (required), type (required), repoPath (required).
dokploy_patch_readRepoFiledokploy_patch_readRepoFileCRead-onlyIdempotent
[patch] patch.readRepoFile (GET)
Parameters:
id (string, required)
type (enum: application, compose, required)
filePath (string, required)
Inputs: id (required), type (required), filePath (required).
dokploy_patch_saveFileAsPatchdokploy_patch_saveFileAsPatchD
[patch] patch.saveFileAsPatch (POST)
Parameters:
id (string, required)
type (enum: application, compose, required)
filePath (string, required)
content (string, required)
patchType (enum: create, update, optional)
Inputs: id (required), type (required), filePath (required), content (required), +1 more.
dokploy_patch_toggleEnableddokploy_patch_toggleEnabledC
[patch] patch.toggleEnabled (POST)
Parameters:
patchId (string, required)
enabled (boolean, required)
Inputs: patchId (required), enabled (required).
dokploy_patch_updatedokploy_patch_updateCIdempotent
[patch] patch.update (POST)
Parameters:
patchId (string, required)
type (enum: create, update, delete, optional)
filePath (string, optional)
enabled (boolean, optional)
content (string, optional)
createdAt (string, optional)
updatedAt (any, optional)
Inputs: patchId (required), type, filePath, enabled, +3 more.
dokploy_port_createdokploy_port_createC
[port] port.create (POST)
Parameters:
publishedPort (number, required)
publishMode (enum: ingress, host, required)
targetPort (number, required)
protocol (enum: tcp, udp, required)
applicationId (string, required)
Inputs: publishedPort (required), publishMode (required), targetPort (required), protocol (required), +1 more.
dokploy_port_deletedokploy_port_deleteCDestructive
[port] port.delete (POST)
Parameters:
portId (string, required)
Inputs: portId (required).
dokploy_port_onedokploy_port_oneCRead-onlyIdempotent
[port] port.one (GET)
Parameters:
portId (string, required)
Inputs: portId (required).
dokploy_port_updatedokploy_port_updateCIdempotent
[port] port.update (POST)
Parameters:
portId (string, required)
publishedPort (number, required)
publishMode (enum: ingress, host, required)
targetPort (number, required)
protocol (enum: tcp, udp, required)
Inputs: portId (required), publishedPort (required), publishMode (required), targetPort (required), +1 more.
dokploy_postgres_changeStatusdokploy_postgres_changeStatusC
[postgres] postgres.changeStatus (POST)
Parameters:
postgresId (string, required)
applicationStatus (enum: idle, running, done, error, required)
Inputs: postgresId (required), applicationStatus (required).
dokploy_postgres_createdokploy_postgres_createC
[postgres] postgres.create (POST)
Parameters:
name (string, required)
appName (string, optional)
databaseName (string, required)
databaseUser (string, required)
databasePassword (string, required)
dockerImage (string, optional)
environmentId (string, required)
description (any, optional)
serverId (any, optional)
Inputs: name (required), databaseName (required), databaseUser (required), databasePassword (required), +5 more.
dokploy_postgres_deploydokploy_postgres_deployD
[postgres] postgres.deploy (POST)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_movedokploy_postgres_moveD
[postgres] postgres.move (POST)
Parameters:
postgresId (string, required)
targetEnvironmentId (string, required)
Inputs: postgresId (required), targetEnvironmentId (required).
dokploy_postgres_onedokploy_postgres_oneCRead-onlyIdempotent
[postgres] postgres.one (GET)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_rebuilddokploy_postgres_rebuildC
[postgres] postgres.rebuild (POST)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_reloaddokploy_postgres_reloadC
[postgres] postgres.reload (POST)
Parameters:
postgresId (string, required)
appName (string, required)
Inputs: postgresId (required), appName (required).
dokploy_postgres_removedokploy_postgres_removeCDestructive
[postgres] postgres.remove (POST)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_saveEnvironmentdokploy_postgres_saveEnvironmentC
[postgres] postgres.saveEnvironment (POST)
Parameters:
postgresId (string, required)
env (any, required)
Inputs: postgresId (required), env (required).
dokploy_postgres_saveExternalPortdokploy_postgres_saveExternalPortC
[postgres] postgres.saveExternalPort (POST)
Parameters:
postgresId (string, required)
externalPort (any, required)
Inputs: postgresId (required), externalPort (required).
dokploy_postgres_searchdokploy_postgres_searchCRead-onlyIdempotent
[postgres] postgres.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_postgres_startdokploy_postgres_startC
[postgres] postgres.start (POST)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_stopdokploy_postgres_stopC
[postgres] postgres.stop (POST)
Parameters:
postgresId (string, required)
Inputs: postgresId (required).
dokploy_postgres_updatedokploy_postgres_updateDIdempotent
[postgres] postgres.update (POST)
Parameters:
postgresId (string, required)
name (string, optional)
appName (string, optional)
databaseName (string, optional)
databaseUser (string, optional)
databasePassword (string, optional)
description (any, optional)
dockerImage (string, optional)
command (any, optional)
args (any, optional)
env (any, optional)
memoryReservation (any, optional)
externalPort (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
applicationStatus (enum: idle, running, done, error, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
createdAt (string, optional)
environmentId (string, optional)
Inputs: postgresId (required), name, appName, databaseName, +27 more.
dokploy_previewDeployment_alldokploy_previewDeployment_allCRead-onlyIdempotent
[previewDeployment] previewDeployment.all (GET)
Parameters:
applicationId (string, required)
Inputs: applicationId (required).
dokploy_previewDeployment_deletedokploy_previewDeployment_deleteCDestructive
[previewDeployment] previewDeployment.delete (POST)
Parameters:
previewDeploymentId (string, required)
Inputs: previewDeploymentId (required).
dokploy_previewDeployment_onedokploy_previewDeployment_oneCRead-onlyIdempotent
[previewDeployment] previewDeployment.one (GET)
Parameters:
previewDeploymentId (string, required)
Inputs: previewDeploymentId (required).
dokploy_previewDeployment_redeploydokploy_previewDeployment_redeployC
[previewDeployment] previewDeployment.redeploy (POST)
Parameters:
previewDeploymentId (string, required)
title (string, optional)
description (string, optional)
Inputs: previewDeploymentId (required), title, description.
dokploy_project_alldokploy_project_allCRead-onlyIdempotent
[project] project.all (GET)
Inputs: no named parameters.
dokploy_project_allForPermissionsdokploy_project_allForPermissionsCRead-onlyIdempotent
[project] project.allForPermissions (GET)
Inputs: no named parameters.
dokploy_project_createdokploy_project_createC
[project] project.create (POST)
Parameters:
name (string, required)
description (any, optional)
env (string, optional)
Inputs: name (required), description, env.
dokploy_project_duplicatedokploy_project_duplicateC
[project] project.duplicate (POST)
Parameters:
sourceEnvironmentId (string, required)
name (string, required)
description (string, optional)
includeServices (boolean, optional)
selectedServices (array, optional)
duplicateInSameProject (boolean, optional)
Inputs: sourceEnvironmentId (required), name (required), description, includeServices, +2 more.
dokploy_project_onedokploy_project_oneCRead-onlyIdempotent
[project] project.one (GET)
Parameters:
projectId (string, required)
Inputs: projectId (required).
dokploy_project_removedokploy_project_removeCDestructive
[project] project.remove (POST)
Parameters:
projectId (string, required)
Inputs: projectId (required).
dokploy_project_searchdokploy_project_searchCRead-onlyIdempotent
[project] project.search (GET)
Parameters:
q (string, optional)
name (string, optional)
description (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, description, limit, +1 more.
dokploy_project_updatedokploy_project_updateCIdempotent
[project] project.update (POST)
Parameters:
projectId (string, required)
name (string, optional)
description (any, optional)
createdAt (string, optional)
organizationId (string, optional)
env (string, optional)
Inputs: projectId (required), name, description, createdAt, +2 more.
dokploy_redirects_createdokploy_redirects_createC
[redirects] redirects.create (POST)
Parameters:
regex (string, required)
replacement (string, required)
permanent (boolean, required)
applicationId (string, required)
Inputs: regex (required), replacement (required), permanent (required), applicationId (required).
dokploy_redirects_deletedokploy_redirects_deleteCDestructive
[redirects] redirects.delete (POST)
Parameters:
redirectId (string, required)
Inputs: redirectId (required).
dokploy_redirects_onedokploy_redirects_oneCRead-onlyIdempotent
[redirects] redirects.one (GET)
Parameters:
redirectId (string, required)
Inputs: redirectId (required).
dokploy_redirects_updatedokploy_redirects_updateCIdempotent
[redirects] redirects.update (POST)
Parameters:
redirectId (string, required)
regex (string, required)
replacement (string, required)
permanent (boolean, required)
Inputs: redirectId (required), regex (required), replacement (required), permanent (required).
dokploy_redis_changeStatusdokploy_redis_changeStatusD
[redis] redis.changeStatus (POST)
Parameters:
redisId (string, required)
applicationStatus (enum: idle, running, done, error, required)
Inputs: redisId (required), applicationStatus (required).
dokploy_redis_createdokploy_redis_createC
[redis] redis.create (POST)
Parameters:
name (string, required)
appName (string, optional)
databasePassword (string, required)
dockerImage (string, optional)
environmentId (string, required)
description (any, optional)
serverId (any, optional)
Inputs: name (required), databasePassword (required), environmentId (required), appName, +3 more.
dokploy_redis_deploydokploy_redis_deployC
[redis] redis.deploy (POST)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_movedokploy_redis_moveD
[redis] redis.move (POST)
Parameters:
redisId (string, required)
targetEnvironmentId (string, required)
Inputs: redisId (required), targetEnvironmentId (required).
dokploy_redis_onedokploy_redis_oneCRead-onlyIdempotent
[redis] redis.one (GET)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_rebuilddokploy_redis_rebuildD
[redis] redis.rebuild (POST)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_reloaddokploy_redis_reloadC
[redis] redis.reload (POST)
Parameters:
redisId (string, required)
appName (string, required)
Inputs: redisId (required), appName (required).
dokploy_redis_removedokploy_redis_removeCDestructive
[redis] redis.remove (POST)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_saveEnvironmentdokploy_redis_saveEnvironmentC
[redis] redis.saveEnvironment (POST)
Parameters:
redisId (string, required)
env (any, required)
Inputs: redisId (required), env (required).
dokploy_redis_saveExternalPortdokploy_redis_saveExternalPortD
[redis] redis.saveExternalPort (POST)
Parameters:
redisId (string, required)
externalPort (any, required)
Inputs: redisId (required), externalPort (required).
dokploy_redis_searchdokploy_redis_searchCRead-onlyIdempotent
[redis] redis.search (GET)
Parameters:
q (string, optional)
name (string, optional)
appName (string, optional)
description (string, optional)
projectId (string, optional)
environmentId (string, optional)
limit (number, optional)
offset (number, optional)
Inputs: q, name, appName, description, +4 more.
dokploy_redis_startdokploy_redis_startC
[redis] redis.start (POST)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_stopdokploy_redis_stopC
[redis] redis.stop (POST)
Parameters:
redisId (string, required)
Inputs: redisId (required).
dokploy_redis_updatedokploy_redis_updateDIdempotent
[redis] redis.update (POST)
Parameters:
redisId (string, required)
name (string, optional)
appName (string, optional)
description (any, optional)
databasePassword (string, optional)
dockerImage (string, optional)
command (any, optional)
args (any, optional)
env (any, optional)
memoryReservation (any, optional)
memoryLimit (any, optional)
cpuReservation (any, optional)
cpuLimit (any, optional)
externalPort (any, optional)
createdAt (string, optional)
applicationStatus (enum: idle, running, done, error, optional)
healthCheckSwarm (any, optional)
restartPolicySwarm (any, optional)
placementSwarm (any, optional)
updateConfigSwarm (any, optional)
rollbackConfigSwarm (any, optional)
modeSwarm (any, optional)
labelsSwarm (any, optional)
networkSwarm (any, optional)
stopGracePeriodSwarm (any, optional)
endpointSpecSwarm (any, optional)
ulimitsSwarm (any, optional)
replicas (number, optional)
environmentId (string, optional)
Inputs: redisId (required), name, appName, description, +25 more.
dokploy_registry_alldokploy_registry_allCRead-onlyIdempotent
[registry] registry.all (GET)
Inputs: no named parameters.
dokploy_registry_createdokploy_registry_createC
[registry] registry.create (POST)
Parameters:
registryName (string, required)
username (string, required)
password (string, required)
registryUrl (string, required)
registryType (enum: cloud, required)
imagePrefix (any, required)
serverId (string, optional)
Inputs: registryName (required), username (required), password (required), registryUrl (required), +3 more.
dokploy_registry_onedokploy_registry_oneCRead-onlyIdempotent
[registry] registry.one (GET)
Parameters:
registryId (string, required)
Inputs: registryId (required).
dokploy_registry_removedokploy_registry_removeCDestructive
[registry] registry.remove (POST)
Parameters:
registryId (string, required)
Inputs: registryId (required).
dokploy_registry_testRegistrydokploy_registry_testRegistryC
[registry] registry.testRegistry (POST)
Parameters:
registryName (string, optional)
username (string, required)
password (string, required)
registryUrl (string, required)
registryType (enum: cloud, required)
imagePrefix (any, optional)
serverId (string, optional)
Inputs: username (required), password (required), registryUrl (required), registryType (required), +3 more.
dokploy_registry_testRegistryByIddokploy_registry_testRegistryByIdD
[registry] registry.testRegistryById (POST)
Parameters:
registryId (string, optional)
serverId (string, optional)
Inputs: registryId, serverId.
dokploy_registry_updatedokploy_registry_updateDIdempotent
[registry] registry.update (POST)
Parameters:
registryId (string, required)
registryName (string, optional)
imagePrefix (any, optional)
username (string, optional)
password (string, optional)
registryUrl (string, optional)
createdAt (string, optional)
registryType (enum: cloud, optional)
organizationId (string, optional)
serverId (string, optional)
Inputs: registryId (required), registryName, imagePrefix, username, +6 more.
dokploy_rollback_deletedokploy_rollback_deleteCDestructive
[rollback] rollback.delete (POST)
Parameters:
rollbackId (string, required)
Inputs: rollbackId (required).
dokploy_rollback_rollbackdokploy_rollback_rollbackD
[rollback] rollback.rollback (POST)
Parameters:
rollbackId (string, required)
Inputs: rollbackId (required).
dokploy_schedule_createdokploy_schedule_createD
[schedule] schedule.create (POST)
Parameters:
scheduleId (string, optional)
name (string, required)
cronExpression (string, required)
appName (string, optional)
serviceName (any, optional)
shellType (enum: bash, sh, optional)
scheduleType (enum: application, compose, server, dokploy-server, optional)
command (string, required)
script (any, optional)
applicationId (any, optional)
composeId (any, optional)
serverId (any, optional)
userId (any, optional)
enabled (boolean, optional)
timezone (any, optional)
createdAt (string, optional)
Inputs: name (required), cronExpression (required), command (required), scheduleId, +12 more.
dokploy_schedule_deletedokploy_schedule_deleteBDestructive
[schedule] schedule.delete (POST)
Parameters:
scheduleId (string, required)
Inputs: scheduleId (required).
dokploy_schedule_listdokploy_schedule_listCRead-onlyIdempotent
[schedule] schedule.list (GET)
Parameters:
id (string, required)
scheduleType (enum: application, compose, server, dokploy-server, required)
Inputs: id (required), scheduleType (required).
dokploy_schedule_onedokploy_schedule_oneCRead-onlyIdempotent
[schedule] schedule.one (GET)
Parameters:
scheduleId (string, required)
Inputs: scheduleId (required).
dokploy_schedule_runManuallydokploy_schedule_runManuallyC
[schedule] schedule.runManually (POST)
Parameters:
scheduleId (string, required)
Inputs: scheduleId (required).
dokploy_schedule_updatedokploy_schedule_updateCIdempotent
[schedule] schedule.update (POST)
Parameters:
scheduleId (string, required)
name (string, required)
cronExpression (string, required)
appName (string, optional)
serviceName (any, optional)
shellType (enum: bash, sh, optional)
scheduleType (enum: application, compose, server, dokploy-server, optional)
command (string, required)
script (any, optional)
applicationId (any, optional)
composeId (any, optional)
serverId (any, optional)
userId (any, optional)
enabled (boolean, optional)
timezone (any, optional)
createdAt (string, optional)
Inputs: scheduleId (required), name (required), cronExpression (required), command (required), +12 more.
dokploy_security_createdokploy_security_createC
[security] security.create (POST)
Parameters:
applicationId (string, required)
username (string, required)
password (string, required)
Inputs: applicationId (required), username (required), password (required).
dokploy_security_deletedokploy_security_deleteCDestructive
[security] security.delete (POST)
Parameters:
securityId (string, required)
Inputs: securityId (required).
dokploy_security_onedokploy_security_oneCRead-onlyIdempotent
[security] security.one (GET)
Parameters:
securityId (string, required)
Inputs: securityId (required).
dokploy_security_updatedokploy_security_updateDIdempotent
[security] security.update (POST)
Parameters:
securityId (string, required)
username (string, required)
password (string, required)
Inputs: securityId (required), username (required), password (required).
dokploy_server_alldokploy_server_allCRead-onlyIdempotent
[server] server.all (GET)
Inputs: no named parameters.
dokploy_server_buildServersdokploy_server_buildServersDRead-onlyIdempotent
[server] server.buildServers (GET)
Inputs: no named parameters.
dokploy_server_countdokploy_server_countCRead-onlyIdempotent
[server] server.count (GET)
Inputs: no named parameters.
dokploy_server_createdokploy_server_createC
[server] server.create (POST)
Parameters:
name (string, required)
description (any, required)
ipAddress (string, required)
port (number, required)
username (string, required)
sshKeyId (any, required)
serverType (enum: deploy, build, required)
Inputs: name (required), description (required), ipAddress (required), port (required), +3 more.
dokploy_server_getDefaultCommanddokploy_server_getDefaultCommandCRead-onlyIdempotent
[server] server.getDefaultCommand (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_getServerMetricsdokploy_server_getServerMetricsCRead-onlyIdempotent
[server] server.getServerMetrics (GET)
Parameters:
url (string, required)
token (string, required)
dataPoints (string, required)
Inputs: url (required), token (required), dataPoints (required).
dokploy_server_getServerTimedokploy_server_getServerTimeCRead-onlyIdempotent
[server] server.getServerTime (GET)
Inputs: no named parameters.
dokploy_server_onedokploy_server_oneCRead-onlyIdempotent
[server] server.one (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_publicIpdokploy_server_publicIpCRead-onlyIdempotent
[server] server.publicIp (GET)
Inputs: no named parameters.
dokploy_server_removedokploy_server_removeCDestructive
[server] server.remove (POST)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_securitydokploy_server_securityCRead-onlyIdempotent
[server] server.security (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_setupdokploy_server_setupCIdempotent
[server] server.setup (POST)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_setupMonitoringdokploy_server_setupMonitoringCIdempotent
[server] server.setupMonitoring (POST)
Parameters:
serverId (string, required)
metricsConfig (object, required)
Inputs: serverId (required), metricsConfig (required).
dokploy_server_updatedokploy_server_updateCIdempotent
[server] server.update (POST)
Parameters:
name (string, required)
description (any, required)
serverId (string, required)
ipAddress (string, required)
port (number, required)
username (string, required)
sshKeyId (any, required)
serverType (enum: deploy, build, required)
command (string, optional)
Inputs: name (required), description (required), serverId (required), ipAddress (required), +5 more.
dokploy_server_validatedokploy_server_validateCRead-onlyIdempotent
[server] server.validate (GET)
Parameters:
serverId (string, required)
Inputs: serverId (required).
dokploy_server_withSSHKeydokploy_server_withSSHKeyCRead-onlyIdempotent
[server] server.withSSHKey (GET)
Inputs: no named parameters.
dokploy_settings_assignDomainServerdokploy_settings_assignDomainServerC
[settings] settings.assignDomainServer (POST)
Parameters:
host (string, required)
certificateType (enum: letsencrypt, none, custom, required)
letsEncryptEmail (any, optional)
https (boolean, optional)
Inputs: host (required), certificateType (required), letsEncryptEmail, https.
dokploy_settings_checkGPUStatusdokploy_settings_checkGPUStatusCRead-onlyIdempotent
[settings] settings.checkGPUStatus (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanAlldokploy_settings_cleanAllCDestructive
[settings] settings.cleanAll (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanAllDeploymentQueuedokploy_settings_cleanAllDeploymentQueueCDestructive
[settings] settings.cleanAllDeploymentQueue (POST)
Inputs: no named parameters.
dokploy_settings_cleanDockerBuilderdokploy_settings_cleanDockerBuilderCDestructive
[settings] settings.cleanDockerBuilder (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanDockerPrunedokploy_settings_cleanDockerPruneCDestructive
[settings] settings.cleanDockerPrune (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanMonitoringdokploy_settings_cleanMonitoringCDestructive
[settings] settings.cleanMonitoring (POST)
Inputs: no named parameters.
dokploy_settings_cleanRedisdokploy_settings_cleanRedisCDestructive
[settings] settings.cleanRedis (POST)
Inputs: no named parameters.
dokploy_settings_cleanSSHPrivateKeydokploy_settings_cleanSSHPrivateKeyCDestructive
[settings] settings.cleanSSHPrivateKey (POST)
Inputs: no named parameters.
dokploy_settings_cleanStoppedContainersdokploy_settings_cleanStoppedContainersCDestructive
[settings] settings.cleanStoppedContainers (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanUnusedImagesdokploy_settings_cleanUnusedImagesCDestructive
[settings] settings.cleanUnusedImages (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_cleanUnusedVolumesdokploy_settings_cleanUnusedVolumesCDestructive
[settings] settings.cleanUnusedVolumes (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_getDokployCloudIpsdokploy_settings_getDokployCloudIpsCRead-onlyIdempotent
[settings] settings.getDokployCloudIps (GET)
Inputs: no named parameters.
dokploy_settings_getDokployVersiondokploy_settings_getDokployVersionCRead-onlyIdempotent
[settings] settings.getDokployVersion (GET)
Inputs: no named parameters.
dokploy_settings_getIpdokploy_settings_getIpCRead-onlyIdempotent
[settings] settings.getIp (GET)
Inputs: no named parameters.
dokploy_settings_getLogCleanupStatusdokploy_settings_getLogCleanupStatusCRead-onlyDestructiveIdempotent
[settings] settings.getLogCleanupStatus (GET)
Inputs: no named parameters.
dokploy_settings_getOpenApiDocumentdokploy_settings_getOpenApiDocumentCRead-onlyIdempotent
[settings] settings.getOpenApiDocument (GET)
Inputs: no named parameters.
dokploy_settings_getReleaseTagdokploy_settings_getReleaseTagCRead-onlyIdempotent
[settings] settings.getReleaseTag (GET)
Inputs: no named parameters.
dokploy_settings_getTraefikPortsdokploy_settings_getTraefikPortsCRead-onlyIdempotent
[settings] settings.getTraefikPorts (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_getUpdateDatadokploy_settings_getUpdateDataCRead-onlyIdempotent
[settings] settings.getUpdateData (POST)
Inputs: no named parameters.
dokploy_settings_getWebServerSettingsdokploy_settings_getWebServerSettingsCRead-onlyIdempotent
[settings] settings.getWebServerSettings (GET)
Inputs: no named parameters.
dokploy_settings_haveActivateRequestsdokploy_settings_haveActivateRequestsCRead-onlyIdempotent
[settings] settings.haveActivateRequests (GET)
Inputs: no named parameters.
dokploy_settings_haveTraefikDashboardPortEnableddokploy_settings_haveTraefikDashboardPortEnabledCRead-onlyIdempotent
[settings] settings.haveTraefikDashboardPortEnabled (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_healthdokploy_settings_healthCRead-onlyIdempotent
[settings] settings.health (GET)
Inputs: no named parameters.
dokploy_settings_isClouddokploy_settings_isCloudCRead-onlyIdempotent
[settings] settings.isCloud (GET)
Inputs: no named parameters.
dokploy_settings_isUserSubscribeddokploy_settings_isUserSubscribedCRead-onlyIdempotent
[settings] settings.isUserSubscribed (GET)
Inputs: no named parameters.
dokploy_settings_readDirectoriesdokploy_settings_readDirectoriesCRead-onlyIdempotent
[settings] settings.readDirectories (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_readMiddlewareTraefikConfigdokploy_settings_readMiddlewareTraefikConfigCRead-onlyIdempotent
[settings] settings.readMiddlewareTraefikConfig (GET)
Inputs: no named parameters.
dokploy_settings_readTraefikConfigdokploy_settings_readTraefikConfigCRead-onlyIdempotent
[settings] settings.readTraefikConfig (GET)
Inputs: no named parameters.
dokploy_settings_readTraefikEnvdokploy_settings_readTraefikEnvCRead-onlyIdempotent
[settings] settings.readTraefikEnv (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_readTraefikFiledokploy_settings_readTraefikFileCRead-onlyIdempotent
[settings] settings.readTraefikFile (GET)
Parameters:
path (string, required)
serverId (string, optional)
Inputs: path (required), serverId.
dokploy_settings_readWebServerTraefikConfigdokploy_settings_readWebServerTraefikConfigCRead-onlyIdempotent
[settings] settings.readWebServerTraefikConfig (GET)
Inputs: no named parameters.
dokploy_settings_reloadRedisdokploy_settings_reloadRedisC
[settings] settings.reloadRedis (POST)
Inputs: no named parameters.
dokploy_settings_reloadServerdokploy_settings_reloadServerC
[settings] settings.reloadServer (POST)
Inputs: no named parameters.
dokploy_settings_reloadTraefikdokploy_settings_reloadTraefikC
[settings] settings.reloadTraefik (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_saveSSHPrivateKeydokploy_settings_saveSSHPrivateKeyC
[settings] settings.saveSSHPrivateKey (POST)
Parameters:
sshPrivateKey (string, required)
Inputs: sshPrivateKey (required).
dokploy_settings_setupGPUdokploy_settings_setupGPUCIdempotent
[settings] settings.setupGPU (POST)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_settings_toggleDashboarddokploy_settings_toggleDashboardD
[settings] settings.toggleDashboard (POST)
Parameters:
enableDashboard (boolean, optional)
serverId (string, optional)
Inputs: enableDashboard, serverId.
dokploy_settings_toggleRequestsdokploy_settings_toggleRequestsC
[settings] settings.toggleRequests (POST)
Parameters:
enable (boolean, required)
Inputs: enable (required).
dokploy_settings_updateDockerCleanupdokploy_settings_updateDockerCleanupCDestructiveIdempotent
[settings] settings.updateDockerCleanup (POST)
Parameters:
enableDockerCleanup (boolean, required)
serverId (string, optional)
Inputs: enableDockerCleanup (required), serverId.
dokploy_settings_updateLogCleanupdokploy_settings_updateLogCleanupCDestructiveIdempotent
[settings] settings.updateLogCleanup (POST)
Parameters:
cronExpression (any, required)
Inputs: cronExpression (required).
dokploy_settings_updateMiddlewareTraefikConfigdokploy_settings_updateMiddlewareTraefikConfigCIdempotent
[settings] settings.updateMiddlewareTraefikConfig (POST)
Parameters:
traefikConfig (string, required)
Inputs: traefikConfig (required).
dokploy_settings_updateServerdokploy_settings_updateServerCIdempotent
[settings] settings.updateServer (POST)
Inputs: no named parameters.
dokploy_settings_updateServerIpdokploy_settings_updateServerIpCIdempotent
[settings] settings.updateServerIp (POST)
Parameters:
serverIp (string, required)
Inputs: serverIp (required).
dokploy_settings_updateTraefikConfigdokploy_settings_updateTraefikConfigCIdempotent
[settings] settings.updateTraefikConfig (POST)
Parameters:
traefikConfig (string, required)
Inputs: traefikConfig (required).
dokploy_settings_updateTraefikFiledokploy_settings_updateTraefikFileCIdempotent
[settings] settings.updateTraefikFile (POST)
Parameters:
path (string, required)
traefikConfig (string, required)
serverId (string, optional)
Inputs: path (required), traefikConfig (required), serverId.
dokploy_settings_updateTraefikPortsdokploy_settings_updateTraefikPortsCIdempotent
[settings] settings.updateTraefikPorts (POST)
Parameters:
serverId (string, optional)
additionalPorts (array, required)
Inputs: additionalPorts (required), serverId.
dokploy_settings_updateWebServerTraefikConfigdokploy_settings_updateWebServerTraefikConfigCIdempotent
[settings] settings.updateWebServerTraefikConfig (POST)
Parameters:
traefikConfig (string, required)
Inputs: traefikConfig (required).
dokploy_settings_writeTraefikEnvdokploy_settings_writeTraefikEnvC
[settings] settings.writeTraefikEnv (POST)
Parameters:
env (string, required)
serverId (string, optional)
Inputs: env (required), serverId.
dokploy_sshKey_alldokploy_sshKey_allCRead-onlyIdempotent
[sshKey] sshKey.all (GET)
Inputs: no named parameters.
dokploy_sshKey_createdokploy_sshKey_createC
[sshKey] sshKey.create (POST)
Parameters:
name (string, required)
description (any, optional)
privateKey (string, required)
publicKey (string, required)
organizationId (string, required)
Inputs: name (required), privateKey (required), publicKey (required), organizationId (required), +1 more.
dokploy_sshKey_generatedokploy_sshKey_generateD
[sshKey] sshKey.generate (POST)
Parameters:
type (enum: rsa, ed25519, optional)
Inputs: type.
dokploy_sshKey_onedokploy_sshKey_oneCRead-onlyIdempotent
[sshKey] sshKey.one (GET)
Parameters:
sshKeyId (string, required)
Inputs: sshKeyId (required).
dokploy_sshKey_removedokploy_sshKey_removeCDestructive
[sshKey] sshKey.remove (POST)
Parameters:
sshKeyId (string, required)
Inputs: sshKeyId (required).
dokploy_sshKey_updatedokploy_sshKey_updateCIdempotent
[sshKey] sshKey.update (POST)
Parameters:
name (string, optional)
description (any, optional)
lastUsedAt (any, optional)
sshKeyId (string, required)
Inputs: sshKeyId (required), name, description, lastUsedAt.
dokploy_sso_addTrustedOrigindokploy_sso_addTrustedOriginC
[sso] sso.addTrustedOrigin (POST)
Parameters:
origin (string, required)
Inputs: origin (required).
dokploy_sso_deleteProviderdokploy_sso_deleteProviderCDestructive
[sso] sso.deleteProvider (POST)
Parameters:
providerId (string, required)
Inputs: providerId (required).
dokploy_sso_getTrustedOriginsdokploy_sso_getTrustedOriginsCRead-onlyIdempotent
[sso] sso.getTrustedOrigins (GET)
Inputs: no named parameters.
dokploy_sso_listProvidersdokploy_sso_listProvidersCRead-onlyIdempotent
[sso] sso.listProviders (GET)
Inputs: no named parameters.
dokploy_sso_onedokploy_sso_oneCRead-onlyIdempotent
[sso] sso.one (GET)
Parameters:
providerId (string, required)
Inputs: providerId (required).
dokploy_sso_registerdokploy_sso_registerD
[sso] sso.register (POST)
Parameters:
providerId (string, required)
issuer (string, required)
domains (array, required)
oidcConfig (object, optional)
samlConfig (object, optional)
organizationId (string, optional)
overrideUserInfo (boolean, optional)
Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.
dokploy_sso_removeTrustedOrigindokploy_sso_removeTrustedOriginCDestructive
[sso] sso.removeTrustedOrigin (POST)
Parameters:
origin (string, required)
Inputs: origin (required).
dokploy_sso_showSignInWithSSOdokploy_sso_showSignInWithSSOCRead-onlyIdempotent
[sso] sso.showSignInWithSSO (GET)
Inputs: no named parameters.
dokploy_sso_updatedokploy_sso_updateDIdempotent
[sso] sso.update (POST)
Parameters:
providerId (string, required)
issuer (string, required)
domains (array, required)
oidcConfig (object, optional)
samlConfig (object, optional)
organizationId (string, optional)
overrideUserInfo (boolean, optional)
Inputs: providerId (required), issuer (required), domains (required), oidcConfig, +3 more.
dokploy_sso_updateTrustedOrigindokploy_sso_updateTrustedOriginCIdempotent
[sso] sso.updateTrustedOrigin (POST)
Parameters:
oldOrigin (string, required)
newOrigin (string, required)
Inputs: oldOrigin (required), newOrigin (required).
dokploy_stripe_canCreateMoreServersdokploy_stripe_canCreateMoreServersCRead-onlyIdempotent
[stripe] stripe.canCreateMoreServers (GET)
Inputs: no named parameters.
dokploy_stripe_createCheckoutSessiondokploy_stripe_createCheckoutSessionC
[stripe] stripe.createCheckoutSession (POST)
Parameters:
tier (enum: legacy, hobby, startup, required)
productId (string, required)
serverQuantity (number, required)
isAnnual (boolean, required)
Inputs: tier (required), productId (required), serverQuantity (required), isAnnual (required).
dokploy_stripe_createCustomerPortalSessiondokploy_stripe_createCustomerPortalSessionC
[stripe] stripe.createCustomerPortalSession (POST)
Inputs: no named parameters.
dokploy_stripe_getCurrentPlandokploy_stripe_getCurrentPlanCRead-onlyIdempotent
[stripe] stripe.getCurrentPlan (GET)
Inputs: no named parameters.
dokploy_stripe_getInvoicesdokploy_stripe_getInvoicesCRead-onlyIdempotent
[stripe] stripe.getInvoices (GET)
Inputs: no named parameters.
dokploy_stripe_getProductsdokploy_stripe_getProductsCRead-onlyIdempotent
[stripe] stripe.getProducts (GET)
Inputs: no named parameters.
dokploy_stripe_upgradeSubscriptiondokploy_stripe_upgradeSubscriptionD
[stripe] stripe.upgradeSubscription (POST)
Parameters:
tier (enum: hobby, startup, required)
serverQuantity (number, required)
isAnnual (boolean, required)
Inputs: tier (required), serverQuantity (required), isAnnual (required).
dokploy_swarm_getNodeAppsdokploy_swarm_getNodeAppsCRead-onlyIdempotent
[swarm] swarm.getNodeApps (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_swarm_getNodeInfodokploy_swarm_getNodeInfoCRead-onlyIdempotent
[swarm] swarm.getNodeInfo (GET)
Parameters:
nodeId (string, required)
serverId (string, optional)
Inputs: nodeId (required), serverId.
dokploy_swarm_getNodesdokploy_swarm_getNodesCRead-onlyIdempotent
[swarm] swarm.getNodes (GET)
Parameters:
serverId (string, optional)
Inputs: serverId.
dokploy_user_alldokploy_user_allCRead-onlyIdempotent
[user] user.all (GET)
Inputs: no named parameters.
dokploy_user_assignPermissionsdokploy_user_assignPermissionsD
[user] user.assignPermissions (POST)
Parameters:
id (string, required)
accessedProjects (array, required)
accessedEnvironments (array, required)
accessedServices (array, required)
canCreateProjects (boolean, required)
canCreateServices (boolean, required)
canDeleteProjects (boolean, required)
canDeleteServices (boolean, required)
canAccessToDocker (boolean, required)
canAccessToTraefikFiles (boolean, required)
canAccessToAPI (boolean, required)
canAccessToSSHKeys (boolean, required)
canAccessToGitProviders (boolean, required)
canDeleteEnvironments (boolean, required)
canCreateEnvironments (boolean, required)
Inputs: id (required), accessedProjects (required), accessedEnvironments (required), accessedServices (required), +11 more.
dokploy_user_checkUserOrganizationsdokploy_user_checkUserOrganizationsCRead-onlyIdempotent
[user] user.checkUserOrganizations (GET)
Parameters:
userId (string, required)
Inputs: userId (required).
dokploy_user_createApiKeydokploy_user_createApiKeyD
[user] user.createApiKey (POST)
Parameters:
name (string, required)
prefix (string, optional)
expiresIn (number, optional)
metadata (object, required)
rateLimitEnabled (boolean, optional)
rateLimitTimeWindow (number, optional)
rateLimitMax (number, optional)
remaining (number, optional)
refillAmount (number, optional)
refillInterval (number, optional)
Inputs: name (required), metadata (required), prefix, expiresIn, +6 more.
dokploy_user_deleteApiKeydokploy_user_deleteApiKeyCDestructive
[user] user.deleteApiKey (POST)
Parameters:
apiKeyId (string, required)
Inputs: apiKeyId (required).
dokploy_user_generateTokendokploy_user_generateTokenC
[user] user.generateToken (POST)
Inputs: no named parameters.
dokploy_user_getdokploy_user_getCRead-onlyIdempotent
[user] user.get (GET)
Inputs: no named parameters.
dokploy_user_getBackupsdokploy_user_getBackupsCRead-onlyIdempotent
[user] user.getBackups (GET)
Inputs: no named parameters.
dokploy_user_getContainerMetricsdokploy_user_getContainerMetricsCRead-onlyIdempotent
[user] user.getContainerMetrics (GET)
Parameters:
url (string, required)
token (string, required)
appName (string, required)
dataPoints (string, required)
Inputs: url (required), token (required), appName (required), dataPoints (required).
dokploy_user_getInvitationsdokploy_user_getInvitationsCRead-onlyIdempotent
[user] user.getInvitations (GET)
Inputs: no named parameters.
dokploy_user_getMetricsTokendokploy_user_getMetricsTokenCRead-onlyIdempotent
[user] user.getMetricsToken (GET)
Inputs: no named parameters.
dokploy_user_getPermissionsdokploy_user_getPermissionsCRead-onlyIdempotent
[user] user.getPermissions (GET)
Inputs: no named parameters.
dokploy_user_getServerMetricsdokploy_user_getServerMetricsCRead-onlyIdempotent
[user] user.getServerMetrics (GET)
Inputs: no named parameters.
dokploy_user_getUserByTokendokploy_user_getUserByTokenCRead-onlyIdempotent
[user] user.getUserByToken (GET)
Parameters:
token (string, required)
Inputs: token (required).
dokploy_user_haveRootAccessdokploy_user_haveRootAccessCRead-onlyIdempotent
[user] user.haveRootAccess (GET)
Inputs: no named parameters.
dokploy_user_onedokploy_user_oneCRead-onlyIdempotent
[user] user.one (GET)
Parameters:
userId (string, required)
Inputs: userId (required).
dokploy_user_removedokploy_user_removeCDestructive
[user] user.remove (POST)
Parameters:
userId (string, required)
Inputs: userId (required).
dokploy_user_sendInvitationdokploy_user_sendInvitationC
[user] user.sendInvitation (POST)
Parameters:
invitationId (string, required)
notificationId (string, required)
Inputs: invitationId (required), notificationId (required).
dokploy_user_sessiondokploy_user_sessionCRead-onlyIdempotent
[user] user.session (GET)
Inputs: no named parameters.
dokploy_user_updatedokploy_user_updateCIdempotent
[user] user.update (POST)
Parameters:
id (string, optional)
firstName (string, optional)
lastName (string, optional)
isRegistered (boolean, optional)
expirationDate (string, optional)
createdAt2 (string, optional)
createdAt (any, optional)
twoFactorEnabled (any, optional)
email (string, optional)
emailVerified (boolean, optional)
image (any, optional)
banned (any, optional)
banReason (any, optional)
banExpires (any, optional)
updatedAt (string, optional)
enablePaidFeatures (boolean, optional)
allowImpersonation (boolean, optional)
enableEnterpriseFeatures (boolean, optional)
licenseKey (any, optional)
stripeCustomerId (any, optional)
stripeSubscriptionId (any, optional)
serversQuantity (number, optional)
password (string, optional)
currentPassword (string, optional)
Inputs: id, firstName, lastName, isRegistered, +20 more.
dokploy_volumeBackups_createdokploy_volumeBackups_createC
[volumeBackups] volumeBackups.create (POST)
Parameters:
name (string, required)
volumeName (string, required)
prefix (string, required)
serviceType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, optional)
appName (string, optional)
serviceName (any, optional)
turnOff (boolean, optional)
cronExpression (string, required)
keepLatestCount (any, optional)
enabled (any, optional)
applicationId (any, optional)
postgresId (any, optional)
mariadbId (any, optional)
mongoId (any, optional)
mysqlId (any, optional)
redisId (any, optional)
composeId (any, optional)
createdAt (string, optional)
destinationId (string, required)
Inputs: name (required), volumeName (required), prefix (required), cronExpression (required), +15 more.
dokploy_volumeBackups_deletedokploy_volumeBackups_deleteCDestructive
[volumeBackups] volumeBackups.delete (POST)
Parameters:
volumeBackupId (string, required)
Inputs: volumeBackupId (required).
dokploy_volumeBackups_listdokploy_volumeBackups_listCRead-onlyIdempotent
[volumeBackups] volumeBackups.list (GET)
Parameters:
id (string, required)
volumeBackupType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, required)
Inputs: id (required), volumeBackupType (required).
dokploy_volumeBackups_onedokploy_volumeBackups_oneCRead-onlyIdempotent
[volumeBackups] volumeBackups.one (GET)
Parameters:
volumeBackupId (string, required)
Inputs: volumeBackupId (required).
dokploy_volumeBackups_runManuallydokploy_volumeBackups_runManuallyC
[volumeBackups] volumeBackups.runManually (POST)
Parameters:
volumeBackupId (string, required)
Inputs: volumeBackupId (required).
dokploy_volumeBackups_updatedokploy_volumeBackups_updateCIdempotent
[volumeBackups] volumeBackups.update (POST)
Parameters:
name (string, required)
volumeName (string, required)
prefix (string, required)
serviceType (enum: application, postgres, mysql, mariadb, mongo, redis, compose, optional)
appName (string, optional)
serviceName (any, optional)
turnOff (boolean, optional)
cronExpression (string, required)
keepLatestCount (any, optional)
enabled (any, optional)
applicationId (any, optional)
postgresId (any, optional)
mariadbId (any, optional)
mongoId (any, optional)
mysqlId (any, optional)
redisId (any, optional)
composeId (any, optional)
createdAt (string, optional)
destinationId (string, required)
volumeBackupId (string, required)
Inputs: name (required), volumeName (required), prefix (required), cronExpression (required), +16 more.
dokploy_whitelabeling_getdokploy_whitelabeling_getCRead-onlyIdempotent
[whitelabeling] whitelabeling.get (GET)
Inputs: no named parameters.
dokploy_whitelabeling_getPublicdokploy_whitelabeling_getPublicCRead-onlyIdempotent
[whitelabeling] whitelabeling.getPublic (GET)
Inputs: no named parameters.
dokploy_whitelabeling_resetdokploy_whitelabeling_resetCIdempotent
[whitelabeling] whitelabeling.reset (POST)
Inputs: no named parameters.
dokploy_whitelabeling_updatedokploy_whitelabeling_updateCIdempotent
[whitelabeling] whitelabeling.update (POST)
Parameters:
whitelabelingConfig (object, required)
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 463 tools
Many tools are clearly distinct by resource type (e.g., mysql, postgres, redis each have their own lifecycle tools), but there is significant overlap among actions like start, stop, deploy, redeploy, reload, rebuild, and changeStatus which may confuse agents. Also, multiple tools named 'all' or 'getAll' across different resources could be ambiguous without clear resource context.
Tool names follow a consistent pattern: resource name (e.g., application, mysql) followed by an action (e.g., create, update, delete). However, there are minor inconsistencies like 'all' vs 'allForPermissions' and some tools use different verb styles (e.g., 'get' vs 'one', 'create' vs 'register'). Overall, the pattern is predictable.
With 463 tools, the count is far beyond any reasonable scope for an MCP server. The server appears to expose the entire API surface of Dokploy, including many internal or rarely used endpoints. This makes it extremely heavy and impractical for an agent to navigate.
The tool surface is extensive, covering CRUD for most resources, deployments, backups, notifications, and settings. However, there are gaps like missing update for some providers (e.g., github update is present but no corresponding get for individual provider data), and some lifecycle actions are inconsistent across resource types (e.g., mysql has changeStatus but mongo does not). The completeness is high but not perfectly uniform.
Maintenance
Related MCP Connectors
Deploy and manage your apps, databases, storage, and scheduled jobs from your AI agent
Deploy and manage applications, databases, domains, and git repos
Manage your own cloud with AI: deploy apps, push and ship custom Docker images, manage resources via your AI agent.
Deploy services, add databases, run agents, read logs, check vulnerabilities and publish pages.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables AI assistants to interact with Coolify for complete infrastructure management including applications, databases, servers, deployments, and team operations. Provides 100% API coverage with 64 tools for managing the entire Coolify ecosystem through natural language.1811 npm6MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage Dokploy deployments, including creating and deploying applications, managing databases, configuring domains with SSL, and monitoring application status through a standardized interface.MIT
- AlicenseNot gradedqualityNot gradedmaintenanceEnables AI assistants to manage cloud infrastructure through natural language by providing a unified interface to the Dokploy platform. Supports Docker containers, applications, databases, domains, monitoring, and deployment operations through conversational commands.31 npm1-
- 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.478 npmApache 2.0