Get environment variable

GET 
/v2/acts/:actorId/versions/:versionNumber/env-vars/:envVarName

Gets a EnvVar object that contains all the details about a specific environment variable of an Actor.

If isSecret is set to true, then value will never be returned.

Request

Path Parameters

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

Example: janedoe~my-actor
versionNumber string required
Actor version

Example: 0.1
envVarName string required
The name of the environment variable

Example: MY_ENV_VAR

Status 200

Response Headers

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

Schema

• data object required

  • name string required
    Example: MY_ENV_VAR
  • value string required
    Example: my-value
  • isSecret boolean | null nullable
    Example: false

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 required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)