Dokploy/dokploy
1
0
Fork 0
mirror of https://github.com/Dokploy/dokploy synced 2025-06-26 18:27:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
9e4bac1386
dokploy/apps/docs/api.json
Mauricio Siu d9f5d20473 chore(docs): update api.json endpoints
2024-09-01 23:11:17 -06:00

11722 lines
224 KiB
JSON
Raw Blame History

{
"openapi": "3.0.3",
"info": {
"title": "Dokploy API",
"description": "Endpoints for dokploy",
"version": "v0.7.3"
},
"servers": [
{
"url": "http://localhost:3000/api"
}
],
"paths": {
"/admin.one": {
"get": {
"operationId": "admin-one",
"tags": ["admin"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/admin.createUserInvitation": {
"post": {
"operationId": "admin-createUserInvitation",
"tags": ["admin"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": ["email"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/admin.removeUser": {
"post": {
"operationId": "admin-removeUser",
"tags": ["admin"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authId": {
"type": "string",
"minLength": 1
}
},
"required": ["authId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/admin.getUserByToken": {
"get": {
"operationId": "admin-getUserByToken",
"tags": ["admin"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/admin.assignPermissions": {
"post": {
"operationId": "admin-assignPermissions",
"tags": ["admin"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"minLength": 1
},
"canCreateProjects": {
"type": "boolean"
},
"canCreateServices": {
"type": "boolean"
},
"canDeleteProjects": {
"type": "boolean"
},
"canDeleteServices": {
"type": "boolean"
},
"accesedProjects": {
"type": "array",
"items": {
"type": "string"
}
},
"accesedServices": {
"type": "array",
"items": {
"type": "string"
}
},
"canAccessToTraefikFiles": {
"type": "boolean"
},
"canAccessToDocker": {
"type": "boolean"
},
"canAccessToAPI": {
"type": "boolean"
},
"canAccessToSSHKeys": {
"type": "boolean"
},
"canAccessToGitProviders": {
"type": "boolean"
}
},
"required": [
"userId",
"canCreateProjects",
"canCreateServices",
"canDeleteProjects",
"canDeleteServices",
"accesedProjects",
"accesedServices",
"canAccessToTraefikFiles",
"canAccessToDocker",
"canAccessToAPI",
"canAccessToSSHKeys",
"canAccessToGitProviders"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/docker.getContainers": {
"get": {
"operationId": "docker-getContainers",
"tags": ["docker"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/docker.getConfig": {
"get": {
"operationId": "docker-getConfig",
"tags": ["docker"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "containerId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/docker.getContainersByAppNameMatch": {
"get": {
"operationId": "docker-getContainersByAppNameMatch",
"tags": ["docker"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "appType",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"enum": ["stack"]
},
{
"type": "string",
"enum": ["docker-compose"]
}
]
}
},
{
"name": "appName",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/docker.getContainersByAppLabel": {
"get": {
"operationId": "docker-getContainersByAppLabel",
"tags": ["docker"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "appName",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.createAdmin": {
"post": {
"operationId": "auth-createAdmin",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string",
"minLength": 8
}
},
"required": ["email", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.createUser": {
"post": {
"operationId": "auth-createUser",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"minLength": 8
},
"id": {
"type": "string"
},
"token": {
"type": "string",
"minLength": 1
}
},
"required": ["password", "id", "token"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.login": {
"post": {
"operationId": "auth-login",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string",
"minLength": 8
}
},
"required": ["email", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.get": {
"get": {
"operationId": "auth-get",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.logout": {
"post": {
"operationId": "auth-logout",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.update": {
"post": {
"operationId": "auth-update",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"rol": {
"type": "string",
"enum": ["admin", "user"]
},
"image": {
"type": "string"
},
"secret": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
},
"is2FAEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string"
}
},
"required": ["email", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.generateToken": {
"post": {
"operationId": "auth-generateToken",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.one": {
"get": {
"operationId": "auth-one",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.updateByAdmin": {
"post": {
"operationId": "auth-updateByAdmin",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"rol": {
"type": "string",
"enum": ["admin", "user"]
},
"image": {
"type": "string"
},
"secret": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
},
"is2FAEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string"
}
},
"required": ["id", "email", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.generate2FASecret": {
"get": {
"operationId": "auth-generate2FASecret",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.verify2FASetup": {
"post": {
"operationId": "auth-verify2FASetup",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"minLength": 6
},
"secret": {
"type": "string",
"minLength": 1
}
},
"required": ["pin", "secret"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.verifyLogin2FA": {
"post": {
"operationId": "auth-verifyLogin2FA",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"minLength": 6
},
"id": {
"type": "string"
}
},
"required": ["pin", "id"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.disable2FA": {
"post": {
"operationId": "auth-disable2FA",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/auth.verifyToken": {
"post": {
"operationId": "auth-verifyToken",
"tags": ["auth"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/project.create": {
"post": {
"operationId": "project-create",
"tags": ["project"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
}
},
"required": ["name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/project.one": {
"get": {
"operationId": "project-one",
"tags": ["project"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "projectId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/project.all": {
"get": {
"operationId": "project-all",
"tags": ["project"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/project.remove": {
"post": {
"operationId": "project-remove",
"tags": ["project"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1
}
},
"required": ["projectId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/project.update": {
"post": {
"operationId": "project-update",
"tags": ["project"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"projectId": {
"type": "string",
"minLength": 1
}
},
"required": ["name", "projectId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.create": {
"post": {
"operationId": "application-create",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"projectId": {
"type": "string"
}
},
"required": ["name", "projectId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.one": {
"get": {
"operationId": "application-one",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "applicationId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.reload": {
"post": {
"operationId": "application-reload",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"applicationId": {
"type": "string"
}
},
"required": ["appName", "applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.delete": {
"post": {
"operationId": "application-delete",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.stop": {
"post": {
"operationId": "application-stop",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.start": {
"post": {
"operationId": "application-start",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.redeploy": {
"post": {
"operationId": "application-redeploy",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveEnvironment": {
"post": {
"operationId": "application-saveEnvironment",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
},
"buildArgs": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveBuildType": {
"post": {
"operationId": "application-saveBuildType",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"buildType": {
"type": "string",
"enum": [
"dockerfile",
"heroku_buildpacks",
"paketo_buildpacks",
"nixpacks",
"static"
]
},
"dockerfile": {
"type": "string",
"nullable": true
},
"dockerContextPath": {
"type": "string",
"nullable": true
},
"publishDirectory": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId", "buildType", "dockerContextPath"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveGithubProvider": {
"post": {
"operationId": "application-saveGithubProvider",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"repository": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
},
"buildPath": {
"type": "string",
"nullable": true
},
"githubId": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId", "owner", "githubId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveGitlabProvider": {
"post": {
"operationId": "application-saveGitlabProvider",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"gitlabBranch": {
"type": "string",
"nullable": true
},
"gitlabBuildPath": {
"type": "string",
"nullable": true
},
"gitlabOwner": {
"type": "string",
"nullable": true
},
"gitlabRepository": {
"type": "string",
"nullable": true
},
"gitlabId": {
"type": "string",
"nullable": true
},
"gitlabProjectId": {
"type": "number",
"nullable": true
},
"gitlabPathNamespace": {
"type": "string",
"nullable": true
}
},
"required": [
"applicationId",
"gitlabBranch",
"gitlabBuildPath",
"gitlabOwner",
"gitlabRepository",
"gitlabId",
"gitlabProjectId",
"gitlabPathNamespace"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveBitbucketProvider": {
"post": {
"operationId": "application-saveBitbucketProvider",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketBranch": {
"type": "string",
"nullable": true
},
"bitbucketBuildPath": {
"type": "string",
"nullable": true
},
"bitbucketOwner": {
"type": "string",
"nullable": true
},
"bitbucketRepository": {
"type": "string",
"nullable": true
},
"bitbucketId": {
"type": "string",
"nullable": true
},
"applicationId": {
"type": "string"
}
},
"required": [
"bitbucketBranch",
"bitbucketBuildPath",
"bitbucketOwner",
"bitbucketRepository",
"bitbucketId",
"applicationId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveDockerProvider": {
"post": {
"operationId": "application-saveDockerProvider",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dockerImage": {
"type": "string",
"nullable": true
},
"applicationId": {
"type": "string"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.saveGitProdiver": {
"post": {
"operationId": "application-saveGitProdiver",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customGitBranch": {
"type": "string",
"nullable": true
},
"applicationId": {
"type": "string"
},
"customGitBuildPath": {
"type": "string",
"nullable": true
},
"customGitUrl": {
"type": "string",
"nullable": true
},
"customGitSSHKeyId": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.markRunning": {
"post": {
"operationId": "application-markRunning",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.update": {
"post": {
"operationId": "application-update",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"buildArgs": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean",
"nullable": true
},
"subtitle": {
"type": "string",
"nullable": true
},
"command": {
"type": "string",
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
},
"sourceType": {
"type": "string",
"enum": ["github", "docker", "git"]
},
"repository": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"buildPath": {
"type": "string",
"nullable": true
},
"autoDeploy": {
"type": "boolean",
"nullable": true
},
"gitlabProjectId": {
"type": "number",
"nullable": true
},
"gitlabRepository": {
"type": "string",
"nullable": true
},
"gitlabOwner": {
"type": "string",
"nullable": true
},
"gitlabBranch": {
"type": "string",
"nullable": true
},
"gitlabBuildPath": {
"type": "string",
"nullable": true
},
"gitlabPathNamespace": {
"type": "string",
"nullable": true
},
"bitbucketRepository": {
"type": "string",
"nullable": true
},
"bitbucketOwner": {
"type": "string",
"nullable": true
},
"bitbucketBranch": {
"type": "string",
"nullable": true
},
"bitbucketBuildPath": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"dockerImage": {
"type": "string",
"nullable": true
},
"customGitUrl": {
"type": "string",
"nullable": true
},
"customGitBranch": {
"type": "string",
"nullable": true
},
"customGitBuildPath": {
"type": "string",
"nullable": true
},
"customGitSSHKeyId": {
"type": "string",
"nullable": true
},
"dockerfile": {
"type": "string",
"nullable": true
},
"dockerContextPath": {
"type": "string",
"nullable": true
},
"dropBuildPath": {
"type": "string",
"nullable": true
},
"healthCheckSwarm": {
"type": "object",
"properties": {
"Test": {
"type": "array",
"items": {
"type": "string"
}
},
"Interval": {
"type": "number"
},
"Timeout": {
"type": "number"
},
"StartPeriod": {
"type": "number"
},
"Retries": {
"type": "number"
}
},
"additionalProperties": false,
"nullable": true
},
"restartPolicySwarm": {
"type": "object",
"properties": {
"Condition": {
"type": "string"
},
"Delay": {
"type": "number"
},
"MaxAttempts": {
"type": "number"
},
"Window": {
"type": "number"
}
},
"additionalProperties": false,
"nullable": true
},
"placementSwarm": {
"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"],
"additionalProperties": false
}
},
"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,
"nullable": true
},
"updateConfigSwarm": {
"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,
"nullable": true
},
"rollbackConfigSwarm": {
"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,
"nullable": true
},
"modeSwarm": {
"type": "object",
"properties": {
"Replicated": {
"type": "object",
"properties": {
"Replicas": {
"type": "number"
}
},
"additionalProperties": false
},
"Global": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"ReplicatedJob": {
"type": "object",
"properties": {
"MaxConcurrent": {
"type": "number"
},
"TotalCompletions": {
"type": "number"
}
},
"additionalProperties": false
},
"GlobalJob": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"additionalProperties": false,
"nullable": true
},
"labelsSwarm": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"networkSwarm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Target": {
"type": "string"
},
"Aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"DriverOpts": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"additionalProperties": false
},
"nullable": true
},
"replicas": {
"type": "number"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"buildType": {
"type": "string",
"enum": [
"dockerfile",
"heroku_buildpacks",
"paketo_buildpacks",
"nixpacks",
"static"
]
},
"publishDirectory": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"registryId": {
"type": "string",
"nullable": true
},
"projectId": {
"type": "string"
},
"githubId": {
"type": "string",
"nullable": true
},
"gitlabId": {
"type": "string",
"nullable": true
},
"bitbucketId": {
"type": "string",
"nullable": true
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.refreshToken": {
"post": {
"operationId": "application-refreshToken",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.deploy": {
"post": {
"operationId": "application-deploy",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.cleanQueues": {
"post": {
"operationId": "application-cleanQueues",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
}
},
"required": ["applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.readTraefikConfig": {
"get": {
"operationId": "application-readTraefikConfig",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "applicationId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.updateTraefikConfig": {
"post": {
"operationId": "application-updateTraefikConfig",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"traefikConfig": {
"type": "string"
}
},
"required": ["applicationId", "traefikConfig"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/application.readAppMonitoring": {
"get": {
"operationId": "application-readAppMonitoring",
"tags": ["application"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "appName",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.create": {
"post": {
"operationId": "mysql-create",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"dockerImage": {
"type": "string",
"default": "mysql:8"
},
"projectId": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"databaseRootPassword": {
"type": "string"
}
},
"required": [
"name",
"appName",
"projectId",
"databaseName",
"databaseUser",
"databasePassword",
"databaseRootPassword"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.one": {
"get": {
"operationId": "mysql-one",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "mysqlId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.start": {
"post": {
"operationId": "mysql-start",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.stop": {
"post": {
"operationId": "mysql-stop",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.saveExternalPort": {
"post": {
"operationId": "mysql-saveExternalPort",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
},
"externalPort": {
"type": "number",
"nullable": true
}
},
"required": ["mysqlId", "externalPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.deploy": {
"post": {
"operationId": "mysql-deploy",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.changeStatus": {
"post": {
"operationId": "mysql-changeStatus",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
}
},
"required": ["mysqlId", "applicationStatus"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.reload": {
"post": {
"operationId": "mysql-reload",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
},
"appName": {
"type": "string",
"minLength": 1
}
},
"required": ["mysqlId", "appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.remove": {
"post": {
"operationId": "mysql-remove",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.saveEnvironment": {
"post": {
"operationId": "mysql-saveEnvironment",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mysql.update": {
"post": {
"operationId": "mysql-update",
"tags": ["mysql"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mysqlId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"databaseRootPassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "mysql:8"
},
"command": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"externalPort": {
"type": "number",
"nullable": true
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"required": ["mysqlId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.create": {
"post": {
"operationId": "postgres-create",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string"
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "postgres:15"
},
"projectId": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"appName",
"databaseName",
"databaseUser",
"databasePassword",
"projectId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.one": {
"get": {
"operationId": "postgres-one",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "postgresId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.start": {
"post": {
"operationId": "postgres-start",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.stop": {
"post": {
"operationId": "postgres-stop",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.saveExternalPort": {
"post": {
"operationId": "postgres-saveExternalPort",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
},
"externalPort": {
"type": "number",
"nullable": true
}
},
"required": ["postgresId", "externalPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.deploy": {
"post": {
"operationId": "postgres-deploy",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.changeStatus": {
"post": {
"operationId": "postgres-changeStatus",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
}
},
"required": ["postgresId", "applicationStatus"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.remove": {
"post": {
"operationId": "postgres-remove",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.saveEnvironment": {
"post": {
"operationId": "postgres-saveEnvironment",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.reload": {
"post": {
"operationId": "postgres-reload",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string"
},
"appName": {
"type": "string"
}
},
"required": ["postgresId", "appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/postgres.update": {
"post": {
"operationId": "postgres-update",
"tags": ["postgres"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"postgresId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string"
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"dockerImage": {
"type": "string",
"default": "postgres:15"
},
"command": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"externalPort": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"required": ["postgresId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.create": {
"post": {
"operationId": "redis-create",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "redis:8"
},
"projectId": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"appName",
"databasePassword",
"projectId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.one": {
"get": {
"operationId": "redis-one",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "redisId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.start": {
"post": {
"operationId": "redis-start",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.reload": {
"post": {
"operationId": "redis-reload",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
},
"appName": {
"type": "string",
"minLength": 1
}
},
"required": ["redisId", "appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.stop": {
"post": {
"operationId": "redis-stop",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.saveExternalPort": {
"post": {
"operationId": "redis-saveExternalPort",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
},
"externalPort": {
"type": "number",
"nullable": true
}
},
"required": ["redisId", "externalPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.deploy": {
"post": {
"operationId": "redis-deploy",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.changeStatus": {
"post": {
"operationId": "redis-changeStatus",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
}
},
"required": ["redisId", "applicationStatus"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.remove": {
"post": {
"operationId": "redis-remove",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.saveEnvironment": {
"post": {
"operationId": "redis-saveEnvironment",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redis.update": {
"post": {
"operationId": "redis-update",
"tags": ["redis"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redisId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"databasePassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "redis:8"
},
"command": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"externalPort": {
"type": "number",
"nullable": true
},
"createdAt": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"projectId": {
"type": "string"
}
},
"required": ["redisId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.create": {
"post": {
"operationId": "mongo-create",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"dockerImage": {
"type": "string",
"default": "mongo:15"
},
"projectId": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
}
},
"required": [
"name",
"appName",
"projectId",
"databaseUser",
"databasePassword"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.one": {
"get": {
"operationId": "mongo-one",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "mongoId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.start": {
"post": {
"operationId": "mongo-start",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.stop": {
"post": {
"operationId": "mongo-stop",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.saveExternalPort": {
"post": {
"operationId": "mongo-saveExternalPort",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
},
"externalPort": {
"type": "number",
"nullable": true
}
},
"required": ["mongoId", "externalPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.deploy": {
"post": {
"operationId": "mongo-deploy",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.changeStatus": {
"post": {
"operationId": "mongo-changeStatus",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
}
},
"required": ["mongoId", "applicationStatus"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.reload": {
"post": {
"operationId": "mongo-reload",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
},
"appName": {
"type": "string",
"minLength": 1
}
},
"required": ["mongoId", "appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.remove": {
"post": {
"operationId": "mongo-remove",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.saveEnvironment": {
"post": {
"operationId": "mongo-saveEnvironment",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mongo.update": {
"post": {
"operationId": "mongo-update",
"tags": ["mongo"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mongoId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "mongo:15"
},
"command": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"externalPort": {
"type": "number",
"nullable": true
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"required": ["mongoId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.create": {
"post": {
"operationId": "mariadb-create",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"dockerImage": {
"type": "string",
"default": "mariadb:6"
},
"databaseRootPassword": {
"type": "string"
},
"projectId": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
}
},
"required": [
"name",
"appName",
"databaseRootPassword",
"projectId",
"databaseName",
"databaseUser",
"databasePassword"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.one": {
"get": {
"operationId": "mariadb-one",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "mariadbId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.start": {
"post": {
"operationId": "mariadb-start",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.stop": {
"post": {
"operationId": "mariadb-stop",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.saveExternalPort": {
"post": {
"operationId": "mariadb-saveExternalPort",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
},
"externalPort": {
"type": "number",
"nullable": true
}
},
"required": ["mariadbId", "externalPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.deploy": {
"post": {
"operationId": "mariadb-deploy",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.changeStatus": {
"post": {
"operationId": "mariadb-changeStatus",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
}
},
"required": ["mariadbId", "applicationStatus"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.remove": {
"post": {
"operationId": "mariadb-remove",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.saveEnvironment": {
"post": {
"operationId": "mariadb-saveEnvironment",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
},
"env": {
"type": "string",
"nullable": true
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.reload": {
"post": {
"operationId": "mariadb-reload",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string"
},
"appName": {
"type": "string",
"minLength": 1
}
},
"required": ["mariadbId", "appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mariadb.update": {
"post": {
"operationId": "mariadb-update",
"tags": ["mariadb"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mariadbId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"databaseName": {
"type": "string",
"minLength": 1
},
"databaseUser": {
"type": "string",
"minLength": 1
},
"databasePassword": {
"type": "string"
},
"databaseRootPassword": {
"type": "string"
},
"dockerImage": {
"type": "string",
"default": "mariadb:6"
},
"command": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"memoryReservation": {
"type": "number",
"nullable": true
},
"memoryLimit": {
"type": "number",
"nullable": true
},
"cpuReservation": {
"type": "number",
"nullable": true
},
"cpuLimit": {
"type": "number",
"nullable": true
},
"externalPort": {
"type": "number",
"nullable": true
},
"applicationStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"required": ["mariadbId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.create": {
"post": {
"operationId": "compose-create",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"projectId": {
"type": "string"
},
"composeType": {
"type": "string",
"enum": ["docker-compose", "stack"]
},
"appName": {
"type": "string"
}
},
"required": ["name", "projectId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.one": {
"get": {
"operationId": "compose-one",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.update": {
"post": {
"operationId": "compose-update",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"appName": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"env": {
"type": "string",
"nullable": true
},
"composeFile": {
"type": "string"
},
"refreshToken": {
"type": "string",
"nullable": true
},
"sourceType": {
"type": "string",
"enum": ["git", "github", "gitlab", "bitbucket", "raw"]
},
"composeType": {
"type": "string",
"enum": ["docker-compose", "stack"]
},
"repository": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"autoDeploy": {
"type": "boolean",
"nullable": true
},
"gitlabProjectId": {
"type": "number",
"nullable": true
},
"gitlabRepository": {
"type": "string",
"nullable": true
},
"gitlabOwner": {
"type": "string",
"nullable": true
},
"gitlabBranch": {
"type": "string",
"nullable": true
},
"gitlabPathNamespace": {
"type": "string",
"nullable": true
},
"bitbucketRepository": {
"type": "string",
"nullable": true
},
"bitbucketOwner": {
"type": "string",
"nullable": true
},
"bitbucketBranch": {
"type": "string",
"nullable": true
},
"customGitUrl": {
"type": "string",
"nullable": true
},
"customGitBranch": {
"type": "string",
"nullable": true
},
"customGitSSHKeyId": {
"type": "string",
"nullable": true
},
"command": {
"type": "string"
},
"composePath": {
"type": "string",
"minLength": 1
},
"composeStatus": {
"type": "string",
"enum": ["idle", "running", "done", "error"]
},
"projectId": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"githubId": {
"type": "string",
"nullable": true
},
"gitlabId": {
"type": "string",
"nullable": true
},
"bitbucketId": {
"type": "string",
"nullable": true
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.delete": {
"post": {
"operationId": "compose-delete",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.cleanQueues": {
"post": {
"operationId": "compose-cleanQueues",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.loadServices": {
"get": {
"operationId": "compose-loadServices",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"not": {}
},
{
"type": "string",
"enum": ["fetch", "cache"]
}
],
"default": "cache"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.fetchSourceType": {
"post": {
"operationId": "compose-fetchSourceType",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.randomizeCompose": {
"post": {
"operationId": "compose-randomizeCompose",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
},
"prefix": {
"type": "string"
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.getConvertedCompose": {
"get": {
"operationId": "compose-getConvertedCompose",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.deploy": {
"post": {
"operationId": "compose-deploy",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.redeploy": {
"post": {
"operationId": "compose-redeploy",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.stop": {
"post": {
"operationId": "compose-stop",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.getDefaultCommand": {
"get": {
"operationId": "compose-getDefaultCommand",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.refreshToken": {
"post": {
"operationId": "compose-refreshToken",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"composeId": {
"type": "string",
"minLength": 1
}
},
"required": ["composeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.deployTemplate": {
"post": {
"operationId": "compose-deployTemplate",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"projectId": {
"type": "string"
},
"id": {
"type": "string",
"minLength": 1
}
},
"required": ["projectId", "id"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.templates": {
"get": {
"operationId": "compose-templates",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/compose.getTags": {
"get": {
"operationId": "compose-getTags",
"tags": ["compose"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/user.all": {
"get": {
"operationId": "user-all",
"tags": ["user"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/user.byAuthId": {
"get": {
"operationId": "user-byAuthId",
"tags": ["user"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "authId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/user.byUserId": {
"get": {
"operationId": "user-byUserId",
"tags": ["user"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "userId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.create": {
"post": {
"operationId": "domain-create",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"host": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1,
"nullable": true
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535,
"nullable": true
},
"https": {
"type": "boolean"
},
"applicationId": {
"type": "string",
"nullable": true
},
"certificateType": {
"type": "string",
"enum": ["letsencrypt", "none"]
},
"composeId": {
"type": "string",
"nullable": true
},
"serviceName": {
"type": "string",
"nullable": true
},
"domainType": {
"type": "string",
"enum": ["compose", "application"],
"nullable": true
}
},
"required": ["host"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.byApplicationId": {
"get": {
"operationId": "domain-byApplicationId",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "applicationId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.byComposeId": {
"get": {
"operationId": "domain-byComposeId",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.generateDomain": {
"post": {
"operationId": "domain-generateDomain",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appName": {
"type": "string",
"minLength": 1
}
},
"required": ["appName"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.update": {
"post": {
"operationId": "domain-update",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"host": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1,
"nullable": true
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535,
"nullable": true
},
"https": {
"type": "boolean"
},
"certificateType": {
"type": "string",
"enum": ["letsencrypt", "none"]
},
"serviceName": {
"type": "string",
"nullable": true
},
"domainType": {
"type": "string",
"enum": ["compose", "application"],
"nullable": true
},
"domainId": {
"type": "string"
}
},
"required": ["host", "domainId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.one": {
"get": {
"operationId": "domain-one",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "domainId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/domain.delete": {
"post": {
"operationId": "domain-delete",
"tags": ["domain"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"domainId": {
"type": "string"
}
},
"required": ["domainId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.create": {
"post": {
"operationId": "destination-create",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"accessKey": {
"type": "string"
},
"bucket": {
"type": "string"
},
"region": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"secretAccessKey": {
"type": "string"
}
},
"required": [
"name",
"accessKey",
"bucket",
"region",
"endpoint",
"secretAccessKey"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.testConnection": {
"post": {
"operationId": "destination-testConnection",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"accessKey": {
"type": "string"
},
"bucket": {
"type": "string"
},
"region": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"secretAccessKey": {
"type": "string"
}
},
"required": [
"name",
"accessKey",
"bucket",
"region",
"endpoint",
"secretAccessKey"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.one": {
"get": {
"operationId": "destination-one",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "destinationId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.all": {
"get": {
"operationId": "destination-all",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.remove": {
"post": {
"operationId": "destination-remove",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"destinationId": {
"type": "string"
}
},
"required": ["destinationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/destination.update": {
"post": {
"operationId": "destination-update",
"tags": ["destination"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"accessKey": {
"type": "string"
},
"bucket": {
"type": "string"
},
"region": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"secretAccessKey": {
"type": "string"
},
"destinationId": {
"type": "string"
}
},
"required": [
"name",
"accessKey",
"bucket",
"region",
"endpoint",
"secretAccessKey",
"destinationId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.create": {
"post": {
"operationId": "backup-create",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "string"
},
"enabled": {
"type": "boolean",
"nullable": true
},
"prefix": {
"type": "string",
"minLength": 1
},
"destinationId": {
"type": "string"
},
"database": {
"type": "string",
"minLength": 1
},
"mariadbId": {
"type": "string",
"nullable": true
},
"mysqlId": {
"type": "string",
"nullable": true
},
"postgresId": {
"type": "string",
"nullable": true
},
"mongoId": {
"type": "string",
"nullable": true
},
"databaseType": {
"type": "string",
"enum": ["postgres", "mariadb", "mysql", "mongo"]
}
},
"required": [
"schedule",
"prefix",
"destinationId",
"database",
"databaseType"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.one": {
"get": {
"operationId": "backup-one",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "backupId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.update": {
"post": {
"operationId": "backup-update",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"type": "string"
},
"enabled": {
"type": "boolean",
"nullable": true
},
"prefix": {
"type": "string",
"minLength": 1
},
"backupId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"database": {
"type": "string",
"minLength": 1
}
},
"required": [
"schedule",
"prefix",
"backupId",
"destinationId",
"database"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.remove": {
"post": {
"operationId": "backup-remove",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": ["backupId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.manualBackupPostgres": {
"post": {
"operationId": "backup-manualBackupPostgres",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": ["backupId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.manualBackupMySql": {
"post": {
"operationId": "backup-manualBackupMySql",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": ["backupId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.manualBackupMariadb": {
"post": {
"operationId": "backup-manualBackupMariadb",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": ["backupId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/backup.manualBackupMongo": {
"post": {
"operationId": "backup-manualBackupMongo",
"tags": ["backup"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupId": {
"type": "string"
}
},
"required": ["backupId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/deployment.all": {
"get": {
"operationId": "deployment-all",
"tags": ["deployment"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "applicationId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/deployment.allByCompose": {
"get": {
"operationId": "deployment-allByCompose",
"tags": ["deployment"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "composeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mounts.create": {
"post": {
"operationId": "mounts-create",
"tags": ["mounts"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["bind", "volume", "file"]
},
"hostPath": {
"type": "string",
"nullable": true
},
"volumeName": {
"type": "string",
"nullable": true
},
"content": {
"type": "string",
"nullable": true
},
"mountPath": {
"type": "string",
"minLength": 1
},
"serviceType": {
"type": "string",
"enum": [
"application",
"postgres",
"mysql",
"mariadb",
"mongo",
"redis",
"compose"
],
"default": "application"
},
"filePath": {
"type": "string",
"nullable": true
},
"serviceId": {
"type": "string",
"minLength": 1
}
},
"required": ["type", "mountPath", "serviceId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mounts.remove": {
"post": {
"operationId": "mounts-remove",
"tags": ["mounts"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mountId": {
"type": "string"
}
},
"required": ["mountId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mounts.one": {
"get": {
"operationId": "mounts-one",
"tags": ["mounts"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "mountId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/mounts.update": {
"post": {
"operationId": "mounts-update",
"tags": ["mounts"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mountId": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": ["bind", "volume", "file"]
},
"hostPath": {
"type": "string",
"nullable": true
},
"volumeName": {
"type": "string",
"nullable": true
},
"filePath": {
"type": "string",
"nullable": true
},
"content": {
"type": "string",
"nullable": true
},
"serviceType": {
"type": "string",
"enum": [
"application",
"postgres",
"mysql",
"mariadb",
"mongo",
"redis",
"compose"
],
"default": "application"
},
"mountPath": {
"type": "string",
"minLength": 1
},
"applicationId": {
"type": "string",
"nullable": true
},
"postgresId": {
"type": "string",
"nullable": true
},
"mariadbId": {
"type": "string",
"nullable": true
},
"mongoId": {
"type": "string",
"nullable": true
},
"mysqlId": {
"type": "string",
"nullable": true
},
"redisId": {
"type": "string",
"nullable": true
},
"composeId": {
"type": "string",
"nullable": true
}
},
"required": ["mountId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/certificates.create": {
"post": {
"operationId": "certificates-create",
"tags": ["certificates"],
"security": [
{
"Authorization": []
}
],
"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": {
"type": "boolean",
"nullable": true
}
},
"required": ["name", "certificateData", "privateKey"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/certificates.one": {
"get": {
"operationId": "certificates-one",
"tags": ["certificates"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "certificateId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/certificates.remove": {
"post": {
"operationId": "certificates-remove",
"tags": ["certificates"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateId": {
"type": "string",
"minLength": 1
}
},
"required": ["certificateId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/certificates.all": {
"get": {
"operationId": "certificates-all",
"tags": ["certificates"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.reloadServer": {
"post": {
"operationId": "settings-reloadServer",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.reloadTraefik": {
"post": {
"operationId": "settings-reloadTraefik",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.toggleDashboard": {
"post": {
"operationId": "settings-toggleDashboard",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enableDashboard": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanUnusedImages": {
"post": {
"operationId": "settings-cleanUnusedImages",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanUnusedVolumes": {
"post": {
"operationId": "settings-cleanUnusedVolumes",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanStoppedContainers": {
"post": {
"operationId": "settings-cleanStoppedContainers",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanDockerBuilder": {
"post": {
"operationId": "settings-cleanDockerBuilder",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanDockerPrune": {
"post": {
"operationId": "settings-cleanDockerPrune",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanAll": {
"post": {
"operationId": "settings-cleanAll",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanMonitoring": {
"post": {
"operationId": "settings-cleanMonitoring",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.saveSSHPrivateKey": {
"post": {
"operationId": "settings-saveSSHPrivateKey",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sshPrivateKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.assignDomainServer": {
"post": {
"operationId": "settings-assignDomainServer",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"letsEncryptEmail": {
"type": "string",
"nullable": true
},
"host": {
"type": "string",
"nullable": true
},
"certificateType": {
"type": "string",
"enum": ["letsencrypt", "none"],
"default": "none"
}
},
"required": ["letsEncryptEmail", "host"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.cleanSSHPrivateKey": {
"post": {
"operationId": "settings-cleanSSHPrivateKey",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateDockerCleanup": {
"post": {
"operationId": "settings-updateDockerCleanup",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enableDockerCleanup": {
"type": "boolean"
}
},
"required": ["enableDockerCleanup"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readTraefikConfig": {
"get": {
"operationId": "settings-readTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateTraefikConfig": {
"post": {
"operationId": "settings-updateTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"traefikConfig": {
"type": "string",
"minLength": 1
}
},
"required": ["traefikConfig"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readWebServerTraefikConfig": {
"get": {
"operationId": "settings-readWebServerTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateWebServerTraefikConfig": {
"post": {
"operationId": "settings-updateWebServerTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"traefikConfig": {
"type": "string",
"minLength": 1
}
},
"required": ["traefikConfig"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readMiddlewareTraefikConfig": {
"get": {
"operationId": "settings-readMiddlewareTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateMiddlewareTraefikConfig": {
"post": {
"operationId": "settings-updateMiddlewareTraefikConfig",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"traefikConfig": {
"type": "string",
"minLength": 1
}
},
"required": ["traefikConfig"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.checkAndUpdateImage": {
"post": {
"operationId": "settings-checkAndUpdateImage",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateServer": {
"post": {
"operationId": "settings-updateServer",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.getDokployVersion": {
"get": {
"operationId": "settings-getDokployVersion",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readDirectories": {
"get": {
"operationId": "settings-readDirectories",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.updateTraefikFile": {
"post": {
"operationId": "settings-updateTraefikFile",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"traefikConfig": {
"type": "string",
"minLength": 1
}
},
"required": ["path", "traefikConfig"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readTraefikFile": {
"get": {
"operationId": "settings-readTraefikFile",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "path",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.getIp": {
"get": {
"operationId": "settings-getIp",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.getOpenApiDocument": {
"get": {
"operationId": "settings-getOpenApiDocument",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.readTraefikEnv": {
"get": {
"operationId": "settings-readTraefikEnv",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.writeTraefikEnv": {
"post": {
"operationId": "settings-writeTraefikEnv",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"env": {
"type": "string"
}
},
"required": ["env"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/settings.haveTraefikDashboardPortEnabled": {
"get": {
"operationId": "settings-haveTraefikDashboardPortEnabled",
"tags": ["settings"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/security.create": {
"post": {
"operationId": "security-create",
"tags": ["security"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applicationId": {
"type": "string"
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
}
},
"required": ["applicationId", "username", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/security.one": {
"get": {
"operationId": "security-one",
"tags": ["security"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "securityId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/security.delete": {
"post": {
"operationId": "security-delete",
"tags": ["security"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"securityId": {
"type": "string",
"minLength": 1
}
},
"required": ["securityId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/security.update": {
"post": {
"operationId": "security-update",
"tags": ["security"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"securityId": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
}
},
"required": ["securityId", "username", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redirects.create": {
"post": {
"operationId": "redirects-create",
"tags": ["redirects"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"regex": {
"type": "string",
"minLength": 1
},
"replacement": {
"type": "string",
"minLength": 1
},
"permanent": {
"type": "boolean"
},
"applicationId": {
"type": "string"
}
},
"required": [
"regex",
"replacement",
"permanent",
"applicationId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redirects.one": {
"get": {
"operationId": "redirects-one",
"tags": ["redirects"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "redirectId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redirects.delete": {
"post": {
"operationId": "redirects-delete",
"tags": ["redirects"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redirectId": {
"type": "string",
"minLength": 1
}
},
"required": ["redirectId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/redirects.update": {
"post": {
"operationId": "redirects-update",
"tags": ["redirects"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redirectId": {
"type": "string",
"minLength": 1
},
"regex": {
"type": "string",
"minLength": 1
},
"replacement": {
"type": "string",
"minLength": 1
},
"permanent": {
"type": "boolean"
}
},
"required": ["redirectId", "regex", "replacement", "permanent"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/port.create": {
"post": {
"operationId": "port-create",
"tags": ["port"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"publishedPort": {
"type": "number"
},
"targetPort": {
"type": "number"
},
"protocol": {
"type": "string",
"enum": ["tcp", "udp"],
"default": "tcp"
},
"applicationId": {
"type": "string",
"minLength": 1
}
},
"required": ["publishedPort", "targetPort", "applicationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/port.one": {
"get": {
"operationId": "port-one",
"tags": ["port"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "portId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/port.delete": {
"post": {
"operationId": "port-delete",
"tags": ["port"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"portId": {
"type": "string",
"minLength": 1
}
},
"required": ["portId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/port.update": {
"post": {
"operationId": "port-update",
"tags": ["port"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"portId": {
"type": "string",
"minLength": 1
},
"publishedPort": {
"type": "number"
},
"targetPort": {
"type": "number"
},
"protocol": {
"type": "string",
"enum": ["tcp", "udp"],
"default": "tcp"
}
},
"required": ["portId", "publishedPort", "targetPort"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.create": {
"post": {
"operationId": "registry-create",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registryName": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"registryUrl": {
"type": "string"
},
"registryType": {
"type": "string",
"enum": ["selfHosted", "cloud"]
},
"imagePrefix": {
"type": "string",
"nullable": true
}
},
"required": [
"registryName",
"username",
"password",
"registryUrl",
"registryType",
"imagePrefix"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.remove": {
"post": {
"operationId": "registry-remove",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registryId": {
"type": "string",
"minLength": 1
}
},
"required": ["registryId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.update": {
"post": {
"operationId": "registry-update",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registryId": {
"type": "string",
"minLength": 1
},
"registryName": {
"type": "string",
"minLength": 1
},
"imagePrefix": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"registryUrl": {
"type": "string",
"minLength": 1
},
"createdAt": {
"type": "string"
},
"registryType": {
"type": "string",
"enum": ["selfHosted", "cloud"]
},
"adminId": {
"type": "string",
"minLength": 1
}
},
"required": ["registryId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.all": {
"get": {
"operationId": "registry-all",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.one": {
"get": {
"operationId": "registry-one",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "registryId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.testRegistry": {
"post": {
"operationId": "registry-testRegistry",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registryName": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"registryUrl": {
"type": "string"
},
"registryType": {
"type": "string",
"enum": ["selfHosted", "cloud"]
},
"imagePrefix": {
"type": "string",
"nullable": true
}
},
"required": [
"registryName",
"username",
"password",
"registryUrl",
"registryType"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/registry.enableSelfHostedRegistry": {
"post": {
"operationId": "registry-enableSelfHostedRegistry",
"tags": ["registry"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registryUrl": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
}
},
"required": ["registryUrl", "username", "password"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/cluster.getNodes": {
"get": {
"operationId": "cluster-getNodes",
"tags": ["cluster"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/cluster.removeWorker": {
"post": {
"operationId": "cluster-removeWorker",
"tags": ["cluster"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
}
},
"required": ["nodeId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/cluster.addWorker": {
"get": {
"operationId": "cluster-addWorker",
"tags": ["cluster"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/cluster.addManager": {
"get": {
"operationId": "cluster-addManager",
"tags": ["cluster"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.createSlack": {
"post": {
"operationId": "notification-createSlack",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"webhookUrl": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string"
}
},
"required": [
"appBuildError",
"databaseBackup",
"dokployRestart",
"name",
"appDeploy",
"dockerCleanup",
"webhookUrl",
"channel"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.updateSlack": {
"post": {
"operationId": "notification-updateSlack",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"webhookUrl": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string"
},
"notificationId": {
"type": "string",
"minLength": 1
},
"slackId": {
"type": "string"
}
},
"required": ["notificationId", "slackId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.testSlackConnection": {
"post": {
"operationId": "notification-testSlackConnection",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"webhookUrl": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string"
}
},
"required": ["webhookUrl", "channel"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.createTelegram": {
"post": {
"operationId": "notification-createTelegram",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"botToken": {
"type": "string",
"minLength": 1
},
"chatId": {
"type": "string",
"minLength": 1
}
},
"required": [
"appBuildError",
"databaseBackup",
"dokployRestart",
"name",
"appDeploy",
"dockerCleanup",
"botToken",
"chatId"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.updateTelegram": {
"post": {
"operationId": "notification-updateTelegram",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"botToken": {
"type": "string",
"minLength": 1
},
"chatId": {
"type": "string",
"minLength": 1
},
"notificationId": {
"type": "string",
"minLength": 1
},
"telegramId": {
"type": "string",
"minLength": 1
}
},
"required": ["notificationId", "telegramId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.testTelegramConnection": {
"post": {
"operationId": "notification-testTelegramConnection",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"botToken": {
"type": "string",
"minLength": 1
},
"chatId": {
"type": "string",
"minLength": 1
}
},
"required": ["botToken", "chatId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.createDiscord": {
"post": {
"operationId": "notification-createDiscord",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"webhookUrl": {
"type": "string",
"minLength": 1
}
},
"required": [
"appBuildError",
"databaseBackup",
"dokployRestart",
"name",
"appDeploy",
"dockerCleanup",
"webhookUrl"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.updateDiscord": {
"post": {
"operationId": "notification-updateDiscord",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"webhookUrl": {
"type": "string",
"minLength": 1
},
"notificationId": {
"type": "string",
"minLength": 1
},
"discordId": {
"type": "string",
"minLength": 1
}
},
"required": ["notificationId", "discordId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.testDiscordConnection": {
"post": {
"operationId": "notification-testDiscordConnection",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"webhookUrl": {
"type": "string",
"minLength": 1
}
},
"required": ["webhookUrl"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.createEmail": {
"post": {
"operationId": "notification-createEmail",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"smtpServer": {
"type": "string",
"minLength": 1
},
"smtpPort": {
"type": "number",
"minimum": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"fromAddress": {
"type": "string",
"minLength": 1
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"appBuildError",
"databaseBackup",
"dokployRestart",
"name",
"appDeploy",
"dockerCleanup",
"smtpServer",
"smtpPort",
"username",
"password",
"fromAddress",
"toAddresses"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.updateEmail": {
"post": {
"operationId": "notification-updateEmail",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appBuildError": {
"type": "boolean"
},
"databaseBackup": {
"type": "boolean"
},
"dokployRestart": {
"type": "boolean"
},
"name": {
"type": "string"
},
"appDeploy": {
"type": "boolean"
},
"dockerCleanup": {
"type": "boolean"
},
"smtpServer": {
"type": "string",
"minLength": 1
},
"smtpPort": {
"type": "number",
"minimum": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"fromAddress": {
"type": "string",
"minLength": 1
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"notificationId": {
"type": "string",
"minLength": 1
},
"emailId": {
"type": "string",
"minLength": 1
}
},
"required": ["notificationId", "emailId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.testEmailConnection": {
"post": {
"operationId": "notification-testEmailConnection",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"smtpServer": {
"type": "string",
"minLength": 1
},
"smtpPort": {
"type": "number",
"minimum": 1
},
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"fromAddress": {
"type": "string",
"minLength": 1
}
},
"required": [
"smtpServer",
"smtpPort",
"username",
"password",
"toAddresses",
"fromAddress"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.remove": {
"post": {
"operationId": "notification-remove",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"notificationId": {
"type": "string"
}
},
"required": ["notificationId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.one": {
"get": {
"operationId": "notification-one",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "notificationId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/notification.all": {
"get": {
"operationId": "notification-all",
"tags": ["notification"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.create": {
"post": {
"operationId": "sshKey-create",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"publicKey": {
"type": "string"
},
"privateKey": {
"type": "string"
}
},
"required": ["name", "publicKey", "privateKey"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.remove": {
"post": {
"operationId": "sshKey-remove",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sshKeyId": {
"type": "string"
}
},
"required": ["sshKeyId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.one": {
"get": {
"operationId": "sshKey-one",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "sshKeyId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.all": {
"get": {
"operationId": "sshKey-all",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.generate": {
"post": {
"operationId": "sshKey-generate",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["rsa", "ed25519"]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/sshKey.update": {
"post": {
"operationId": "sshKey-update",
"tags": ["sshKey"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"lastUsedAt": {
"type": "string",
"nullable": true
},
"sshKeyId": {
"type": "string"
}
},
"required": ["sshKeyId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitProvider.getAll": {
"get": {
"operationId": "gitProvider-getAll",
"tags": ["gitProvider"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitProvider.remove": {
"post": {
"operationId": "gitProvider-remove",
"tags": ["gitProvider"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gitProviderId": {
"type": "string",
"minLength": 1
}
},
"required": ["gitProviderId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.create": {
"post": {
"operationId": "bitbucket-create",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string"
},
"bitbucketUsername": {
"type": "string"
},
"appPassword": {
"type": "string"
},
"bitbucketWorkspaceName": {
"type": "string"
},
"gitProviderId": {
"type": "string"
},
"authId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["authId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.one": {
"get": {
"operationId": "bitbucket-one",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "bitbucketId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.bitbucketProviders": {
"get": {
"operationId": "bitbucket-bitbucketProviders",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.getBitbucketRepositories": {
"get": {
"operationId": "bitbucket-getBitbucketRepositories",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "bitbucketId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.getBitbucketBranches": {
"get": {
"operationId": "bitbucket-getBitbucketBranches",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "owner",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bitbucketId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.testConnection": {
"post": {
"operationId": "bitbucket-testConnection",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string",
"minLength": 1
},
"bitbucketUsername": {
"type": "string"
},
"workspaceName": {
"type": "string"
}
},
"required": ["bitbucketId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/bitbucket.update": {
"post": {
"operationId": "bitbucket-update",
"tags": ["bitbucket"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bitbucketId": {
"type": "string",
"minLength": 1
},
"bitbucketUsername": {
"type": "string"
},
"appPassword": {
"type": "string",
"nullable": true
},
"bitbucketWorkspaceName": {
"type": "string"
},
"gitProviderId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["bitbucketId", "gitProviderId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.create": {
"post": {
"operationId": "gitlab-create",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gitlabId": {
"type": "string"
},
"applicationId": {
"type": "string"
},
"redirectUri": {
"type": "string"
},
"secret": {
"type": "string"
},
"accessToken": {
"type": "string",
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
},
"groupName": {
"type": "string"
},
"expiresAt": {
"type": "number",
"nullable": true
},
"gitProviderId": {
"type": "string"
},
"authId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["authId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.one": {
"get": {
"operationId": "gitlab-one",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "gitlabId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.gitlabProviders": {
"get": {
"operationId": "gitlab-gitlabProviders",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.getGitlabRepositories": {
"get": {
"operationId": "gitlab-getGitlabRepositories",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "gitlabId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.getGitlabBranches": {
"get": {
"operationId": "gitlab-getGitlabBranches",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "owner",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gitlabId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.testConnection": {
"post": {
"operationId": "gitlab-testConnection",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gitlabId": {
"type": "string"
},
"groupName": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitlab.update": {
"post": {
"operationId": "gitlab-update",
"tags": ["gitlab"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gitlabId": {
"type": "string",
"minLength": 1
},
"applicationId": {
"type": "string"
},
"redirectUri": {
"type": "string"
},
"secret": {
"type": "string"
},
"accessToken": {
"type": "string",
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
},
"groupName": {
"type": "string"
},
"expiresAt": {
"type": "number",
"nullable": true
},
"gitProviderId": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["gitlabId", "gitProviderId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.one": {
"get": {
"operationId": "github-one",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "githubId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.getGithubRepositories": {
"get": {
"operationId": "github-getGithubRepositories",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "githubId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.getGithubBranches": {
"get": {
"operationId": "github-getGithubBranches",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "repo",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "owner",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "githubId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.githubProviders": {
"get": {
"operationId": "github-githubProviders",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.testConnection": {
"post": {
"operationId": "github-testConnection",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"githubId": {
"type": "string",
"minLength": 1
}
},
"required": ["githubId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.update": {
"post": {
"operationId": "github-update",
"tags": ["github"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"githubId": {
"type": "string",
"minLength": 1
},
"githubAppName": {
"type": "string",
"nullable": true
},
"githubAppId": {
"type": "number",
"nullable": true
},
"githubClientId": {
"type": "string",
"nullable": true
},
"githubClientSecret": {
"type": "string",
"nullable": true
},
"githubInstallationId": {
"type": "string",
"nullable": true
},
"githubPrivateKey": {
"type": "string",
"nullable": true
},
"githubWebhookSecret": {
"type": "string",
"nullable": true
},
"gitProviderId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": ["githubId", "gitProviderId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
}
},
"components": {
"securitySchemes": {
"Authorization": {
"type": "http",
"scheme": "bearer"
}
},
"responses": {
"error": {
"description": "Error response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": ["message"],
"additionalProperties": false
}
}
},
"required": ["message", "code"],
"additionalProperties": false
}
}
}
}
}
},
"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"
}
],
"externalDocs": {
"url": "http://localhost:3000/api/settings.getOpenApiDocument"
}
}
Reference in New Issue View Git Blame Copy Permalink