/apps/{id} (GET)

GET

/apps/{id}

curl --request GET \
  --url https://example.com/api/v1/apps/example

Parameters

Path Parameters

id

required

string

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"
    }
  ]
}