Compose
POST
/
compose.createCompose create
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequirednameRequiredstring
Minimum length:
1descriptionstring | null
projectIdRequiredstring
composeTypestring
Value in:
"docker-compose" | "stack"appNamestring
serverIdstring | null
Successful response
GET
/
compose.oneCompose one
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
composeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.updateCompose update
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
namestring
Minimum length:
1appNamestring
descriptionstring | null
envstring | null
composeFilestring
refreshTokenstring | null
sourceTypestring
Value in:
"git" | "github" | "gitlab" | "bitbucket" | "raw"composeTypestring
Value in:
"docker-compose" | "stack"repositorystring | null
ownerstring | null
branchstring | null
autoDeployboolean | null
gitlabProjectIdnumber | null
gitlabRepositorystring | null
gitlabOwnerstring | null
gitlabBranchstring | null
gitlabPathNamespacestring | null
bitbucketRepositorystring | null
bitbucketOwnerstring | null
bitbucketBranchstring | null
customGitUrlstring | null
customGitBranchstring | null
customGitSSHKeyIdstring | null
commandstring
composePathstring
Minimum length:
1suffixstring
randomizeboolean
composeStatusstring
Value in:
"idle" | "running" | "done" | "error"projectIdstring
createdAtstring
githubIdstring | null
gitlabIdstring | null
bitbucketIdstring | null
Successful response
POST
/
compose.deleteCompose delete
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.cleanQueuesCompose clean Queues
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
GET
/
compose.loadServicesCompose load Services
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
composeIdRequiredstring
Minimum length:
1typeAny properties in not unknown, string
Default:
"cache"Successful response
POST
/
compose.fetchSourceTypeCompose fetch Source Type
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.randomizeComposeCompose randomize Compose
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1suffixstring
Successful response
GET
/
compose.getConvertedComposeCompose get Converted Compose
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
composeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.deployCompose deploy
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.redeployCompose redeploy
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.stopCompose stop
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
GET
/
compose.getDefaultCommandCompose get Default Command
Authorization
AuthorizationRequiredBearer <token>
In: header
Query Parameters
composeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.refreshTokenCompose refresh Token
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredcomposeIdRequiredstring
Minimum length:
1Successful response
POST
/
compose.deployTemplateCompose deploy Template
Authorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequiredprojectIdRequiredstring
idRequiredstring
Minimum length:
1serverIdstring
Successful response
GET
/
compose.templatesSuccessful response
GET
/
compose.getTagsSuccessful response