{ "openapi": "3.0.3", "info": { "title": "Dokploy API", "description": "Endpoints for dokploy", "version": "v0.7.3" }, "servers": [ { "url": "http://localhost:3000/api" } ], "paths": { "/admin.one": { "get": { "operationId": "admin-one", "tags": ["admin"], "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.createUserInvitation": { "post": { "operationId": "admin-createUserInvitation", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": ["email"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.removeUser": { "post": { "operationId": "admin-removeUser", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "authId": { "type": "string", "minLength": 1 } }, "required": ["authId"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.getUserByToken": { "get": { "operationId": "admin-getUserByToken", "tags": ["admin"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.assignPermissions": { "post": { "operationId": "admin-assignPermissions", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1 }, "canCreateProjects": { "type": "boolean" }, "canCreateServices": { "type": "boolean" }, "canDeleteProjects": { "type": "boolean" }, "canDeleteServices": { "type": "boolean" }, "accesedProjects": { "type": "array", "items": { "type": "string" } }, "accesedServices": { "type": "array", "items": { "type": "string" } }, "canAccessToTraefikFiles": { "type": "boolean" }, "canAccessToDocker": { "type": "boolean" }, "canAccessToAPI": { "type": "boolean" }, "canAccessToSSHKeys": { "type": "boolean" }, "canAccessToGitProviders": { "type": "boolean" } }, "required": [ "userId", "canCreateProjects", "canCreateServices", "canDeleteProjects", "canDeleteServices", "accesedProjects", "accesedServices", "canAccessToTraefikFiles", "canAccessToDocker", "canAccessToAPI", "canAccessToSSHKeys", "canAccessToGitProviders" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainers": { "get": { "operationId": "docker-getContainers", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getConfig": { "get": { "operationId": "docker-getConfig", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainersByAppNameMatch": { "get": { "operationId": "docker-getContainersByAppNameMatch", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "appType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": ["stack"] }, { "type": "string", "enum": ["docker-compose"] } ] } }, { "name": "appName", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainersByAppLabel": { "get": { "operationId": "docker-getContainersByAppLabel", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "appName", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.createAdmin": { "post": { "operationId": "auth-createAdmin", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } }, "required": ["email", "password"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.createUser": { "post": { "operationId": "auth-createUser", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "minLength": 8 }, "id": { "type": "string" }, "token": { "type": "string", "minLength": 1 } }, "required": ["password", "id", "token"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.login": { "post": { "operationId": "auth-login", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 }Lines 1–500 of 11721. Load more
{ "openapi": "3.0.3", "info": { "title": "Dokploy API", "description": "Endpoints for dokploy", "version": "v0.7.3" }, "servers": [ { "url": "http://localhost:3000/api" } ], "paths": { "/admin.one": { "get": { "operationId": "admin-one", "tags": ["admin"], "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.createUserInvitation": { "post": { "operationId": "admin-createUserInvitation", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": ["email"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.removeUser": { "post": { "operationId": "admin-removeUser", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "authId": { "type": "string", "minLength": 1 } }, "required": ["authId"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.getUserByToken": { "get": { "operationId": "admin-getUserByToken", "tags": ["admin"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/admin.assignPermissions": { "post": { "operationId": "admin-assignPermissions", "tags": ["admin"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1 }, "canCreateProjects": { "type": "boolean" }, "canCreateServices": { "type": "boolean" }, "canDeleteProjects": { "type": "boolean" }, "canDeleteServices": { "type": "boolean" }, "accesedProjects": { "type": "array", "items": { "type": "string" } }, "accesedServices": { "type": "array", "items": { "type": "string" } }, "canAccessToTraefikFiles": { "type": "boolean" }, "canAccessToDocker": { "type": "boolean" }, "canAccessToAPI": { "type": "boolean" }, "canAccessToSSHKeys": { "type": "boolean" }, "canAccessToGitProviders": { "type": "boolean" } }, "required": [ "userId", "canCreateProjects", "canCreateServices", "canDeleteProjects", "canDeleteServices", "accesedProjects", "accesedServices", "canAccessToTraefikFiles", "canAccessToDocker", "canAccessToAPI", "canAccessToSSHKeys", "canAccessToGitProviders" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainers": { "get": { "operationId": "docker-getContainers", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getConfig": { "get": { "operationId": "docker-getConfig", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainersByAppNameMatch": { "get": { "operationId": "docker-getContainersByAppNameMatch", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "appType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": ["stack"] }, { "type": "string", "enum": ["docker-compose"] } ] } }, { "name": "appName", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/docker.getContainersByAppLabel": { "get": { "operationId": "docker-getContainersByAppLabel", "tags": ["docker"], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "appName", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.createAdmin": { "post": { "operationId": "auth-createAdmin", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } }, "required": ["email", "password"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.createUser": { "post": { "operationId": "auth-createUser", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "minLength": 8 }, "id": { "type": "string" }, "token": { "type": "string", "minLength": 1 } }, "required": ["password", "id", "token"], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } }, "default": { "$ref": "#/components/responses/error" } } } }, "/auth.login": { "post": { "operationId": "auth-login", "tags": ["auth"], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 }