Deployi

application

POST/application.create

application-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appNamestring

descriptionstring | null

projectId
Required
string

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

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.saveEnvironment" \
  -d '{
  "applicationId": "string",
  "env": "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"

dockerfilestring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.saveBuildType" \
  -d '{
  "applicationId": "string",
  "buildType": "dockerfile",
  "dockerfile": "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

repositorystring | null

branchstring | null

owner
Required
string | null

buildPathstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.saveGithubProvider" \
  -d '{
  "applicationId": "string",
  "repository": "string",
  "branch": "string",
  "owner": "string",
  "buildPath": "string"
}'

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

POST/application.saveDockerProvider

application-saveDockerProvider

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

dockerImagestring | null

applicationId
Required
string

usernamestring | null

passwordstring | null

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

customGitBranchstring | null

applicationId
Required
string

customGitBuildPathstring | null

customGitUrlstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.saveGitProdiver" \
  -d '{
  "customGitBranch": "string",
  "applicationId": "string",
  "customGitBuildPath": "string",
  "customGitUrl": "string"
}'

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

POST/application.generateSSHKey

application-generateSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.generateSSHKey" \
  -d '{
  "applicationId": "string"
}'

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

POST/application.removeSSHKey

application-removeSSHKey

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.removeSSHKey" \
  -d '{
  "applicationId": "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 codeDescription
200Successful response
defaultError 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

namestring

Minimum length: 1

appNamestring

descriptionstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

titlestring | null

enabledboolean | null

subtitlestring | null

commandstring | null

refreshTokenstring | null

sourceTypestring

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

repositorystring | null

ownerstring | null

branchstring | null

buildPathstring | null

autoDeployboolean | null

usernamestring | null

passwordstring | null

dockerImagestring | null

customGitUrlstring | null

customGitBranchstring | null

customGitBuildPathstring | null

customGitSSHKeystring | null

dockerfilestring | null

healthCheckSwarmobject | null

restartPolicySwarmobject | null

placementSwarmobject | null

updateConfigSwarmobject | null

rollbackConfigSwarmobject | null

modeSwarmobject | null

labelsSwarmobject | null

networkSwarmarray of object | null

replicasnumber

applicationStatusstring

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

buildTypestring

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

createdAtstring

registryIdstring | null

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/application.update" \
  -d '{
  "applicationId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "env": "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,
  "username": "string",
  "password": "string",
  "dockerImage": "string",
  "customGitUrl": "string",
  "customGitBranch": "string",
  "customGitBuildPath": "string",
  "customGitSSHKey": "string",
  "dockerfile": "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",
  "createdAt": "string",
  "registryId": "string",
  "projectId": "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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/application.readAppMonitoring?appName=string"

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

Previous

admin

Next

auth

On this page

application-createAuthorizationRequest Bodyapplication-oneAuthorizationQuery Parametersapplication-reloadAuthorizationRequest Bodyapplication-deleteAuthorizationRequest Bodyapplication-stopAuthorizationRequest Bodyapplication-startAuthorizationRequest Bodyapplication-redeployAuthorizationRequest Bodyapplication-saveEnvironmentAuthorizationRequest Bodyapplication-saveBuildTypeAuthorizationRequest Bodyapplication-saveGithubProviderAuthorizationRequest Bodyapplication-saveDockerProviderAuthorizationRequest Bodyapplication-saveGitProdiverAuthorizationRequest Bodyapplication-generateSSHKeyAuthorizationRequest Bodyapplication-removeSSHKeyAuthorizationRequest Bodyapplication-markRunningAuthorizationRequest Bodyapplication-updateAuthorizationRequest Bodyapplication-refreshTokenAuthorizationRequest Bodyapplication-deployAuthorizationRequest Bodyapplication-cleanQueuesAuthorizationRequest Bodyapplication-readTraefikConfigAuthorizationQuery Parametersapplication-updateTraefikConfigAuthorizationRequest Bodyapplication-readAppMonitoringAuthorizationQuery Parameters