Dokploy

Dokploy whitelabeling API

The whitelabeling API from Dokploy — 4 operation(s) for whitelabeling.

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-whitelabeling-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-whitelabeling-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Dokploy admin whitelabeling 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: whitelabeling
paths:
  /whitelabeling.get:
    get:
      operationId: whitelabeling-get
      tags:
      - whitelabeling
      security:
      - Authorization: []
      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'
  /whitelabeling.update:
    post:
      operationId: whitelabeling-update
      tags:
      - whitelabeling
      security:
      - Authorization: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                whitelabelingConfig:
                  type: object
                  properties:
                    appName:
                      anyOf:
                      - type: string
                      - type: 'null'
                    appDescription:
                      anyOf:
                      - type: string
                      - type: 'null'
                    logoUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                    faviconUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                    customCss:
                      anyOf:
                      - type: string
                      - type: 'null'
                    loginLogoUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                    supportUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                    docsUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                    errorPageTitle:
                      anyOf:
                      - type: string
                      - type: 'null'
                    errorPageDescription:
                      anyOf:
                      - type: string
                      - type: 'null'
                    metaTitle:
                      anyOf:
                      - type: string
                      - type: 'null'
                    footerText:
                      anyOf:
                      - type: string
                      - type: 'null'
                  required:
                  - appName
                  - appDescription
                  - logoUrl
                  - faviconUrl
                  - customCss
                  - loginLogoUrl
                  - supportUrl
                  - docsUrl
                  - errorPageTitle
                  - errorPageDescription
                  - metaTitle
                  - footerText
              required:
              - whitelabelingConfig
      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'
  /whitelabeling.reset:
    post:
      operationId: whitelabeling-reset
      tags:
      - whitelabeling
      security:
      - Authorization: []
      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'
  /whitelabeling.getPublic:
    get:
      operationId: whitelabeling-getPublic
      tags:
      - whitelabeling
      security:
      - Authorization: []
      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'
components:
  schemas:
    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.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.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: []
    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: []
  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.
externalDocs:
  description: Full documentation
  url: https://docs.dokploy.com