Vexor

Vexor API

GET/admin.one

admin-one

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/admin.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/admin.createUserInvitation

admin-createUserInvitation

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

email
Required
string

Format: "email"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/admin.createUserInvitation" \
  -d '{
  "email": "user@example.com"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/admin.removeUser

admin-removeUser

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

authId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/admin.removeUser" \
  -d '{
  "authId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/admin.getUserByToken

admin-getUserByToken

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

token
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/admin.getUserByToken"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/admin.assignPermissions

admin-assignPermissions

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

userId
Required
string

Minimum length: 1

canCreateProjects
Required
boolean

canCreateServices
Required
boolean

canDeleteProjects
Required
boolean

canDeleteServices
Required
boolean

accesedProjects
Required
array of string

accesedServices
Required
array of string

canAccessToTraefikFiles
Required
boolean

canAccessToDocker
Required
boolean

canAccessToAPI
Required
boolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/admin.assignPermissions" \
  -d '{
  "userId": "string",
  "canCreateProjects": true,
  "canCreateServices": true,
  "canDeleteProjects": true,
  "canDeleteServices": true,
  "accesedProjects": [
    "string"
  ],
  "accesedServices": [
    "string"
  ],
  "canAccessToTraefikFiles": true,
  "canAccessToDocker": true,
  "canAccessToAPI": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/admin.cleanGithubApp

admin-cleanGithubApp

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/admin.cleanGithubApp"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/admin.getRepositories

admin-getRepositories

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/admin.getRepositories"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/admin.getBranches

admin-getBranches

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

repo
Required
string

Minimum length: 1

owner
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/admin.getBranches"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/admin.haveGithubConfigured

admin-haveGithubConfigured

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/admin.haveGithubConfigured"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getContainers

docker-getContainers

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/docker.getContainers"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getConfig

docker-getConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

containerId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/docker.getConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getContainersByAppNameMatch

docker-getContainersByAppNameMatch

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/docker.getContainersByAppNameMatch"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getContainersByAppLabel

docker-getContainersByAppLabel

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/docker.getContainersByAppLabel"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.createAdmin

auth-createAdmin

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

email
Required
string

Format: "email"

password
Required
string

Minimum length: 8
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.createAdmin" \
  -d '{
  "email": "user@example.com",
  "password": "stringst"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.createUser

auth-createUser

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

password
Required
string

Minimum length: 8

id
Required
string

token
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.createUser" \
  -d '{
  "password": "stringst",
  "id": "string",
  "token": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.login

auth-login

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

email
Required
string

Format: "email"

password
Required
string

Minimum length: 8
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.login" \
  -d '{
  "email": "user@example.com",
  "password": "stringst"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/auth.get

auth-get

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/auth.get"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.logout

auth-logout

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.logout"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.update

auth-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

idstring

email
Required
string | null

password
Required
string | null

rolstring

Value in: "admin" | "user"

imagestring

secretstring | null

tokenstring | null

is2FAEnabledboolean

createdAtstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.update" \
  -d '{
  "id": "string",
  "email": "string",
  "password": "string",
  "rol": "admin",
  "image": "string",
  "secret": "string",
  "token": "string",
  "is2FAEnabled": true,
  "createdAt": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.generateToken

auth-generateToken

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.generateToken"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/auth.one

auth-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

id
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/auth.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.updateByAdmin

auth-updateByAdmin

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

id
Required
string

Minimum length: 1

email
Required
string | null

password
Required
string | null

rolstring

Value in: "admin" | "user"

imagestring

secretstring | null

tokenstring | null

is2FAEnabledboolean

createdAtstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.updateByAdmin" \
  -d '{
  "id": "string",
  "email": "string",
  "password": "string",
  "rol": "admin",
  "image": "string",
  "secret": "string",
  "token": "string",
  "is2FAEnabled": true,
  "createdAt": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/auth.generate2FASecret

auth-generate2FASecret

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/auth.generate2FASecret"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.verify2FASetup

auth-verify2FASetup

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

pin
Required
string

Minimum length: 6

secret
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.verify2FASetup" \
  -d '{
  "pin": "string",
  "secret": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.verifyLogin2FA

auth-verifyLogin2FA

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

pin
Required
string

Minimum length: 6

id
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.verifyLogin2FA" \
  -d '{
  "pin": "string",
  "id": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.disable2FA

auth-disable2FA

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.disable2FA"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/auth.verifyToken

auth-verifyToken

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/auth.verifyToken"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/project.create

project-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/project.create" \
  -d '{
  "name": "string",
  "description": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/project.one

project-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/project.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/project.all

project-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/project.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/project.remove

project-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/project.remove" \
  -d '{
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/project.update

project-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

projectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/project.update" \
  -d '{
  "name": "string",
  "description": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.create

application-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appNamestring

descriptionstring | null

projectId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "description": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/application.one

application-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/application.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.reload

application-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appName
Required
string

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.reload" \
  -d '{
  "appName": "string",
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.delete

application-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.delete" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.stop

application-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.stop" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.start

application-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.start" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.redeploy

application-redeploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.redeploy" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.saveEnvironment

