environments.unsetVariable

DELETE

/environments/{environmentId}/variables/{key}

const url = 'https://example.com/api/environments/example/variables/example';
const options = {
  method: 'DELETE',
  headers: {'Content-Type': 'application/json'},
  body: '{"exposure":"build-time","scope":"defaults"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/environments/example/variables/example \
  --header 'Content-Type: application/json' \
  --data '{ "exposure": "build-time", "scope": "defaults" }'

Removes an environment variable in a specific exposure and optional scope. Public docs: /docs/environments/variables/precedence/#environment-variable-precedence

Parameters

Path Parameters

environmentId

required

string

>= 1 characters

key

required

string

>= 1 characters

Request Body^required

application/json

object

exposure

required

string

Allowed values: build-time runtime

scope

string

Allowed values: defaults system organization project environment resource deployment

Responses

204

application/json

null

Example ^generated

example

environments.unsetVariable

Parameters

Path Parameters

Request Body required

Responses

204

Example generated

Request Body^required

Example ^generated