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
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_VARStatus 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
The environment variable value. This field is absent in responses when
Example:isSecretistrue, as secret values are never returned by the API.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 ErrorType (string)
Machine-processable error type identifier.
Possible values: [
actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding] - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)
Status 401
Unauthorized - authentication required or invalid token.
{
"error": {
"type": "token-not-valid",
"message": "Authentication token is not valid."
}
}
Schema
error object required
- type ErrorType (string)
Machine-processable error type identifier.
Possible values: [
actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding] - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)
Status 403
Forbidden - insufficient permissions to perform this action.
{
"error": {
"type": "permission-denied",
"message": "You do not have permission to perform this action."
}
}
Schema
error object required
- type ErrorType (string)
Machine-processable error type identifier.
Possible values: [
actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding] - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)
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 ErrorType (string)
Machine-processable error type identifier.
Possible values: [
Constant value:actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding]actor-not-found - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)
Status 405
Method not allowed.
{
"error": {
"type": "method-not-allowed",
"message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
}
}
Schema
error object required
- type ErrorType (string)
Machine-processable error type identifier.
Possible values: [
actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding] - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)
Status 429
Too many requests - rate limit exceeded.
{
"error": {
"type": "rate-limit-exceeded",
"message": "You have exceeded the rate limit. Please try again later."
}
}
Schema
error object required
- type ErrorType (string)
Machine-processable error type identifier.
Possible values: [
actor-memory-limit-exceeded,actor-not-found,invalid-input,method-not-allowed,permission-denied,rate-limit-exceeded,record-not-found,record-not-unique,record-or-token-not-found,request-id-invalid,request-too-large,run-failed,run-timeout-exceeded,token-not-valid,unknown-build-tag,unsupported-content-encoding] - message string
Human-readable error message describing what went wrong.
- type ErrorType (string)