application-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.saveEnvironment" \
  -d '{
  "applicationId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.saveBuildType

application-saveBuildType

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

buildType
Required
string

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"

dockerfilestring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.saveBuildType" \
  -d '{
  "applicationId": "string",
  "buildType": "dockerfile",
  "dockerfile": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.saveGithubProvider

application-saveGithubProvider

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

repositorystring | null

branchstring | null

owner
Required
string | null

buildPathstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.saveGithubProvider" \
  -d '{
  "applicationId": "string",
  "repository": "string",
  "branch": "string",
  "owner": "string",
  "buildPath": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.saveDockerProvider

application-saveDockerProvider

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

dockerImagestring | null

applicationId
Required
string

usernamestring | null

passwordstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.saveDockerProvider" \
  -d '{
  "dockerImage": "string",
  "applicationId": "string",
  "username": "string",
  "password": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.saveGitProdiver

application-saveGitProdiver

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

customGitBranchstring | null

applicationId
Required
string

customGitBuildPathstring | null

customGitUrlstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.saveGitProdiver" \
  -d '{
  "customGitBranch": "string",
  "applicationId": "string",
  "customGitBuildPath": "string",
  "customGitUrl": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.generateSSHKey

application-generateSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.generateSSHKey" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.removeSSHKey

application-removeSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.removeSSHKey" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.markRunning

application-markRunning

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.markRunning" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.update

application-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

descriptionstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

titlestring | null

enabledboolean | null

subtitlestring | null

commandstring | null

refreshTokenstring | null

sourceTypestring

Value in: "github" | "docker" | "git"

repositorystring | null

ownerstring | null

branchstring | null

buildPathstring | null

autoDeployboolean | null

usernamestring | null

passwordstring | null

dockerImagestring | null

customGitUrlstring | null

customGitBranchstring | null

customGitBuildPathstring | null

customGitSSHKeystring | null

dockerfilestring | null

healthCheckSwarmobject | null

restartPolicySwarmobject | null

placementSwarmobject | null

updateConfigSwarmobject | null

rollbackConfigSwarmobject | null

modeSwarmobject | null

labelsSwarmobject | null

networkSwarmarray of object | null

replicasnumber

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

buildTypestring

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"

createdAtstring

registryIdstring | null

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.update" \
  -d '{
  "applicationId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "title": "string",
  "enabled": true,
  "subtitle": "string",
  "command": "string",
  "refreshToken": "string",
  "sourceType": "github",
  "repository": "string",
  "owner": "string",
  "branch": "string",
  "buildPath": "string",
  "autoDeploy": true,
  "username": "string",
  "password": "string",
  "dockerImage": "string",
  "customGitUrl": "string",
  "customGitBranch": "string",
  "customGitBuildPath": "string",
  "customGitSSHKey": "string",
  "dockerfile": "string",
  "healthCheckSwarm": {
    "Test": [
      "string"
    ],
    "Interval": 0,
    "Timeout": 0,
    "StartPeriod": 0,
    "Retries": 0
  },
  "restartPolicySwarm": {
    "Condition": "string",
    "Delay": 0,
    "MaxAttempts": 0,
    "Window": 0
  },
  "placementSwarm": {
    "Constraints": [
      "string"
    ],
    "Preferences": [
      {
        "Spread": {
          "SpreadDescriptor": "string"
        }
      }
    ],
    "MaxReplicas": 0,
    "Platforms": [
      {
        "Architecture": "string",
        "OS": "string"
      }
    ]
  },
  "updateConfigSwarm": {
    "Parallelism": 0,
    "Delay": 0,
    "FailureAction": "string",
    "Monitor": 0,
    "MaxFailureRatio": 0,
    "Order": "string"
  },
  "rollbackConfigSwarm": {
    "Parallelism": 0,
    "Delay": 0,
    "FailureAction": "string",
    "Monitor": 0,
    "MaxFailureRatio": 0,
    "Order": "string"
  },
  "modeSwarm": {
    "Replicated": {
      "Replicas": 0
    },
    "Global": {},
    "ReplicatedJob": {
      "MaxConcurrent": 0,
      "TotalCompletions": 0
    },
    "GlobalJob": {}
  },
  "labelsSwarm": {
    "property1": "string",
    "property2": "string"
  },
  "networkSwarm": [
    {
      "Target": "string",
      "Aliases": [
        "string"
      ],
      "DriverOpts": {}
    }
  ],
  "replicas": 0,
  "applicationStatus": "idle",
  "buildType": "dockerfile",
  "createdAt": "string",
  "registryId": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.refreshToken

application-refreshToken

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.refreshToken" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.deploy

application-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.deploy" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.cleanQueues

application-cleanQueues

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.cleanQueues" \
  -d '{
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/application.readTraefikConfig

application-readTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/application.readTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/application.updateTraefikConfig

application-updateTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

traefikConfig
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/application.updateTraefikConfig" \
  -d '{
  "applicationId": "string",
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/application.readAppMonitoring

application-readAppMonitoring

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

appName
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/application.readAppMonitoring"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.create

mysql-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

dockerImagestring

Default: "mysql:8"

projectId
Required
string

