openapi.json
Rama canary · réplica de lectura del repositorio original.
{
"openapi": "3.1.0",
"info": {
"title": "Dokploy API",
"description": "Complete API documentation for Dokploy - Deploy applications, manage databases, and orchestrate your infrastructure. This API allows you to programmatically manage all aspects of your Dokploy instance.",
"version": "1.0.0",
"contact": {
"name": "Dokploy Team",
"url": "https://dokploy.com"
},
"license": {
"name": "Apache 2.0",
"url": "https://github.com/dokploy/dokploy/blob/canary/LICENSE"
}
},
"servers": [
{
"url": "https://your-dokploy-instance.com/api"
}
],
"tags": [
{
"name": "admin"
},
{
"name": "docker"
},
{
"name": "compose"
},
{
"name": "registry"
},
{
"name": "cluster"
},
{
"name": "user"
},
{
"name": "domain"
},
{
"name": "destination"
},
{
"name": "backup"
},
{
"name": "deployment"
},
{
"name": "mounts"
},
{
"name": "certificates"
},
{
"name": "settings"
},
{
"name": "security"
},
{
"name": "redirects"
},
{
"name": "port"
},
{
"name": "project"
},
{
"name": "application"
},
{
"name": "mysql"
},
{
"name": "postgres"
},
{
"name": "redis"
},
{
"name": "mongo"
},
{
"name": "mariadb"
},
{
"name": "sshRouter"
},
{
"name": "gitProvider"
},
{
"name": "bitbucket"
},
{
"name": "github"
},
{
"name": "gitlab"
},
{
"name": "gitea"
},
{
"name": "server"
},
{
"name": "swarm"
},
{
"name": "ai"
},
{
"name": "organization"
},
{
"name": "schedule"
},
{
"name": "rollback"
},
{
"name": "volumeBackups"
},
{
"name": "environment"
}
],
"externalDocs": {
"description": "Full documentation",
"url": "https://docs.dokploy.com"
},
"paths": {
"/admin.setupMonitoring": {
"post": {
"operationId": "admin-setupMonitoring",
"tags": [
"admin"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"metricsConfig": {
"type": "object",
"properties": {
"server": {
"type": "object",
"properties": {
"refreshRate": {
"type": "number",
"minimum": 2
},
"port": {
"type": "number",
"minimum": 1
},
"token": {
"type": "string"
},
"urlCallback": {
"type": "string",
"format": "uri"
},
"retentionDays": {
"type": "number",
"minimum": 1
},
"cronJob": {
"type": "string",
"minLength": 1
},
"thresholds": {
"type": "object",
"properties": {
"cpu": {
"type": "number",
"minimum": 0
},
"memory": {
"type": "number",
"minimum": 0
}
},
"required": [
"cpu",
"memory"
]
}
},
"required": [
"refreshRate",
"port",
"token",
"urlCallback",
"retentionDays",
"cronJob",
"thresholds"
]
},
"containers": {
"type": "object",
"properties": {
"refreshRate": {
"type": "number",
"minimum": 2
},
"services": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": [
"refreshRate",
"services"
]
}
},
"required": [
"server",
"containers"
]
}
},
"required": [
"metricsConfig"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.create": {
"post": {
"operationId": "application-create",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environmentId": {
"type": "string"
},
"serverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"environmentId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.one": {
"get": {
"operationId": "application-one",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "applicationId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.reload": {
"post": {
"operationId": "application-reload",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appName": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"applicationId": {
"type": "string"
}
},
"required": [
"appName",
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.delete": {
"post": {
"operationId": "application-delete",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.stop": {
"post": {
"operationId": "application-stop",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.start": {
"post": {
"operationId": "application-start",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.redeploy": {
"post": {
"operationId": "application-redeploy",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveEnvironment": {
"post": {
"operationId": "application-saveEnvironment",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"env": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildArgs": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildSecrets": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createEnvFile": {
"type": "boolean"
}
},
"required": [
"applicationId",
"env",
"buildArgs",
"buildSecrets",
"createEnvFile"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveBuildType": {
"post": {
"operationId": "application-saveBuildType",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"buildType": {
"type": "string",
"enum": [
"dockerfile",
"heroku_buildpacks",
"paketo_buildpacks",
"nixpacks",
"static",
"railpack"
]
},
"dockerfile": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dockerContextPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dockerBuildStage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"herokuVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"railpackVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publishDirectory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isStaticSpa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"applicationId",
"buildType",
"dockerfile",
"dockerContextPath",
"dockerBuildStage",
"herokuVersion",
"railpackVersion"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveGithubProvider": {
"post": {
"operationId": "application-saveGithubProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"repository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"githubId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"branch": {
"type": "string",
"minLength": 1,
"pattern": "^[a-zA-Z0-9._\\-/#]+$"
},
"triggerType": {
"default": "push",
"type": "string",
"enum": [
"push",
"tag"
]
},
"enableSubmodules": {
"type": "boolean"
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"applicationId",
"repository",
"owner",
"buildPath",
"githubId",
"branch",
"triggerType"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveGitlabProvider": {
"post": {
"operationId": "application-saveGitlabProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"gitlabBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabProjectId": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"gitlabPathNamespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabBranch": {
"type": "string",
"minLength": 1,
"pattern": "^[a-zA-Z0-9._\\-/#]+$"
},
"enableSubmodules": {
"type": "boolean"
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"applicationId",
"gitlabBuildPath",
"gitlabOwner",
"gitlabRepository",
"gitlabId",
"gitlabProjectId",
"gitlabPathNamespace",
"gitlabBranch"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveBitbucketProvider": {
"post": {
"operationId": "application-saveBitbucketProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepositorySlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"applicationId": {
"type": "string"
},
"bitbucketBranch": {
"type": "string",
"minLength": 1,
"pattern": "^[a-zA-Z0-9._\\-/#]+$"
},
"enableSubmodules": {
"type": "boolean"
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"bitbucketBuildPath",
"bitbucketOwner",
"bitbucketRepository",
"bitbucketRepositorySlug",
"bitbucketId",
"applicationId",
"bitbucketBranch"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveGiteaProvider": {
"post": {
"operationId": "application-saveGiteaProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"giteaBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaBranch": {
"type": "string",
"minLength": 1,
"pattern": "^[a-zA-Z0-9._\\-/#]+$"
},
"enableSubmodules": {
"type": "boolean"
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"applicationId",
"giteaBuildPath",
"giteaOwner",
"giteaRepository",
"giteaId",
"giteaBranch"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveDockerProvider": {
"post": {
"operationId": "application-saveDockerProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dockerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"applicationId": {
"type": "string"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"registryUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"dockerImage",
"applicationId",
"username",
"password",
"registryUrl"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.saveGitProvider": {
"post": {
"operationId": "application-saveGitProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"customGitBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"enableSubmodules": {
"type": "boolean"
},
"customGitBranch": {
"type": "string",
"minLength": 1,
"pattern": "^[a-zA-Z0-9._\\-/#]+$"
},
"customGitSSHKeyId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"applicationId",
"customGitBuildPath",
"customGitUrl",
"watchPaths",
"customGitBranch"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.disconnectGitProvider": {
"post": {
"operationId": "application-disconnectGitProvider",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.markRunning": {
"post": {
"operationId": "application-markRunning",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.update": {
"post": {
"operationId": "application-update",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"env": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"previewBuildArgs": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewBuildSecrets": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewLabels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"previewWildcard": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewPort": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"previewHttps": {
"type": "boolean"
},
"previewPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewCertificateType": {
"type": "string",
"enum": [
"letsencrypt",
"none",
"custom"
]
},
"previewCustomCertResolver": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"previewLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"isPreviewDeploymentsActive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"previewRequireCollaboratorPermissions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"rollbackActive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"buildArgs": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildSecrets": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"memoryReservation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"memoryLimit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cpuReservation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cpuLimit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subtitle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"command": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"args": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"icon": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 2097152
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"refreshToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceType": {
"type": "string",
"enum": [
"github",
"docker",
"git",
"gitlab",
"bitbucket",
"gitea",
"drop"
]
},
"cleanCache": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"repository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"triggerType": {
"anyOf": [
{
"type": "string",
"enum": [
"push",
"tag"
]
},
{
"type": "null"
}
]
},
"autoDeploy": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"gitlabProjectId": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"gitlabRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabPathNamespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepositorySlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dockerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"registryUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitSSHKeyId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enableSubmodules": {
"type": "boolean"
},
"dockerfile": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dockerContextPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dockerBuildStage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dropBuildPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"healthCheckSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Test": {
"type": "array",
"items": {
"type": "string"
}
},
"Interval": {
"type": "number"
},
"Timeout": {
"type": "number"
},
"StartPeriod": {
"type": "number"
},
"Retries": {
"type": "number"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"restartPolicySwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Condition": {
"type": "string"
},
"Delay": {
"type": "number"
},
"MaxAttempts": {
"type": "number"
},
"Window": {
"type": "number"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"placementSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Constraints": {
"type": "array",
"items": {
"type": "string"
}
},
"Preferences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Spread": {
"type": "object",
"properties": {
"SpreadDescriptor": {
"type": "string"
}
},
"required": [
"SpreadDescriptor"
]
}
},
"required": [
"Spread"
],
"additionalProperties": false
}
},
"MaxReplicas": {
"type": "number"
},
"Platforms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Architecture": {
"type": "string"
},
"OS": {
"type": "string"
}
},
"required": [
"Architecture",
"OS"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"updateConfigSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Parallelism": {
"type": "number"
},
"Delay": {
"type": "number"
},
"FailureAction": {
"type": "string"
},
"Monitor": {
"type": "number"
},
"MaxFailureRatio": {
"type": "number"
},
"Order": {
"type": "string"
}
},
"required": [
"Parallelism",
"Order"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"rollbackConfigSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Parallelism": {
"type": "number"
},
"Delay": {
"type": "number"
},
"FailureAction": {
"type": "string"
},
"Monitor": {
"type": "number"
},
"MaxFailureRatio": {
"type": "number"
},
"Order": {
"type": "string"
}
},
"required": [
"Parallelism",
"Order"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"modeSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Replicated": {
"type": "object",
"properties": {
"Replicas": {
"type": "number"
}
},
"additionalProperties": false
},
"Global": {
"type": "object",
"properties": {}
},
"ReplicatedJob": {
"type": "object",
"properties": {
"MaxConcurrent": {
"type": "number"
},
"TotalCompletions": {
"type": "number"
}
},
"additionalProperties": false
},
"GlobalJob": {
"type": "object",
"properties": {}
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"labelsSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"networkSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"Target": {
"type": "string"
},
"Aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"DriverOpts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"stopGracePeriodSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"endpointSpecSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"Mode": {
"type": "string"
},
"Ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Protocol": {
"type": "string"
},
"TargetPort": {
"type": "number"
},
"PublishedPort": {
"type": "number"
},
"PublishMode": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"ulimitsSwarm": {
"anyOf": [
{
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"minLength": 1
},
"Soft": {
"type": "integer",
"minimum": -1,
"maximum": 9007199254740991
},
"Hard": {
"type": "integer",
"minimum": -1,
"maximum": 9007199254740991
}
},
"required": [
"Name",
"Soft",
"Hard"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
},
"replicas": {
"type": "number"
},
"applicationStatus": {
"type": "string",
"enum": [
"idle",
"running",
"done",
"error"
]
},
"buildType": {
"type": "string",
"enum": [
"dockerfile",
"heroku_buildpacks",
"paketo_buildpacks",
"nixpacks",
"static",
"railpack"
]
},
"railpackVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"herokuVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publishDirectory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isStaticSpa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"createEnvFile": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"registryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"rollbackRegistryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environmentId": {
"type": "string"
},
"githubId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildServerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"buildRegistryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"networkIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"detachDokployNetwork": {
"type": "boolean"
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.refreshToken": {
"post": {
"operationId": "application-refreshToken",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.deploy": {
"post": {
"operationId": "application-deploy",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.cleanQueues": {
"post": {
"operationId": "application-cleanQueues",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.clearDeployments": {
"post": {
"operationId": "application-clearDeployments",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.killBuild": {
"post": {
"operationId": "application-killBuild",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.readTraefikConfig": {
"get": {
"operationId": "application-readTraefikConfig",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "applicationId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.dropDeployment": {
"post": {
"operationId": "application-dropDeployment",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"zip": {
"type": "string",
"format": "binary"
},
"dropBuildPath": {
"type": "string"
}
},
"required": [
"applicationId",
"zip"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.updateTraefikConfig": {
"post": {
"operationId": "application-updateTraefikConfig",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"traefikConfig": {
"type": "string"
}
},
"required": [
"applicationId",
"traefikConfig"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.readAppMonitoring": {
"get": {
"operationId": "application-readAppMonitoring",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "appName",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.move": {
"post": {
"operationId": "application-move",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"targetEnvironmentId": {
"type": "string"
}
},
"required": [
"applicationId",
"targetEnvironmentId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.cancelDeployment": {
"post": {
"operationId": "application-cancelDeployment",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": [
"applicationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.search": {
"get": {
"operationId": "application-search",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "appName",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "repository",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "owner",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "dockerImage",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "projectId",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "environmentId",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"default": 20,
"type": "number",
"minimum": 1,
"maximum": 100
}
},
{
"in": "query",
"name": "offset",
"schema": {
"default": 0,
"type": "number",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/application.readLogs": {
"get": {
"operationId": "application-readLogs",
"tags": [
"application"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "applicationId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
},
{
"in": "query",
"name": "tail",
"schema": {
"default": 100,
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
{
"in": "query",
"name": "since",
"schema": {
"default": "all",
"type": "string",
"pattern": "^(all|\\d+[smhd])$"
}
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9 ._-]{0,500}$"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.create": {
"post": {
"operationId": "backup-create",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "string"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"prefix": {
"type": "string",
"minLength": 1
},
"destinationId": {
"type": "string"
},
"keepLatestCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"database": {
"type": "string",
"minLength": 1
},
"mariadbId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mysqlId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postgresId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mongoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"libsqlId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"databaseType": {
"type": "string",
"enum": [
"postgres",
"mariadb",
"mysql",
"mongo",
"web-server",
"libsql"
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"backupType": {
"type": "string",
"enum": [
"database",
"compose"
]
},
"composeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"serviceName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"includeEncryptionKey": {
"type": "boolean"
},
"metadata": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"required": [
"schedule",
"prefix",
"destinationId",
"database",
"databaseType"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.one": {
"get": {
"operationId": "backup-one",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "backupId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.update": {
"post": {
"operationId": "backup-update",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "string"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"prefix": {
"type": "string",
"minLength": 1
},
"backupId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"database": {
"type": "string",
"minLength": 1
},
"keepLatestCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"serviceName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"metadata": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"databaseType": {
"type": "string",
"enum": [
"postgres",
"mariadb",
"mysql",
"mongo",
"web-server",
"libsql"
]
},
"includeEncryptionKey": {
"type": "boolean"
}
},
"required": [
"schedule",
"enabled",
"prefix",
"backupId",
"destinationId",
"database",
"keepLatestCount",
"serviceName",
"metadata",
"databaseType"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.remove": {
"post": {
"operationId": "backup-remove",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupPostgres": {
"post": {
"operationId": "backup-manualBackupPostgres",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupMySql": {
"post": {
"operationId": "backup-manualBackupMySql",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupMariadb": {
"post": {
"operationId": "backup-manualBackupMariadb",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupCompose": {
"post": {
"operationId": "backup-manualBackupCompose",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupMongo": {
"post": {
"operationId": "backup-manualBackupMongo",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupLibsql": {
"post": {
"operationId": "backup-manualBackupLibsql",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.manualBackupWebServer": {
"post": {
"operationId": "backup-manualBackupWebServer",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string",
"minLength": 1
}
},
"required": [
"backupId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/backup.listBackupFiles": {
"get": {
"operationId": "backup-listBackupFiles",
"tags": [
"backup"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "destinationId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.create": {
"post": {
"operationId": "bitbucket-create",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string"
},
"bitbucketUsername": {
"type": "string"
},
"bitbucketEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"appPassword": {
"type": "string"
},
"apiToken": {
"type": "string"
},
"bitbucketWorkspaceName": {
"type": "string"
},
"gitProviderId": {
"type": "string"
},
"authId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"authId",
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.one": {
"get": {
"operationId": "bitbucket-one",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "bitbucketId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.bitbucketProviders": {
"get": {
"operationId": "bitbucket-bitbucketProviders",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.getBitbucketRepositories": {
"get": {
"operationId": "bitbucket-getBitbucketRepositories",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "bitbucketId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.getBitbucketBranches": {
"get": {
"operationId": "bitbucket-getBitbucketBranches",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "owner",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "repo",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "bitbucketId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.testConnection": {
"post": {
"operationId": "bitbucket-testConnection",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string",
"minLength": 1
},
"bitbucketUsername": {
"type": "string"
},
"bitbucketEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"workspaceName": {
"type": "string"
},
"apiToken": {
"type": "string"
},
"appPassword": {
"type": "string"
}
},
"required": [
"bitbucketId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/bitbucket.update": {
"post": {
"operationId": "bitbucket-update",
"tags": [
"bitbucket"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string",
"minLength": 1
},
"bitbucketUsername": {
"type": "string"
},
"bitbucketEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"appPassword": {
"type": "string"
},
"apiToken": {
"type": "string"
},
"bitbucketWorkspaceName": {
"type": "string"
},
"gitProviderId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"organizationId": {
"type": "string"
}
},
"required": [
"bitbucketId",
"gitProviderId",
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.all": {
"get": {
"operationId": "network-all",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.one": {
"get": {
"operationId": "network-one",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "networkId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.create": {
"post": {
"operationId": "network-create",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"driver": {
"type": "string",
"enum": [
"bridge",
"overlay"
]
},
"internal": {
"type": "boolean"
},
"attachable": {
"type": "boolean"
},
"enableIPv4": {
"type": "boolean"
},
"enableIPv6": {
"type": "boolean"
},
"ipam": {
"anyOf": [
{
"type": "object",
"properties": {
"driver": {
"type": "string"
},
"config": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subnet": {
"type": "string"
},
"gateway": {
"type": "string"
},
"ipRange": {
"type": "string"
}
}
}
}
}
},
{
"type": "null"
}
]
},
"serverId": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.networksToSync": {
"get": {
"operationId": "network-networksToSync",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.import": {
"post": {
"operationId": "network-import",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"names": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"names"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.inspect": {
"get": {
"operationId": "network-inspect",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "networkId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.recreate": {
"post": {
"operationId": "network-recreate",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"minLength": 1
}
},
"required": [
"networkId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/network.remove": {
"post": {
"operationId": "network-remove",
"tags": [
"network"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"minLength": 1
}
},
"required": [
"networkId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/certificates.create": {
"post": {
"operationId": "certificates-create",
"tags": [
"certificates"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"certificateData": {
"type": "string",
"minLength": 1
},
"privateKey": {
"type": "string",
"minLength": 1
},
"certificatePath": {
"type": "string"
},
"autoRenew": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"organizationId": {
"type": "string"
},
"serverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"certificateData",
"privateKey",
"organizationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/certificates.one": {
"get": {
"operationId": "certificates-one",
"tags": [
"certificates"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "certificateId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/certificates.remove": {
"post": {
"operationId": "certificates-remove",
"tags": [
"certificates"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateId": {
"type": "string",
"minLength": 1
}
},
"required": [
"certificateId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/certificates.all": {
"get": {
"operationId": "certificates-all",
"tags": [
"certificates"
],
"security": [
{
"Authorization": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/certificates.update": {
"post": {
"operationId": "certificates-update",
"tags": [
"certificates"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"certificateData": {
"type": "string",
"minLength": 1
},
"privateKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"certificateId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/cluster.getNodes": {
"get": {
"operationId": "cluster-getNodes",
"tags": [
"cluster"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/cluster.removeWorker": {
"post": {
"operationId": "cluster-removeWorker",
"tags": [
"cluster"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"serverId": {
"type": "string"
}
},
"required": [
"nodeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/cluster.addWorker": {
"get": {
"operationId": "cluster-addWorker",
"tags": [
"cluster"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/cluster.addManager": {
"get": {
"operationId": "cluster-addManager",
"tags": [
"cluster"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "serverId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.create": {
"post": {
"operationId": "compose-create",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environmentId": {
"type": "string"
},
"composeType": {
"type": "string",
"enum": [
"docker-compose",
"stack"
]
},
"appName": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"serverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"composeFile": {
"type": "string"
}
},
"required": [
"name",
"environmentId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.one": {
"get": {
"operationId": "compose-one",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "composeId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.update": {
"post": {
"operationId": "compose-update",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z0-9._-]+$"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"env": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"composeFile": {
"type": "string"
},
"refreshToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceType": {
"type": "string",
"enum": [
"git",
"github",
"gitlab",
"bitbucket",
"gitea",
"raw"
]
},
"composeType": {
"type": "string",
"enum": [
"docker-compose",
"stack"
]
},
"repository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoDeploy": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"gitlabProjectId": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"gitlabRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabPathNamespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketRepositorySlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaRepository": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaOwner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customGitSSHKeyId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"command": {
"type": "string"
},
"enableSubmodules": {
"type": "boolean"
},
"composePath": {
"type": "string",
"minLength": 1
},
"suffix": {
"type": "string"
},
"randomize": {
"type": "boolean"
},
"isolatedDeployment": {
"type": "boolean"
},
"isolatedDeploymentsVolume": {
"type": "boolean"
},
"triggerType": {
"anyOf": [
{
"type": "string",
"enum": [
"push",
"tag"
]
},
{
"type": "null"
}
]
},
"composeStatus": {
"type": "string",
"enum": [
"idle",
"running",
"done",
"error"
]
},
"environmentId": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"watchPaths": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"githubId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gitlabId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bitbucketId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"giteaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"serviceNetworks": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceName": {
"type": "string"
},
"networkIds": {
"type": "array",
"items": {
"type": "string"
}
},
"detachDokployNetwork": {
"type": "boolean"
}
},
"required": [
"serviceName",
"networkIds",
"detachDokployNetwork"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.saveEnvironment": {
"post": {
"operationId": "compose-saveEnvironment",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string"
},
"env": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"composeId",
"env"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.delete": {
"post": {
"operationId": "compose-delete",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"deleteVolumes": {
"type": "boolean"
}
},
"required": [
"composeId",
"deleteVolumes"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.cleanQueues": {
"post": {
"operationId": "compose-cleanQueues",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.clearDeployments": {
"post": {
"operationId": "compose-clearDeployments",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.killBuild": {
"post": {
"operationId": "compose-killBuild",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.loadServices": {
"get": {
"operationId": "compose-loadServices",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "composeId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
},
{
"in": "query",
"name": "type",
"schema": {
"default": "cache",
"type": "string",
"enum": [
"fetch",
"cache"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.loadMountsByService": {
"get": {
"operationId": "compose-loadMountsByService",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "composeId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
},
{
"in": "query",
"name": "serviceName",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.fetchSourceType": {
"post": {
"operationId": "compose-fetchSourceType",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.randomizeCompose": {
"post": {
"operationId": "compose-randomizeCompose",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"suffix": {
"type": "string"
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.isolatedDeployment": {
"post": {
"operationId": "compose-isolatedDeployment",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"suffix": {
"type": "string"
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.getConvertedCompose": {
"get": {
"operationId": "compose-getConvertedCompose",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "composeId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.deploy": {
"post": {
"operationId": "compose-deploy",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.redeploy": {
"post": {
"operationId": "compose-redeploy",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.stop": {
"post": {
"operationId": "compose-stop",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.start": {
"post": {
"operationId": "compose-start",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.getDefaultCommand": {
"get": {
"operationId": "compose-getDefaultCommand",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "composeId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.refreshToken": {
"post": {
"operationId": "compose-refreshToken",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": [
"composeId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.deployTemplate": {
"post": {
"operationId": "compose-deployTemplate",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"environmentId": {
"type": "string"
},
"serverId": {
"type": "string"
},
"id": {
"type": "string"
},
"baseUrl": {
"type": "string"
}
},
"required": [
"environmentId",
"id"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
}
}
}
}
}
}
},
"/compose.templates": {
"get": {
"operationId": "compose-templates",
"tags": [
"compose"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "baseUrl",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/j