deploy.env.getVariables with sync status, database bindings, and whether a redeploy is pending
Request syntax
GET /deploy/api/apps/{id}/envPath parameters
idRequiredstring
Constraints: uuid
Response
200 with `data`: `vars` (key, valueKind, plainValue, kmsSecretId and, for a secret, its name, source and sync status), `databaseBindings`, `cacheBindings` and `brokerBindings` (each with its envPrefix and generatedKeys), and `status` — pending, liveDeploymentId, liveGeneration and the reasons a redeploy is pending.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
varsAlwaysarray of object
The variables set on the appvars[].keyAlwaysstring
Variable namevars[].valueKindAlwaysone of plain, secret
plain or secretvars[].plainValueAlwaysstring, may be null
The value; null for a secretvars[].kmsSecretIdAlwaysstring, may be null
The bound Secret; null for plainvars[].secretAlwaysobject, may be null
The bound Secret; null for plain, or when it was deletedvars[].secret.idAlwaysstring
Secret idvars[].secret.nameAlwaysstring
Secret namevars[].secret.sourceAlwaysobject, may be null
The external source it is synced from; null for an ordinary secretvars[].secret.source.idAlwaysstring
Secret source idvars[].secret.source.nameAlwaysstring
Its namevars[].secret.source.providerAlwaysstring
Its provider, e.g. 1passwordvars[].secret.sourceRefAlwaysstring, may be null
Reference in the source, e.g. op://vault/item/field; null if nonevars[].secret.syncStatusAlwaysone of ok, error, may be null
Outcome of the last sync; null for an ordinary secretvars[].secret.syncErrorAlwaysstring, may be null
Why the last sync failedvars[].secret.lastSyncedAtAlwaysstring, may be null
When it was last synceddatabaseBindingsAlwaysarray of object
Managed Postgres bindingsdatabaseBindings[].idAlwaysstring
Binding iddatabaseBindings[].dbInstanceIdAlwaysstring
The database instancedatabaseBindings[].dbIdentifierAlwaysstring, may be null
Its name; null if it is gonedatabaseBindings[].databaseAlwaysstring
Database the app connects todatabaseBindings[].modeAlwaysone of app_role, master
app_role or masterdatabaseBindings[].roleNameAlwaysstring, may be null
The app’s role; null for masterdatabaseBindings[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonedatabaseBindings[].pooledAlwaysboolean
Whether it connects through the poolerdatabaseBindings[].statusAlwaysone of pending, ready, error
pending, ready or errordatabaseBindings[].statusMessageAlwaysstring, may be null
What was done, or what faileddatabaseBindings[].unreachableAlwaysstring, may be null
Why the app’s machines cannot reach it; null when they candatabaseBindings[].generatedKeysAlwaysarray of string
Variable names the binding generatescacheBindingsAlwaysarray of object
Managed cache bindingscacheBindings[].idAlwaysstring
Binding idcacheBindings[].cacheClusterIdAlwaysstring
The cachecacheBindings[].cacheIdentifierAlwaysstring, may be null
Its name; null if it is gonecacheBindings[].cacheStatusAlwaysstring, may be null
Its status; null if it is gonecacheBindings[].privateAddressAlwaysstring, may be null
Its private address; null until it has onecacheBindings[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonecacheBindings[].generatedKeysAlwaysarray of string
Variable names the binding generatesbrokerBindingsAlwaysarray of object
Kafka, RabbitMQ and Document Database bindingsbrokerBindings[].idAlwaysstring
Binding idbrokerBindings[].engineAlwaysone of kafka, rabbitmq, docdb
kafka, rabbitmq or docdbbrokerBindings[].resourceIdAlwaysstring, may be null
The cluster or brokerbrokerBindings[].identifierAlwaysstring, may be null
Its name; null if it is gonebrokerBindings[].statusAlwaysstring, may be null
Its status; null if it is gonebrokerBindings[].userNameAlwaysstring
User the app signs in asbrokerBindings[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonebrokerBindings[].generatedKeysAlwaysarray of string
Variable names the binding generatesstatusAlwaysobject
Whether the saved configuration is runningstatus.pendingAlwaysboolean
True when the live deployment runs an older configurationstatus.liveDeploymentIdAlwaysstring, may be null
The live deployment; null if nonestatus.liveGenerationAlwaysnumber, may be null
Its generationstatus.reasonsAlwaysarray of string
Why a redeploy is pending
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:ManageEnv 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 env get idcurl -X GET "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/env" \
-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_env_get.