deploy.apps.listList apps
Request syntax
GET /deploy/api/appsResponse
200 with `data`: every app of the organization, oldest first — its settings (builder, branch, image, port, instanceType, replicas, hosting), status, generation, activeDeploymentId and defaultUrl. The compose file is left out; hasComposeFile says whether there is one.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
[].idAlwaysstring
App id[].orgIdAlwaysstring
Organization the app belongs to[].nameAlwaysstring
Display name[].slugAlwaysstring
Short name used in the default hostname, unique in the organization[].environmentIdAlwaysstring, may be null
Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets only[].gitRepositoryIdAlwaysstring, may be null
Git repository the app builds from; null for an app that runs an image[].branchAlwaysstring, may be null
Branch the app deploys from; null means the repository’s default branch[].deployOnPushAlwaysboolean
Whether each commit pushed to the branch is deployed[].rootDirAlwaysstring
Directory in the repository the app is built from[].imageRefAlwaysstring, may be null
Container image the app runs, for builder image; null otherwise[].composeSourceAlwaysone of inline, git, may be null
Compose apps: where the compose file comes from; null for other builders[].composePathAlwaysstring, may be null
Compose apps with composeSource git: path of the compose file in the repository[].composeServiceAlwaysstring, may be null
Compose apps: the service published on the app’s domains[].composePortAlwaysnumber, may be null
Compose apps: the container port of composeService that receives traffic[].hostingAlwaysone of machine, pooled
machine: its own machines; pooled: a Next.js app on shared hosts[].memoryMbAlwaysnumber
Pooled hosting: memory reserved for the app’s server while it runs, in MB[].idleSecondsAlwaysnumber
Pooled hosting: seconds without a request after which the server is stopped[].poolHostIdAlwaysstring, may be null
Pooled hosting: the shared host the app is placed on; null until placed[].dataSavedAtAlwaysstring, may be null
Pooled hosting: when the app’s data directory was last saved; null if never[].dataBytesAlwaysnumber, may be null
Pooled hosting: size of the last saved data directory, in bytes[].builderAlwaysone of railpack, dockerfile, forgejo_actions, image, compose, nextjs
How the app is built; nextjs for pooled hosting[].buildCommandAlwaysstring, may be null
Build command replacing the detected one; null: the detected one[].startCommandAlwaysstring, may be null
Start command replacing the detected one; null: the detected one[].portAlwaysnumber
Port the app listens on in its container[].releaseCommandAlwaysstring, may be null
Command run once per deployment before traffic moves; null: none[].releaseServiceAlwaysstring, may be null
Compose apps: service the release command runs in; null: the published service[].releaseTimeoutSecAlwaysnumber
Seconds the release command may run[].healthCheckAlwaysobject, may be null
HTTP check a new container must pass; null means GET / below 500[].healthCheck.pathAlwaysstring
Path requested with GET on the container[].healthCheck.portWhen presentnumber
Container port probed; absent means the app’s (or published service’s) port[].healthCheck.expectedStatusWhen presentnumber
The one HTTP status that counts as healthy; absent means any status below 500[].healthCheck.timeoutSecWhen presentnumber
Seconds a new container has to start answering[].composeHealthChecksAlwaysmap, may be null
Compose apps: health checks of other services, by service name; null: none[].composeHealthChecks.<key>.pathAlwaysstring
Path requested with GET on the container[].composeHealthChecks.<key>.portWhen presentnumber
Container port probed; absent means the app’s (or published service’s) port[].composeHealthChecks.<key>.expectedStatusWhen presentnumber
The one HTTP status that counts as healthy; absent means any status below 500[].composeHealthChecks.<key>.timeoutSecWhen presentnumber
Seconds a new container has to start answering[].instanceTypeAlwaysstring
Machine size of each machine (pooled for pooled hosting), e.g. performance-2[].replicasAlwaysnumber
Number of machines[].locationsAlwaysarray of string
Locations the machines are spread over in order; empty: the region’s own location[].hetznerLoadBalancerIdAlwaysnumber, may be null
The app’s load balancer, when it has more than one machine or location; else null[].loadBalancerIpv4Alwaysstring, may be null
Public address of the app’s load balancer; null without one[].ecrRepositoryIdAlwaysstring, may be null
Repository of the organization’s registry the app pulls from; null: none[].serviceAccountIamUserIdAlwaysstring, may be null
The app’s own identity its machines sign in with; null until provisioned[].generationAlwaysnumber
Counter raised with every new desired deployment; machines roll when it changes[].activeDeploymentIdAlwaysstring, may be null
The deployment live now; null before the first one[].statusAlwaysone of created, provisioning, active, suspended, error, deleting
created, provisioning, active, suspended, error or deleting[].reconcileErrorAlwaysstring, may be null
Why the last provisioning or teardown step failed; null when nothing failed[].tlsReportAlwaysobject, may be null
Certificate state a machine last reported, hostname by hostname; null: none yet[].tlsReport.atAlwaysstring
When a machine reported[].tlsReport.entriesAlwaysarray of object
One entry per hostname the machine serves[].tlsReport.entries[].hostAlwaysstring
Hostname[].tlsReport.entries[].okAlwaysboolean
Whether a certificate is served for it[].tlsReport.entries[].errorWhen presentstring
Why not, as the TLS handshake said it[].envChangedAtAlwaysstring, may be null
When the environment or a binding last changed; null if never[].createdAtAlwaysstring
When the app was created[].updatedAtAlwaysstring
When the app was last changed[].hasComposeFileAlwaysboolean
Whether the app has an uploaded compose file[].defaultUrlAlwaysstring
The app’s default hostname
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 listcurl -X GET "https://console.platform-development.deutschecloud.app/deploy/api/apps" \
-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_list.