Skip to content
GitHub

App detail with pods. Plain env values are included only for callers holding `secret-read`.

GET
/api/v1/projects/{project}/environments/{environment}/apps/{app}
curl --request GET \
  --url https://example.com/api/v1/projects/example/environments/example/apps/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
app
required
object
name
required
string
project
required
string
environment
required

Environment short name.

string
namespace
required
string
image
string | null
git_repo
string | null
url
string | null
ready
required
boolean
reason

Available, Progressing, RolloutFailed, Scheduled, AwaitingBuild, …

string | null
message
string | null
processes
required
Array<object>
object
name
required
string
command
required
Array<string>
port
integer | null format: int32
size
required
string
min_replicas
required
integer format: int32
max_replicas
required
integer format: int32
schedule

Cron expression of scheduled processes.

string | null
protocol
required

http or tcp.

string
env
required

Values are only included in the app detail, for callers allowed to read secrets.

Array<object>

Environment variable: a plain value or a secret reference.

object
name
required
string
value
string | null
secret
One of:
null
domains
required
Array<string>
volumes
required
Array<object>

Persistent volume (kept when the app is deleted, unless requested).

object
name
required
string
mount_path
required
string
size

Capacity such as 5Gi. Can grow, never shrink.

string
created_at
string | null
pods
required
Array<object>
object
name
required
string
process
string | null
phase
required

pending, running, succeeded, failed or unknown.

string
ready
required
boolean
restarts
required
integer format: int32
reason
string | null
node
string | null
started_at
string | null
Example
{
  "app": {
    "env": [
      {
        "name": "LOG_LEVEL"
      }
    ],
    "volumes": [
      {
        "name": "data",
        "mount_path": "/data",
        "size": "5Gi"
      }
    ]
  }
}

404

Section titled “404”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}