{ "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", "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" } } } } } } }, "/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": {Lines 1–500 of 60412. Load more
{ "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", "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" } } } } } } }, "/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": {