Update environment variable
PUT/v2/acts/:actorId/versions/:versionNumber/env-vars/:envVarName
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.
Request
Path Parameters
Actor ID or a tilde-separated owner's username and Actor name.
Example:janedoe~my-actorActor version
Example:0.1The name of the environment variable
Example:MY_ENV_VARBodyrequired
- name string requiredExample:
MY_ENV_VAR - value string requiredExample:
my-value - isSecret boolean | null nullableExample:
false
Status 200
Response Headers
{
"data": {
"name": "MY_ENV_VAR",
"value": "my-value",
"isSecret": false
}
}
Schema
data object required
- name string requiredExample:
MY_ENV_VAR - value string requiredExample:
my-value - isSecret boolean | null nullableExample:
false
- name string requiredExample:
Status 400
Bad request - invalid input parameters or request body.
{
"error": {
"type": "invalid-input",
"message": "Invalid input: The request body contains invalid data."
}
}
Schema
error object required
- type string requiredExample:
run-failed - message string requiredExample:
Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)
- type string requiredExample:
Status 404
Not found - the requested resource was not found.
{
"error": {
"type": "actor-not-found",
"message": "Actor was not found"
}
}
Schema
- oneOf
- ActorNotFoundError
- ActorVersionNotFoundError
- EnvironmentVariableNotFoundError
error object
- type string
Possible values: [
actor-not-found] - message string
Possible values: [
Actor was not found]
- type string