compose
POST/compose.create
compose-create
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
name
Requiredstring
Minimum length: 1
description
string | null
projectId
Requiredstring
composeType
string
Value in: "docker-compose" | "stack"
appName
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.one
compose-one
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.update
compose-update
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
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
composeStatus
string
Value in: "idle" | "running" | "done" | "error"
projectId
string
createdAt
string
githubId
string | null
gitlabId
string | null
bitbucketId
string | null
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.delete
compose-delete
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.cleanQueues
compose-cleanQueues
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.loadServices
compose-loadServices
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
type
Any properties in not unknown, string
Default: "cache"
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.fetchSourceType
compose-fetchSourceType
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.randomizeCompose
compose-randomizeCompose
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
prefix
string
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.getConvertedCompose
compose-getConvertedCompose
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.deploy
compose-deploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.redeploy
compose-redeploy
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.stop
compose-stop
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.getDefaultCommand
compose-getDefaultCommand
Authorization
Authorization
RequiredBearer <token>
In: header
Query Parameters
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.refreshToken
compose-refreshToken
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
composeId
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
POST/compose.deployTemplate
compose-deployTemplate
Authorization
Authorization
RequiredBearer <token>
In: header
Request Body
projectId
Requiredstring
id
Requiredstring
Minimum length: 1
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.templates
compose-templates
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |
GET/compose.getTags
compose-getTags
Authorization
Authorization
RequiredBearer <token>
In: header
Status code | Description |
---|---|
200 | Successful response |
default | Error response |