v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB

Actors/Actor versions

Update environment variable

Updates Actor environment variable using values specified by a EnvVar object passed as JSON in the POST payload. If the object does not define a specific property, its value will not be updated.

The request needs to specify the Content-Type: application/json HTTP header!

When providing your API authentication token, we recommend using the request's Authorization header, rather than the URL. (More info).

The response is the EnvVar object as returned by the Get environment variable endpoint.

put/v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}

Path parameters

actorIdstring required

Example:janedoe~my-actor

Actor ID or a tilde-separated owner's username and Actor name.

versionNumberstring required

Example:0.1

Actor version.

envVarNamestring required

Example:MY_ENV_VAR

The name of the environment variable

Request body

namestring required

The name of the environment variable.

valuestring required

The value of the environment variable. If isSecret is true, this value isn't returned by the API.

isSecretboolean nullable

Whether the environment variable is encrypted. Secret values aren't returned by the API.

Example request

{
  "name": "MY_ENV_VAR",
  "value": "my-value"
}

Response

Example response

{
  "data": {
    "name": "MY_ENV_VAR",
    "value": "my-value"
  }
}