descriptionstring | null

databaseName
Required
string

Minimum length: 1

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

databaseRootPassword
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "dockerImage": "mysql:8",
  "projectId": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "databaseRootPassword": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/mysql.one

mysql-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mysqlId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/mysql.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.start

mysql-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.start" \
  -d '{
  "mysqlId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.stop

mysql-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.stop" \
  -d '{
  "mysqlId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.saveExternalPort

mysql-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.saveExternalPort" \
  -d '{
  "mysqlId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.deploy

mysql-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.deploy" \
  -d '{
  "mysqlId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.changeStatus

mysql-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.changeStatus" \
  -d '{
  "mysqlId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.reload

mysql-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.reload" \
  -d '{
  "mysqlId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.remove

mysql-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.remove" \
  -d '{
  "mysqlId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.saveEnvironment

mysql-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.saveEnvironment" \
  -d '{
  "mysqlId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mysql.update

mysql-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mysqlId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databaseNamestring

Minimum length: 1

databaseUserstring

Minimum length: 1

databasePasswordstring

databaseRootPasswordstring

dockerImagestring

Default: "mysql:8"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mysql.update" \
  -d '{
  "mysqlId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "databaseRootPassword": "string",
  "dockerImage": "mysql:8",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.create

postgres-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

databaseName
Required
string

Minimum length: 1

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

dockerImagestring

Default: "postgres:15"

projectId
Required
string

descriptionstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "dockerImage": "postgres:15",
  "projectId": "string",
  "description": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/postgres.one

postgres-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

postgresId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/postgres.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.start

postgres-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.start" \
  -d '{
  "postgresId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.stop

postgres-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.stop" \
  -d '{
  "postgresId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.saveExternalPort

postgres-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.saveExternalPort" \
  -d '{
  "postgresId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.deploy

postgres-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.deploy" \
  -d '{
  "postgresId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.changeStatus

postgres-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.changeStatus" \
  -d '{
  "postgresId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.remove

postgres-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.remove" \
  -d '{
  "postgresId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.saveEnvironment

postgres-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.saveEnvironment" \
  -d '{
  "postgresId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.reload

postgres-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

appName
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.reload" \
  -d '{
  "postgresId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/postgres.update

postgres-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

postgresId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

databaseNamestring

Minimum length: 1

databaseUserstring

Minimum length: 1

databasePasswordstring

descriptionstring | null

dockerImagestring

Default: "postgres:15"

commandstring | null

envstring | null

memoryReservationnumber | null

externalPortnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/postgres.update" \
  -d '{
  "postgresId": "string",
  "name": "string",
  "appName": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "description": "string",
  "dockerImage": "postgres:15",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "externalPort": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.create

redis-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

databasePassword
Required
string

dockerImagestring

Default: "redis:8"

projectId
Required
string

descriptionstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "databasePassword": "string",
  "dockerImage": "redis:8",
  "projectId": "string",
  "description": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/redis.one

redis-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/redis.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.start

redis-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.start" \
  -d '{
  "redisId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.reload

redis-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.reload" \
  -d '{
  "redisId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.stop

redis-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.stop" \
  -d '{
  "redisId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.saveExternalPort

redis-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.saveExternalPort" \
  -d '{
  "redisId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.deploy

redis-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.deploy" \
  -d '{
  "redisId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.changeStatus

redis-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.changeStatus" \
  -d '{
  "redisId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.remove

redis-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.remove" \
  -d '{
  "redisId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.saveEnvironment

redis-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.saveEnvironment" \
  -d '{
  "redisId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redis.update

redis-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databasePasswordstring

dockerImagestring

Default: "redis:8"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

createdAtstring

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redis.update" \
  -d '{
  "redisId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databasePassword": "string",
  "dockerImage": "redis:8",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "createdAt": "string",
  "applicationStatus": "idle",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.create

mongo-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

dockerImagestring

Default: "mongo:15"

projectId
Required
string

descriptionstring | null

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "dockerImage": "mongo:15",
  "projectId": "string",
  "description": "string",
  "databaseUser": "string",
  "databasePassword": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/mongo.one

mongo-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mongoId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/mongo.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.start

mongo-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.start" \
  -d '{
  "mongoId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.stop

mongo-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.stop" \
  -d '{
  "mongoId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.saveExternalPort

mongo-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.saveExternalPort" \
  -d '{
  "mongoId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.deploy

mongo-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.deploy" \
  -d '{
  "mongoId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.changeStatus

mongo-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.changeStatus" \
  -d '{
  "mongoId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.reload

mongo-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.reload" \
  -d '{
  "mongoId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.remove

mongo-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.remove" \
  -d '{
  "mongoId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.saveEnvironment

mongo-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.saveEnvironment" \
  -d '{
  "mongoId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mongo.update

mongo-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mongoId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databaseUserstring

Minimum length: 1

databasePasswordstring

dockerImagestring

Default: "mongo:15"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mongo.update" \
  -d '{
  "mongoId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "dockerImage": "mongo:15",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.create

mariadb-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

dockerImagestring

Default: "mariadb:6"

databaseRootPassword
Required
string

projectId
Required
string

descriptionstring | null

