/apps/{id} (PATCH)

PATCH

/apps/{id}

curl --request PATCH \
  --url https://example.com/api/v1/apps/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "repo": "https://example.com", "image": "example", "branch": "example", "port": 1, "cpu": 1, "memoryMb": 1, "serverId": "example", "vcsConnectionId": "example", "buildStrategy": "compose", "buildConfig": { "rootDirectory": "example", "dockerfilePath": "example", "publishDirectory": "example", "builder": "example" }, "gitPollEnabled": true, "previewEnabled": true, "previewWildcardDomain": "example", "previewLimit": 1, "registryCredentialId": "example", "preDeployCommand": "example", "postDeployCommand": "example" }'

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

name

string

>= 1 characters <= 63 characters

repo

Any of:

string

string format: uri

null

null

image

Any of:

string

string

>= 1 characters <= 255 characters

null

null

branch

string

port

integer

>= 1 <= 65535

cpu

Any of:

number

number

>= 0.1 <= 64

null

null

memoryMb

Any of:

integer

integer

>= 6 <= 524288

null

null

serverId

Any of:

string

string

null

null

vcsConnectionId

Any of:

string

string

null

null

buildStrategy

Any of:

string

string

Allowed values: compose

string

string

Allowed values: dockerfile

string

string

Allowed values: nixpacks

string

string

Allowed values: buildpacks

string

string

Allowed values: static

buildConfig

object

rootDirectory

string

<= 255 characters

dockerfilePath

string

<= 255 characters

publishDirectory

string

<= 255 characters

builder

string

<= 255 characters

gitPollEnabled

boolean

previewEnabled

boolean

previewWildcardDomain

Any of:

string

string

<= 253 characters

null

null

previewLimit

integer

>= 1 <= 50

registryCredentialId

Any of:

string

string

null

null

preDeployCommand

Any of:

string

string

<= 4096 characters

null

null

postDeployCommand

Any of:

string

string

<= 4096 characters

null

null

Responses

200

Default Response

Media type application/json

object

id

required

string

organizationId

required

string

name

required

string

repo

required

Any of:

string

string

null

null

image

required

Any of:

string

string

null

null

branch

required

string

port

required

integer

cpu

required

Any of:

number

number

null

null

memoryMb

required

Any of:

integer

integer

null

null

buildStrategy

required

Any of:

string

string

Allowed values: compose

string

string

Allowed values: dockerfile

string

string

Allowed values: nixpacks

string

string

Allowed values: buildpacks

string

string

Allowed values: static

buildConfig

required

object

rootDirectory

required

Any of:

string

string

null

null

dockerfilePath

required

Any of:

string

string

null

null

publishDirectory

required

Any of:

string

string

null

null

builder

required

Any of:

string

string

null

null

vcsConnectionId

required

Any of:

string

string

null

null

gitPollEnabled

required

boolean

previewEnabled

required

boolean

previewWildcardDomain

required

Any of:

string

string

null

null

previewLimit

required

integer

registryCredentialId

required

Any of:

string

string

null

null

preDeployCommand

required

Any of:

string

string

null

null

postDeployCommand

required

Any of:

string

string

null

null

createdAt

required

string format: date-time

Example

{
  "buildStrategy": "compose"
}

404

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}