APapify
Actors/Actor versions

Update environment variable in Actor version

Changed on

Updates Actor environment variable using values specified by an 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. For details, see Authentication.

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

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

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

actorIdstring required
Example:compass~google-maps-extractor

Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (~).

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. Can't contain =.

valuestring required

The value of the environment variable.

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",
    "valueHash": "a1b2c3"
  }
}

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • e52dd2239ceeRevision changes
    • info

      added the optional property / to the response with the status