databaseName
Required
string

Minimum length: 1

databaseUser
Required
string

Minimum length: 1

databasePassword
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "dockerImage": "mariadb:6",
  "databaseRootPassword": "string",
  "projectId": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/mariadb.one

mariadb-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/mariadb.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.start

mariadb-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.start" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.stop

mariadb-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.stop" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.saveExternalPort

mariadb-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.saveExternalPort" \
  -d '{
  "mariadbId": "string",
  "externalPort": 0
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.deploy

mariadb-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.deploy" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.changeStatus

mariadb-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.changeStatus" \
  -d '{
  "mariadbId": "string",
  "applicationStatus": "idle"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.remove

mariadb-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.remove" \
  -d '{
  "mariadbId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.saveEnvironment

mariadb-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.saveEnvironment" \
  -d '{
  "mariadbId": "string",
  "env": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.reload

mariadb-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.reload" \
  -d '{
  "mariadbId": "string",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mariadb.update

mariadb-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mariadbId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databaseNamestring

Minimum length: 1

databaseUserstring

Minimum length: 1

databasePasswordstring

databaseRootPasswordstring

dockerImagestring

Default: "mariadb:6"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mariadb.update" \
  -d '{
  "mariadbId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "databaseRootPassword": "string",
  "dockerImage": "mariadb:6",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.create

compose-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

projectId
Required
string

composeTypestring

Value in: "docker-compose" | "stack"

appNamestring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.create" \
  -d '{
  "name": "string",
  "description": "string",
  "projectId": "string",
  "composeType": "docker-compose",
  "appName": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/compose.one

compose-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/compose.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.update

compose-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

namestring

Minimum length: 1

appNamestring

descriptionstring | null

envstring | null

composeFilestring

refreshTokenstring | null

sourceTypestring

Value in: "git" | "github" | "raw"

composeTypestring

Value in: "docker-compose" | "stack"

repositorystring | null

ownerstring | null

branchstring | null

autoDeployboolean | null

customGitUrlstring | null

customGitBranchstring | null

customGitSSHKeystring | null

commandstring

composePathstring

Minimum length: 1

composeStatusstring

Value in: "idle" | "running" | "done" | "error"

projectIdstring

createdAtstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.update" \
  -d '{
  "composeId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "env": "string",
  "composeFile": "string",
  "refreshToken": "string",
  "sourceType": "git",
  "composeType": "docker-compose",
  "repository": "string",
  "owner": "string",
  "branch": "string",
  "autoDeploy": true,
  "customGitUrl": "string",
  "customGitBranch": "string",
  "customGitSSHKey": "string",
  "command": "string",
  "composePath": "string",
  "composeStatus": "idle",
  "projectId": "string",
  "createdAt": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.delete

compose-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.delete" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.cleanQueues

compose-cleanQueues

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.cleanQueues" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/compose.allServices

compose-allServices

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/compose.allServices"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.randomizeCompose

compose-randomizeCompose

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1

prefixstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.randomizeCompose" \
  -d '{
  "composeId": "string",
  "prefix": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.deploy

compose-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.deploy" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.redeploy

compose-redeploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.redeploy" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.stop

compose-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.stop" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/compose.getDefaultCommand

compose-getDefaultCommand

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/compose.getDefaultCommand"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.generateSSHKey

compose-generateSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.generateSSHKey" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.refreshToken

compose-refreshToken

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.refreshToken" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.removeSSHKey

compose-removeSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.removeSSHKey" \
  -d '{
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/compose.deployTemplate

compose-deployTemplate

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

projectId
Required
string

id
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/compose.deployTemplate" \
  -d '{
  "projectId": "string",
  "id": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/compose.templates

compose-templates

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/compose.templates"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/user.all

user-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/user.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/user.byAuthId

user-byAuthId

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

authId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/user.byAuthId"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/user.byUserId

user-byUserId

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

userId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/user.byUserId"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.create

domain-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

host
Required
string

Minimum length: 1

path
Required
string | null

Minimum length: 1

port
Required
number | null

https
Required
boolean

applicationId
Required
string

certificateType
Required
string

Value in: "letsencrypt" | "none"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/domain.create" \
  -d '{
  "host": "string",
  "path": "string",
  "port": 0,
  "https": true,
  "applicationId": "string",
  "certificateType": "letsencrypt"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/domain.byApplicationId

domain-byApplicationId

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/domain.byApplicationId"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.update

domain-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

domainId
Required
string

Minimum length: 1

host
Required
string

Minimum length: 1

path
Required
string | null

Minimum length: 1

port
Required
number | null

https
Required
boolean

certificateType
Required
string

Value in: "letsencrypt" | "none"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/domain.update" \
  -d '{
  "domainId": "string",
  "host": "string",
  "path": "string",
  "port": 0,
  "https": true,
  "certificateType": "letsencrypt"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/domain.one

domain-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

domainId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/domain.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/domain.delete

domain-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

domainId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/domain.delete" \
  -d '{
  "domainId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.create

destination-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/destination.create" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.testConnection

destination-testConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/destination.testConnection" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/destination.one

destination-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/destination.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/destination.all

