Client API: Deployments: Variables

Part of Deployments.

GET /api/v1/client/deployments/{deployment_uuid}/variables

List a deployment's variables without their values, by environment, branch and key, and the env groups linked to it. environment and branch narrow the list; hint is the last four characters of a value of eight or more.

Authentication: an access token, sent as Authorization: Bearer <token>.

PUT /api/v1/client/deployments/{deployment_uuid}/variables

Set many variables in one environment (and, for preview, one branch); a variable given without value keeps its saved one. With replace every variable of that environment and branch not listed is deleted. Changes reach the deployment with its next release.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/deployments/{deployment_uuid}/variables/export

The .env file a release of environment reads, as text/plain: development when left out, preview or production, and for preview a branch whose own values win. Env groups and bindings are included, and build and runtime values together unless target narrows them. A value marked secret is never written: a comment at the top names its key, as it does a value that could not be read. Only the account, an Admin or Technical member of its team or an API key with a write permission may export (for an organization, its owners and admins); anyone else answers 403. Each export is rate-limited per caller and audited, without values, before it is answered.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/deployments/{deployment_uuid}/variables/import

Import a .env file into one environment (and branch). Every value is secret and reaches target as the body says. A line that is not KEY=value, a key the platform sets, or a key given twice is refused with 422 and its line number, and nothing is saved.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/deployments/{deployment_uuid}/variables/resolved

Each key a release of environment (and branch) would read for target, and where its value comes from: branch, environment, all, group, or binding with the binding's id, kind and label. Never a value.

Authentication: an access token, sent as Authorization: Bearer <token>.

PUT /api/v1/client/deployments/{deployment_uuid}/variables/{key}

Set one variable in one environment, creating it when it is new. A new variable needs a value and is secret unless secret is false. A key the platform sets itself, such as PORT or one starting CORITAN_, is refused with 422.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

DELETE /api/v1/client/deployments/{deployment_uuid}/variables/{key}

Delete one variable of one environment. Running instances keep it until the next release; a key the environment does not have answers 404.

Authentication: an access token, sent as Authorization: Bearer <token>.