application

POST`/application.create`

application-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`name`
Required
string

Minimum length: 1

`appName`string

`description`string | null

`projectId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "description": "string",
  "projectId": "string"
}'

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

GET`/application.one`

application-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`applicationId`
Required
string

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

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

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

POST`/application.reload`

application-reload

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`appName`
Required
string

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.reload" \
  -d '{
  "appName": "string",
  "applicationId": "string"
}'

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

POST`/application.delete`

application-delete

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.delete" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.stop`

application-stop

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.stop" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.start`

application-start

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.start" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.redeploy`

application-redeploy

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.redeploy" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.saveEnvironment`

application-saveEnvironment

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

`env`string | null

`buildArgs`string | null

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

curl -X POST "http://localhost:3000/api/application.saveEnvironment" \
  -d '{
  "applicationId": "string",
  "env": "string",
  "buildArgs": "string"
}'

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

POST`/application.saveBuildType`

application-saveBuildType

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

`buildType`
Required
string

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"

`dockerfile`string | null

`dockerContextPath`
Required
string | null

`publishDirectory`string | null

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

curl -X POST "http://localhost:3000/api/application.saveBuildType" \
  -d '{
  "applicationId": "string",
  "buildType": "dockerfile",
  "dockerfile": "string",
  "dockerContextPath": "string",
  "publishDirectory": "string"
}'

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

POST`/application.saveGithubProvider`

application-saveGithubProvider

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

`repository`string | null

`branch`string | null

`owner`
Required
string | null

`buildPath`string | null

`githubId`
Required
string | null

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

curl -X POST "http://localhost:3000/api/application.saveGithubProvider" \
  -d '{
  "applicationId": "string",
  "repository": "string",
  "branch": "string",
  "owner": "string",
  "buildPath": "string",
  "githubId": "string"
}'

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

POST`/application.saveGitlabProvider`

application-saveGitlabProvider

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

`gitlabBranch`
Required
string | null

`gitlabBuildPath`
Required
string | null

`gitlabOwner`
Required
string | null

`gitlabRepository`
Required
string | null

`gitlabId`
Required
string | null

`gitlabProjectId`
Required
number | null

`gitlabPathNamespace`
Required
string | null

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

curl -X POST "http://localhost:3000/api/application.saveGitlabProvider" \
  -d '{
  "applicationId": "string",
  "gitlabBranch": "string",
  "gitlabBuildPath": "string",
  "gitlabOwner": "string",
  "gitlabRepository": "string",
  "gitlabId": "string",
  "gitlabProjectId": 0,
  "gitlabPathNamespace": "string"
}'

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

POST`/application.saveBitbucketProvider`

application-saveBitbucketProvider

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`bitbucketBranch`
Required
string | null

`bitbucketBuildPath`
Required
string | null

`bitbucketOwner`
Required
string | null

`bitbucketRepository`
Required
string | null

`bitbucketId`
Required
string | null

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.saveBitbucketProvider" \
  -d '{
  "bitbucketBranch": "string",
  "bitbucketBuildPath": "string",
  "bitbucketOwner": "string",
  "bitbucketRepository": "string",
  "bitbucketId": "string",
  "applicationId": "string"
}'

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

POST`/application.saveDockerProvider`

application-saveDockerProvider

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`dockerImage`string | null

`applicationId`
Required
string

`username`string | null

`password`string | null

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

curl -X POST "http://localhost:3000/api/application.saveDockerProvider" \
  -d '{
  "dockerImage": "string",
  "applicationId": "string",
  "username": "string",
  "password": "string"
}'

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

POST`/application.saveGitProdiver`

application-saveGitProdiver

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`customGitBranch`string | null

`applicationId`
Required
string

`customGitBuildPath`string | null

`customGitUrl`string | null

`customGitSSHKeyId`string | null

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

curl -X POST "http://localhost:3000/api/application.saveGitProdiver" \
  -d '{
  "customGitBranch": "string",
  "applicationId": "string",
  "customGitBuildPath": "string",
  "customGitUrl": "string",
  "customGitSSHKeyId": "string"
}'

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

POST`/application.markRunning`

application-markRunning

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.markRunning" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.update`

application-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

Minimum length: 1

`name`string

Minimum length: 1

`appName`string

`description`string | null

`env`string | null

`buildArgs`string | null

`memoryReservation`number | null

`memoryLimit`number | null

`cpuReservation`number | null

`cpuLimit`number | null

`title`string | null

