{ "components": { "responses": { "error": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "issues": { "items": { "additionalProperties": false, "properties": { "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message", "code" ], "type": "object" } } }, "description": "Error response" } }, "securitySchemes": { "ApiKeyAuth": { "description": "Provide your API key via the x-api-key header.", "in": "header", "name": "x-api-key", "type": "apiKey" }, "apiKey": { "description": "API key authentication", "in": "header", "name": "x-api-key", "type": "apiKey" } } }, "externalDocs": { "url": "http://localhost:3000/api/settings.getOpenApiDocument" }, "info": { "description": "Endpoints for dokploy", "title": "Dokploy API", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/admin.setupMonitoring": { "post": { "operationId": "admin-setupMonitoring", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "metricsConfig": { "additionalProperties": false, "properties": { "containers": { "additionalProperties": false, "properties": { "refreshRate": { "minimum": 2, "type": "number" }, "services": { "additionalProperties": false, "properties": { "exclude": { "items": { "type": "string" }, "type": "array" }, "include": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "refreshRate", "services" ], "type": "object" }, "server": { "additionalProperties": false, "properties": { "cronJob": { "minLength": 1, "type": "string" }, "port": { "minimum": 1, "type": "number" }, "refreshRate": { "minimum": 2, "type": "number" }, "retentionDays": { "minimum": 1, "type": "number" }, "thresholds": { "additionalProperties": false, "properties": { "cpu": { "minimum": 0, "type": "number" }, "memory": { "minimum": 0, "type": "number" } }, "required": [ "cpu", "memory" ], "type": "object" }, "token": { "type": "string" }, "urlCallback": { "format": "uri", "type": "string" } }, "required": [ "refreshRate", "port", "token", "urlCallback", "retentionDays", "cronJob", "thresholds" ], "type": "object" } }, "required": [ "server", "containers" ], "type": "object" } }, "required": [ "metricsConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "admin" ] } }, "/ai.create": { "post": { "operationId": "ai-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "apiKey": { "type": "string" }, "apiUrl": { "format": "uri", "type": "string" }, "isEnabled": { "type": "boolean" }, "model": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "name", "apiUrl", "apiKey", "model", "isEnabled" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.delete": { "post": { "operationId": "ai-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "aiId": { "type": "string" } }, "required": [ "aiId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.deploy": { "post": { "operationId": "ai-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "configFiles": { "items": { "additionalProperties": false, "properties": { "content": { "minLength": 1, "type": "string" }, "filePath": { "minLength": 1, "type": "string" } }, "required": [ "filePath", "content" ], "type": "object" }, "type": "array" }, "description": { "type": "string" }, "dockerCompose": { "minLength": 1, "type": "string" }, "domains": { "items": { "additionalProperties": false, "properties": { "host": { "minLength": 1, "type": "string" }, "port": { "minimum": 1, "type": "number" }, "serviceName": { "minLength": 1, "type": "string" } }, "required": [ "host", "port", "serviceName" ], "type": "object" }, "type": "array" }, "envVariables": { "type": "string" }, "environmentId": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "type": "string" } }, "required": [ "environmentId", "id", "dockerCompose", "envVariables", "name", "description" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.get": { "get": { "operationId": "ai-get", "parameters": [ { "in": "query", "name": "aiId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.getAll": { "get": { "operationId": "ai-getAll", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.getModels": { "get": { "operationId": "ai-getModels", "parameters": [ { "in": "query", "name": "apiUrl", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "apiKey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.one": { "get": { "operationId": "ai-one", "parameters": [ { "in": "query", "name": "aiId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.suggest": { "post": { "operationId": "ai-suggest", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "aiId": { "type": "string" }, "input": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "aiId", "input" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/ai.update": { "post": { "operationId": "ai-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "aiId": { "minLength": 1, "type": "string" }, "apiKey": { "type": "string" }, "apiUrl": { "format": "uri", "type": "string" }, "createdAt": { "type": "string" }, "isEnabled": { "type": "boolean" }, "model": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "aiId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "ai" ] } }, "/application.cancelDeployment": { "post": { "operationId": "application-cancelDeployment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.cleanQueues": { "post": { "operationId": "application-cleanQueues", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.create": { "post": { "operationId": "application-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.delete": { "post": { "operationId": "application-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucket": { "additionalProperties": false, "nullable": true, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "deployments": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "domains": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "gitea": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt" ], "type": "object" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "github": { "additionalProperties": false, "nullable": true, "properties": { "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId" ], "type": "object" }, "githubId": { "nullable": true, "type": "string" }, "gitlab": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId" ], "type": "object" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ports": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" }, "type": "array" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewDeployments": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" }, "type": "array" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "redirects": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "refreshToken": { "nullable": true, "type": "string" }, "registry": { "additionalProperties": false, "nullable": true, "properties": { "createdAt": { "type": "string" }, "imagePrefix": { "nullable": true, "type": "string" }, "organizationId": { "type": "string" }, "password": { "type": "string" }, "registryId": { "type": "string" }, "registryName": { "type": "string" }, "registryType": { "enum": [ "selfHosted", "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string" } }, "required": [ "registryId", "registryName", "imagePrefix", "username", "password", "registryUrl", "createdAt", "registryType", "organizationId" ], "type": "object" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "security": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId", "environment", "domains", "deployments", "mounts", "redirects", "security", "ports", "registry", "github", "gitlab", "bitbucket", "gitea", "server", "previewDeployments" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.deploy": { "post": { "operationId": "application-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.disconnectGitProvider": { "post": { "operationId": "application-disconnectGitProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.markRunning": { "post": { "operationId": "application-markRunning", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.move": { "post": { "operationId": "application-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "applicationId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.one": { "get": { "operationId": "application-one", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucket": { "additionalProperties": false, "nullable": true, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "deployments": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "domains": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "gitea": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt" ], "type": "object" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "github": { "additionalProperties": false, "nullable": true, "properties": { "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId" ], "type": "object" }, "githubId": { "nullable": true, "type": "string" }, "gitlab": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId" ], "type": "object" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "hasGitProviderAccess": { "type": "boolean" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ports": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" }, "type": "array" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewDeployments": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" }, "type": "array" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "redirects": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "refreshToken": { "nullable": true, "type": "string" }, "registry": { "additionalProperties": false, "nullable": true, "properties": { "createdAt": { "type": "string" }, "imagePrefix": { "nullable": true, "type": "string" }, "organizationId": { "type": "string" }, "password": { "type": "string" }, "registryId": { "type": "string" }, "registryName": { "type": "string" }, "registryType": { "enum": [ "selfHosted", "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string" } }, "required": [ "registryId", "registryName", "imagePrefix", "username", "password", "registryUrl", "createdAt", "registryType", "organizationId" ], "type": "object" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "security": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "unauthorizedProvider": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId", "environment", "domains", "deployments", "mounts", "redirects", "security", "ports", "registry", "github", "gitlab", "bitbucket", "gitea", "server", "previewDeployments", "hasGitProviderAccess", "unauthorizedProvider" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.readAppMonitoring": { "get": { "operationId": "application-readAppMonitoring", "parameters": [ { "in": "query", "name": "appName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block": { "items": { "additionalProperties": false, "properties": { "time": { "type": "string" }, "value": { "additionalProperties": false, "properties": { "readMb": { "type": "string" }, "writeMb": { "type": "string" } }, "required": [ "readMb", "writeMb" ], "type": "object" } }, "required": [ "value", "time" ], "type": "object" }, "type": "array" }, "cpu": { "items": { "additionalProperties": false, "properties": { "time": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value", "time" ], "type": "object" }, "type": "array" }, "disk": { "items": { "additionalProperties": false, "properties": { "time": { "type": "string" }, "value": {} }, "required": [ "time" ], "type": "object" }, "type": "array" }, "memory": { "items": { "additionalProperties": false, "properties": { "time": { "type": "string" }, "value": { "additionalProperties": false, "properties": { "total": { "type": "string" }, "used": { "type": "string" } }, "required": [ "used", "total" ], "type": "object" } }, "required": [ "value", "time" ], "type": "object" }, "type": "array" }, "network": { "items": { "additionalProperties": false, "properties": { "time": { "type": "string" }, "value": { "additionalProperties": false, "properties": { "inputMb": { "type": "string" }, "outputMb": { "type": "string" } }, "required": [ "inputMb", "outputMb" ], "type": "object" } }, "required": [ "value", "time" ], "type": "object" }, "type": "array" } }, "required": [ "cpu", "memory", "disk", "network", "block" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.readTraefikConfig": { "get": { "operationId": "application-readTraefikConfig", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.redeploy": { "post": { "operationId": "application-redeploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.refreshToken": { "post": { "operationId": "application-refreshToken", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.reload": { "post": { "operationId": "application-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" } }, "required": [ "appName", "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveBitbucketProvider": { "post": { "operationId": "application-saveBitbucketProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "bitbucketBranch", "bitbucketBuildPath", "bitbucketOwner", "bitbucketRepository", "bitbucketId", "applicationId", "enableSubmodules" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveBuildType": { "post": { "operationId": "application-saveBuildType", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "herokuVersion": { "nullable": true, "type": "string" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" } }, "required": [ "applicationId", "buildType", "dockerContextPath", "dockerBuildStage" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveDockerProvider": { "post": { "operationId": "application-saveDockerProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "username": { "nullable": true, "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveEnvironment": { "post": { "operationId": "application-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "env": { "nullable": true, "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveGitProdiver": { "post": { "operationId": "application-saveGitProdiver", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "enableSubmodules" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveGiteaProvider": { "post": { "operationId": "application-saveGiteaProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "enableSubmodules": { "type": "boolean" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "giteaBranch", "giteaBuildPath", "giteaOwner", "giteaRepository", "giteaId", "enableSubmodules" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveGithubProvider": { "post": { "operationId": "application-saveGithubProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "githubId": { "nullable": true, "type": "string" }, "owner": { "nullable": true, "type": "string" }, "repository": { "nullable": true, "type": "string" }, "triggerType": { "default": "push", "enum": [ "push", "tag" ], "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "owner", "githubId", "enableSubmodules" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.saveGitlabProvider": { "post": { "operationId": "application-saveGitlabProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "enableSubmodules": { "type": "boolean" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "gitlabBranch", "gitlabBuildPath", "gitlabOwner", "gitlabRepository", "gitlabId", "gitlabProjectId", "gitlabPathNamespace", "enableSubmodules" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.start": { "post": { "operationId": "application-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucket": { "additionalProperties": false, "nullable": true, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "deployments": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "domains": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "gitea": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt" ], "type": "object" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "github": { "additionalProperties": false, "nullable": true, "properties": { "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId" ], "type": "object" }, "githubId": { "nullable": true, "type": "string" }, "gitlab": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId" ], "type": "object" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ports": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" }, "type": "array" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewDeployments": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" }, "type": "array" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "redirects": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "refreshToken": { "nullable": true, "type": "string" }, "registry": { "additionalProperties": false, "nullable": true, "properties": { "createdAt": { "type": "string" }, "imagePrefix": { "nullable": true, "type": "string" }, "organizationId": { "type": "string" }, "password": { "type": "string" }, "registryId": { "type": "string" }, "registryName": { "type": "string" }, "registryType": { "enum": [ "selfHosted", "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string" } }, "required": [ "registryId", "registryName", "imagePrefix", "username", "password", "registryUrl", "createdAt", "registryType", "organizationId" ], "type": "object" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "security": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId", "environment", "domains", "deployments", "mounts", "redirects", "security", "ports", "registry", "github", "gitlab", "bitbucket", "gitea", "server", "previewDeployments" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.stop": { "post": { "operationId": "application-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucket": { "additionalProperties": false, "nullable": true, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "deployments": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "domains": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "gitea": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt" ], "type": "object" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "github": { "additionalProperties": false, "nullable": true, "properties": { "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId" ], "type": "object" }, "githubId": { "nullable": true, "type": "string" }, "gitlab": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId" ], "type": "object" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ports": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" }, "type": "array" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewDeployments": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" }, "type": "array" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "redirects": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "refreshToken": { "nullable": true, "type": "string" }, "registry": { "additionalProperties": false, "nullable": true, "properties": { "createdAt": { "type": "string" }, "imagePrefix": { "nullable": true, "type": "string" }, "organizationId": { "type": "string" }, "password": { "type": "string" }, "registryId": { "type": "string" }, "registryName": { "type": "string" }, "registryType": { "enum": [ "selfHosted", "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string" } }, "required": [ "registryId", "registryName", "imagePrefix", "username", "password", "registryUrl", "createdAt", "registryType", "organizationId" ], "type": "object" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "security": { "items": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" }, "type": "array" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "name", "environmentId", "environment", "domains", "deployments", "mounts", "redirects", "security", "ports", "registry", "github", "gitlab", "bitbucket", "gitea", "server", "previewDeployments" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.update": { "post": { "operationId": "application-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "minLength": 1, "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "sourceType": { "enum": [ "github", "docker", "git", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/application.updateTraefikConfig": { "post": { "operationId": "application-updateTraefikConfig", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "traefikConfig": { "type": "string" } }, "required": [ "applicationId", "traefikConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "application" ] } }, "/backup.create": { "post": { "operationId": "backup-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "minLength": 1, "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "nullable": true }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "minLength": 1, "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "schedule", "prefix", "destinationId", "database", "databaseType" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.listBackupFiles": { "get": { "operationId": "backup-listBackupFiles", "parameters": [ { "in": "query", "name": "destinationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "search", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupCompose": { "post": { "operationId": "backup-manualBackupCompose", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupMariadb": { "post": { "operationId": "backup-manualBackupMariadb", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupMongo": { "post": { "operationId": "backup-manualBackupMongo", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupMySql": { "post": { "operationId": "backup-manualBackupMySql", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupPostgres": { "post": { "operationId": "backup-manualBackupPostgres", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.manualBackupWebServer": { "post": { "operationId": "backup-manualBackupWebServer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.one": { "get": { "operationId": "backup-one", "parameters": [ { "in": "query", "name": "backupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.remove": { "post": { "operationId": "backup-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" } }, "required": [ "backupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/backup.update": { "post": { "operationId": "backup-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backupId": { "type": "string" }, "database": { "minLength": 1, "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "metadata": { "nullable": true }, "prefix": { "minLength": 1, "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" } }, "required": [ "schedule", "prefix", "backupId", "destinationId", "database", "serviceName", "databaseType" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "backup" ] } }, "/bitbucket.bitbucketProviders": { "get": { "operationId": "bitbucket-bitbucketProviders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "bitbucketId": { "type": "string" }, "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" } }, "required": [ "bitbucketId", "gitProvider" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.create": { "post": { "operationId": "bitbucket-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appPassword": { "type": "string" }, "authId": { "minLength": 1, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "type": "string" }, "bitbucketWorkspaceName": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "authId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.getBitbucketBranches": { "get": { "operationId": "bitbucket-getBitbucketBranches", "parameters": [ { "in": "query", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "repo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "bitbucketId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.getBitbucketRepositories": { "get": { "operationId": "bitbucket-getBitbucketRepositories", "parameters": [ { "in": "query", "name": "bitbucketId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.one": { "get": { "operationId": "bitbucket-one", "parameters": [ { "in": "query", "name": "bitbucketId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId", "gitProvider" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.testConnection": { "post": { "operationId": "bitbucket-testConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bitbucketId": { "minLength": 1, "type": "string" }, "bitbucketUsername": { "type": "string" }, "workspaceName": { "type": "string" } }, "required": [ "bitbucketId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/bitbucket.update": { "post": { "operationId": "bitbucket-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "minLength": 1, "type": "string" }, "bitbucketUsername": { "type": "string" }, "bitbucketWorkspaceName": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" } }, "required": [ "bitbucketId", "gitProviderId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "bitbucket" ] } }, "/certificates.all": { "get": { "operationId": "certificates-all", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "autoRenew": { "nullable": true, "type": "boolean" }, "certificateData": { "type": "string" }, "certificateId": { "type": "string" }, "certificatePath": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "certificateId", "name", "certificateData", "privateKey", "certificatePath", "autoRenew", "organizationId", "serverId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "certificates" ] } }, "/certificates.create": { "post": { "operationId": "certificates-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "autoRenew": { "nullable": true, "type": "boolean" }, "certificateData": { "minLength": 1, "type": "string" }, "certificateId": { "type": "string" }, "certificatePath": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "certificateData", "privateKey", "organizationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "autoRenew": { "nullable": true, "type": "boolean" }, "certificateData": { "type": "string" }, "certificateId": { "type": "string" }, "certificatePath": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "certificateId", "name", "certificateData", "privateKey", "certificatePath", "autoRenew", "organizationId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "certificates" ] } }, "/certificates.one": { "get": { "operationId": "certificates-one", "parameters": [ { "in": "query", "name": "certificateId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "autoRenew": { "nullable": true, "type": "boolean" }, "certificateData": { "type": "string" }, "certificateId": { "type": "string" }, "certificatePath": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "certificateId", "name", "certificateData", "privateKey", "certificatePath", "autoRenew", "organizationId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "certificates" ] } }, "/certificates.remove": { "post": { "operationId": "certificates-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "certificateId": { "minLength": 1, "type": "string" } }, "required": [ "certificateId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "autoRenew": { "nullable": true, "type": "boolean" }, "certificateData": { "type": "string" }, "certificateId": { "type": "string" }, "certificatePath": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "certificateId", "name", "certificateData", "privateKey", "certificatePath", "autoRenew", "organizationId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "certificates" ] } }, "/cluster.addManager": { "get": { "operationId": "cluster-addManager", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "cluster" ] } }, "/cluster.addWorker": { "get": { "operationId": "cluster-addWorker", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "cluster" ] } }, "/cluster.getNodes": { "get": { "operationId": "cluster-getNodes", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "cluster" ] } }, "/cluster.removeWorker": { "post": { "operationId": "cluster-removeWorker", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "nodeId": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "nodeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "cluster" ] } }, "/compose.cancelDeployment": { "post": { "operationId": "compose-cancelDeployment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.cleanQueues": { "post": { "operationId": "compose-cleanQueues", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.create": { "post": { "operationId": "compose-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "composeFile": { "type": "string" }, "composeType": { "enum": [ "docker-compose", "stack" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.delete": { "post": { "operationId": "compose-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" }, "deleteVolumes": { "type": "boolean" } }, "required": [ "composeId", "deleteVolumes" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.deploy": { "post": { "operationId": "compose-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.deployTemplate": { "post": { "operationId": "compose-deployTemplate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "baseUrl": { "type": "string" }, "environmentId": { "type": "string" }, "id": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "environmentId", "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.disconnectGitProvider": { "post": { "operationId": "compose-disconnectGitProvider", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.fetchSourceType": { "post": { "operationId": "compose-fetchSourceType", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.getConvertedCompose": { "get": { "operationId": "compose-getConvertedCompose", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.getDefaultCommand": { "get": { "operationId": "compose-getDefaultCommand", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.getTags": { "get": { "operationId": "compose-getTags", "parameters": [ { "in": "query", "name": "baseUrl", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.import": { "post": { "operationId": "compose-import", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "base64": { "type": "string" }, "composeId": { "minLength": 1, "type": "string" } }, "required": [ "base64", "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.isolatedDeployment": { "post": { "operationId": "compose-isolatedDeployment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" }, "suffix": { "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.loadMountsByService": { "get": { "operationId": "compose-loadMountsByService", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "serviceName", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.loadServices": { "get": { "operationId": "compose-loadServices", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "not": {} }, { "enum": [ "fetch", "cache" ], "type": "string" } ], "default": "cache" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.move": { "post": { "operationId": "compose-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "composeId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.one": { "get": { "operationId": "compose-one", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.processTemplate": { "post": { "operationId": "compose-processTemplate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "base64": { "type": "string" }, "composeId": { "minLength": 1, "type": "string" } }, "required": [ "base64", "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.randomizeCompose": { "post": { "operationId": "compose-randomizeCompose", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" }, "suffix": { "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.redeploy": { "post": { "operationId": "compose-redeploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.refreshToken": { "post": { "operationId": "compose-refreshToken", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.start": { "post": { "operationId": "compose-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.stop": { "post": { "operationId": "compose-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "composeId": { "minLength": 1, "type": "string" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.templates": { "get": { "operationId": "compose-templates", "parameters": [ { "in": "query", "name": "baseUrl", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/compose.update": { "post": { "operationId": "compose-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "command": { "type": "string" }, "composeFile": { "type": "string" }, "composeId": { "type": "string" }, "composePath": { "minLength": 1, "type": "string" }, "composeStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "composeType": { "enum": [ "docker-compose", "stack" ], "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "isolatedDeployment": { "type": "boolean" }, "isolatedDeploymentsVolume": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "owner": { "nullable": true, "type": "string" }, "randomize": { "type": "boolean" }, "refreshToken": { "nullable": true, "type": "string" }, "repository": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "git", "github", "gitlab", "bitbucket", "gitea", "raw" ], "type": "string" }, "suffix": { "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "composeId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "compose" ] } }, "/deployment.all": { "get": { "operationId": "deployment-all", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "deployment" ] } }, "/deployment.allByCompose": { "get": { "operationId": "deployment-allByCompose", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "deployment" ] } }, "/deployment.allByServer": { "get": { "operationId": "deployment-allByServer", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "deployment" ] } }, "/deployment.allByType": { "get": { "operationId": "deployment-allByType", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "type", "required": true, "schema": { "enum": [ "application", "compose", "server", "schedule", "previewDeployment", "backup", "volumeBackup" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "backupId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "deploymentId": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "finishedAt": { "nullable": true, "type": "string" }, "isPreviewDeployment": { "nullable": true, "type": "boolean" }, "logPath": { "type": "string" }, "pid": { "nullable": true, "type": "string" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "rollbackId": { "nullable": true, "type": "string" }, "scheduleId": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "startedAt": { "nullable": true, "type": "string" }, "status": { "enum": [ "running", "done", "error" ], "nullable": true, "type": "string" }, "title": { "type": "string" }, "volumeBackupId": { "nullable": true, "type": "string" } }, "required": [ "deploymentId", "title", "description", "status", "logPath", "pid", "applicationId", "composeId", "serverId", "isPreviewDeployment", "previewDeploymentId", "createdAt", "startedAt", "finishedAt", "errorMessage", "scheduleId", "backupId", "rollbackId", "volumeBackupId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "deployment" ] } }, "/deployment.killProcess": { "post": { "operationId": "deployment-killProcess", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "deploymentId": { "minLength": 1, "type": "string" } }, "required": [ "deploymentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "deployment" ] } }, "/destination.all": { "get": { "operationId": "destination-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/destination.create": { "post": { "operationId": "destination-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessKey": { "type": "string" }, "bucket": { "type": "string" }, "endpoint": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "provider": { "nullable": true, "type": "string" }, "region": { "type": "string" }, "secretAccessKey": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "name", "provider", "accessKey", "bucket", "region", "endpoint", "secretAccessKey" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/destination.one": { "get": { "operationId": "destination-one", "parameters": [ { "in": "query", "name": "destinationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/destination.remove": { "post": { "operationId": "destination-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destinationId": { "type": "string" } }, "required": [ "destinationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/destination.testConnection": { "post": { "operationId": "destination-testConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessKey": { "type": "string" }, "bucket": { "type": "string" }, "endpoint": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "provider": { "nullable": true, "type": "string" }, "region": { "type": "string" }, "secretAccessKey": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "name", "provider", "accessKey", "bucket", "region", "endpoint", "secretAccessKey" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/destination.update": { "post": { "operationId": "destination-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessKey": { "type": "string" }, "bucket": { "type": "string" }, "destinationId": { "type": "string" }, "endpoint": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "provider": { "nullable": true, "type": "string" }, "region": { "type": "string" }, "secretAccessKey": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "name", "accessKey", "bucket", "region", "endpoint", "secretAccessKey", "destinationId", "provider" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "destination" ] } }, "/docker.getConfig": { "get": { "operationId": "docker-getConfig", "parameters": [ { "in": "query", "name": "containerId", "required": true, "schema": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.getContainers": { "get": { "operationId": "docker-getContainers", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.getContainersByAppLabel": { "get": { "operationId": "docker-getContainersByAppLabel", "parameters": [ { "in": "query", "name": "appName", "required": true, "schema": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": true, "schema": { "enum": [ "standalone", "swarm" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.getContainersByAppNameMatch": { "get": { "operationId": "docker-getContainersByAppNameMatch", "parameters": [ { "in": "query", "name": "appType", "required": false, "schema": { "anyOf": [ { "enum": [ "stack" ], "type": "string" }, { "enum": [ "docker-compose" ], "type": "string" } ] } }, { "in": "query", "name": "appName", "required": true, "schema": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.getServiceContainersByAppName": { "get": { "operationId": "docker-getServiceContainersByAppName", "parameters": [ { "in": "query", "name": "appName", "required": true, "schema": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.getStackContainersByAppName": { "get": { "operationId": "docker-getStackContainersByAppName", "parameters": [ { "in": "query", "name": "appName", "required": true, "schema": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/docker.restartContainer": { "post": { "operationId": "docker-restartContainer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "containerId": { "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "type": "string" } }, "required": [ "containerId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "docker" ] } }, "/domain.byApplicationId": { "get": { "operationId": "domain-byApplicationId", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.byComposeId": { "get": { "operationId": "domain-byComposeId", "parameters": [ { "in": "query", "name": "composeId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.canGenerateTraefikMeDomains": { "get": { "operationId": "domain-canGenerateTraefikMeDomains", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.create": { "post": { "operationId": "domain-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "minLength": 1, "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "minLength": 1, "nullable": true, "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" } }, "required": [ "host" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.delete": { "post": { "operationId": "domain-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "domainId": { "type": "string" } }, "required": [ "domainId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.generateDomain": { "post": { "operationId": "domain-generateDomain", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.one": { "get": { "operationId": "domain-one", "parameters": [ { "in": "query", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.update": { "post": { "operationId": "domain-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "minLength": 1, "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "minLength": 1, "nullable": true, "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "nullable": true, "type": "number" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" } }, "required": [ "host", "domainId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customCertResolver": { "nullable": true, "type": "string" }, "domainId": { "type": "string" }, "domainType": { "enum": [ "compose", "application", "preview" ], "nullable": true, "type": "string" }, "host": { "type": "string" }, "https": { "type": "boolean" }, "internalPath": { "nullable": true, "type": "string" }, "path": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "number" }, "previewDeploymentId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "stripPath": { "type": "boolean" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "domainId", "host", "https", "port", "path", "serviceName", "domainType", "uniqueConfigKey", "createdAt", "composeId", "customCertResolver", "applicationId", "previewDeploymentId", "certificateType", "internalPath", "stripPath" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/domain.validateDomain": { "post": { "operationId": "domain-validateDomain", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "domain": { "type": "string" }, "serverIp": { "type": "string" } }, "required": [ "domain" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "domain" ] } }, "/environment.byProjectId": { "get": { "operationId": "environment-byProjectId", "parameters": [ { "in": "query", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "applications": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "docker", "git", "github", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "name", "appName", "description", "env", "previewEnv", "watchPaths", "previewBuildArgs", "previewLabels", "previewWildcard", "previewPort", "previewHttps", "previewPath", "previewCertificateType", "previewCustomCertResolver", "previewLimit", "isPreviewDeploymentsActive", "previewRequireCollaboratorPermissions", "rollbackActive", "buildArgs", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "title", "enabled", "subtitle", "command", "refreshToken", "sourceType", "cleanCache", "repository", "owner", "branch", "buildPath", "triggerType", "autoDeploy", "gitlabProjectId", "gitlabRepository", "gitlabOwner", "gitlabBranch", "gitlabBuildPath", "gitlabPathNamespace", "giteaRepository", "giteaOwner", "giteaBranch", "giteaBuildPath", "bitbucketRepository", "bitbucketOwner", "bitbucketBranch", "bitbucketBuildPath", "username", "password", "dockerImage", "registryUrl", "customGitUrl", "customGitBranch", "customGitBuildPath", "customGitSSHKeyId", "enableSubmodules", "dockerfile", "dockerContextPath", "dockerBuildStage", "dropBuildPath", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "applicationStatus", "buildType", "railpackVersion", "herokuVersion", "publishDirectory", "isStaticSpa", "createdAt", "registryId", "environmentId", "githubId", "gitlabId", "giteaId", "bitbucketId", "serverId" ], "type": "object" }, "type": "array" }, "compose": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "command": { "type": "string" }, "composeFile": { "type": "string" }, "composeId": { "type": "string" }, "composePath": { "type": "string" }, "composeStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "composeType": { "enum": [ "docker-compose", "stack" ], "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "isolatedDeployment": { "type": "boolean" }, "isolatedDeploymentsVolume": { "type": "boolean" }, "name": { "type": "string" }, "owner": { "nullable": true, "type": "string" }, "randomize": { "type": "boolean" }, "refreshToken": { "nullable": true, "type": "string" }, "repository": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "git", "github", "gitlab", "bitbucket", "gitea", "raw" ], "type": "string" }, "suffix": { "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "composeId", "name", "appName", "description", "env", "composeFile", "refreshToken", "sourceType", "composeType", "repository", "owner", "branch", "autoDeploy", "gitlabProjectId", "gitlabRepository", "gitlabOwner", "gitlabBranch", "gitlabPathNamespace", "bitbucketRepository", "bitbucketOwner", "bitbucketBranch", "giteaRepository", "giteaOwner", "giteaBranch", "customGitUrl", "customGitBranch", "customGitSSHKeyId", "command", "enableSubmodules", "composePath", "suffix", "randomize", "isolatedDeployment", "isolatedDeploymentsVolume", "triggerType", "composeStatus", "environmentId", "createdAt", "watchPaths", "githubId", "gitlabId", "bitbucketId", "giteaId", "serverId" ], "type": "object" }, "type": "array" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "mariadb": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "mongo": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mongoId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets" ], "type": "object" }, "type": "array" }, "mysql": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "postgres": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" }, "redis": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId" ], "type": "object" }, "type": "array" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project", "applications", "mariadb", "mongo", "mysql", "postgres", "redis", "compose" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/environment.create": { "post": { "operationId": "environment-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "projectId": { "type": "string" } }, "required": [ "name", "projectId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/environment.duplicate": { "post": { "operationId": "environment-duplicate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "environmentId": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "environmentId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/environment.one": { "get": { "operationId": "environment-one", "parameters": [ { "in": "query", "name": "environmentId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applications": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketBuildPath": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "buildArgs": { "nullable": true, "type": "string" }, "buildPath": { "nullable": true, "type": "string" }, "buildType": { "enum": [ "dockerfile", "heroku_buildpacks", "paketo_buildpacks", "nixpacks", "static", "railpack" ], "type": "string" }, "cleanCache": { "nullable": true, "type": "boolean" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitBuildPath": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerBuildStage": { "nullable": true, "type": "string" }, "dockerContextPath": { "nullable": true, "type": "string" }, "dockerImage": { "nullable": true, "type": "string" }, "dockerfile": { "nullable": true, "type": "string" }, "dropBuildPath": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "enabled": { "nullable": true, "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaBuildPath": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabBuildPath": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "herokuVersion": { "nullable": true, "type": "string" }, "isPreviewDeploymentsActive": { "nullable": true, "type": "boolean" }, "isStaticSpa": { "nullable": true, "type": "boolean" }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "owner": { "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "previewBuildArgs": { "nullable": true, "type": "string" }, "previewCertificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "previewCustomCertResolver": { "nullable": true, "type": "string" }, "previewEnv": { "nullable": true, "type": "string" }, "previewHttps": { "type": "boolean" }, "previewLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "previewLimit": { "nullable": true, "type": "number" }, "previewPath": { "nullable": true, "type": "string" }, "previewPort": { "nullable": true, "type": "number" }, "previewRequireCollaboratorPermissions": { "nullable": true, "type": "boolean" }, "previewWildcard": { "nullable": true, "type": "string" }, "publishDirectory": { "nullable": true, "type": "string" }, "railpackVersion": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "registryId": { "nullable": true, "type": "string" }, "registryUrl": { "nullable": true, "type": "string" }, "replicas": { "type": "number" }, "repository": { "nullable": true, "type": "string" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackActive": { "nullable": true, "type": "boolean" }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "docker", "git", "github", "gitlab", "bitbucket", "gitea", "drop" ], "type": "string" }, "subtitle": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "username": { "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "applicationId", "name", "appName", "description", "env", "previewEnv", "watchPaths", "previewBuildArgs", "previewLabels", "previewWildcard", "previewPort", "previewHttps", "previewPath", "previewCertificateType", "previewCustomCertResolver", "previewLimit", "isPreviewDeploymentsActive", "previewRequireCollaboratorPermissions", "rollbackActive", "buildArgs", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "title", "enabled", "subtitle", "command", "refreshToken", "sourceType", "cleanCache", "repository", "owner", "branch", "buildPath", "triggerType", "autoDeploy", "gitlabProjectId", "gitlabRepository", "gitlabOwner", "gitlabBranch", "gitlabBuildPath", "gitlabPathNamespace", "giteaRepository", "giteaOwner", "giteaBranch", "giteaBuildPath", "bitbucketRepository", "bitbucketOwner", "bitbucketBranch", "bitbucketBuildPath", "username", "password", "dockerImage", "registryUrl", "customGitUrl", "customGitBranch", "customGitBuildPath", "customGitSSHKeyId", "enableSubmodules", "dockerfile", "dockerContextPath", "dockerBuildStage", "dropBuildPath", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "applicationStatus", "buildType", "railpackVersion", "herokuVersion", "publishDirectory", "isStaticSpa", "createdAt", "registryId", "environmentId", "githubId", "gitlabId", "giteaId", "bitbucketId", "serverId" ], "type": "object" }, "type": "array" }, "compose": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "autoDeploy": { "nullable": true, "type": "boolean" }, "bitbucketBranch": { "nullable": true, "type": "string" }, "bitbucketId": { "nullable": true, "type": "string" }, "bitbucketOwner": { "nullable": true, "type": "string" }, "bitbucketRepository": { "nullable": true, "type": "string" }, "branch": { "nullable": true, "type": "string" }, "command": { "type": "string" }, "composeFile": { "type": "string" }, "composeId": { "type": "string" }, "composePath": { "type": "string" }, "composeStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "composeType": { "enum": [ "docker-compose", "stack" ], "type": "string" }, "createdAt": { "type": "string" }, "customGitBranch": { "nullable": true, "type": "string" }, "customGitSSHKeyId": { "nullable": true, "type": "string" }, "customGitUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableSubmodules": { "type": "boolean" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "giteaBranch": { "nullable": true, "type": "string" }, "giteaId": { "nullable": true, "type": "string" }, "giteaOwner": { "nullable": true, "type": "string" }, "giteaRepository": { "nullable": true, "type": "string" }, "githubId": { "nullable": true, "type": "string" }, "gitlabBranch": { "nullable": true, "type": "string" }, "gitlabId": { "nullable": true, "type": "string" }, "gitlabOwner": { "nullable": true, "type": "string" }, "gitlabPathNamespace": { "nullable": true, "type": "string" }, "gitlabProjectId": { "nullable": true, "type": "number" }, "gitlabRepository": { "nullable": true, "type": "string" }, "isolatedDeployment": { "type": "boolean" }, "isolatedDeploymentsVolume": { "type": "boolean" }, "name": { "type": "string" }, "owner": { "nullable": true, "type": "string" }, "randomize": { "type": "boolean" }, "refreshToken": { "nullable": true, "type": "string" }, "repository": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "sourceType": { "enum": [ "git", "github", "gitlab", "bitbucket", "gitea", "raw" ], "type": "string" }, "suffix": { "type": "string" }, "triggerType": { "enum": [ "push", "tag" ], "nullable": true, "type": "string" }, "watchPaths": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "composeId", "name", "appName", "description", "env", "composeFile", "refreshToken", "sourceType", "composeType", "repository", "owner", "branch", "autoDeploy", "gitlabProjectId", "gitlabRepository", "gitlabOwner", "gitlabBranch", "gitlabPathNamespace", "bitbucketRepository", "bitbucketOwner", "bitbucketBranch", "giteaRepository", "giteaOwner", "giteaBranch", "customGitUrl", "customGitBranch", "customGitSSHKeyId", "command", "enableSubmodules", "composePath", "suffix", "randomize", "isolatedDeployment", "isolatedDeploymentsVolume", "triggerType", "composeStatus", "environmentId", "createdAt", "watchPaths", "githubId", "gitlabId", "bitbucketId", "giteaId", "serverId" ], "type": "object" }, "type": "array" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "mariadb": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "mongo": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mongoId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets" ], "type": "object" }, "type": "array" }, "mysql": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "postgres": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" }, "type": "array" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" }, "redis": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "labelsSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "name": { "type": "string" }, "networkSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "placementSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "rollbackConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ], "nullable": true } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId" ], "type": "object" }, "type": "array" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project", "applications", "mariadb", "mongo", "mysql", "postgres", "redis", "compose" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/environment.remove": { "post": { "operationId": "environment-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "environmentId": { "minLength": 1, "type": "string" } }, "required": [ "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/environment.update": { "post": { "operationId": "environment-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "environment" ] } }, "/gitProvider.getAll": { "get": { "operationId": "gitProvider-getAll", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "bitbucket": { "additionalProperties": false, "nullable": true, "properties": { "appPassword": { "nullable": true, "type": "string" }, "bitbucketId": { "type": "string" }, "bitbucketUsername": { "nullable": true, "type": "string" }, "bitbucketWorkspaceName": { "nullable": true, "type": "string" }, "gitProviderId": { "type": "string" } }, "required": [ "bitbucketId", "bitbucketUsername", "appPassword", "bitbucketWorkspaceName", "gitProviderId" ], "type": "object" }, "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "gitea": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt" ], "type": "object" }, "github": { "additionalProperties": false, "nullable": true, "properties": { "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId" ], "type": "object" }, "gitlab": { "additionalProperties": false, "nullable": true, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId" ], "type": "object" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId", "gitlab", "bitbucket", "github", "gitea" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitProvider" ] } }, "/gitProvider.remove": { "post": { "operationId": "gitProvider-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "gitProviderId": { "minLength": 1, "type": "string" } }, "required": [ "gitProviderId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitProvider" ] } }, "/gitea.create": { "post": { "operationId": "gitea-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "expiresAt": { "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "minLength": 1, "type": "string" }, "giteaUsername": { "type": "string" }, "lastAuthenticatedAt": { "type": "number" }, "name": { "minLength": 1, "type": "string" }, "organizationName": { "type": "string" }, "redirectUri": { "type": "string" }, "refreshToken": { "type": "string" }, "scopes": { "type": "string" } }, "required": [ "giteaUrl", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "clientId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" } }, "required": [ "giteaId", "giteaUrl", "clientId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.getGiteaBranches": { "get": { "operationId": "gitea-getGiteaBranches", "parameters": [ { "in": "query", "name": "owner", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "repositoryName", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "giteaId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.getGiteaRepositories": { "get": { "operationId": "gitea-getGiteaRepositories", "parameters": [ { "in": "query", "name": "giteaId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.getGiteaUrl": { "get": { "operationId": "gitea-getGiteaUrl", "parameters": [ { "in": "query", "name": "giteaId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.giteaProviders": { "get": { "operationId": "gitea-giteaProviders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "giteaId": { "type": "string" } }, "required": [ "giteaId", "gitProvider" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.one": { "get": { "operationId": "gitea-one", "parameters": [ { "in": "query", "name": "giteaId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "nullable": true, "type": "string" }, "clientId": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "gitProviderId": { "type": "string" }, "giteaId": { "type": "string" }, "giteaUrl": { "type": "string" }, "lastAuthenticatedAt": { "nullable": true, "type": "number" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "scopes": { "nullable": true, "type": "string" } }, "required": [ "giteaId", "giteaUrl", "redirectUri", "clientId", "clientSecret", "gitProviderId", "accessToken", "refreshToken", "expiresAt", "scopes", "lastAuthenticatedAt", "gitProvider" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.testConnection": { "post": { "operationId": "gitea-testConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "giteaId": { "type": "string" }, "organizationName": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/gitea.update": { "post": { "operationId": "gitea-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "expiresAt": { "type": "number" }, "gitProviderId": { "type": "string" }, "giteaId": { "minLength": 1, "type": "string" }, "giteaUrl": { "minLength": 1, "type": "string" }, "giteaUsername": { "type": "string" }, "lastAuthenticatedAt": { "type": "number" }, "name": { "minLength": 1, "type": "string" }, "organizationName": { "type": "string" }, "redirectUri": { "type": "string" }, "refreshToken": { "type": "string" }, "scopes": { "type": "string" } }, "required": [ "giteaId", "giteaUrl", "gitProviderId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitea" ] } }, "/github.getGithubBranches": { "get": { "operationId": "github-getGithubBranches", "parameters": [ { "in": "query", "name": "repo", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "owner", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "githubId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/github.getGithubRepositories": { "get": { "operationId": "github-getGithubRepositories", "parameters": [ { "in": "query", "name": "githubId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/github.githubProviders": { "get": { "operationId": "github-githubProviders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "githubId": { "type": "string" } }, "required": [ "githubId", "gitProvider" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/github.one": { "get": { "operationId": "github-one", "parameters": [ { "in": "query", "name": "githubId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "gitProviderId": { "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" } }, "required": [ "githubId", "githubAppName", "githubAppId", "githubClientId", "githubClientSecret", "githubInstallationId", "githubPrivateKey", "githubWebhookSecret", "gitProviderId", "gitProvider" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/github.testConnection": { "post": { "operationId": "github-testConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "githubId": { "minLength": 1, "type": "string" } }, "required": [ "githubId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/github.update": { "post": { "operationId": "github-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "gitProviderId": { "minLength": 1, "type": "string" }, "githubAppId": { "nullable": true, "type": "number" }, "githubAppName": { "nullable": true, "type": "string" }, "githubClientId": { "nullable": true, "type": "string" }, "githubClientSecret": { "nullable": true, "type": "string" }, "githubId": { "minLength": 1, "type": "string" }, "githubInstallationId": { "nullable": true, "type": "string" }, "githubPrivateKey": { "nullable": true, "type": "string" }, "githubWebhookSecret": { "nullable": true, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "githubId", "gitProviderId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "github" ] } }, "/gitlab.create": { "post": { "operationId": "gitlab-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "type": "string" }, "authId": { "minLength": 1, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "minLength": 1, "type": "string" }, "groupName": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "redirectUri": { "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "type": "string" } }, "required": [ "gitlabUrl", "authId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.getGitlabBranches": { "get": { "operationId": "gitlab-getGitlabBranches", "parameters": [ { "in": "query", "name": "id", "required": false, "schema": { "type": "number" } }, { "in": "query", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "repo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "gitlabId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.getGitlabRepositories": { "get": { "operationId": "gitlab-getGitlabRepositories", "parameters": [ { "in": "query", "name": "gitlabId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.gitlabProviders": { "get": { "operationId": "gitlab-gitlabProviders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" } }, "required": [ "gitlabId", "gitProvider", "gitlabUrl" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.one": { "get": { "operationId": "gitlab-one", "parameters": [ { "in": "query", "name": "gitlabId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProvider": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "gitProviderId": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "providerType": { "enum": [ "github", "gitlab", "bitbucket", "gitea" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "gitProviderId", "name", "providerType", "createdAt", "organizationId", "userId" ], "type": "object" }, "gitProviderId": { "type": "string" }, "gitlabId": { "type": "string" }, "gitlabUrl": { "type": "string" }, "groupName": { "nullable": true, "type": "string" }, "redirectUri": { "nullable": true, "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "nullable": true, "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "applicationId", "redirectUri", "secret", "accessToken", "refreshToken", "groupName", "expiresAt", "gitProviderId", "gitProvider" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.testConnection": { "post": { "operationId": "gitlab-testConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "gitlabId": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/gitlab.update": { "post": { "operationId": "gitlab-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "nullable": true, "type": "string" }, "applicationId": { "type": "string" }, "expiresAt": { "nullable": true, "type": "number" }, "gitProviderId": { "type": "string" }, "gitlabId": { "minLength": 1, "type": "string" }, "gitlabUrl": { "minLength": 1, "type": "string" }, "groupName": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "redirectUri": { "type": "string" }, "refreshToken": { "nullable": true, "type": "string" }, "secret": { "type": "string" } }, "required": [ "gitlabId", "gitlabUrl", "gitProviderId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "gitlab" ] } }, "/mariadb.changeStatus": { "post": { "operationId": "mariadb-changeStatus", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "mariadbId": { "type": "string" } }, "required": [ "mariadbId", "applicationStatus" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.create": { "post": { "operationId": "mariadb-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseRootPassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mariadb:6", "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "appName", "databaseRootPassword", "environmentId", "databaseName", "databaseUser", "databasePassword" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.deploy": { "post": { "operationId": "mariadb-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.move": { "post": { "operationId": "mariadb-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "mariadbId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.one": { "get": { "operationId": "mariadb-one", "parameters": [ { "in": "query", "name": "mariadbId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.rebuild": { "post": { "operationId": "mariadb-rebuild", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.reload": { "post": { "operationId": "mariadb-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "mariadbId": { "type": "string" } }, "required": [ "mariadbId", "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.remove": { "post": { "operationId": "mariadb-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.saveEnvironment": { "post": { "operationId": "mariadb-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "nullable": true, "type": "string" }, "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.saveExternalPort": { "post": { "operationId": "mariadb-saveExternalPort", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "externalPort": { "nullable": true, "type": "number" }, "mariadbId": { "type": "string" } }, "required": [ "mariadbId", "externalPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.start": { "post": { "operationId": "mariadb-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.stop": { "post": { "operationId": "mariadb-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mariadbId": { "type": "string" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mariadb.update": { "post": { "operationId": "mariadb-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseRootPassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mariadb:6", "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "mariadbId": { "minLength": 1, "type": "string" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mariadbId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mariadb" ] } }, "/mongo.changeStatus": { "post": { "operationId": "mongo-changeStatus", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "mongoId": { "type": "string" } }, "required": [ "mongoId", "applicationStatus" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.create": { "post": { "operationId": "mongo-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mongo:15", "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "replicaSets": { "default": false, "nullable": true, "type": "boolean" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "appName", "environmentId", "databaseUser", "databasePassword" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.deploy": { "post": { "operationId": "mongo-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.move": { "post": { "operationId": "mongo-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "mongoId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.one": { "get": { "operationId": "mongo-one", "parameters": [ { "in": "query", "name": "mongoId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.rebuild": { "post": { "operationId": "mongo-rebuild", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.reload": { "post": { "operationId": "mongo-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "mongoId": { "type": "string" } }, "required": [ "mongoId", "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.remove": { "post": { "operationId": "mongo-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.saveEnvironment": { "post": { "operationId": "mongo-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "nullable": true, "type": "string" }, "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.saveExternalPort": { "post": { "operationId": "mongo-saveExternalPort", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "externalPort": { "nullable": true, "type": "number" }, "mongoId": { "type": "string" } }, "required": [ "mongoId", "externalPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.start": { "post": { "operationId": "mongo-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.stop": { "post": { "operationId": "mongo-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mongoId": { "type": "string" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "type": "string" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId", "name", "appName", "description", "databaseUser", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "replicaSets", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mongo.update": { "post": { "operationId": "mongo-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mongo:15", "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mongoId": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicaSets": { "default": false, "nullable": true, "type": "boolean" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mongoId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mongo" ] } }, "/mounts.allNamedByApplicationId": { "get": { "operationId": "mounts-allNamedByApplicationId", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mounts" ] } }, "/mounts.create": { "post": { "operationId": "mounts-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mountPath": { "minLength": 1, "type": "string" }, "serviceId": { "minLength": 1, "type": "string" }, "serviceType": { "default": "application", "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "type", "mountPath", "serviceId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mounts" ] } }, "/mounts.one": { "get": { "operationId": "mounts-one", "parameters": [ { "in": "query", "name": "mountId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mounts" ] } }, "/mounts.remove": { "post": { "operationId": "mounts-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mountId": { "type": "string" } }, "required": [ "mountId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mounts" ] } }, "/mounts.update": { "post": { "operationId": "mounts-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "minLength": 1, "type": "string" }, "mountPath": { "minLength": 1, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "default": "application", "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mounts" ] } }, "/mysql.changeStatus": { "post": { "operationId": "mysql-changeStatus", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "mysqlId": { "type": "string" } }, "required": [ "mysqlId", "applicationStatus" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.create": { "post": { "operationId": "mysql-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseRootPassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mysql:8", "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "appName", "environmentId", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.deploy": { "post": { "operationId": "mysql-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.move": { "post": { "operationId": "mysql-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "mysqlId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.one": { "get": { "operationId": "mysql-one", "parameters": [ { "in": "query", "name": "mysqlId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.rebuild": { "post": { "operationId": "mysql-rebuild", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.reload": { "post": { "operationId": "mysql-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "mysqlId": { "type": "string" } }, "required": [ "mysqlId", "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.remove": { "post": { "operationId": "mysql-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.saveEnvironment": { "post": { "operationId": "mysql-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "nullable": true, "type": "string" }, "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.saveExternalPort": { "post": { "operationId": "mysql-saveExternalPort", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "externalPort": { "nullable": true, "type": "number" }, "mysqlId": { "type": "string" } }, "required": [ "mysqlId", "externalPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.start": { "post": { "operationId": "mysql-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.stop": { "post": { "operationId": "mysql-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "mysqlId": { "type": "string" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseRootPassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "mysqlId": { "type": "string" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId", "name", "appName", "description", "databaseName", "databaseUser", "databasePassword", "databaseRootPassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/mysql.update": { "post": { "operationId": "mysql-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseRootPassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "mysql:8", "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mysqlId": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "mysqlId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "mysql" ] } }, "/notification.all": { "get": { "operationId": "notification-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createDiscord": { "post": { "operationId": "notification-createDiscord", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "decoration": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "serverThreshold": { "type": "boolean" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverThreshold", "webhookUrl", "decoration" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createEmail": { "post": { "operationId": "notification-createEmail", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "fromAddress": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "password": { "minLength": 1, "type": "string" }, "serverThreshold": { "type": "boolean" }, "smtpPort": { "minimum": 1, "type": "number" }, "smtpServer": { "minLength": 1, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverThreshold", "smtpServer", "smtpPort", "username", "password", "fromAddress", "toAddresses" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createGotify": { "post": { "operationId": "notification-createGotify", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "appToken": { "minLength": 1, "type": "string" }, "databaseBackup": { "type": "boolean" }, "decoration": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverUrl", "appToken", "priority", "decoration" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createNtfy": { "post": { "operationId": "notification-createNtfy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "minLength": 1, "type": "string" }, "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" }, "topic": { "minLength": 1, "type": "string" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverUrl", "topic", "accessToken", "priority" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createSlack": { "post": { "operationId": "notification-createSlack", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "channel": { "type": "string" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "serverThreshold": { "type": "boolean" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverThreshold", "webhookUrl", "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.createTelegram": { "post": { "operationId": "notification-createTelegram", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "botToken": { "minLength": 1, "type": "string" }, "chatId": { "minLength": 1, "type": "string" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "messageThreadId": { "type": "string" }, "name": { "type": "string" }, "serverThreshold": { "type": "boolean" } }, "required": [ "appBuildError", "databaseBackup", "dokployRestart", "name", "appDeploy", "dockerCleanup", "serverThreshold", "botToken", "chatId", "messageThreadId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.getEmailProviders": { "get": { "operationId": "notification-getEmailProviders", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.one": { "get": { "operationId": "notification-one", "parameters": [ { "in": "query", "name": "notificationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.receiveNotification": { "post": { "operationId": "notification-receiveNotification", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "Message": { "type": "string" }, "ServerType": { "default": "Dokploy", "enum": [ "Dokploy", "Remote" ], "type": "string" }, "Threshold": { "type": "number" }, "Timestamp": { "type": "string" }, "Token": { "type": "string" }, "Type": { "enum": [ "Memory", "CPU" ], "type": "string" }, "Value": { "type": "number" } }, "required": [ "Type", "Value", "Threshold", "Message", "Timestamp", "Token" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.remove": { "post": { "operationId": "notification-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "notificationId": { "type": "string" } }, "required": [ "notificationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testDiscordConnection": { "post": { "operationId": "notification-testDiscordConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "decoration": { "type": "boolean" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "webhookUrl" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testEmailConnection": { "post": { "operationId": "notification-testEmailConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "fromAddress": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "smtpPort": { "minimum": 1, "type": "number" }, "smtpServer": { "minLength": 1, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "smtpServer", "smtpPort", "username", "password", "toAddresses", "fromAddress" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testGotifyConnection": { "post": { "operationId": "notification-testGotifyConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appToken": { "minLength": 1, "type": "string" }, "decoration": { "type": "boolean" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" } }, "required": [ "serverUrl", "appToken", "priority" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testNtfyConnection": { "post": { "operationId": "notification-testNtfyConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "minLength": 1, "type": "string" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" }, "topic": { "minLength": 1, "type": "string" } }, "required": [ "serverUrl", "topic", "accessToken", "priority" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testSlackConnection": { "post": { "operationId": "notification-testSlackConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "channel": { "type": "string" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "webhookUrl", "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.testTelegramConnection": { "post": { "operationId": "notification-testTelegramConnection", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "botToken": { "minLength": 1, "type": "string" }, "chatId": { "minLength": 1, "type": "string" }, "messageThreadId": { "type": "string" } }, "required": [ "botToken", "chatId", "messageThreadId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateDiscord": { "post": { "operationId": "notification-updateDiscord", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "decoration": { "type": "boolean" }, "discordId": { "minLength": 1, "type": "string" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "serverThreshold": { "type": "boolean" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "discordId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateEmail": { "post": { "operationId": "notification-updateEmail", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "emailId": { "minLength": 1, "type": "string" }, "fromAddress": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "password": { "minLength": 1, "type": "string" }, "serverThreshold": { "type": "boolean" }, "smtpPort": { "minimum": 1, "type": "number" }, "smtpServer": { "minLength": 1, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "emailId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateGotify": { "post": { "operationId": "notification-updateGotify", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "appToken": { "minLength": 1, "type": "string" }, "databaseBackup": { "type": "boolean" }, "decoration": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "gotifyId": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "gotifyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateNtfy": { "post": { "operationId": "notification-updateNtfy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessToken": { "minLength": 1, "type": "string" }, "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "ntfyId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "priority": { "minimum": 1, "type": "number" }, "serverUrl": { "minLength": 1, "type": "string" }, "topic": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "ntfyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateSlack": { "post": { "operationId": "notification-updateSlack", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "channel": { "type": "string" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "serverThreshold": { "type": "boolean" }, "slackId": { "type": "string" }, "webhookUrl": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "slackId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/notification.updateTelegram": { "post": { "operationId": "notification-updateTelegram", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appBuildError": { "type": "boolean" }, "appDeploy": { "type": "boolean" }, "botToken": { "minLength": 1, "type": "string" }, "chatId": { "minLength": 1, "type": "string" }, "databaseBackup": { "type": "boolean" }, "dockerCleanup": { "type": "boolean" }, "dokployRestart": { "type": "boolean" }, "messageThreadId": { "type": "string" }, "name": { "type": "string" }, "notificationId": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "serverThreshold": { "type": "boolean" }, "telegramId": { "minLength": 1, "type": "string" } }, "required": [ "notificationId", "telegramId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "notification" ] } }, "/organization.all": { "get": { "operationId": "organization-all", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "nullable": true, "type": "string" }, "metadata": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "slug": { "nullable": true, "type": "string" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "metadata", "ownerId" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.allInvitations": { "get": { "operationId": "organization-allInvitations", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.create": { "post": { "operationId": "organization-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "logo": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "nullable": true, "type": "string" }, "metadata": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "slug": { "nullable": true, "type": "string" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "metadata", "ownerId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.delete": { "post": { "operationId": "organization-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "organizationId": { "type": "string" } }, "required": [ "organizationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "nullable": true, "type": "string" }, "metadata": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "slug": { "nullable": true, "type": "string" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "metadata", "ownerId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.one": { "get": { "operationId": "organization-one", "parameters": [ { "in": "query", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "nullable": true, "type": "string" }, "metadata": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "slug": { "nullable": true, "type": "string" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "metadata", "ownerId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.removeInvitation": { "post": { "operationId": "organization-removeInvitation", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "invitationId": { "type": "string" } }, "required": [ "invitationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/organization.update": { "post": { "operationId": "organization-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "logo": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" } }, "required": [ "organizationId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "nullable": true, "type": "string" }, "metadata": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "slug": { "nullable": true, "type": "string" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "metadata", "ownerId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "organization" ] } }, "/port.create": { "post": { "operationId": "port-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "minLength": 1, "type": "string" }, "protocol": { "default": "tcp", "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "default": "ingress", "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "publishedPort", "targetPort", "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "port" ] } }, "/port.delete": { "post": { "operationId": "port-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "portId": { "minLength": 1, "type": "string" } }, "required": [ "portId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "port" ] } }, "/port.one": { "get": { "operationId": "port-one", "parameters": [ { "in": "query", "name": "portId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "port" ] } }, "/port.update": { "post": { "operationId": "port-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "portId": { "minLength": 1, "type": "string" }, "protocol": { "default": "tcp", "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "default": "ingress", "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "targetPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "portId": { "type": "string" }, "protocol": { "enum": [ "tcp", "udp" ], "type": "string" }, "publishMode": { "enum": [ "ingress", "host" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "portId", "publishedPort", "publishMode", "targetPort", "protocol", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "port" ] } }, "/postgres.changeStatus": { "post": { "operationId": "postgres-changeStatus", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "postgresId": { "type": "string" } }, "required": [ "postgresId", "applicationStatus" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.create": { "post": { "operationId": "postgres-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "postgres:15", "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "appName", "databaseName", "databaseUser", "databasePassword", "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.deploy": { "post": { "operationId": "postgres-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.move": { "post": { "operationId": "postgres-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "postgresId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.one": { "get": { "operationId": "postgres-one", "parameters": [ { "in": "query", "name": "postgresId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.rebuild": { "post": { "operationId": "postgres-rebuild", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.reload": { "post": { "operationId": "postgres-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "postgresId": { "type": "string" } }, "required": [ "postgresId", "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.remove": { "post": { "operationId": "postgres-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.saveEnvironment": { "post": { "operationId": "postgres-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "nullable": true, "type": "string" }, "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.saveExternalPort": { "post": { "operationId": "postgres-saveExternalPort", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "externalPort": { "nullable": true, "type": "number" }, "postgresId": { "type": "string" } }, "required": [ "postgresId", "externalPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.start": { "post": { "operationId": "postgres-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.stop": { "post": { "operationId": "postgres-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "postgresId": { "type": "string" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "backups": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "backupId": { "type": "string" }, "backupType": { "enum": [ "database", "compose" ], "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "database": { "type": "string" }, "databaseType": { "enum": [ "postgres", "mariadb", "mysql", "mongo", "web-server" ], "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": false, "properties": { "mariadb": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mongo": { "additionalProperties": false, "properties": { "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" } }, "required": [ "databaseUser", "databasePassword" ], "type": "object" }, "mysql": { "additionalProperties": false, "properties": { "databaseRootPassword": { "type": "string" } }, "required": [ "databaseRootPassword" ], "type": "object" }, "postgres": { "additionalProperties": false, "properties": { "databaseUser": { "type": "string" } }, "required": [ "databaseUser" ], "type": "object" } }, "type": "object" }, { "enum": [ "null" ], "nullable": true } ] }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "backupId", "appName", "schedule", "enabled", "database", "prefix", "serviceName", "destinationId", "keepLatestCount", "backupType", "databaseType", "composeId", "postgresId", "mariadbId", "mysqlId", "mongoId", "userId" ], "type": "object" }, "type": "array" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "type": "string" }, "databasePassword": { "type": "string" }, "databaseUser": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId", "name", "appName", "databaseName", "databaseUser", "databasePassword", "description", "dockerImage", "command", "env", "memoryReservation", "externalPort", "memoryLimit", "cpuReservation", "cpuLimit", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "createdAt", "environmentId", "serverId", "environment", "mounts", "server", "backups" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/postgres.update": { "post": { "operationId": "postgres-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databaseName": { "minLength": 1, "type": "string" }, "databasePassword": { "pattern": "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$", "type": "string" }, "databaseUser": { "minLength": 1, "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "postgres:15", "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "postgresId": { "minLength": 1, "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "postgresId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "postgres" ] } }, "/previewDeployment.all": { "get": { "operationId": "previewDeployment-all", "parameters": [ { "in": "query", "name": "applicationId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "previewDeployment" ] } }, "/previewDeployment.delete": { "post": { "operationId": "previewDeployment-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "previewDeploymentId": { "type": "string" } }, "required": [ "previewDeploymentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "previewDeployment" ] } }, "/previewDeployment.one": { "get": { "operationId": "previewDeployment-one", "parameters": [ { "in": "query", "name": "previewDeploymentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "type": "string" }, "branch": { "type": "string" }, "createdAt": { "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "previewDeploymentId": { "type": "string" }, "previewStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "pullRequestCommentId": { "type": "string" }, "pullRequestId": { "type": "string" }, "pullRequestNumber": { "type": "string" }, "pullRequestTitle": { "type": "string" }, "pullRequestURL": { "type": "string" } }, "required": [ "previewDeploymentId", "branch", "pullRequestId", "pullRequestNumber", "pullRequestURL", "pullRequestTitle", "pullRequestCommentId", "previewStatus", "appName", "applicationId", "domainId", "createdAt", "expiresAt" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "previewDeployment" ] } }, "/project.all": { "get": { "operationId": "project-all", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environments": { "items": { "additionalProperties": false, "properties": { "applications": { "items": {}, "type": "array" }, "compose": { "items": {}, "type": "array" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "mariadb": { "items": {}, "type": "array" }, "mongo": { "items": {}, "type": "array" }, "mysql": { "items": {}, "type": "array" }, "name": { "type": "string" }, "postgres": { "items": {}, "type": "array" }, "projectId": { "type": "string" }, "redis": { "items": {}, "type": "array" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env", "environments" ], "type": "object" }, "type": "array" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/project.create": { "post": { "operationId": "project-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" } }, "required": [ "project", "environment" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/project.duplicate": { "post": { "operationId": "project-duplicate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "duplicateInSameProject": { "default": false, "type": "boolean" }, "includeServices": { "default": true, "type": "boolean" }, "name": { "type": "string" }, "selectedServices": { "items": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "enum": [ "application", "postgres", "mariadb", "mongo", "mysql", "redis", "compose" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "type": "array" }, "sourceEnvironmentId": { "type": "string" } }, "required": [ "sourceEnvironmentId", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/project.one": { "get": { "operationId": "project-one", "parameters": [ { "in": "query", "name": "projectId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environments": { "items": { "additionalProperties": false, "properties": { "applications": { "items": {}, "type": "array" }, "compose": { "items": {}, "type": "array" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "mariadb": { "items": {}, "type": "array" }, "mongo": { "items": {}, "type": "array" }, "mysql": { "items": {}, "type": "array" }, "name": { "type": "string" }, "postgres": { "items": {}, "type": "array" }, "projectId": { "type": "string" }, "redis": { "items": {}, "type": "array" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env", "environments" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/project.remove": { "post": { "operationId": "project-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "projectId": { "minLength": 1, "type": "string" } }, "required": [ "projectId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/project.update": { "post": { "operationId": "project-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "minLength": 1, "type": "string" } }, "required": [ "projectId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "project" ] } }, "/redirects.create": { "post": { "operationId": "redirects-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "permanent": { "type": "boolean" }, "regex": { "minLength": 1, "type": "string" }, "replacement": { "minLength": 1, "type": "string" } }, "required": [ "regex", "replacement", "permanent", "applicationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redirects" ] } }, "/redirects.delete": { "post": { "operationId": "redirects-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redirectId": { "minLength": 1, "type": "string" } }, "required": [ "redirectId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redirects" ] } }, "/redirects.one": { "get": { "operationId": "redirects-one", "parameters": [ { "in": "query", "name": "redirectId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redirects" ] } }, "/redirects.update": { "post": { "operationId": "redirects-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "permanent": { "type": "boolean" }, "redirectId": { "minLength": 1, "type": "string" }, "regex": { "minLength": 1, "type": "string" }, "replacement": { "minLength": 1, "type": "string" } }, "required": [ "redirectId", "regex", "replacement", "permanent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "permanent": { "type": "boolean" }, "redirectId": { "type": "string" }, "regex": { "type": "string" }, "replacement": { "type": "string" }, "uniqueConfigKey": { "type": "number" } }, "required": [ "redirectId", "regex", "replacement", "permanent", "uniqueConfigKey", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redirects" ] } }, "/redis.changeStatus": { "post": { "operationId": "redis-changeStatus", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "redisId": { "type": "string" } }, "required": [ "redisId", "applicationStatus" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.create": { "post": { "operationId": "redis-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "redis:8", "type": "string" }, "environmentId": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "serverId": { "nullable": true, "type": "string" } }, "required": [ "name", "appName", "databasePassword", "environmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.deploy": { "post": { "operationId": "redis-deploy", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.move": { "post": { "operationId": "redis-move", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" }, "targetEnvironmentId": { "type": "string" } }, "required": [ "redisId", "targetEnvironmentId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.one": { "get": { "operationId": "redis-one", "parameters": [ { "in": "query", "name": "redisId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.rebuild": { "post": { "operationId": "redis-rebuild", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.reload": { "post": { "operationId": "redis-reload", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "redisId": { "type": "string" } }, "required": [ "redisId", "appName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.remove": { "post": { "operationId": "redis-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.saveEnvironment": { "post": { "operationId": "redis-saveEnvironment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "nullable": true, "type": "string" }, "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.saveExternalPort": { "post": { "operationId": "redis-saveExternalPort", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "externalPort": { "nullable": true, "type": "number" }, "redisId": { "type": "string" } }, "required": [ "redisId", "externalPort" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.start": { "post": { "operationId": "redis-start", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.stop": { "post": { "operationId": "redis-stop", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "redisId": { "type": "string" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "type": "string" }, "env": { "nullable": true, "type": "string" }, "environment": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "environmentId": { "type": "string" }, "name": { "type": "string" }, "project": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "env": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" } }, "required": [ "projectId", "name", "description", "createdAt", "organizationId", "env" ], "type": "object" }, "projectId": { "type": "string" } }, "required": [ "environmentId", "name", "description", "createdAt", "env", "projectId", "project" ], "type": "object" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "mounts": { "items": { "additionalProperties": false, "properties": { "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "content": { "nullable": true, "type": "string" }, "filePath": { "nullable": true, "type": "string" }, "hostPath": { "nullable": true, "type": "string" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mountId": { "type": "string" }, "mountPath": { "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "type": { "enum": [ "bind", "volume", "file" ], "type": "string" }, "volumeName": { "nullable": true, "type": "string" } }, "required": [ "mountId", "type", "hostPath", "volumeName", "filePath", "content", "serviceType", "mountPath", "applicationId", "postgresId", "mariadbId", "mongoId", "mysqlId", "redisId", "composeId" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "server": { "additionalProperties": false, "nullable": true, "properties": { "appName": { "type": "string" }, "command": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "enableDockerCleanup": { "type": "boolean" }, "ipAddress": { "type": "string" }, "metricsConfig": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, { "items": {}, "type": "array" }, { "additionalProperties": {}, "type": "object" } ] }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "port": { "type": "number" }, "serverId": { "type": "string" }, "serverStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "serverId", "name", "description", "ipAddress", "port", "username", "appName", "enableDockerCleanup", "createdAt", "organizationId", "serverStatus", "command", "sshKeyId", "metricsConfig" ], "type": "object" }, "serverId": { "nullable": true, "type": "string" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId", "name", "appName", "description", "databasePassword", "dockerImage", "command", "env", "memoryReservation", "memoryLimit", "cpuReservation", "cpuLimit", "externalPort", "createdAt", "applicationStatus", "healthCheckSwarm", "restartPolicySwarm", "placementSwarm", "updateConfigSwarm", "rollbackConfigSwarm", "modeSwarm", "labelsSwarm", "networkSwarm", "replicas", "environmentId", "serverId", "environment", "mounts", "server" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/redis.update": { "post": { "operationId": "redis-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "minLength": 1, "type": "string" }, "applicationStatus": { "enum": [ "idle", "running", "done", "error" ], "type": "string" }, "command": { "nullable": true, "type": "string" }, "cpuLimit": { "nullable": true, "type": "string" }, "cpuReservation": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "databasePassword": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "dockerImage": { "default": "redis:8", "type": "string" }, "env": { "nullable": true, "type": "string" }, "environmentId": { "type": "string" }, "externalPort": { "nullable": true, "type": "number" }, "healthCheckSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Interval": { "type": "number" }, "Retries": { "type": "number" }, "StartPeriod": { "type": "number" }, "Test": { "items": { "type": "string" }, "type": "array" }, "Timeout": { "type": "number" } }, "type": "object" }, "labelsSwarm": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "memoryLimit": { "nullable": true, "type": "string" }, "memoryReservation": { "nullable": true, "type": "string" }, "modeSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Global": { "additionalProperties": false, "properties": {}, "type": "object" }, "GlobalJob": { "additionalProperties": false, "properties": {}, "type": "object" }, "Replicated": { "additionalProperties": false, "properties": { "Replicas": { "type": "number" } }, "type": "object" }, "ReplicatedJob": { "additionalProperties": false, "properties": { "MaxConcurrent": { "type": "number" }, "TotalCompletions": { "type": "number" } }, "type": "object" } }, "type": "object" }, "name": { "minLength": 1, "type": "string" }, "networkSwarm": { "items": { "additionalProperties": false, "properties": { "Aliases": { "items": { "type": "string" }, "type": "array" }, "DriverOpts": { "additionalProperties": false, "properties": {}, "type": "object" }, "Target": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "placementSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Constraints": { "items": { "type": "string" }, "type": "array" }, "MaxReplicas": { "type": "number" }, "Platforms": { "items": { "additionalProperties": false, "properties": { "Architecture": { "type": "string" }, "OS": { "type": "string" } }, "required": [ "Architecture", "OS" ], "type": "object" }, "type": "array" }, "Preferences": { "items": { "additionalProperties": false, "properties": { "Spread": { "additionalProperties": false, "properties": { "SpreadDescriptor": { "type": "string" } }, "required": [ "SpreadDescriptor" ], "type": "object" } }, "required": [ "Spread" ], "type": "object" }, "type": "array" } }, "type": "object" }, "redisId": { "minLength": 1, "type": "string" }, "replicas": { "type": "number" }, "restartPolicySwarm": { "additionalProperties": false, "nullable": true, "properties": { "Condition": { "type": "string" }, "Delay": { "type": "number" }, "MaxAttempts": { "type": "number" }, "Window": { "type": "number" } }, "type": "object" }, "rollbackConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" }, "updateConfigSwarm": { "additionalProperties": false, "nullable": true, "properties": { "Delay": { "type": "number" }, "FailureAction": { "type": "string" }, "MaxFailureRatio": { "type": "number" }, "Monitor": { "type": "number" }, "Order": { "type": "string" }, "Parallelism": { "type": "number" } }, "required": [ "Parallelism", "Order" ], "type": "object" } }, "required": [ "redisId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "redis" ] } }, "/registry.all": { "get": { "operationId": "registry-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/registry.create": { "post": { "operationId": "registry-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "imagePrefix": { "nullable": true, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "registryName": { "minLength": 1, "type": "string" }, "registryType": { "enum": [ "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "serverId": { "type": "string" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "registryName", "username", "password", "registryUrl", "registryType", "imagePrefix" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/registry.one": { "get": { "operationId": "registry-one", "parameters": [ { "in": "query", "name": "registryId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/registry.remove": { "post": { "operationId": "registry-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "registryId": { "minLength": 1, "type": "string" } }, "required": [ "registryId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/registry.testRegistry": { "post": { "operationId": "registry-testRegistry", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "imagePrefix": { "nullable": true, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "registryName": { "type": "string" }, "registryType": { "enum": [ "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "serverId": { "type": "string" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "username", "password", "registryUrl", "registryType" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/registry.update": { "post": { "operationId": "registry-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "imagePrefix": { "nullable": true, "type": "string" }, "organizationId": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "registryId": { "minLength": 1, "type": "string" }, "registryName": { "minLength": 1, "type": "string" }, "registryType": { "enum": [ "cloud" ], "type": "string" }, "registryUrl": { "type": "string" }, "serverId": { "type": "string" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "registryId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "registry" ] } }, "/rollback.delete": { "post": { "operationId": "rollback-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "rollbackId": { "minLength": 1, "type": "string" } }, "required": [ "rollbackId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "rollback" ] } }, "/rollback.rollback": { "post": { "operationId": "rollback-rollback", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "rollbackId": { "minLength": 1, "type": "string" } }, "required": [ "rollbackId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "rollback" ] } }, "/schedule.create": { "post": { "operationId": "schedule-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "command": { "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "cronExpression": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduleType": { "enum": [ "application", "compose", "server", "dokploy-server" ], "type": "string" }, "script": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "shellType": { "enum": [ "bash", "sh" ], "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "name", "cronExpression", "command" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/schedule.delete": { "post": { "operationId": "schedule-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "scheduleId": { "type": "string" } }, "required": [ "scheduleId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/schedule.list": { "get": { "operationId": "schedule-list", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "scheduleType", "required": true, "schema": { "enum": [ "application", "compose", "server", "dokploy-server" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/schedule.one": { "get": { "operationId": "schedule-one", "parameters": [ { "in": "query", "name": "scheduleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/schedule.runManually": { "post": { "operationId": "schedule-runManually", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "scheduleId": { "minLength": 1, "type": "string" } }, "required": [ "scheduleId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/schedule.update": { "post": { "operationId": "schedule-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "command": { "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "cronExpression": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "scheduleId": { "minLength": 1, "type": "string" }, "scheduleType": { "enum": [ "application", "compose", "server", "dokploy-server" ], "type": "string" }, "script": { "nullable": true, "type": "string" }, "serverId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "shellType": { "enum": [ "bash", "sh" ], "type": "string" }, "userId": { "nullable": true, "type": "string" } }, "required": [ "scheduleId", "name", "cronExpression", "command" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "schedule" ] } }, "/security.create": { "post": { "operationId": "security-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "password": { "minLength": 1, "type": "string" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "applicationId", "username", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "security" ] } }, "/security.delete": { "post": { "operationId": "security-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "securityId": { "minLength": 1, "type": "string" } }, "required": [ "securityId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "security" ] } }, "/security.one": { "get": { "operationId": "security-one", "parameters": [ { "in": "query", "name": "securityId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "security" ] } }, "/security.update": { "post": { "operationId": "security-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "password": { "minLength": 1, "type": "string" }, "securityId": { "minLength": 1, "type": "string" }, "username": { "minLength": 1, "type": "string" } }, "required": [ "securityId", "username", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "applicationId": { "type": "string" }, "createdAt": { "type": "string" }, "password": { "type": "string" }, "securityId": { "type": "string" }, "username": { "type": "string" } }, "required": [ "securityId", "username", "password", "createdAt", "applicationId" ], "type": "object" } } }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "security" ] } }, "/server.all": { "get": { "operationId": "server-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.count": { "get": { "operationId": "server-count", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.create": { "post": { "operationId": "server-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "ipAddress": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "port": { "type": "number" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "name", "ipAddress", "port", "username", "sshKeyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.getDefaultCommand": { "get": { "operationId": "server-getDefaultCommand", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.getServerMetrics": { "get": { "operationId": "server-getServerMetrics", "parameters": [ { "in": "query", "name": "url", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "dataPoints", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.one": { "get": { "operationId": "server-one", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.publicIp": { "get": { "operationId": "server-publicIp", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.remove": { "post": { "operationId": "server-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "minLength": 1, "type": "string" } }, "required": [ "serverId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.security": { "get": { "operationId": "server-security", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.setup": { "post": { "operationId": "server-setup", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "minLength": 1, "type": "string" } }, "required": [ "serverId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.setupMonitoring": { "post": { "operationId": "server-setupMonitoring", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "metricsConfig": { "additionalProperties": false, "properties": { "containers": { "additionalProperties": false, "properties": { "refreshRate": { "minimum": 2, "type": "number" }, "services": { "additionalProperties": false, "properties": { "exclude": { "items": { "type": "string" }, "type": "array" }, "include": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "refreshRate", "services" ], "type": "object" }, "server": { "additionalProperties": false, "properties": { "cronJob": { "minLength": 1, "type": "string" }, "port": { "minimum": 1, "type": "number" }, "refreshRate": { "minimum": 2, "type": "number" }, "retentionDays": { "minimum": 1, "type": "number" }, "thresholds": { "additionalProperties": false, "properties": { "cpu": { "minimum": 0, "type": "number" }, "memory": { "minimum": 0, "type": "number" } }, "required": [ "cpu", "memory" ], "type": "object" }, "token": { "type": "string" }, "urlCallback": { "format": "uri", "type": "string" } }, "required": [ "refreshRate", "port", "token", "urlCallback", "retentionDays", "cronJob", "thresholds" ], "type": "object" } }, "required": [ "server", "containers" ], "type": "object" }, "serverId": { "minLength": 1, "type": "string" } }, "required": [ "serverId", "metricsConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.update": { "post": { "operationId": "server-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "command": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "ipAddress": { "type": "string" }, "name": { "minLength": 1, "type": "string" }, "port": { "type": "number" }, "serverId": { "minLength": 1, "type": "string" }, "sshKeyId": { "nullable": true, "type": "string" }, "username": { "type": "string" } }, "required": [ "name", "serverId", "ipAddress", "port", "username", "sshKeyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.validate": { "get": { "operationId": "server-validate", "parameters": [ { "in": "query", "name": "serverId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/server.withSSHKey": { "get": { "operationId": "server-withSSHKey", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "server" ] } }, "/settings.assignDomainServer": { "post": { "operationId": "settings-assignDomainServer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "host": { "nullable": true, "type": "string" }, "https": { "type": "boolean" }, "letsEncryptEmail": { "nullable": true, "type": "string" } }, "required": [ "host", "certificateType" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.checkGPUStatus": { "get": { "operationId": "settings-checkGPUStatus", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanAll": { "post": { "operationId": "settings-cleanAll", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanDockerBuilder": { "post": { "operationId": "settings-cleanDockerBuilder", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanDockerPrune": { "post": { "operationId": "settings-cleanDockerPrune", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanMonitoring": { "post": { "operationId": "settings-cleanMonitoring", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanRedis": { "post": { "operationId": "settings-cleanRedis", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanSSHPrivateKey": { "post": { "operationId": "settings-cleanSSHPrivateKey", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanStoppedContainers": { "post": { "operationId": "settings-cleanStoppedContainers", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanUnusedImages": { "post": { "operationId": "settings-cleanUnusedImages", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.cleanUnusedVolumes": { "post": { "operationId": "settings-cleanUnusedVolumes", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getDokployCloudIps": { "get": { "operationId": "settings-getDokployCloudIps", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getDokployVersion": { "get": { "operationId": "settings-getDokployVersion", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getIp": { "get": { "operationId": "settings-getIp", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getLogCleanupStatus": { "get": { "operationId": "settings-getLogCleanupStatus", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getOpenApiDocument": { "get": { "operationId": "settings-getOpenApiDocument", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getReleaseTag": { "get": { "operationId": "settings-getReleaseTag", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getTraefikPorts": { "get": { "operationId": "settings-getTraefikPorts", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.getUpdateData": { "post": { "operationId": "settings-getUpdateData", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.haveActivateRequests": { "get": { "operationId": "settings-haveActivateRequests", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.haveTraefikDashboardPortEnabled": { "get": { "operationId": "settings-haveTraefikDashboardPortEnabled", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.health": { "get": { "operationId": "settings-health", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.isCloud": { "get": { "operationId": "settings-isCloud", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.isUserSubscribed": { "get": { "operationId": "settings-isUserSubscribed", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readDirectories": { "get": { "operationId": "settings-readDirectories", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readMiddlewareTraefikConfig": { "get": { "operationId": "settings-readMiddlewareTraefikConfig", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readTraefikConfig": { "get": { "operationId": "settings-readTraefikConfig", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readTraefikEnv": { "get": { "operationId": "settings-readTraefikEnv", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readTraefikFile": { "get": { "operationId": "settings-readTraefikFile", "parameters": [ { "in": "query", "name": "path", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.readWebServerTraefikConfig": { "get": { "operationId": "settings-readWebServerTraefikConfig", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.reloadRedis": { "post": { "operationId": "settings-reloadRedis", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.reloadServer": { "post": { "operationId": "settings-reloadServer", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.reloadTraefik": { "post": { "operationId": "settings-reloadTraefik", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.saveSSHPrivateKey": { "post": { "operationId": "settings-saveSSHPrivateKey", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "sshPrivateKey": { "nullable": true, "type": "string" } }, "required": [ "sshPrivateKey" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.setupGPU": { "post": { "operationId": "settings-setupGPU", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "serverId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.toggleDashboard": { "post": { "operationId": "settings-toggleDashboard", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "enableDashboard": { "type": "boolean" }, "serverId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.toggleRequests": { "post": { "operationId": "settings-toggleRequests", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "enable": { "type": "boolean" } }, "required": [ "enable" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateDockerCleanup": { "post": { "operationId": "settings-updateDockerCleanup", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "enableDockerCleanup": { "type": "boolean" }, "serverId": { "type": "string" } }, "required": [ "enableDockerCleanup" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateLogCleanup": { "post": { "operationId": "settings-updateLogCleanup", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "cronExpression": { "nullable": true, "type": "string" } }, "required": [ "cronExpression" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateMiddlewareTraefikConfig": { "post": { "operationId": "settings-updateMiddlewareTraefikConfig", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "traefikConfig": { "minLength": 1, "type": "string" } }, "required": [ "traefikConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateServer": { "post": { "operationId": "settings-updateServer", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateTraefikConfig": { "post": { "operationId": "settings-updateTraefikConfig", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "traefikConfig": { "minLength": 1, "type": "string" } }, "required": [ "traefikConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateTraefikFile": { "post": { "operationId": "settings-updateTraefikFile", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "path": { "minLength": 1, "type": "string" }, "serverId": { "type": "string" }, "traefikConfig": { "minLength": 1, "type": "string" } }, "required": [ "path", "traefikConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateTraefikPorts": { "post": { "operationId": "settings-updateTraefikPorts", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "additionalPorts": { "items": { "additionalProperties": false, "properties": { "protocol": { "enum": [ "tcp", "udp", "sctp" ], "type": "string" }, "publishedPort": { "type": "number" }, "targetPort": { "type": "number" } }, "required": [ "targetPort", "publishedPort", "protocol" ], "type": "object" }, "type": "array" }, "serverId": { "type": "string" } }, "required": [ "additionalPorts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.updateWebServerTraefikConfig": { "post": { "operationId": "settings-updateWebServerTraefikConfig", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "traefikConfig": { "minLength": 1, "type": "string" } }, "required": [ "traefikConfig" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/settings.writeTraefikEnv": { "post": { "operationId": "settings-writeTraefikEnv", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "env": { "type": "string" }, "serverId": { "type": "string" } }, "required": [ "env" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "settings" ] } }, "/sshKey.all": { "get": { "operationId": "sshKey-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/sshKey.create": { "post": { "operationId": "sshKey-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string" }, "privateKey": { "type": "string" }, "publicKey": { "type": "string" } }, "required": [ "name", "privateKey", "publicKey", "organizationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/sshKey.generate": { "post": { "operationId": "sshKey-generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "type": { "enum": [ "rsa", "ed25519" ], "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/sshKey.one": { "get": { "operationId": "sshKey-one", "parameters": [ { "in": "query", "name": "sshKeyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/sshKey.remove": { "post": { "operationId": "sshKey-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "sshKeyId": { "type": "string" } }, "required": [ "sshKeyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/sshKey.update": { "post": { "operationId": "sshKey-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "nullable": true, "type": "string" }, "lastUsedAt": { "nullable": true, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "sshKeyId": { "type": "string" } }, "required": [ "sshKeyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "sshKey" ] } }, "/stripe.canCreateMoreServers": { "get": { "operationId": "stripe-canCreateMoreServers", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "stripe" ] } }, "/stripe.createCheckoutSession": { "post": { "operationId": "stripe-createCheckoutSession", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "isAnnual": { "type": "boolean" }, "productId": { "type": "string" }, "serverQuantity": { "minimum": 1, "type": "number" } }, "required": [ "productId", "serverQuantity", "isAnnual" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "stripe" ] } }, "/stripe.createCustomerPortalSession": { "post": { "operationId": "stripe-createCustomerPortalSession", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "stripe" ] } }, "/stripe.getProducts": { "get": { "operationId": "stripe-getProducts", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "stripe" ] } }, "/swarm.getNodeApps": { "get": { "operationId": "swarm-getNodeApps", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "swarm" ] } }, "/swarm.getNodeInfo": { "get": { "operationId": "swarm-getNodeInfo", "parameters": [ { "in": "query", "name": "nodeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "swarm" ] } }, "/swarm.getNodes": { "get": { "operationId": "swarm-getNodes", "parameters": [ { "in": "query", "name": "serverId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "swarm" ] } }, "/user.all": { "get": { "operationId": "user-all", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.assignPermissions": { "post": { "operationId": "user-assignPermissions", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessedEnvironments": { "items": { "type": "string" }, "type": "array" }, "accessedProjects": { "items": { "type": "string" }, "type": "array" }, "accessedServices": { "items": { "type": "string" }, "type": "array" }, "canAccessToAPI": { "type": "boolean" }, "canAccessToDocker": { "type": "boolean" }, "canAccessToGitProviders": { "type": "boolean" }, "canAccessToSSHKeys": { "type": "boolean" }, "canAccessToTraefikFiles": { "type": "boolean" }, "canCreateProjects": { "type": "boolean" }, "canCreateServices": { "type": "boolean" }, "canDeleteProjects": { "type": "boolean" }, "canDeleteServices": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "accessedProjects", "accessedEnvironments", "accessedServices", "canCreateProjects", "canCreateServices", "canDeleteProjects", "canDeleteServices", "canAccessToDocker", "canAccessToTraefikFiles", "canAccessToAPI", "canAccessToSSHKeys", "canAccessToGitProviders" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.checkUserOrganizations": { "get": { "operationId": "user-checkUserOrganizations", "parameters": [ { "in": "query", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.createApiKey": { "post": { "operationId": "user-createApiKey", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expiresIn": { "type": "number" }, "metadata": { "additionalProperties": false, "properties": { "organizationId": { "type": "string" } }, "required": [ "organizationId" ], "type": "object" }, "name": { "minLength": 1, "type": "string" }, "prefix": { "type": "string" }, "rateLimitEnabled": { "type": "boolean" }, "rateLimitMax": { "type": "number" }, "rateLimitTimeWindow": { "type": "number" }, "refillAmount": { "type": "number" }, "refillInterval": { "type": "number" }, "remaining": { "type": "number" } }, "required": [ "name", "metadata" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.deleteApiKey": { "post": { "operationId": "user-deleteApiKey", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "apiKeyId": { "type": "string" } }, "required": [ "apiKeyId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.generateToken": { "post": { "operationId": "user-generateToken", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.get": { "get": { "operationId": "user-get", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getBackups": { "get": { "operationId": "user-getBackups", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getContainerMetrics": { "get": { "operationId": "user-getContainerMetrics", "parameters": [ { "in": "query", "name": "url", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "token", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "dataPoints", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getInvitations": { "get": { "operationId": "user-getInvitations", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getMetricsToken": { "get": { "operationId": "user-getMetricsToken", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getServerMetrics": { "get": { "operationId": "user-getServerMetrics", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.getUserByToken": { "get": { "operationId": "user-getUserByToken", "parameters": [ { "in": "query", "name": "token", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.haveRootAccess": { "get": { "operationId": "user-haveRootAccess", "parameters": [], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.one": { "get": { "operationId": "user-one", "parameters": [ { "in": "query", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.remove": { "post": { "operationId": "user-remove", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.sendInvitation": { "post": { "operationId": "user-sendInvitation", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "invitationId": { "minLength": 1, "type": "string" }, "notificationId": { "minLength": 1, "type": "string" } }, "required": [ "invitationId", "notificationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/user.update": { "post": { "operationId": "user-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowImpersonation": { "type": "boolean" }, "banExpires": { "format": "date-time", "nullable": true, "type": "string" }, "banReason": { "nullable": true, "type": "string" }, "banned": { "nullable": true, "type": "boolean" }, "certificateType": { "enum": [ "letsencrypt", "none", "custom" ], "type": "string" }, "cleanupCacheApplications": { "type": "boolean" }, "cleanupCacheOnCompose": { "type": "boolean" }, "cleanupCacheOnPreviews": { "type": "boolean" }, "createdAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt2": { "type": "string" }, "currentPassword": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "enableDockerCleanup": { "type": "boolean" }, "enablePaidFeatures": { "type": "boolean" }, "expirationDate": { "type": "string" }, "host": { "nullable": true, "type": "string" }, "https": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "image": { "nullable": true, "type": "string" }, "isRegistered": { "type": "boolean" }, "letsEncryptEmail": { "nullable": true, "type": "string" }, "logCleanupCron": { "nullable": true, "type": "string" }, "metricsConfig": { "additionalProperties": false, "properties": { "containers": { "additionalProperties": false, "properties": { "refreshRate": { "type": "number" }, "services": { "additionalProperties": false, "properties": { "exclude": { "items": { "type": "string" }, "type": "array" }, "include": { "items": { "type": "string" }, "type": "array" } }, "required": [ "include", "exclude" ], "type": "object" } }, "required": [ "refreshRate", "services" ], "type": "object" }, "server": { "additionalProperties": false, "properties": { "cronJob": { "type": "string" }, "port": { "type": "number" }, "refreshRate": { "type": "number" }, "retentionDays": { "type": "number" }, "thresholds": { "additionalProperties": false, "properties": { "cpu": { "type": "number" }, "memory": { "type": "number" } }, "required": [ "cpu", "memory" ], "type": "object" }, "token": { "type": "string" }, "type": { "enum": [ "Dokploy", "Remote" ], "type": "string" }, "urlCallback": { "type": "string" } }, "required": [ "type", "refreshRate", "port", "token", "urlCallback", "retentionDays", "cronJob", "thresholds" ], "type": "object" } }, "required": [ "server", "containers" ], "type": "object" }, "name": { "type": "string" }, "password": { "type": "string" }, "serverIp": { "nullable": true, "type": "string" }, "serversQuantity": { "type": "number" }, "sshPrivateKey": { "nullable": true, "type": "string" }, "stripeCustomerId": { "nullable": true, "type": "string" }, "stripeSubscriptionId": { "nullable": true, "type": "string" }, "twoFactorEnabled": { "nullable": true, "type": "boolean" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "user" ] } }, "/volumeBackups.create": { "post": { "operationId": "volumeBackups-create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "cronExpression": { "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "turnOff": { "type": "boolean" }, "volumeName": { "type": "string" } }, "required": [ "name", "volumeName", "prefix", "cronExpression", "destinationId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } }, "/volumeBackups.delete": { "post": { "operationId": "volumeBackups-delete", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "volumeBackupId": { "minLength": 1, "type": "string" } }, "required": [ "volumeBackupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } }, "/volumeBackups.list": { "get": { "operationId": "volumeBackups-list", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "volumeBackupType", "required": true, "schema": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } }, "/volumeBackups.one": { "get": { "operationId": "volumeBackups-one", "parameters": [ { "in": "query", "name": "volumeBackupId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } }, "/volumeBackups.runManually": { "post": { "operationId": "volumeBackups-runManually", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "volumeBackupId": { "minLength": 1, "type": "string" } }, "required": [ "volumeBackupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } }, "/volumeBackups.update": { "post": { "operationId": "volumeBackups-update", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appName": { "type": "string" }, "applicationId": { "nullable": true, "type": "string" }, "composeId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "cronExpression": { "type": "string" }, "destinationId": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keepLatestCount": { "nullable": true, "type": "number" }, "mariadbId": { "nullable": true, "type": "string" }, "mongoId": { "nullable": true, "type": "string" }, "mysqlId": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "postgresId": { "nullable": true, "type": "string" }, "prefix": { "type": "string" }, "redisId": { "nullable": true, "type": "string" }, "serviceName": { "nullable": true, "type": "string" }, "serviceType": { "enum": [ "application", "postgres", "mysql", "mariadb", "mongo", "redis", "compose" ], "type": "string" }, "turnOff": { "type": "boolean" }, "volumeBackupId": { "minLength": 1, "type": "string" }, "volumeName": { "type": "string" } }, "required": [ "name", "volumeName", "prefix", "cronExpression", "destinationId", "volumeBackupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Successful response" }, "default": { "$ref": "#/components/responses/error" } }, "security": [ { "Authorization": [] } ], "tags": [ "volumeBackups" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "http://localhost:3000/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" } ] }