destination-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/destination.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.remove

destination-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/destination.remove" \
  -d '{
  "destinationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.update

destination-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/destination.update" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string",
  "destinationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.create

backup-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

schedule
Required
string

enabledboolean | null

prefix
Required
string

Minimum length: 1

destinationId
Required
string

database
Required
string

Minimum length: 1

mariadbIdstring | null

mysqlIdstring | null

postgresIdstring | null

mongoIdstring | null

databaseType
Required
string

Value in: "postgres" | "mariadb" | "mysql" | "mongo"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.create" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "destinationId": "string",
  "database": "string",
  "mariadbId": "string",
  "mysqlId": "string",
  "postgresId": "string",
  "mongoId": "string",
  "databaseType": "postgres"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/backup.one

backup-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/backup.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.update

backup-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

schedule
Required
string

enabledboolean | null

prefix
Required
string

Minimum length: 1

backupId
Required
string

destinationId
Required
string

database
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.update" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "backupId": "string",
  "destinationId": "string",
  "database": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.remove

backup-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.remove" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupPostgres

backup-manualBackupPostgres

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.manualBackupPostgres" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMySql

backup-manualBackupMySql

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.manualBackupMySql" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMariadb

backup-manualBackupMariadb

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.manualBackupMariadb" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/backup.manualBackupMongo

backup-manualBackupMongo

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

backupId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/backup.manualBackupMongo" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/deployment.all

deployment-all

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

applicationId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/deployment.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/deployment.allByCompose

deployment-allByCompose

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

composeId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/deployment.allByCompose"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mounts.create

mounts-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

type
Required
string

Value in: "bind" | "volume" | "file"

hostPathstring | null

volumeNamestring | null

contentstring | null

mountPath
Required
string

Minimum length: 1

serviceTypestring

Default: "application"Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"

serviceId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mounts.create" \
  -d '{
  "type": "bind",
  "hostPath": "string",
  "volumeName": "string",
  "content": "string",
  "mountPath": "string",
  "serviceType": "application",
  "serviceId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mounts.remove

mounts-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mountId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mounts.remove" \
  -d '{
  "mountId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/mounts.one

mounts-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mountId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/mounts.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/mounts.update

mounts-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

mountId
Required
string

Minimum length: 1

typestring

Value in: "bind" | "volume" | "file"

hostPathstring | null

volumeNamestring | null

contentstring | null

serviceTypestring

Default: "application"Value in: "application" | "postgres" | "mysql" | "mariadb" | "mongo" | "redis" | "compose"

mountPathstring

Minimum length: 1

applicationIdstring | null

postgresIdstring | null

mariadbIdstring | null

mongoIdstring | null

mysqlIdstring | null

redisIdstring | null

composeIdstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/mounts.update" \
  -d '{
  "mountId": "string",
  "type": "bind",
  "hostPath": "string",
  "volumeName": "string",
  "content": "string",
  "serviceType": "application",
  "mountPath": "string",
  "applicationId": "string",
  "postgresId": "string",
  "mariadbId": "string",
  "mongoId": "string",
  "mysqlId": "string",
  "redisId": "string",
  "composeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/certificates.create

certificates-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

certificateIdstring

name
Required
string

Minimum length: 1

certificateData
Required
string

Minimum length: 1

privateKey
Required
string

Minimum length: 1

certificatePathstring

autoRenewboolean | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/certificates.create" \
  -d '{
  "certificateId": "string",
  "name": "string",
  "certificateData": "string",
  "privateKey": "string",
  "certificatePath": "string",
  "autoRenew": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/certificates.one

certificates-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

certificateId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/certificates.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/certificates.remove

certificates-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

certificateId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/certificates.remove" \
  -d '{
  "certificateId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/certificates.all

certificates-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/certificates.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.reloadServer

settings-reloadServer

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.reloadServer"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.reloadTraefik

settings-reloadTraefik

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.reloadTraefik"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanUnusedImages

settings-cleanUnusedImages

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanUnusedImages"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanUnusedVolumes

settings-cleanUnusedVolumes

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanUnusedVolumes"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanStoppedContainers

settings-cleanStoppedContainers

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanStoppedContainers"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanDockerBuilder

settings-cleanDockerBuilder

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanDockerBuilder"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanDockerPrune

settings-cleanDockerPrune

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanDockerPrune"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanAll

settings-cleanAll

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanAll"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanMonitoring

settings-cleanMonitoring

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanMonitoring"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.saveSSHPrivateKey

settings-saveSSHPrivateKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

sshPrivateKeystring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.saveSSHPrivateKey" \
  -d '{
  "sshPrivateKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.assignDomainServer

settings-assignDomainServer

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

letsEncryptEmail
Required
string | null

host
Required
string | null

certificateTypestring

Default: "none"Value in: "letsencrypt" | "none"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.assignDomainServer" \
  -d '{
  "letsEncryptEmail": "string",
  "host": "string",
  "certificateType": "letsencrypt"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.cleanSSHPrivateKey

settings-cleanSSHPrivateKey

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.cleanSSHPrivateKey"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateDockerCleanup

settings-updateDockerCleanup

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

