Compose
POST
/
compose.create
Compose create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
Requiredname
Requiredstring
Minimum length:
1
description
string | null
projectId
Requiredstring
composeType
string
Value in:
"docker-compose" | "stack"
appName
string
serverId
string | null
Successful response
GET
/
compose.one
Compose one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.update
Compose update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
name
string
Minimum length:
1
appName
string
description
string | null
env
string | null
composeFile
string
refreshToken
string | null
sourceType
string
Value in:
"git" | "github" | "gitlab" | "bitbucket" | "raw"
composeType
string
Value in:
"docker-compose" | "stack"
repository
string | null
owner
string | null
branch
string | null
autoDeploy
boolean | null
gitlabProjectId
number | null
gitlabRepository
string | null
gitlabOwner
string | null
gitlabBranch
string | null
gitlabPathNamespace
string | null
bitbucketRepository
string | null
bitbucketOwner
string | null
bitbucketBranch
string | null
customGitUrl
string | null
customGitBranch
string | null
customGitSSHKeyId
string | null
command
string
composePath
string
Minimum length:
1
suffix
string
randomize
boolean
composeStatus
string
Value in:
"idle" | "running" | "done" | "error"
projectId
string
createdAt
string
githubId
string | null
gitlabId
string | null
bitbucketId
string | null
Successful response
POST
/
compose.delete
Compose delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.cleanQueues
Compose clean Queues
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
GET
/
compose.loadServices
Compose load Services
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length:
1
type
Any properties in not unknown, string
Default:
"cache"
Successful response
POST
/
compose.fetchSourceType
Compose fetch Source Type
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.randomizeCompose
Compose randomize Compose
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
suffix
string
Successful response
GET
/
compose.getConvertedCompose
Compose get Converted Compose
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.deploy
Compose deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.redeploy
Compose redeploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.stop
Compose stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
GET
/
compose.getDefaultCommand
Compose get Default Command
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.refreshToken
Compose refresh Token
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredcomposeId
Requiredstring
Minimum length:
1
Successful response
POST
/
compose.deployTemplate
Compose deploy Template
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
application/json
RequiredprojectId
Requiredstring
id
Requiredstring
Minimum length:
1
serverId
string
Successful response
GET
/
compose.templates
Successful response
GET
/
compose.getTags
Successful response