Dokploy

Dokploy Admin API

The admin API from Dokploy — 1 operation(s) for admin.

Documentation GitHub OpenAPI

Operations 1

POST /admin.setupMonitoring Admin setup monitoring #

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-admin-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

openapi: 3.2.0
info:
  title: Dokploy Admin 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 admin 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: Admin
paths:
  /admin.setupMonitoring:
    post:
      operationId: admin-setupMonitoring
      tags:
      - Admin
      security:
      - x-api-key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                metricsConfig:
                  type: object
                  properties:
                    server:
                      type: object
                      properties:
                        refreshRate:
                          type: number
                          minimum: 2
                        port:
                          type: number
                          minimum: 1
                        token:
                          type: string
                        urlCallback:
                          type: string
                          format: uri
                        retentionDays:
                          type: number
                          minimum: 1
                        cronJob:
                          type: string
                          minLength: 1
                        thresholds:
                          type: object
                          properties:
                            cpu:
                              type: number
                              minimum: 0
                            memory:
                              type: number
                              minimum: 0
                          required:
                          - cpu
                          - memory
                      required:
                      - refreshRate
                      - port
                      - token
                      - urlCallback
                      - retentionDays
                      - cronJob
                      - thresholds
                    containers:
                      type: object
                      properties:
                        refreshRate:
                          type: number
                          minimum: 2
                        services:
                          type: object
                          properties:
                            include:
                              type: array
                              items:
                                type: string
                            exclude:
                              type: array
                              items:
                                type: string
                      required:
                      - refreshRate
                      - services
                  required:
                  - server
                  - containers
              required:
              - metricsConfig
      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: Admin setup monitoring
      x-summary-source: derived
    servers:
    - url: https://your-dokploy-instance.com/api
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.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.
    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