Hawiyat

compose

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/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 codeDescription
200Successful response
defaultError 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

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/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,
  "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/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 codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/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/api/compose.allServices?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

prefixstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/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/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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/compose.getDefaultCommand?composeId=string"

{
  "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/api/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/api/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/api/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/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 codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/compose.templates"

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

Previous

cluster

Next

deployment

On this page

compose-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-templatesAuthorization