Dokploy
Generated

Application

POST
/application.create

Application create

/application.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

appNamestring

descriptionstring | null

environmentId
Required
string

serverIdstring | null

curl -X POST "https://your-dokploy-instance.com/api/application.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "appName": "string",
    "description": "string",
    "environmentId": "string",
    "serverId": "string"
  }'

Successful response

{}

GET
/application.one

Application one

/application.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

applicationId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/application.one?applicationId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/application.reload

Application reload

/application.reload

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

appName
Required
string

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.reload" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appName": "string",
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.delete

Application delete

/application.delete

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.stop

Application stop

/application.stop

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.stop" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.start

Application start

/application.start

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.start" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.redeploy

Application redeploy

/application.redeploy

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

Minimum length: 1

titlestring

descriptionstring

curl -X POST "https://your-dokploy-instance.com/api/application.redeploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "title": "string",
    "description": "string"
  }'

Successful response

{}

POST
/application.saveEnvironment

Application save Environment

/application.saveEnvironment

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

envstring | null

buildArgsstring | null

buildSecretsstring | null

curl -X POST "https://your-dokploy-instance.com/api/application.saveEnvironment" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "env": "string",
    "buildArgs": "string",
    "buildSecrets": "string"
  }'

Successful response

{}

POST
/application.saveBuildType

Application save Build Type

/application.saveBuildType

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

buildType
Required
string

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static" | "railpack"

dockerfilestring | null

dockerContextPath
Required
string | null

dockerBuildStage
Required
string | null

herokuVersionstring | null

railpackVersionstring | null

publishDirectorystring | null

isStaticSpaboolean | null

curl -X POST "https://your-dokploy-instance.com/api/application.saveBuildType" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "buildType": "dockerfile",
    "dockerfile": "string",
    "dockerContextPath": "string",
    "dockerBuildStage": "string",
    "herokuVersion": "string",
    "railpackVersion": "string",
    "publishDirectory": "string",
    "isStaticSpa": true
  }'

Successful response

{}

POST
/application.saveGithubProvider

Application save Github Provider

/application.saveGithubProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

repositorystring | null

branchstring | null

owner
Required
string | null

buildPathstring | null

githubId
Required
string | null

watchPathsarray<string> | null

enableSubmodules
Required
boolean

triggerTypestring

Default: "push"Value in: "push" | "tag"
curl -X POST "https://your-dokploy-instance.com/api/application.saveGithubProvider" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "repository": "string",
    "branch": "string",
    "owner": "string",
    "buildPath": "string",
    "githubId": "string",
    "watchPaths": [
      "string"
    ],
    "enableSubmodules": true,
    "triggerType": "push"
  }'

Successful response

{}

POST
/application.saveGitlabProvider

Application save Gitlab Provider

/application.saveGitlabProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

gitlabBranch
Required
string | null

gitlabBuildPath
Required
string | null

gitlabOwner
Required
string | null

gitlabRepository
Required
string | null

gitlabId
Required
string | null

gitlabProjectId
Required
number | null

gitlabPathNamespace
Required
string | null

watchPathsarray<string> | null

enableSubmodules
Required
boolean

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

Successful response

{}

POST
/application.saveBitbucketProvider

Application save Bitbucket Provider

/application.saveBitbucketProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

bitbucketBranch
Required
string | null

bitbucketBuildPath
Required
string | null

bitbucketOwner
Required
string | null

bitbucketRepository
Required
string | null

bitbucketId
Required
string | null

applicationId
Required
string

watchPathsarray<string> | null

enableSubmodules
Required
boolean

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

Successful response

{}

POST
/application.saveGiteaProvider

Application save Gitea Provider

/application.saveGiteaProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

giteaBranch
Required
string | null

giteaBuildPath
Required
string | null

giteaOwner
Required
string | null

giteaRepository
Required
string | null

giteaId
Required
string | null

watchPathsarray<string> | null

enableSubmodules
Required
boolean

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

Successful response

{}

POST
/application.saveDockerProvider

Application save Docker Provider

/application.saveDockerProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

dockerImagestring | null

applicationId
Required
string

usernamestring | null

passwordstring | null

registryUrlstring | null

curl -X POST "https://your-dokploy-instance.com/api/application.saveDockerProvider" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "dockerImage": "string",
    "applicationId": "string",
    "username": "string",
    "password": "string",
    "registryUrl": "string"
  }'

Successful response

{}

POST
/application.saveGitProvider

Application save Git Provider

/application.saveGitProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

customGitBranchstring | null

applicationId
Required
string

customGitBuildPathstring | null

customGitUrlstring | null

watchPathsarray<string> | null

enableSubmodules
Required
boolean

customGitSSHKeyIdstring | null

