deploy.env.importImport a .env or .env.op file — dry run for the plan, then apply atomically
dcloud deploy env import <appId> --content "$(cat .env.op)" --preview. op:// references become synced secrets; sensitive-looking values become secrets, the rest plain (override per key with classify); dcloud-secret://NAME (or ews-secret://NAME) binds an existing secret. mode=merge keeps keys the file omits, replace removes them. Nothing is applied if any key has an error. No value is ever echoed back. 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, secrets:RotateSecret, secrets:UseSecretSource, secrets:GetSecretValue, deploy:DeployApp instead; hold all of them to be sure it is allowed.
Request syntax
POST /deploy/api/apps/{id}/env/import
{
"content": "string",
"mode": "enum",
"classify": "map of string",
"source": "string",
"sourceId": "string",
"keyId": "string",
"preview": "boolean",
"redeploy": "boolean"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
contentRequiredstring
The .env / .env.op file text
Constraints: max 524288 chars
modeOptionalenum
merge (default) keeps variables the file does not mention; replace removes them
One of:
merge,replaceclassifyOptionalmap of string
Per key, plain or secret, overriding the kind the import would pick
Constraints: key=value
sourceOptionalstring
Secret source (by name) for NEW op:// references, needed only when several sources reach the vault
Constraints: 2-63 chars
May be null.
sourceIdOptionalstring
The same secret source as source, by id (the older spelling)
Constraints: uuid
May be null.
keyIdOptionalstring
KMS key new secrets are encrypted under; default the organization’s default key
Constraints: uuid
May be null.
previewOptionalboolean
Return the plan without changing anything; default false
redeployOptionalboolean
Also roll the live deployment onto the imported environment; default false, ignored with preview
Response
200 with `data`: `applied` (false for a preview) and `plan` — `items` (per key, what happens to it), `issues` (lines that could not be read), `summary` (counts of add, update, unchanged, remove, error) and `applicable`. The top-level `redeploy` is null unless redeploy was requested; then { ok: true, deploymentId, generation, reusedDeploymentId } or { ok: false, error }. A plan with errors is answered 422 with the plan and nothing changed.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
appliedAlwaysboolean
False for a preview: nothing was changedplanAlwaysobject
The planplan.itemsAlwaysarray of object
Per key, what happens to itplan.items[].keyAlwaysstring
Variable nameplan.items[].kindAlwaysone of plain, secret, reference, existing-secret, removed
What it becomesplan.items[].changeAlwaysone of add, update, unchanged, remove, error
What happens to itplan.items[].reasonAlwaysstring
Why it was classified soplan.items[].detailAlwaysstring
What applying does, in a sentenceplan.items[].errorAlwaysstring, may be null
Why it cannot be applied; null if it canplan.items[].lineAlwaysnumber, may be null
Line in the file; null for a removalplan.issuesAlwaysarray of object
Lines that could not be readplan.issues[].lineAlwaysnumber
Line in the fileplan.issues[].keyAlwaysstring, may be null
Variable name, if one could be readplan.issues[].messageAlwaysstring
What is wrongplan.summaryAlwaysobject
Counts by changeplan.summary.addAlwaysnumber
Variables addedplan.summary.updateAlwaysnumber
Variables changedplan.summary.unchangedAlwaysnumber
Variables left as they areplan.summary.removeAlwaysnumber
Variables removedplan.summary.errorAlwaysnumber
Variables with an errorplan.applicableAlwaysboolean
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 import id --content examplecurl -X POST "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/env/import" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"content":"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_import.