Skip to content
Coritan Docs

App and release fields

Every field the Apps API returns for an app, a release, a build, a replica, a domain and an environment variable.

View as Markdown

This page lists the fields of each object the Apps API returns. Times are in UTC, written as in 2026-09-26T10:05:00Z, and a field with nothing to show is null.

The Apps API keeps the words Apps used. Its deployment object is a release in the dashboard, a replica is an instance, and a region is a location (Container Apps and Apps in App Deployment).

App

Section titled App
Field Meaning
uuid The app's ID, used in every path.
name What you call the app.
slug Its name on the platform, which its platform name is made from.
status active, paused while a spend limit has stopped it, or suspended (A suspended or paused app).
owner {"type": "user"} for your own app, {"type": "organization"} for an organization's.
source_type git or image.
repo_url, repo_branch, repo_subdir A git app's repository address, branch and directory. repo_subdir is null for the root of the repository.
repo_token_set true when the app holds an access token for its repository.
repo_token_hint The token's last four characters, or null when there is none or it is shorter than eight characters.
image_ref The image an app that runs an image deploys.
framework, install_command, build_command, start_command How a git app builds and starts (Builds).
dockerfile_path Always null for a new app: Dockerfiles are not built. An older app may still show the path it saved.
port The port saved with the app. Replicas listen on the port in their PORT variable.
health_check_path The path each health check requests.
instance_size small, medium or large.
memory_mb, cpu_percent, disk_mb What each replica gets from its size. cpu_percent is 100 for each vCPU.
regions ["*"] for every region that can run apps, or the region codes the app runs in. Saving the app's locations on its Instances tab changes it too (Choose locations and scaling).
min_replicas The fewest replicas each region keeps. Where regions keep different numbers, the smallest of them.
max_replicas The most replicas a region can scale to with traffic (Scale with traffic). Where regions differ, the largest of them.
url https:// and the platform name, or null when the app has none.
platform_hostname The platform name, such as web-shop.apps.example.net.
domains_count How many domains the app has, its platform name included.
current_deployment The live release, which serves the app, without its list of replicas, or null until one has gone live.
replicas Counts for the live release's replicas (Replica counts).
webhook For a git app, the push webhook: its url, secret_set, and secret_hint with the secret's last four characters. null for an app that runs an image.
created_at, updated_at When the app was created and last changed.

Release

Section titled Release

The API names a release deployment: the object is deployment, and a list of them is deployments.

Field Meaning
uuid The release's ID.
status Where it is (Status words).
source What it runs: git, image, upload, redeploy, rollback or promote.
trigger What started it: push for a push to the connected branch, rebuild for Rebuild (Pull again for an image), rollback, deploy_hook, or manual for a deploy of a branch, a tag, a commit or an image, a redeploy, an upload or a promotion.
actor_type Who started it: user, staff, admin or webhook (Read a release through the API).
git_ref The branch or ref a git release fetches.
git_sha The commit it builds. For a release of a branch, it is filled in when the build succeeds.
commit_message, commit_author The commit's message and author, for a release that a push started and for a redeploy or rollback of one.
image_ref The image a release of an image runs; null for a git release.
image_digest The image's digest, once known.
artifact_sha256, artifact_size A git release's build output: its SHA-256 and its size in bytes, once the build has uploaded it.
runtime_image The image each replica of a git release runs its build output on, such as ghcr.io/parkervcp/yolks:nodejs_22 for Node 22.
start_command The command those replicas run.
regions The regions its replicas run in, filled in once it starts deploying.
error Why it failed or was cancelled, or which regions it went live without.
is_current true for the live release, which serves the app.
in_flight true while it is queued, building or deploying.
can_rollback true when you can roll back to it: it went live once, has an image, and is not the live release.
replicas Counts for its replicas (Replica counts).
build Its build (Build), or null for a release with no build: a release of an image, a redeploy or a rollback.
ready_at, promoted_at When it went live.
finished_at When it went live, failed or was cancelled.
created_at, updated_at When it was created and last changed.
replica_list Each of its replicas (Replica). Only the request for one release returns it.

Replica counts

Section titled Replica counts
Field Meaning
healthy Replicas passing their health checks.
unhealthy Replicas that failed their most recent health checks.
starting Replicas that are provisioning or starting.
total The three above together.

Build

Section titled Build
Field Meaning
uuid The build's ID.
status queued, running, succeeded, failed or canceled.
strategy container: the build ran in a build container (Builds). Older builds may name another method.
error Why it failed or was cancelled.
attempts How many times it has started. A build that stops reporting starts once more.
log_bytes How much log it has written in all (The build log).
started_at, finished_at, created_at When it started, ended and was queued.

Replica

Section titled Replica
Field Meaning
location The code of its region, such as fra.
state Where it is (Replicas).
health_failures How many health checks it has failed in a row.
last_health_at When it was last checked.
last_error What last went wrong, such as Health check on /healthz: HTTP 500.
created_at When it was placed.
drained_at When it stopped taking requests.

Domain

Section titled Domain
Field Meaning
hostname The name, such as www.example.com.
kind platform for the platform name, custom for your own domain.
verified, verified_at Whether the domain is verified, and when.
url https:// and the hostname, once verified.
certificate none, pending or issued (Certificates).
verification The TXT record to publish, as type, name and value, until the domain is verified.
cname_target Where a custom domain points: the app's platform name. null for the platform name.
created_at When it was added.

Environment variable

Section titled Environment variable
Field Meaning
key The variable's name.
secret true when its value is hidden in build logs (Secret and plain values).
target both, build or runtime (Where a variable reaches).
value Always null. The API never returns a value.
hint The value's last four characters, or null when it is shorter than eight characters.
readable false when the platform cannot read the saved value, which then needs saving again.
created_at, updated_at When it was created and last changed.

Status words

Section titled Status words
Field Words In the dashboard
App status active, paused, suspended Paused and Suspended. An active app shows Live, Starting, Needs attention, Asleep, Stopped or Not deployed (Your deployments).
Release status queued, building, deploying, ready, failed, canceled, superseded (Releases) A release's Queued, Building, Deploying, Ready, Failed, Cancelled and Replaced, and Live for the ready release that serves the app
Build status queued, running, succeeded, failed, canceled Waiting to build, Building, Built, Build failed, Cancelled
Replica state provisioning, starting, healthy, unhealthy, draining, stopped, failed (Replicas) An instance's Starting for the first two, then Healthy, Unhealthy, Draining, Stopped, Failed, and Asleep while its location sleeps
Domain certificate none, pending, issued No certificate yet, Certificate on its way, Certificate issued
Variable target both, build, runtime Build and runtime, Build only, Runtime only
Section titled Related