Dokploy

Dokploy application API

The application API from Dokploy — 31 operation(s) for application.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.dokploy.com/
📖
APIReference
https://github.com/Dokploy/sdk/blob/main/openapi.json
📖
GettingStarted
https://docs.dokploy.com/docs/core
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/rate-limits/dokploy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/openapi/dokploy-application-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/Dokploy/sdk
🔗
CLI
https://github.com/Dokploy/cli
🔗
MCP
https://github.com/Dokploy/mcp
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/plans/dokploy-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/finops/dokploy-finops.yml

OpenAPI Specification

dokploy-application-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Dokploy admin application API
  description: Complete API documentation for Dokploy - Deploy applications, manage databases, and orchestrate your infrastructure. This API allows you to programmatically manage all aspects of your Dokploy instance.
  version: 1.0.0
  contact:
    name: Dokploy Team
    url: https://dokploy.com
  license:
    name: Apache 2.0
    url: https://github.com/dokploy/dokploy/blob/canary/LICENSE
servers:
- url: https://your-dokploy-instance.com/api
security:
- apiKey: []
tags:
- name: application
paths:
  /application.create:
    post:
      operationId: application-create
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                appName:
                  type: string
                  minLength: 1
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9._-]+$
                description:
                  anyOf:
                  - type: string
                  - type: 'null'
                environmentId:
                  type: string
                serverId:
                  anyOf:
                  - type: string
                  - type: 'null'
              required:
              - name
              - environmentId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.one:
    get:
      operationId: application-one
      tags:
      - application
      security:
      - Authorization: []
      parameters:
      - in: query
        name: applicationId
        schema:
          type: string
          minLength: 1
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.reload:
    post:
      operationId: application-reload
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appName:
                  type: string
                  minLength: 1
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9._-]+$
                applicationId:
                  type: string
              required:
              - appName
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.delete:
    post:
      operationId: application-delete
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  minLength: 1
              required:
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.stop:
    post:
      operationId: application-stop
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  minLength: 1
              required:
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.start:
    post:
      operationId: application-start
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  minLength: 1
              required:
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.redeploy:
    post:
      operationId: application-redeploy
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  minLength: 1
                title:
                  type: string
                description:
                  type: string
              required:
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveEnvironment:
    post:
      operationId: application-saveEnvironment
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                env:
                  anyOf:
                  - type: string
                  - type: 'null'
                buildArgs:
                  anyOf:
                  - type: string
                  - type: 'null'
                buildSecrets:
                  anyOf:
                  - type: string
                  - type: 'null'
                createEnvFile:
                  type: boolean
              required:
              - applicationId
              - env
              - buildArgs
              - buildSecrets
              - createEnvFile
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveBuildType:
    post:
      operationId: application-saveBuildType
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                buildType:
                  type: string
                  enum:
                  - dockerfile
                  - heroku_buildpacks
                  - paketo_buildpacks
                  - nixpacks
                  - static
                  - railpack
                dockerfile:
                  anyOf:
                  - type: string
                  - type: 'null'
                dockerContextPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                dockerBuildStage:
                  anyOf:
                  - type: string
                  - type: 'null'
                herokuVersion:
                  anyOf:
                  - type: string
                  - type: 'null'
                railpackVersion:
                  anyOf:
                  - type: string
                  - type: 'null'
                publishDirectory:
                  anyOf:
                  - type: string
                  - type: 'null'
                isStaticSpa:
                  anyOf:
                  - type: boolean
                  - type: 'null'
              required:
              - applicationId
              - buildType
              - dockerfile
              - dockerContextPath
              - dockerBuildStage
              - herokuVersion
              - railpackVersion
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveGithubProvider:
    post:
      operationId: application-saveGithubProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                repository:
                  anyOf:
                  - type: string
                  - type: 'null'
                owner:
                  anyOf:
                  - type: string
                  - type: 'null'
                buildPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                githubId:
                  anyOf:
                  - type: string
                  - type: 'null'
                branch:
                  type: string
                  minLength: 1
                  pattern: ^[a-zA-Z0-9._\-/]+$
                triggerType:
                  default: push
                  type: string
                  enum:
                  - push
                  - tag
                enableSubmodules:
                  type: boolean
                watchPaths:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              required:
              - applicationId
              - repository
              - owner
              - buildPath
              - githubId
              - branch
              - triggerType
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveGitlabProvider:
    post:
      operationId: application-saveGitlabProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                gitlabBuildPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                gitlabOwner:
                  anyOf:
                  - type: string
                  - type: 'null'
                gitlabRepository:
                  anyOf:
                  - type: string
                  - type: 'null'
                gitlabId:
                  anyOf:
                  - type: string
                  - type: 'null'
                gitlabProjectId:
                  anyOf:
                  - type: number
                  - type: 'null'
                gitlabPathNamespace:
                  anyOf:
                  - type: string
                  - type: 'null'
                gitlabBranch:
                  type: string
                  minLength: 1
                  pattern: ^[a-zA-Z0-9._\-/]+$
                enableSubmodules:
                  type: boolean
                watchPaths:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              required:
              - applicationId
              - gitlabBuildPath
              - gitlabOwner
              - gitlabRepository
              - gitlabId
              - gitlabProjectId
              - gitlabPathNamespace
              - gitlabBranch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveBitbucketProvider:
    post:
      operationId: application-saveBitbucketProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bitbucketBuildPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                bitbucketOwner:
                  anyOf:
                  - type: string
                  - type: 'null'
                bitbucketRepository:
                  anyOf:
                  - type: string
                  - type: 'null'
                bitbucketRepositorySlug:
                  anyOf:
                  - type: string
                  - type: 'null'
                bitbucketId:
                  anyOf:
                  - type: string
                  - type: 'null'
                applicationId:
                  type: string
                bitbucketBranch:
                  type: string
                  minLength: 1
                  pattern: ^[a-zA-Z0-9._\-/]+$
                enableSubmodules:
                  type: boolean
                watchPaths:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              required:
              - bitbucketBuildPath
              - bitbucketOwner
              - bitbucketRepository
              - bitbucketRepositorySlug
              - bitbucketId
              - applicationId
              - bitbucketBranch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveGiteaProvider:
    post:
      operationId: application-saveGiteaProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                giteaBuildPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                giteaOwner:
                  anyOf:
                  - type: string
                  - type: 'null'
                giteaRepository:
                  anyOf:
                  - type: string
                  - type: 'null'
                giteaId:
                  anyOf:
                  - type: string
                  - type: 'null'
                giteaBranch:
                  type: string
                  minLength: 1
                  pattern: ^[a-zA-Z0-9._\-/]+$
                enableSubmodules:
                  type: boolean
                watchPaths:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              required:
              - applicationId
              - giteaBuildPath
              - giteaOwner
              - giteaRepository
              - giteaId
              - giteaBranch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveDockerProvider:
    post:
      operationId: application-saveDockerProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                dockerImage:
                  anyOf:
                  - type: string
                  - type: 'null'
                applicationId:
                  type: string
                username:
                  anyOf:
                  - type: string
                  - type: 'null'
                password:
                  anyOf:
                  - type: string
                  - type: 'null'
                registryUrl:
                  anyOf:
                  - type: string
                  - type: 'null'
              required:
              - dockerImage
              - applicationId
              - username
              - password
              - registryUrl
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.saveGitProvider:
    post:
      operationId: application-saveGitProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                customGitBuildPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                customGitUrl:
                  anyOf:
                  - type: string
                  - type: 'null'
                watchPaths:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
                enableSubmodules:
                  type: boolean
                customGitBranch:
                  type: string
                  minLength: 1
                  pattern: ^[a-zA-Z0-9._\-/]+$
                customGitSSHKeyId:
                  anyOf:
                  - type: string
                  - type: 'null'
              required:
              - applicationId
              - customGitBuildPath
              - customGitUrl
              - watchPaths
              - customGitBranch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
  /application.disconnectGitProvider:
    post:
      operationId: application-disconnectGitProvider
      tags:
      - application
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  minLength: 1
              required:
              - applicationId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
         

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/openapi/dokploy-application-api-openapi.yml