deploy.env.secure

Move plain variables into secrets, without the values leaving the platform

POST /deploy/api/apps/{id}/env/secureIAM deploy:ManageEnvChanges stateDestructive

Each named variable must hold a plain value. Its value becomes a new secret under a KMS key, granted to the deploy consumer and bound to the variable in one transaction; the plain value is no longer stored. Security Posture offers this as the fix for a credential kept as a plain variable. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.

Depending on the resource, the call checks secrets:CreateSecret, deploy:DeployApp instead; hold all of them to be sure it is allowed.

Request syntax

POST /deploy/api/apps/{id}/env/secure
{
  "keys": "array of string",
  "keyId": "string",
  "redeploy": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • keysRequired

    array of string

    Plain variables whose values move into new secrets

    Constraints: 1-128 chars, /^[A-Za-z_][A-Za-z0-9_]*$/

  • keyIdOptional

    string

    KMS key the new secrets are encrypted under; default the organization’s default key

    Constraints: uuid

    May be null.

  • redeployOptional

    boolean

    Also roll the live deployment onto the new environment; default false

Response

200 with `data`: `applied` and `plan` (per key, the secret created). The top-level `redeploy` is null unless redeploy was requested; then { ok: true, deploymentId, generation, reusedDeploymentId } or { ok: false, error }. A variable that is missing is 404, one that holds no plain value 409.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • appliedAlways

    boolean

    Always true on success
  • planAlways

    object

    The plan
  • plan.​itemsAlways

    array of object

    Per key, what happens to it
  • plan.​items[].​keyAlways

    string

    Variable name
  • plan.​items[].​kindAlways

    one of plain, secret, reference, existing-secret, removed

    What it becomes
  • plan.​items[].​changeAlways

    one of add, update, unchanged, remove, error

    What happens to it
  • plan.​items[].​reasonAlways

    string

    Why it was classified so
  • plan.​items[].​detailAlways

    string

    What applying does, in a sentence
  • plan.​items[].​errorAlways

    string, may be null

    Why it cannot be applied; null if it can
  • plan.​items[].​lineAlways

    number, may be null

    Line in the file; null for a removal
  • plan.​issuesAlways

    array of object

    Lines that could not be read
  • plan.​issues[].​lineAlways

    number

    Line in the file
  • plan.​issues[].​keyAlways

    string, may be null

    Variable name, if one could be read
  • plan.​issues[].​messageAlways

    string

    What is wrong
  • plan.​summaryAlways

    object

    Counts by change
  • plan.​summary.​addAlways

    number

    Variables added
  • plan.​summary.​updateAlways

    number

    Variables changed
  • plan.​summary.​unchangedAlways

    number

    Variables left as they are
  • plan.​summary.​removeAlways

    number

    Variables removed
  • plan.​summary.​errorAlways

    number

    Variables with an error
  • plan.​applicableAlways

    boolean

    False when any item has an error; nothing is applied then

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 secure id --keys '["example"]'

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_env_secure.