deploy.env.get

Variables with sync status, database bindings, and whether a redeploy is pending

GET /deploy/api/apps/{id}/envIAM deploy:ManageEnvChanges stateDestructive

Request syntax

GET /deploy/api/apps/{id}/env

Path parameters

  • idRequired

    string

    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

  • varsAlways

    array of object

    The variables set on the app
  • vars[].​keyAlways

    string

    Variable name
  • vars[].​valueKindAlways

    one of plain, secret

    plain or secret
  • vars[].​plainValueAlways

    string, may be null

    The value; null for a secret
  • vars[].​kmsSecretIdAlways

    string, may be null

    The bound Secret; null for plain
  • vars[].​secretAlways

    object, may be null

    The bound Secret; null for plain, or when it was deleted
  • vars[].​secret.​idAlways

    string

    Secret id
  • vars[].​secret.​nameAlways

    string

    Secret name
  • vars[].​secret.​sourceAlways

    object, may be null

    The external source it is synced from; null for an ordinary secret
  • vars[].​secret.​source.​idAlways

    string

    Secret source id
  • vars[].​secret.​source.​nameAlways

    string

    Its name
  • vars[].​secret.​source.​providerAlways

    string

    Its provider, e.g. 1password
  • vars[].​secret.​sourceRefAlways

    string, may be null

    Reference in the source, e.g. op://vault/item/field; null if none
  • vars[].​secret.​syncStatusAlways

    one of ok, error, may be null

    Outcome of the last sync; null for an ordinary secret
  • vars[].​secret.​syncErrorAlways

    string, may be null

    Why the last sync failed
  • vars[].​secret.​lastSyncedAtAlways

    string, may be null

    When it was last synced
  • databaseBindingsAlways

    array of object

    Managed Postgres bindings
  • databaseBindings[].​idAlways

    string

    Binding id
  • databaseBindings[].​dbInstanceIdAlways

    string

    The database instance
  • databaseBindings[].​dbIdentifierAlways

    string, may be null

    Its name; null if it is gone
  • databaseBindings[].​databaseAlways

    string

    Database the app connects to
  • databaseBindings[].​modeAlways

    one of app_role, master

    app_role or master
  • databaseBindings[].​roleNameAlways

    string, may be null

    The app’s role; null for master
  • databaseBindings[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • databaseBindings[].​pooledAlways

    boolean

    Whether it connects through the pooler
  • databaseBindings[].​statusAlways

    one of pending, ready, error

    pending, ready or error
  • databaseBindings[].​statusMessageAlways

    string, may be null

    What was done, or what failed
  • databaseBindings[].​unreachableAlways

    string, may be null

    Why the app’s machines cannot reach it; null when they can
  • databaseBindings[].​generatedKeysAlways

    array of string

    Variable names the binding generates
  • cacheBindingsAlways

    array of object

    Managed cache bindings
  • cacheBindings[].​idAlways

    string

    Binding id
  • cacheBindings[].​cacheClusterIdAlways

    string

    The cache
  • cacheBindings[].​cacheIdentifierAlways

    string, may be null

    Its name; null if it is gone
  • cacheBindings[].​cacheStatusAlways

    string, may be null

    Its status; null if it is gone
  • cacheBindings[].​privateAddressAlways

    string, may be null

    Its private address; null until it has one
  • cacheBindings[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • cacheBindings[].​generatedKeysAlways

    array of string

    Variable names the binding generates
  • brokerBindingsAlways

    array of object

    Kafka, RabbitMQ and Document Database bindings
  • brokerBindings[].​idAlways

    string

    Binding id
  • brokerBindings[].​engineAlways

    one of kafka, rabbitmq, docdb

    kafka, rabbitmq or docdb
  • brokerBindings[].​resourceIdAlways

    string, may be null

    The cluster or broker
  • brokerBindings[].​identifierAlways

    string, may be null

    Its name; null if it is gone
  • brokerBindings[].​statusAlways

    string, may be null

    Its status; null if it is gone
  • brokerBindings[].​userNameAlways

    string

    User the app signs in as
  • brokerBindings[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • brokerBindings[].​generatedKeysAlways

    array of string

    Variable names the binding generates
  • statusAlways

    object

    Whether the saved configuration is running
  • status.​pendingAlways

    boolean

    True when the live deployment runs an older configuration
  • status.​liveDeploymentIdAlways

    string, may be null

    The live deployment; null if none
  • status.​liveGenerationAlways

    number, may be null

    Its generation
  • status.​reasonsAlways

    array 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 id

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.