curl -X POST "https://your-dokploy-instance.com/api/application.saveGitProvider" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customGitBranch": "string",
    "applicationId": "string",
    "customGitBuildPath": "string",
    "customGitUrl": "string",
    "watchPaths": [
      "string"
    ],
    "enableSubmodules": true,
    "customGitSSHKeyId": "string"
  }'

Successful response

{}

POST
/application.disconnectGitProvider

Application disconnect Git Provider

/application.disconnectGitProvider

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.disconnectGitProvider" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.markRunning

Application mark Running

/application.markRunning

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.markRunning" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.update

Application update

/application.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

descriptionstring | null

envstring | null

previewEnvstring | null

watchPathsarray<string> | null

previewBuildArgsstring | null

previewBuildSecretsstring | null

previewLabelsarray<string> | null

previewWildcardstring | null

previewPortnumber | null

previewHttpsboolean

previewPathstring | null

previewCertificateTypestring

Value in: "letsencrypt" | "none" | "custom"

previewCustomCertResolverstring | null

previewLimitnumber | null

isPreviewDeploymentsActiveboolean | null

previewRequireCollaboratorPermissionsboolean | null

rollbackActiveboolean | null

buildArgsstring | null

buildSecretsstring | null

memoryReservationstring | null

memoryLimitstring | null

cpuReservationstring | null

cpuLimitstring | null

titlestring | null

enabledboolean | null

subtitlestring | null

commandstring | null

argsarray<string> | null

refreshTokenstring | null

sourceTypestring

Value in: "github" | "docker" | "git" | "gitlab" | "bitbucket" | "gitea" | "drop"

cleanCacheboolean | null

repositorystring | null

ownerstring | null

branchstring | null

buildPathstring | null

triggerTypestring | null

Value in: "push" | "tag"

autoDeployboolean | null

gitlabProjectIdnumber | null

gitlabRepositorystring | null

gitlabOwnerstring | null

gitlabBranchstring | null

gitlabBuildPathstring | null

gitlabPathNamespacestring | null

giteaRepositorystring | null

giteaOwnerstring | null

giteaBranchstring | null

giteaBuildPathstring | null

bitbucketRepositorystring | null

bitbucketOwnerstring | null

bitbucketBranchstring | null

bitbucketBuildPathstring | null

usernamestring | null

passwordstring | null

dockerImagestring | null

registryUrlstring | null

customGitUrlstring | null

customGitBranchstring | null

customGitBuildPathstring | null

customGitSSHKeyIdstring | null

enableSubmodulesboolean

dockerfilestring | null

dockerContextPathstring | null

dockerBuildStagestring | null

dropBuildPathstring | null

healthCheckSwarmobject | null

restartPolicySwarmobject | null

placementSwarmobject | null

updateConfigSwarmobject | null

rollbackConfigSwarmobject | null

modeSwarmobject | null

labelsSwarmobject | null

networkSwarmarray<object> | null

stopGracePeriodSwarminteger | null

endpointSpecSwarmobject | null

replicasnumber

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

buildTypestring

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static" | "railpack"

railpackVersionstring | null

herokuVersionstring | null

publishDirectorystring | null

isStaticSpaboolean | null

createdAtstring

registryIdstring | null

environmentIdstring

githubIdstring | null

gitlabIdstring | null

giteaIdstring | null

bitbucketIdstring | null

buildServerIdstring | null

buildRegistryIdstring | null