`enabled`boolean | null

`subtitle`string | null

`command`string | null

`refreshToken`string | null

`sourceType`string

Value in: "github" | "docker" | "git"

`repository`string | null

`owner`string | null

`branch`string | null

`buildPath`string | null

`autoDeploy`boolean | null

`gitlabProjectId`number | null

`gitlabRepository`string | null

`gitlabOwner`string | null

`gitlabBranch`string | null

`gitlabBuildPath`string | null

`gitlabPathNamespace`string | null

`bitbucketRepository`string | null

`bitbucketOwner`string | null

`bitbucketBranch`string | null

`bitbucketBuildPath`string | null

`username`string | null

`password`string | null

`dockerImage`string | null

`customGitUrl`string | null

`customGitBranch`string | null

`customGitBuildPath`string | null

`customGitSSHKeyId`string | null

`dockerfile`string | null

`dockerContextPath`string | null

`dropBuildPath`string | null

`healthCheckSwarm`object | null

`restartPolicySwarm`object | null

`placementSwarm`object | null

`updateConfigSwarm`object | null

`rollbackConfigSwarm`object | null

`modeSwarm`object | null

`labelsSwarm`object | null

`networkSwarm`array<object> | null

`replicas`number

`applicationStatus`string

Value in: "idle" | "running" | "done" | "error"

`buildType`string

Value in: "dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"

`publishDirectory`string | null

`createdAt`string

`registryId`string | null

`projectId`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/application.update" \
  -d '{
  "applicationId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "env": "string",
  "buildArgs": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "title": "string",
  "enabled": true,
  "subtitle": "string",
  "command": "string",
  "refreshToken": "string",
  "sourceType": "github",
  "repository": "string",
  "owner": "string",
  "branch": "string",
  "buildPath": "string",
  "autoDeploy": true,
  "gitlabProjectId": 0,
  "gitlabRepository": "string",
  "gitlabOwner": "string",
  "gitlabBranch": "string",
  "gitlabBuildPath": "string",
  "gitlabPathNamespace": "string",
  "bitbucketRepository": "string",
  "bitbucketOwner": "string",
  "bitbucketBranch": "string",
  "bitbucketBuildPath": "string",
  "username": "string",
  "password": "string",
  "dockerImage": "string",
  "customGitUrl": "string",
  "customGitBranch": "string",
  "customGitBuildPath": "string",
  "customGitSSHKeyId": "string",
  "dockerfile": "string",
  "dockerContextPath": "string",
  "dropBuildPath": "string",
  "healthCheckSwarm": {
    "Test": [
      "string"
    ],
    "Interval": 0,
    "Timeout": 0,
    "StartPeriod": 0,
    "Retries": 0
  },
  "restartPolicySwarm": {
    "Condition": "string",
    "Delay": 0,
    "MaxAttempts": 0,
    "Window": 0
  },
  "placementSwarm": {
    "Constraints": [
      "string"
    ],
    "Preferences": [
      {
        "Spread": {
          "SpreadDescriptor": "string"
        }
      }
    ],
    "MaxReplicas": 0,
    "Platforms": [
      {
        "Architecture": "string",
        "OS": "string"
      }
    ]
  },
  "updateConfigSwarm": {
    "Parallelism": 0,
    "Delay": 0,
    "FailureAction": "string",
    "Monitor": 0,
    "MaxFailureRatio": 0,
    "Order": "string"
  },
  "rollbackConfigSwarm": {
    "Parallelism": 0,
    "Delay": 0,
    "FailureAction": "string",
    "Monitor": 0,
    "MaxFailureRatio": 0,
    "Order": "string"
  },
  "modeSwarm": {
    "Replicated": {
      "Replicas": 0
    },
    "Global": {},
    "ReplicatedJob": {
      "MaxConcurrent": 0,
      "TotalCompletions": 0
    },
    "GlobalJob": {}
  },
  "labelsSwarm": {
    "property1": "string",
    "property2": "string"
  },
  "networkSwarm": [
    {
      "Target": "string",
      "Aliases": [
        "string"
      ],
      "DriverOpts": {}
    }
  ],
  "replicas": 0,
  "applicationStatus": "idle",
  "buildType": "dockerfile",
  "publishDirectory": "string",
  "createdAt": "string",
  "registryId": "string",
  "projectId": "string",
  "githubId": "string",
  "gitlabId": "string",
  "bitbucketId": "string"
}'

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

POST`/application.refreshToken`