enableDockerCleanup
Required
boolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateDockerCleanup" \
  -d '{
  "enableDockerCleanup": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readTraefikConfig

settings-readTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.readTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateTraefikConfig

settings-updateTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readWebServerTraefikConfig

settings-readWebServerTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.readWebServerTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateWebServerTraefikConfig

settings-updateWebServerTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateWebServerTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readMiddlewareTraefikConfig

settings-readMiddlewareTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.readMiddlewareTraefikConfig"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateMiddlewareTraefikConfig

settings-updateMiddlewareTraefikConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateMiddlewareTraefikConfig" \
  -d '{
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.checkAndUpdateImage

settings-checkAndUpdateImage

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.checkAndUpdateImage"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateServer

settings-updateServer

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateServer"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.getVexorVersion

settings-getVexorVersion

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.getVexorVersion"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readDirectories

settings-readDirectories

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.readDirectories"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/settings.updateTraefikFile

settings-updateTraefikFile

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

path
Required
string

Minimum length: 1

traefikConfig
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/settings.updateTraefikFile" \
  -d '{
  "path": "string",
  "traefikConfig": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.readTraefikFile

settings-readTraefikFile

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

path
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.readTraefikFile"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/settings.getOpenApiDocument

settings-getOpenApiDocument

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/settings.getOpenApiDocument"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/security.create

security-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/security.create" \
  -d '{
  "applicationId": "string",
  "username": "string",
  "password": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/security.one

security-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

securityId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/security.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/security.delete

security-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

securityId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/security.delete" \
  -d '{
  "securityId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/security.update

security-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

securityId
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/security.update" \
  -d '{
  "securityId": "string",
  "username": "string",
  "password": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redirects.create

redirects-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

regex
Required
string

Minimum length: 1

replacement
Required
string

Minimum length: 1

permanent
Required
boolean

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redirects.create" \
  -d '{
  "regex": "string",
  "replacement": "string",
  "permanent": true,
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/redirects.one

redirects-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

redirectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/redirects.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redirects.delete

redirects-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redirectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redirects.delete" \
  -d '{
  "redirectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redirects.update

redirects-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redirectId
Required
string

Minimum length: 1

regex
Required
string

Minimum length: 1

replacement
Required
string

Minimum length: 1

permanent
Required
boolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/redirects.update" \
  -d '{
  "redirectId": "string",
  "regex": "string",
  "replacement": "string",
  "permanent": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/port.create

port-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

publishedPort
Required
number

targetPort
Required
number

protocolstring

Default: "tcp"Value in: "tcp" | "udp"

applicationId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/port.create" \
  -d '{
  "publishedPort": 0,
  "targetPort": 0,
  "protocol": "tcp",
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/port.one

port-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

portId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/port.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/port.delete

port-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

portId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/port.delete" \
  -d '{
  "portId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/port.update

port-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

portId
Required
string

Minimum length: 1

publishedPort
Required
number

targetPort
Required
number

protocolstring

Default: "tcp"Value in: "tcp" | "udp"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/port.update" \
  -d '{
  "portId": "string",
  "publishedPort": 0,
  "targetPort": 0,
  "protocol": "tcp"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.create

registry-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryName
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

registryUrl
Required
string

registryType
Required
string

Value in: "selfHosted" | "cloud"

imagePrefix
Required
string | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/registry.create" \
  -d '{
  "registryName": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "registryType": "selfHosted",
  "imagePrefix": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.remove

registry-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/registry.remove" \
  -d '{
  "registryId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.update

registry-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryId
Required
string

Minimum length: 1

registryNamestring

Minimum length: 1

imagePrefixstring | null

usernamestring

Minimum length: 1

passwordstring

Minimum length: 1

registryUrlstring

Minimum length: 1

createdAtstring

registryTypestring

Value in: "selfHosted" | "cloud"

adminIdstring

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/registry.update" \
  -d '{
  "registryId": "string",
  "registryName": "string",
  "imagePrefix": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "createdAt": "string",
  "registryType": "selfHosted",
  "adminId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/registry.all

registry-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/registry.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/registry.one

registry-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

registryId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/registry.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.testRegistry

registry-testRegistry

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryName
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

registryUrl
Required
string

registryType
Required
string

Value in: "selfHosted" | "cloud"

imagePrefixstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/registry.testRegistry" \
  -d '{
  "registryName": "string",
  "username": "string",
  "password": "string",
  "registryUrl": "string",
  "registryType": "selfHosted",
  "imagePrefix": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/registry.enableSelfHostedRegistry

registry-enableSelfHostedRegistry

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

registryUrl
Required
string

Minimum length: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/registry.enableSelfHostedRegistry" \
  -d '{
  "registryUrl": "string",
  "username": "string",
  "password": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/cluster.getNodes

cluster-getNodes

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/cluster.getNodes"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/cluster.removeWorker

cluster-removeWorker

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

nodeId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/cluster.removeWorker" \
  -d '{
  "nodeId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/cluster.addWorker

cluster-addWorker

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/cluster.addWorker"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/cluster.addManager

cluster-addManager

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/cluster.addManager"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Next