curl -X POST "https://your-dokploy-instance.com/api/application.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "name": "string",
    "appName": "string",
    "description": "string",
    "env": "string",
    "previewEnv": "string",
    "watchPaths": [
      "string"
    ],
    "previewBuildArgs": "string",
    "previewBuildSecrets": "string",
    "previewLabels": [
      "string"
    ],
    "previewWildcard": "string",
    "previewPort": 0,
    "previewHttps": true,
    "previewPath": "string",
    "previewCertificateType": "letsencrypt",
    "previewCustomCertResolver": "string",
    "previewLimit": 0,
    "isPreviewDeploymentsActive": true,
    "previewRequireCollaboratorPermissions": true,
    "rollbackActive": true,
    "buildArgs": "string",
    "buildSecrets": "string",
    "memoryReservation": "string",
    "memoryLimit": "string",
    "cpuReservation": "string",
    "cpuLimit": "string",
    "title": "string",
    "enabled": true,
    "subtitle": "string",
    "command": "string",
    "args": [
      "string"
    ],
    "refreshToken": "string",
    "sourceType": "github",
    "cleanCache": true,
    "repository": "string",
    "owner": "string",
    "branch": "string",
    "buildPath": "string",
    "triggerType": "push",
    "autoDeploy": true,
    "gitlabProjectId": 0,
    "gitlabRepository": "string",
    "gitlabOwner": "string",
    "gitlabBranch": "string",
    "gitlabBuildPath": "string",
    "gitlabPathNamespace": "string",
    "giteaRepository": "string",
    "giteaOwner": "string",
    "giteaBranch": "string",
    "giteaBuildPath": "string",
    "bitbucketRepository": "string",
    "bitbucketOwner": "string",
    "bitbucketBranch": "string",
    "bitbucketBuildPath": "string",
    "username": "string",
    "password": "string",
    "dockerImage": "string",
    "registryUrl": "string",
    "customGitUrl": "string",
    "customGitBranch": "string",
    "customGitBuildPath": "string",
    "customGitSSHKeyId": "string",
    "enableSubmodules": true,
    "dockerfile": "string",
    "dockerContextPath": "string",
    "dockerBuildStage": "string",
    "dropBuildPath": "string",
    "healthCheckSwarm": {
      "Test": [
        "string"
      ],
      "Interval": 0,
      "Timeout": 0,
      "StartPeriod": 0,
      "Retries": 0
    },
    "restartPolicySwarm": {
      "Condition": "string",
      "Delay": 0,
      "MaxAttempts": 0,
      "Window": 0
    },
    "placementSwarm": {
      "Constraints": [
        "string"
      ],
      "Preferences": [
        {
          "Spread": {
            "SpreadDescriptor": "string"
          }
        }
      ],
      "MaxReplicas": 0,
      "Platforms": [
        {
          "Architecture": "string",
          "OS": "string"
        }
      ]
    },
    "updateConfigSwarm": {
      "Parallelism": 0,
      "Delay": 0,
      "FailureAction": "string",
      "Monitor": 0,
      "MaxFailureRatio": 0,
      "Order": "string"
    },
    "rollbackConfigSwarm": {
      "Parallelism": 0,
      "Delay": 0,
      "FailureAction": "string",
      "Monitor": 0,
      "MaxFailureRatio": 0,
      "Order": "string"
    },
    "modeSwarm": {
      "Replicated": {
        "Replicas": 0
      },
      "Global": {},
      "ReplicatedJob": {
        "MaxConcurrent": 0,
        "TotalCompletions": 0
      },
      "GlobalJob": {}
    },
    "labelsSwarm": {
      "property1": "string",
      "property2": "string"
    },
    "networkSwarm": [
      {
        "Target": "string",
        "Aliases": [
          "string"
        ],
        "DriverOpts": {}
      }
    ],
    "stopGracePeriodSwarm": 0,
    "endpointSpecSwarm": {
      "Mode": "string",
      "Ports": [
        {
          "Protocol": "string",
          "TargetPort": 0,
          "PublishedPort": 0,
          "PublishMode": "string"
        }
      ]
    },
    "replicas": 0,
    "applicationStatus": "idle",
    "buildType": "dockerfile",
    "railpackVersion": "string",
    "herokuVersion": "string",
    "publishDirectory": "string",
    "isStaticSpa": true,
    "createdAt": "string",
    "registryId": "string",
    "environmentId": "string",
    "githubId": "string",
    "gitlabId": "string",
    "giteaId": "string",
    "bitbucketId": "string",
    "buildServerId": "string",
    "buildRegistryId": "string"
  }'

Successful response

{}

POST
/application.refreshToken

Application refresh Token

/application.refreshToken

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.refreshToken" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.deploy

Application deploy

/application.deploy

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

Minimum length: 1

titlestring

descriptionstring

curl -X POST "https://your-dokploy-instance.com/api/application.deploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "title": "string",
    "description": "string"
  }'

Successful response

{}

POST
/application.cleanQueues

Application clean Queues

/application.cleanQueues

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.cleanQueues" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

POST
/application.killBuild

Application kill Build

/application.killBuild

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.killBuild" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

GET
/application.readTraefikConfig

Application read Traefik Config

/application.readTraefikConfig

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

applicationId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/application.readTraefikConfig?applicationId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/application.updateTraefikConfig

Application update Traefik Config

/application.updateTraefikConfig

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

traefikConfig
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.updateTraefikConfig" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "traefikConfig": "string"
  }'

Successful response

{}

GET
/application.readAppMonitoring

Application read App Monitoring

/application.readAppMonitoring

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

appName
Required
string

curl -X GET "https://your-dokploy-instance.com/api/application.readAppMonitoring?appName=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/application.move

Application move

/application.move

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

targetEnvironmentId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.move" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string",
    "targetEnvironmentId": "string"
  }'

Successful response

{}

POST
/application.cancelDeployment

Application cancel Deployment

/application.cancelDeployment

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

applicationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/application.cancelDeployment" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationId": "string"
  }'

Successful response

{}

Previous

Ai

Next

Backup