Dokploy

Dokploy Domain API

The domain API from Dokploy — 9 operation(s) for domain.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 10

POST /domain.create Domain create #
GET /domain.byApplicationId Domain by application id #
GET /domain.byComposeId Domain by compose id #
POST /domain.generateDomain Domain generate domain #
GET /domain.canGenerateTraefikMeDomains Domain can generate traefik me domains #
POST /domain.update Domain update #
POST /domain.toggleEnable Domain toggle enable #
GET /domain.one Domain one #
POST /domain.delete Domain delete #
POST /domain.validateDomain Domain validate domain #

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://artifacts.apis.io/dokploy/rate-limits/dokploy-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/dokploy/openapi/dokploy-domain-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/Dokploy/sdk
🔗
CLI
https://github.com/Dokploy/cli
🔗
MCPServer
https://github.com/Dokploy/mcp
🔗
Plans
https://artifacts.apis.io/dokploy/plans/dokploy-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/dokploy/finops/dokploy-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dokploy:dokploy-domain-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dokploy-domain-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dokploy Domain API
  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
  description: 'Operations tagged domain across 2 of this provider''s published API definitions: dokploy-openapi.json, dokploy-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://your-dokploy-instance.com/api
tags:
- name: Domain
paths:
  /domain.create:
    post:
      operationId: domain-create
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                host:
                  type: string
                  minLength: 1
                path:
                  anyOf:
                  - type: string
                    minLength: 1
                  - type: 'null'
                port:
                  anyOf:
                  - type: number
                    minimum: 1
                    maximum: 65535
                  - type: 'null'
                customEntrypoint:
                  anyOf:
                  - type: string
                  - type: 'null'
                https:
                  type: boolean
                applicationId:
                  anyOf:
                  - type: string
                  - type: 'null'
                certificateType:
                  type: string
                  enum:
                  - letsencrypt
                  - none
                  - custom
                customCertResolver:
                  anyOf:
                  - type: string
                  - type: 'null'
                composeId:
                  anyOf:
                  - type: string
                  - type: 'null'
                serviceName:
                  anyOf:
                  - type: string
                  - type: 'null'
                domainType:
                  anyOf:
                  - type: string
                    enum:
                    - compose
                    - application
                    - preview
                  - type: 'null'
                previewDeploymentId:
                  anyOf:
                  - type: string
                  - type: 'null'
                internalPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                stripPath:
                  type: boolean
                middlewares:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
                forwardAuthEnabled:
                  type: boolean
              required:
              - host
      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'
      summary: Domain create
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.byApplicationId:
    get:
      operationId: domain-byApplicationId
      tags:
      - Domain
      security:
      - x-api-key: []
      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'
      summary: Domain by application id
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.byComposeId:
    get:
      operationId: domain-byComposeId
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters:
      - in: query
        name: composeId
        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'
      summary: Domain by compose id
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.generateDomain:
    post:
      operationId: domain-generateDomain
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appName:
                  type: string
                serverId:
                  type: string
              required:
              - appName
      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'
      summary: Domain generate domain
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.canGenerateTraefikMeDomains:
    get:
      operationId: domain-canGenerateTraefikMeDomains
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters:
      - in: query
        name: serverId
        schema:
          type: string
        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'
      summary: Domain can generate traefik me domains
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.update:
    post:
      operationId: domain-update
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                host:
                  type: string
                  minLength: 1
                path:
                  anyOf:
                  - type: string
                    minLength: 1
                  - type: 'null'
                port:
                  anyOf:
                  - type: number
                    minimum: 1
                    maximum: 65535
                  - type: 'null'
                customEntrypoint:
                  anyOf:
                  - type: string
                  - type: 'null'
                https:
                  type: boolean
                certificateType:
                  type: string
                  enum:
                  - letsencrypt
                  - none
                  - custom
                customCertResolver:
                  anyOf:
                  - type: string
                  - type: 'null'
                serviceName:
                  anyOf:
                  - type: string
                  - type: 'null'
                domainType:
                  anyOf:
                  - type: string
                    enum:
                    - compose
                    - application
                    - preview
                  - type: 'null'
                internalPath:
                  anyOf:
                  - type: string
                  - type: 'null'
                stripPath:
                  type: boolean
                middlewares:
                  anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
                forwardAuthEnabled:
                  type: boolean
                enabled:
                  type: boolean
                domainId:
                  type: string
              required:
              - host
              - domainId
      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'
      summary: Domain update
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.toggleEnable:
    post:
      operationId: domain-toggleEnable
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domainId:
                  type: string
                  minLength: 1
              required:
              - domainId
      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'
      summary: Domain toggle enable
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.one:
    get:
      operationId: domain-one
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters:
      - in: query
        name: domainId
        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'
      summary: Domain one
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.delete:
    post:
      operationId: domain-delete
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domainId:
                  type: string
                  minLength: 1
              required:
              - domainId
      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'
      summary: Domain delete
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
  /domain.validateDomain:
    post:
      operationId: domain-validateDomain
      tags:
      - Domain
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                serverId:
                  type: string
              required:
              - domain
      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'
      summary: Domain validate domain
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
components:
  schemas:
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
            - message
            additionalProperties: false
      required:
      - message
      - code
      additionalProperties: false
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication. Generate an API key from your Dokploy dashboard under Settings > API Keys.
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication. Use YOUR-GENERATED-API-KEY
      x-default: your-key
externalDocs:
  description: Full documentation
  url: https://docs.dokploy.com
x-refined-from:
- dokploy-openapi.json
- dokploy-openapi.yml