Vexor API

On this page

admin-oneAuthorizationadmin-createUserInvitationAuthorizationRequest Bodyadmin-removeUserAuthorizationRequest Bodyadmin-getUserByTokenAuthorizationQuery Parametersadmin-assignPermissionsAuthorizationRequest Bodyadmin-cleanGithubAppAuthorizationadmin-getRepositoriesAuthorizationadmin-getBranchesAuthorizationQuery Parametersadmin-haveGithubConfiguredAuthorizationdocker-getContainersAuthorizationdocker-getConfigAuthorizationQuery Parametersdocker-getContainersByAppNameMatchAuthorizationQuery Parametersdocker-getContainersByAppLabelAuthorizationQuery Parametersauth-createAdminAuthorizationRequest Bodyauth-createUserAuthorizationRequest Bodyauth-loginAuthorizationRequest Bodyauth-getAuthorizationauth-logoutAuthorizationauth-updateAuthorizationRequest Bodyauth-generateTokenAuthorizationauth-oneAuthorizationQuery Parametersauth-updateByAdminAuthorizationRequest Bodyauth-generate2FASecretAuthorizationauth-verify2FASetupAuthorizationRequest Bodyauth-verifyLogin2FAAuthorizationRequest Bodyauth-disable2FAAuthorizationauth-verifyTokenAuthorizationproject-createAuthorizationRequest Bodyproject-oneAuthorizationQuery Parametersproject-allAuthorizationproject-removeAuthorizationRequest Bodyproject-updateAuthorizationRequest Bodyapplication-createAuthorizationRequest Bodyapplication-oneAuthorizationQuery Parametersapplication-reloadAuthorizationRequest Bodyapplication-deleteAuthorizationRequest Bodyapplication-stopAuthorizationRequest Bodyapplication-startAuthorizationRequest Bodyapplication-redeployAuthorizationRequest Bodyapplication-saveEnvironmentAuthorizationRequest Bodyapplication-saveBuildTypeAuthorizationRequest Bodyapplication-saveGithubProviderAuthorizationRequest Bodyapplication-saveDockerProviderAuthorizationRequest Bodyapplication-saveGitProdiverAuthorizationRequest Bodyapplication-generateSSHKeyAuthorizationRequest Bodyapplication-removeSSHKeyAuthorizationRequest Bodyapplication-markRunningAuthorizationRequest Bodyapplication-updateAuthorizationRequest Bodyapplication-refreshTokenAuthorizationRequest Bodyapplication-deployAuthorizationRequest Bodyapplication-cleanQueuesAuthorizationRequest Bodyapplication-readTraefikConfigAuthorizationQuery Parametersapplication-updateTraefikConfigAuthorizationRequest Bodyapplication-readAppMonitoringAuthorizationQuery Parametersmysql-createAuthorizationRequest Bodymysql-oneAuthorizationQuery Parametersmysql-startAuthorizationRequest Bodymysql-stopAuthorizationRequest Bodymysql-saveExternalPortAuthorizationRequest Bodymysql-deployAuthorizationRequest Bodymysql-changeStatusAuthorizationRequest Bodymysql-reloadAuthorizationRequest Bodymysql-removeAuthorizationRequest Bodymysql-saveEnvironmentAuthorizationRequest Bodymysql-updateAuthorizationRequest Bodypostgres-createAuthorizationRequest Bodypostgres-oneAuthorizationQuery Parameterspostgres-startAuthorizationRequest Bodypostgres-stopAuthorizationRequest Bodypostgres-saveExternalPortAuthorizationRequest Bodypostgres-deployAuthorizationRequest Bodypostgres-changeStatusAuthorizationRequest Bodypostgres-removeAuthorizationRequest Bodypostgres-saveEnvironmentAuthorizationRequest Bodypostgres-reloadAuthorizationRequest Bodypostgres-updateAuthorizationRequest Bodyredis-createAuthorizationRequest Bodyredis-oneAuthorizationQuery Parametersredis-startAuthorizationRequest Bodyredis-reloadAuthorizationRequest Bodyredis-stopAuthorizationRequest Bodyredis-saveExternalPortAuthorizationRequest Bodyredis-deployAuthorizationRequest Bodyredis-changeStatusAuthorizationRequest Bodyredis-removeAuthorizationRequest Bodyredis-saveEnvironmentAuthorizationRequest Bodyredis-updateAuthorizationRequest Bodymongo-createAuthorizationRequest Bodymongo-oneAuthorizationQuery Parametersmongo-startAuthorizationRequest Bodymongo-stopAuthorizationRequest Bodymongo-saveExternalPortAuthorizationRequest Bodymongo-deployAuthorizationRequest Bodymongo-changeStatusAuthorizationRequest Bodymongo-reloadAuthorizationRequest Bodymongo-removeAuthorizationRequest Bodymongo-saveEnvironmentAuthorizationRequest Bodymongo-updateAuthorizationRequest Bodymariadb-createAuthorizationRequest Bodymariadb-oneAuthorizationQuery Parametersmariadb-startAuthorizationRequest Bodymariadb-stopAuthorizationRequest Bodymariadb-saveExternalPortAuthorizationRequest Bodymariadb-deployAuthorizationRequest Bodymariadb-changeStatusAuthorizationRequest Bodymariadb-removeAuthorizationRequest Bodymariadb-saveEnvironmentAuthorizationRequest Bodymariadb-reloadAuthorizationRequest Bodymariadb-updateAuthorizationRequest Bodycompose-createAuthorizationRequest Bodycompose-oneAuthorizationQuery Parameterscompose-updateAuthorizationRequest Bodycompose-deleteAuthorizationRequest Bodycompose-cleanQueuesAuthorizationRequest Bodycompose-allServicesAuthorizationQuery Parameterscompose-randomizeComposeAuthorizationRequest Bodycompose-deployAuthorizationRequest Bodycompose-redeployAuthorizationRequest Bodycompose-stopAuthorizationRequest Bodycompose-getDefaultCommandAuthorizationQuery Parameterscompose-generateSSHKeyAuthorizationRequest Bodycompose-refreshTokenAuthorizationRequest Bodycompose-removeSSHKeyAuthorizationRequest Bodycompose-deployTemplateAuthorizationRequest Bodycompose-templatesAuthorizationuser-allAuthorizationuser-byAuthIdAuthorizationQuery Parametersuser-byUserIdAuthorizationQuery Parametersdomain-createAuthorizationRequest Bodydomain-byApplicationIdAuthorizationQuery Parametersdomain-updateAuthorizationRequest Bodydomain-oneAuthorizationQuery Parametersdomain-deleteAuthorizationRequest Bodydestination-createAuthorizationRequest Bodydestination-testConnectionAuthorizationRequest Bodydestination-oneAuthorizationQuery Parametersdestination-allAuthorizationdestination-removeAuthorizationRequest Bodydestination-updateAuthorizationRequest Bodybackup-createAuthorizationRequest Bodybackup-oneAuthorizationQuery Parametersbackup-updateAuthorizationRequest Bodybackup-removeAuthorizationRequest Bodybackup-manualBackupPostgresAuthorizationRequest Bodybackup-manualBackupMySqlAuthorizationRequest Bodybackup-manualBackupMariadbAuthorizationRequest Bodybackup-manualBackupMongoAuthorizationRequest Bodydeployment-allAuthorizationQuery Parametersdeployment-allByComposeAuthorizationQuery Parametersmounts-createAuthorizationRequest Bodymounts-removeAuthorizationRequest Bodymounts-oneAuthorizationQuery Parametersmounts-updateAuthorizationRequest Bodycertificates-createAuthorizationRequest Bodycertificates-oneAuthorizationQuery Parameterscertificates-removeAuthorizationRequest Bodycertificates-allAuthorizationsettings-reloadServerAuthorizationsettings-reloadTraefikAuthorizationsettings-cleanUnusedImagesAuthorizationsettings-cleanUnusedVolumesAuthorizationsettings-cleanStoppedContainersAuthorizationsettings-cleanDockerBuilderAuthorizationsettings-cleanDockerPruneAuthorizationsettings-cleanAllAuthorizationsettings-cleanMonitoringAuthorizationsettings-saveSSHPrivateKeyAuthorizationRequest Bodysettings-assignDomainServerAuthorizationRequest Bodysettings-cleanSSHPrivateKeyAuthorizationsettings-updateDockerCleanupAuthorizationRequest Bodysettings-readTraefikConfigAuthorizationsettings-updateTraefikConfigAuthorizationRequest Bodysettings-readWebServerTraefikConfigAuthorizationsettings-updateWebServerTraefikConfigAuthorizationRequest Bodysettings-readMiddlewareTraefikConfigAuthorizationsettings-updateMiddlewareTraefikConfigAuthorizationRequest Bodysettings-checkAndUpdateImageAuthorizationsettings-updateServerAuthorizationsettings-getVexorVersionAuthorizationsettings-readDirectoriesAuthorizationsettings-updateTraefikFileAuthorizationRequest Bodysettings-readTraefikFileAuthorizationQuery Parameterssettings-getOpenApiDocumentAuthorizationsecurity-createAuthorizationRequest Bodysecurity-oneAuthorizationQuery Parameterssecurity-deleteAuthorizationRequest Bodysecurity-updateAuthorizationRequest Bodyredirects-createAuthorizationRequest Bodyredirects-oneAuthorizationQuery Parametersredirects-deleteAuthorizationRequest Bodyredirects-updateAuthorizationRequest Bodyport-createAuthorizationRequest Bodyport-oneAuthorizationQuery Parametersport-deleteAuthorizationRequest Bodyport-updateAuthorizationRequest Bodyregistry-createAuthorizationRequest Bodyregistry-removeAuthorizationRequest Bodyregistry-updateAuthorizationRequest Bodyregistry-allAuthorizationregistry-oneAuthorizationQuery Parametersregistry-testRegistryAuthorizationRequest Bodyregistry-enableSelfHostedRegistryAuthorizationRequest Bodycluster-getNodesAuthorizationcluster-removeWorkerAuthorizationRequest Bodycluster-addWorkerAuthorizationcluster-addManagerAuthorization