deploy.apps.getDescribe an app with its environment, deployments, domains and machines
Environment values are included only with deploy:ManageEnv, the compose file only with deploy:UpdateApp.
Without deploy:ManageEnv the answer is reduced rather than refused.
Request syntax
GET /deploy/api/apps/{id}Path parameters
idRequiredstring
Constraints: uuid
Response
200 with `data`: `app` (all its settings, status and defaultUrl), `env` (its variables), `envRedacted` and `composeFileRedacted` (whether they were withheld), `deployments` (the last 50, newest first), `domains`, and `targets` (each machine with its health, sync state and instance).
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
appAlwaysobject
The app with all its settingsapp.idAlwaysstring
App idapp.orgIdAlwaysstring
Organization the app belongs toapp.nameAlwaysstring
Display nameapp.slugAlwaysstring
Short name used in the default hostname, unique in the organizationapp.environmentIdAlwaysstring, may be null
Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets onlyapp.gitRepositoryIdAlwaysstring, may be null
Git repository the app builds from; null for an app that runs an imageapp.branchAlwaysstring, may be null
Branch the app deploys from; null means the repository’s default branchapp.deployOnPushAlwaysboolean
Whether each commit pushed to the branch is deployedapp.rootDirAlwaysstring
Directory in the repository the app is built fromapp.imageRefAlwaysstring, may be null
Container image the app runs, for builder image; null otherwiseapp.composeSourceAlwaysone of inline, git, may be null
Compose apps: where the compose file comes from; null for other buildersapp.composePathAlwaysstring, may be null
Compose apps with composeSource git: path of the compose file in the repositoryapp.composeServiceAlwaysstring, may be null
Compose apps: the service published on the app’s domainsapp.composePortAlwaysnumber, may be null
Compose apps: the container port of composeService that receives trafficapp.hostingAlwaysone of machine, pooled
machine: its own machines; pooled: a Next.js app on shared hostsapp.memoryMbAlwaysnumber
Pooled hosting: memory reserved for the app’s server while it runs, in MBapp.idleSecondsAlwaysnumber
Pooled hosting: seconds without a request after which the server is stoppedapp.poolHostIdAlwaysstring, may be null
Pooled hosting: the shared host the app is placed on; null until placedapp.dataSavedAtAlwaysstring, may be null
Pooled hosting: when the app’s data directory was last saved; null if neverapp.dataBytesAlwaysnumber, may be null
Pooled hosting: size of the last saved data directory, in bytesapp.builderAlwaysone of railpack, dockerfile, forgejo_actions, image, compose, nextjs
How the app is built; nextjs for pooled hostingapp.buildCommandAlwaysstring, may be null
Build command replacing the detected one; null: the detected oneapp.startCommandAlwaysstring, may be null
Start command replacing the detected one; null: the detected oneapp.portAlwaysnumber
Port the app listens on in its containerapp.releaseCommandAlwaysstring, may be null
Command run once per deployment before traffic moves; null: noneapp.releaseServiceAlwaysstring, may be null
Compose apps: service the release command runs in; null: the published serviceapp.releaseTimeoutSecAlwaysnumber
Seconds the release command may runapp.healthCheckAlwaysobject, may be null
HTTP check a new container must pass; null means GET / below 500app.healthCheck.pathAlwaysstring
Path requested with GET on the containerapp.healthCheck.portWhen presentnumber
Container port probed; absent means the app’s (or published service’s) portapp.healthCheck.expectedStatusWhen presentnumber
The one HTTP status that counts as healthy; absent means any status below 500app.healthCheck.timeoutSecWhen presentnumber
Seconds a new container has to start answeringapp.composeHealthChecksAlwaysmap, may be null
Compose apps: health checks of other services, by service name; null: noneapp.composeHealthChecks.<key>.pathAlwaysstring
Path requested with GET on the containerapp.composeHealthChecks.<key>.portWhen presentnumber
Container port probed; absent means the app’s (or published service’s) portapp.composeHealthChecks.<key>.expectedStatusWhen presentnumber
The one HTTP status that counts as healthy; absent means any status below 500app.composeHealthChecks.<key>.timeoutSecWhen presentnumber
Seconds a new container has to start answeringapp.instanceTypeAlwaysstring
Machine size of each machine (pooled for pooled hosting), e.g. performance-2app.replicasAlwaysnumber
Number of machinesapp.locationsAlwaysarray of string
Locations the machines are spread over in order; empty: the region’s own locationapp.hetznerLoadBalancerIdAlwaysnumber, may be null
The app’s load balancer, when it has more than one machine or location; else nullapp.loadBalancerIpv4Alwaysstring, may be null
Public address of the app’s load balancer; null without oneapp.ecrRepositoryIdAlwaysstring, may be null
Repository of the organization’s registry the app pulls from; null: noneapp.serviceAccountIamUserIdAlwaysstring, may be null
The app’s own identity its machines sign in with; null until provisionedapp.generationAlwaysnumber
Counter raised with every new desired deployment; machines roll when it changesapp.activeDeploymentIdAlwaysstring, may be null
The deployment live now; null before the first oneapp.statusAlwaysone of created, provisioning, active, suspended, error, deleting
created, provisioning, active, suspended, error or deletingapp.reconcileErrorAlwaysstring, may be null
Why the last provisioning or teardown step failed; null when nothing failedapp.tlsReportAlwaysobject, may be null
Certificate state a machine last reported, hostname by hostname; null: none yetapp.tlsReport.atAlwaysstring
When a machine reportedapp.tlsReport.entriesAlwaysarray of object
One entry per hostname the machine servesapp.tlsReport.entries[].hostAlwaysstring
Hostnameapp.tlsReport.entries[].okAlwaysboolean
Whether a certificate is served for itapp.tlsReport.entries[].errorWhen presentstring
Why not, as the TLS handshake said itapp.envChangedAtAlwaysstring, may be null
When the environment or a binding last changed; null if neverapp.createdAtAlwaysstring
When the app was createdapp.updatedAtAlwaysstring
When the app was last changedapp.composeFileAlwaysstring, may be null
Compose file text; null without one or without deploy:UpdateAppapp.defaultUrlAlwaysstring
The app’s default hostnameenvAlwaysarray of object
Its variables; empty without deploy:ManageEnv (see envRedacted)env[].idAlwaysstring
Variable idenv[].appIdAlwaysstring
The appenv[].keyAlwaysstring
Variable nameenv[].valueKindAlwaysone of plain, secret
plain (a value) or secret (a bound Secret)env[].plainValueAlwaysstring, may be null
The value of a plain variable; null for a secretenv[].kmsSecretIdAlwaysstring, may be null
The Secret bound to a secret variable; null for plain, or when it was deletedenv[].createdAtAlwaysstring
When it was first setenv[].updatedAtAlwaysstring
When it was last changedenvRedactedAlwaysboolean
True when the variables were withheldcomposeFileRedactedAlwaysboolean
True when the compose file was withhelddeploymentsAlwaysarray of object
The last 50 deployments, newest firstdeployments[].idAlwaysstring
Deployment iddeployments[].appIdAlwaysstring
The app deployeddeployments[].orgIdAlwaysstring
Organization the deployment belongs todeployments[].generationAlwaysnumber
The app generation this deployment representsdeployments[].triggerAlwaysone of push, manual, rollback
What started itdeployments[].gitCommitShaAlwaysstring, may be null
Commit built; null for an image or compose appdeployments[].imageRefAlwaysstring, may be null
Image run, by digest once built; null for a compose deploymentdeployments[].composeDigestAlwaysstring, may be null
sha256 of the compose file pinned to it; null for other buildersdeployments[].composeImagePinsAlwaysmap, may be null
Compose: service name → image digest, for images whose signature was checked; null: nonedeployments[].envSnapshotAlwaysarray of object, may be null
The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnvdeployments[].envSnapshot[].keyAlwaysstring
Variable namedeployments[].envSnapshot[].valueKindAlwaysone of plain, secret
plain or secretdeployments[].envSnapshot[].plainValueAlwaysstring, may be null
The value of a plain variable; null for a secretdeployments[].envSnapshot[].kmsSecretIdAlwaysstring, may be null
The Secret bound, for a secret; null for plaindeployments[].statusAlwaysone of queued, building, pushing, deploying, live, failed, superseded
queued, building, pushing, deploying, live, failed or supersededdeployments[].releaseCommandAlwaysstring, may be null
Release command pinned when it started; null: nonedeployments[].releaseStatusAlwaysone of pending, running, succeeded, failed, skipped
Where the release command stands; skipped when there is nonedeployments[].releaseExitCodeAlwaysnumber, may be null
Exit code of the release command; null until it randeployments[].buildLogRefAlwaysstring, may be null
Unused; always nulldeployments[].buildExitCodeAlwaysnumber, may be null
Exit code the builder reported; null until it finisheddeployments[].errorMessageAlwaysstring, may be null
Why it failed; null unless faileddeployments[].createdByAlwaysstring, may be null
IAM user who started it; null for a push or the platformdeployments[].reasonAlwaysstring, may be null
Why it was started, as the starter said; null: nonedeployments[].statusHistoryAlwaysarray of object
Every status it passed through, oldest firstdeployments[].statusHistory[].statusAlwaysstring
Status entereddeployments[].statusHistory[].atAlwaysstring
Whendeployments[].bundleKeyAlwaysstring, may be null
Pooled hosting: storage key of the uploaded bundle; null otherwisedeployments[].bundleSha256Alwaysstring, may be null
Pooled hosting: sha256 of the bundledeployments[].bundleBytesAlwaysnumber, may be null
Pooled hosting: size of the bundle, in bytesdeployments[].branchAlwaysstring, may be null
Pooled hosting: branch the commit was pushed todeployments[].previewAlwaysboolean
Pooled hosting: a preview at its own URL rather than productiondeployments[].hostingSummaryAlwaysobject, may be null
Pooled hosting: what the bundle contains; null until readdeployments[].hostingSummary.kindAlwaysone of static, hybrid, fallback
static: files only; hybrid: some routes need the server; fallback: all dodeployments[].hostingSummary.nextVersionAlwaysstring, may be null
Next.js version of the build; null if unknowndeployments[].hostingSummary.filesAlwaysnumber
Number of files served without the serverdeployments[].hostingSummary.nodeRoutesAlwaysarray of object
Routes the app’s server answersdeployments[].hostingSummary.nodeRoutes[].pathAlwaysstring
Routedeployments[].hostingSummary.nodeRoutes[].reasonAlwaysstring
Why it needs the serverdeployments[].createdAtAlwaysstring
When it was starteddeployments[].liveAtAlwaysstring, may be null
When it went live; null if it never diddomainsAlwaysarray of object
Custom domainsdomains[].idAlwaysstring
Domain iddomains[].appIdAlwaysstring
The app it servesdomains[].domainAlwaysstring
Hostname, or *.host for every subdomaindomains[].isPrimaryAlwaysboolean
Whether it is the app’s primary domaindomains[].tlsStatusAlwaysone of pending, active, failed
Certificate statedomains[].dnsVerifiedAtAlwaysstring, may be null
When it was last seen pointing at the app; null if neverdomains[].createdAtAlwaysstring
When it was addeddomains[].updatedAtAlwaysstring
When it was last changedtargetsAlwaysarray of object
Each machine with its health and synctargets[].idAlwaysstring
Target idtargets[].deploymentIdAlwaysstring
Deployment the machine was set up fortargets[].healthAlwaysone of pending, healthy, unhealthy, stale
As of now; stale when the machine stopped reportingtargets[].lastReportedAtAlwaysstring, may be null
Last report about this deployment; null if nonetargets[].createdAtAlwaysstring
When the target was createdtargets[].syncAlwaysone of in_sync, out_of_sync, unknown
Whether the machine runs the deployment it shouldtargets[].syncReasonAlwaysstring
Why, in one sentencetargets[].rollingOutAlwaysboolean
Out of sync only because a rollout is in progresstargets[].expectedAlwaysobject, may be null
What it should run; null when nothing is desiredtargets[].expected.generationAlwaysnumber
App generationtargets[].expected.imageRefAlwaysstring, may be null
Image; null for composetargets[].expected.composeDigestAlwaysstring, may be null
Compose file digest; null for an imagetargets[].runningAlwaysobject, may be null
What it says it runs; null before its first reporttargets[].running.generationAlwaysnumber
App generationtargets[].running.imageRefAlwaysstring, may be null
Image; null for composetargets[].running.composeDigestAlwaysstring, may be null
Compose file digest; null for an imagetargets[].driftSinceAlwaysstring, may be null
Since when it runs something else; null while in synctargets[].reportedAtAlwaysstring, may be null
When it last reported anything; null if nevertargets[].instanceAlwaysobject, may be null
The machine; null when it was deletedtargets[].instance.idAlwaysstring
Instance id (i-…)targets[].instance.nameAlwaysstring, may be null
Instance nametargets[].instance.stateAlwaysstring
Instance state, e.g. runningtargets[].instance.publicIpAlwaysstring, may be null
Public IPv4 address; null if nonetargets[].instance.regionIdAlwaysstring
Regiontargets[].instance.serverTypeAlwaysstring, may be null
Instance type; null if unknown
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow deploy:DescribeApp on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud deploy apps get idcurl -X GET "https://console.platform-development.deutschecloud.app/deploy/api/apps/id" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_apps_get.