application-refreshToken

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.refreshToken" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.deploy`

application-deploy

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

curl -X POST "http://localhost:3000/api/application.deploy" \
  -d '{
  "applicationId": "string"
}'

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

POST`/application.cleanQueues`

application-cleanQueues

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

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

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

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

GET`/application.readTraefikConfig`

application-readTraefikConfig

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`applicationId`
Required
string

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

curl -X GET "http://localhost:3000/api/application.readTraefikConfig?applicationId=string"

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

POST`/application.updateTraefikConfig`

application-updateTraefikConfig

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`applicationId`
Required
string

`traefikConfig`
Required
string

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

curl -X POST "http://localhost:3000/api/application.updateTraefikConfig" \
  -d '{
  "applicationId": "string",
  "traefikConfig": "string"
}'

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

GET`/application.readAppMonitoring`

application-readAppMonitoring

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`appName`
Required
string

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

curl -X GET "http://localhost:3000/api/application.readAppMonitoring?appName=string"

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

application

POST/application.create

AuthorizationRequiredBearer <token>

nameRequiredstring

appNamestring

descriptionstring | null

projectIdRequiredstring

Response

Typescript

GET/application.one

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

POST/application.reload

AuthorizationRequiredBearer <token>

appNameRequiredstring

applicationIdRequiredstring

Response

Typescript

POST/application.delete

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

POST/application.stop

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

POST/application.start

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

POST/application.redeploy

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

Response

Typescript

POST/application.saveEnvironment

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

envstring | null

buildArgsstring | null

Response

Typescript

POST/application.saveBuildType

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

buildTypeRequiredstring

dockerfilestring | null

dockerContextPathRequiredstring | null

publishDirectorystring | null

Response

Typescript

POST/application.saveGithubProvider

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

repositorystring | null

branchstring | null

ownerRequiredstring | null

buildPathstring | null

githubIdRequiredstring | null

Response

Typescript

POST/application.saveGitlabProvider

AuthorizationRequiredBearer <token>

applicationIdRequiredstring

gitlabBranchRequiredstring | null

gitlabBuildPathRequiredstring | null

gitlabOwnerRequiredstring | null

gitlabRepositoryRequiredstring | null

gitlabIdRequiredstring | null

gitlabProjectIdRequirednumber | null

gitlabPathNamespaceRequiredstring | null

Response

Typescript

POST/application.saveBitbucketProvider

AuthorizationRequiredBearer <token>

POST`/application.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`appName`string

`description`string | null

`projectId`
Required
string

GET`/application.one`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

POST`/application.reload`

`Authorization`
Required
Bearer <token>

`appName`
Required
string

`applicationId`
Required
string

POST`/application.delete`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

POST`/application.stop`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

POST`/application.start`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

POST`/application.redeploy`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

POST`/application.saveEnvironment`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

`env`string | null

`buildArgs`string | null

POST`/application.saveBuildType`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

`buildType`
Required
string

`dockerfile`string | null

`dockerContextPath`
Required
string | null

`publishDirectory`string | null

POST`/application.saveGithubProvider`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

`repository`string | null

`branch`string | null

`owner`
Required
string | null

`buildPath`string | null

`githubId`
Required
string | null

POST`/application.saveGitlabProvider`

`Authorization`
Required
Bearer <token>

`applicationId`
Required
string

`gitlabBranch`
Required
string | null

`gitlabBuildPath`
Required
string | null

`gitlabOwner`
Required
string | null

`gitlabRepository`
Required
string | null

`gitlabId`
Required
string | null

`gitlabProjectId`
Required
number | null

`gitlabPathNamespace`
Required
string | null

POST`/application.saveBitbucketProvider`

`Authorization`
Required
Bearer <token>

`bitbucketBranch`
Required
string | null

`bitbucketBuildPath`
Required
string | null

`bitbucketOwner`
Required
string | null

`bitbucketRepository`
Required
string | null

`bitbucketId`
Required
string | null

`applicationId`
Required
string

POST`/application.saveDockerProvider`

`Authorization`
Required
Bearer <token>

`dockerImage`string | null

`applicationId`
Required
string

`username`string | null

`password`string | null

POST`/application.saveGitProdiver`

`Authorization`
Required
Bearer <token>

`customGitBranch`string | null

`applicationId`
Required
string

`customGitBuildPath`string | null

`customGitUrl`string | null

`customGitSSHKeyId`string | null

POST`/application.markRunning`