Dokploy

Application

POST
/application.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
Length1 <= length
appName?string
description?string|null
environmentId*string
serverId?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "environmentId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/application.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

applicationId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/application.one?applicationId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.reload

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

appName*string
applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.reload" \  -H "Content-Type: application/json" \  -d '{    "appName": "string",    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.delete" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.stop

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.stop" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.start

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.start" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.redeploy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
Length1 <= length
title?string
description?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.redeploy" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveEnvironment

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
env?string|null
buildArgs?string|null
buildSecrets?string|null
createEnvFile*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveEnvironment" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "createEnvFile": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveBuildType

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
buildType*string
Value in"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static" | "railpack"
dockerfile?string|null
dockerContextPath*string|null
dockerBuildStage*string|null
herokuVersion?string|null
railpackVersion?string|null
publishDirectory?string|null
isStaticSpa?boolean|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveBuildType" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "buildType": "dockerfile",    "dockerContextPath": "string",    "dockerBuildStage": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveGithubProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
repository?string|null
branch?string|null
owner*string|null
buildPath?string|null
githubId*string|null
watchPaths?|null
enableSubmodules*boolean
triggerType?string
Default"push"
Value in"push" | "tag"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveGithubProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "owner": "string",    "githubId": "string",    "enableSubmodules": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveGitlabProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
gitlabBranch*string|null
gitlabBuildPath*string|null
gitlabOwner*string|null
gitlabRepository*string|null
gitlabId*string|null
gitlabProjectId*number|null
gitlabPathNamespace*string|null
watchPaths?|null
enableSubmodules*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveGitlabProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "gitlabBranch": "string",    "gitlabBuildPath": "string",    "gitlabOwner": "string",    "gitlabRepository": "string",    "gitlabId": "string",    "gitlabProjectId": 0,    "gitlabPathNamespace": "string",    "enableSubmodules": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveBitbucketProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

bitbucketBranch*string|null
bitbucketBuildPath*string|null
bitbucketOwner*string|null
bitbucketRepository*string|null
bitbucketId*string|null
applicationId*string
watchPaths?|null
enableSubmodules*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveBitbucketProvider" \  -H "Content-Type: application/json" \  -d '{    "bitbucketBranch": "string",    "bitbucketBuildPath": "string",    "bitbucketOwner": "string",    "bitbucketRepository": "string",    "bitbucketId": "string",    "applicationId": "string",    "enableSubmodules": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveGiteaProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
giteaBranch*string|null
giteaBuildPath*string|null
giteaOwner*string|null
giteaRepository*string|null
giteaId*string|null
watchPaths?|null
enableSubmodules*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveGiteaProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "giteaBranch": "string",    "giteaBuildPath": "string",    "giteaOwner": "string",    "giteaRepository": "string",    "giteaId": "string",    "enableSubmodules": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveDockerProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

dockerImage?string|null
applicationId*string
username?string|null
password?string|null
registryUrl?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveDockerProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.saveGitProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

customGitBranch?string|null
applicationId*string
customGitBuildPath?string|null
customGitUrl?string|null
watchPaths?|null
enableSubmodules*boolean
customGitSSHKeyId?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.saveGitProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "enableSubmodules": true  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.disconnectGitProvider

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.disconnectGitProvider" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.markRunning

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.markRunning" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
Length1 <= length
name?string
Length1 <= length
appName?string
description?string|null
env?string|null
previewEnv?string|null
watchPaths?|null
previewBuildArgs?string|null
previewBuildSecrets?string|null
previewLabels?|null
previewWildcard?string|null
previewPort?number|null
previewHttps?boolean
previewPath?string|null
previewCertificateType?string
Value in"letsencrypt" | "none" | "custom"
previewCustomCertResolver?string|null
previewLimit?number|null
isPreviewDeploymentsActive?boolean|null
previewRequireCollaboratorPermissions?boolean|null
rollbackActive?boolean|null
buildArgs?string|null
buildSecrets?string|null
memoryReservation?string|null
memoryLimit?string|null
cpuReservation?string|null
cpuLimit?string|null
title?string|null
enabled?boolean|null
subtitle?string|null
command?string|null
args?|null
refreshToken?string|null
sourceType?string
Value in"github" | "docker" | "git" | "gitlab" | "bitbucket" | "gitea" | "drop"
cleanCache?boolean|null
repository?string|null
owner?string|null
branch?string|null
buildPath?string|null
triggerType?string|null
Value in"push" | "tag"
autoDeploy?boolean|null
gitlabProjectId?number|null
gitlabRepository?string|null
gitlabOwner?string|null
gitlabBranch?string|null
gitlabBuildPath?string|null
gitlabPathNamespace?string|null
giteaRepository?string|null
giteaOwner?string|null
giteaBranch?string|null
giteaBuildPath?string|null
bitbucketRepository?string|null
bitbucketOwner?string|null
bitbucketBranch?string|null
bitbucketBuildPath?string|null
username?string|null
password?string|null
dockerImage?string|null
registryUrl?string|null
customGitUrl?string|null
customGitBranch?string|null
customGitBuildPath?string|null
customGitSSHKeyId?string|null
enableSubmodules?boolean
dockerfile?string|null
dockerContextPath?string|null
dockerBuildStage?string|null
dropBuildPath?string|null
healthCheckSwarm?|null
restartPolicySwarm?|null
placementSwarm?|null
updateConfigSwarm?|null
rollbackConfigSwarm?|null
modeSwarm?|null
labelsSwarm?|null
networkSwarm?|null
stopGracePeriodSwarm?integer|null
endpointSpecSwarm?|null
replicas?number
applicationStatus?string
Value in"idle" | "running" | "done" | "error"
buildType?string
Value in"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static" | "railpack"
railpackVersion?string|null
herokuVersion?string|null
publishDirectory?string|null
isStaticSpa?boolean|null
createEnvFile?boolean
createdAt?string
registryId?string|null
rollbackRegistryId?string|null
environmentId?string
githubId?string|null
gitlabId?string|null
giteaId?string|null
bitbucketId?string|null
buildServerId?string|null
buildRegistryId?string|null
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.update" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.refreshToken

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.refreshToken" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.deploy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
Length1 <= length
title?string
description?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.deploy" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.cleanQueues

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.cleanQueues" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.killBuild

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.killBuild" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/application.readTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

applicationId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/application.readTraefikConfig?applicationId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.updateTraefikConfig

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
traefikConfig*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.updateTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "traefikConfig": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/application.readAppMonitoring

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

appName*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/application.readAppMonitoring?appName=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.move

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
targetEnvironmentId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.move" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string",    "targetEnvironmentId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/application.cancelDeployment

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

applicationId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/application.cancelDeployment" \  -H "Content-Type: application/json" \  -d '{    "applicationId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Ai

Previous Page

Backup

Next Page