compose

POST`/compose.create`

compose-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`name`
Required
string

Minimum length: 1

`description`string | null

`projectId`
Required
string

`composeType`string

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

`appName`string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.one?composeId=string"

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

POST`/compose.update`

compose-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`composeId`
Required
string

`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

curl -X POST "http://localhost:3000/api/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,
  "gitlabProjectId": 0,
  "gitlabRepository": "string",
  "gitlabOwner": "string",
  "gitlabBranch": "string",
  "gitlabPathNamespace": "string",
  "bitbucketRepository": "string",
  "bitbucketOwner": "string",
  "bitbucketBranch": "string",
  "customGitUrl": "string",
  "customGitBranch": "string",
  "customGitSSHKeyId": "string",
  "command": "string",
  "composePath": "string",
  "composeStatus": "idle",
  "projectId": "string",
  "createdAt": "string",
  "githubId": "string",
  "gitlabId": "string",
  "bitbucketId": "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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/compose.cleanQueues" \
  -d '{
  "composeId": "string"
}'

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

GET`/compose.loadServices`

compose-loadServices

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

`type`Any properties in not unknown, string

Default: "cache"

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.loadServices?composeId=string&type=cache"

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

POST`/compose.fetchSourceType`

compose-fetchSourceType

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`composeId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/compose.fetchSourceType" \
  -d '{
  "composeId": "string"
}'

{
  "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

`prefix`string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/compose.randomizeCompose" \
  -d '{
  "composeId": "string",
  "prefix": "string"
}'

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

GET`/compose.getConvertedCompose`

compose-getConvertedCompose

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`composeId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.getConvertedCompose?composeId=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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.getDefaultCommand?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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/compose.refreshToken" \
  -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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/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 code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.templates"

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

GET`/compose.getTags`

compose-getTags

Authorization

`Authorization`
Required
Bearer <token>

In: header

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/compose.getTags"

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

compose

POST/compose.create

AuthorizationRequiredBearer <token>

nameRequiredstring

descriptionstring | null

projectIdRequiredstring

composeTypestring

appNamestring

Response

Typescript

GET/compose.one

AuthorizationRequiredBearer <token>

composeIdRequiredstring

Response

Typescript

POST/compose.update

AuthorizationRequiredBearer <token>

composeIdRequiredstring

namestring

appNamestring

descriptionstring | null

envstring | null

composeFilestring

refreshTokenstring | null

sourceTypestring

composeTypestring

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

composeStatusstring

projectIdstring

createdAtstring

githubIdstring | null

gitlabIdstring | null

bitbucketIdstring | null

Response

Typescript

POST/compose.delete

AuthorizationRequiredBearer <token>

composeIdRequiredstring

Response

Typescript

POST/compose.cleanQueues

AuthorizationRequiredBearer <token>

composeIdRequiredstring

Response

Typescript

GET/compose.loadServices

AuthorizationRequiredBearer <token>

composeIdRequiredstring

typeAny properties in not unknown, string

Response

Typescript

POST/compose.fetchSourceType

AuthorizationRequiredBearer <token>

composeIdRequiredstring

Response

Typescript

POST/compose.randomizeCompose

AuthorizationRequiredBearer <token>

composeIdRequiredstring

prefixstring

Response

Typescript

GET/compose.getConvertedCompose

AuthorizationRequiredBearer <token>

POST`/compose.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`description`string | null

`projectId`
Required
string

`composeType`string

`appName`string

GET`/compose.one`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.update`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

`name`string

`appName`string

`description`string | null

`env`string | null

`composeFile`string

`refreshToken`string | null

`sourceType`string

`composeType`string

`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

`composeStatus`string

`projectId`string

`createdAt`string

`githubId`string | null

`gitlabId`string | null

`bitbucketId`string | null

POST`/compose.delete`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.cleanQueues`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

GET`/compose.loadServices`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

`type`Any properties in not unknown, string

POST`/compose.fetchSourceType`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.randomizeCompose`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

`prefix`string

GET`/compose.getConvertedCompose`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.deploy`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.redeploy`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.stop`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

GET`/compose.getDefaultCommand`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string

POST`/compose.refreshToken`

`Authorization`
Required
Bearer <token>

`composeId`
Required
string