48976 lines · 1.3 MB · JSON
RawDownload
{  "openapi": "3.1.0",  "info": {    "title": "Dokploy 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"    }  ],  "tags": [    {      "name": "admin"    },    {      "name": "docker"    },    {      "name": "compose"    },    {      "name": "registry"    },    {      "name": "cluster"    },    {      "name": "user"    },    {      "name": "domain"    },    {      "name": "destination"    },    {      "name": "backup"    },    {      "name": "deployment"    },    {      "name": "mounts"    },    {      "name": "certificates"    },    {      "name": "settings"    },    {      "name": "security"    },    {      "name": "redirects"    },    {      "name": "port"    },    {      "name": "project"    },    {      "name": "application"    },    {      "name": "mysql"    },    {      "name": "postgres"    },    {      "name": "redis"    },    {      "name": "mongo"    },    {      "name": "mariadb"    },    {      "name": "sshRouter"    },    {      "name": "gitProvider"    },    {      "name": "bitbucket"    },    {      "name": "github"    },    {      "name": "gitlab"    },    {      "name": "gitea"    },    {      "name": "server"    },    {      "name": "swarm"    },    {      "name": "ai"    },    {      "name": "organization"    },    {      "name": "schedule"    },    {      "name": "rollback"    },    {      "name": "volumeBackups"    },    {      "name": "environment"    }  ],  "externalDocs": {    "description": "Full documentation",    "url": "https://docs.dokploy.com"  },  "paths": {    "/admin.setupMonitoring": {      "post": {        "operationId": "admin-setupMonitoring",        "tags": [          "admin"        ],        "security": [          {            "Authorization": []          }        ],        "parameters": [],        "requestBody": {          "required": true,          "content": {            "application/json": {              "schema": {                "type": "object",                "properties": {                  "metricsConfig": {                    "type": "object",                    "properties": {                      "server": {                        "type": "object",                        "properties": {                          "refreshRate": {                            "type": "number"                          },                          "port": {                            "type": "number"                          },                          "token": {                            "type": "string"                          },                          "urlCallback": {                            "type": "string"                          },                          "retentionDays": {                            "type": "number"                          },                          "cronJob": {                            "type": "string"                          },                          "thresholds": {                            "type": "object",                            "properties": {                              "cpu": {                                "type": "number"                              },                              "memory": {                                "type": "number"                              }                            },                            "required": [                              "cpu",                              "memory"                            ]                          }                        },                        "required": [                          "refreshRate",                          "port",                          "token",                          "urlCallback",                          "retentionDays",                          "cronJob",                          "thresholds"                        ]                      },                      "containers": {                        "type": "object",                        "properties": {                          "refreshRate": {                            "type": "number"                          },                          "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"                }              }            }          }        }      }    },    "/docker.getContainers": {      "get": {        "operationId": "docker-getContainers",        "tags": [          "docker"        ],        "security": [          {            "Authorization": []          }        ],        "parameters": [          {            "in": "query",            "name": "serverId",            "schema": {              "type": "string"            }          }        ],        "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"                }              }            }          }        }      }    },    "/docker.restartContainer": {      "post": {        "operationId": "docker-restartContainer",        "tags": [          "docker"        ],        "security": [          {            "Authorization": []          }        ],        "parameters": [],        "requestBody": {          "required": true,          "content": {            "application/json": {              "schema": {                "type": "object",                "properties": {                  "containerId": {                    "type": "string"                  }                },                "required": [                  "containerId"                ]              }            }          }        },        "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"                }              }            }          }        }      }    },    "/docker.getConfig": {      "get": {        "operationId": "docker-getConfig",        "tags": [          "docker"        ],        "security": [          {            "Authorization": []          }        ],        "parameters": [          {            "in": "query",            "name": "containerId",            "schema": {              "type": "string"            },            "required": true          },          {            "in": "query",

Lines 1–500 of 48976.