Skip to main content
Version: Next

ActorEnvVarClient

Client for managing a specific Actor environment variable.

Environment variables are key-value pairs that are available to the Actor during execution. This client provides methods to get, update, and delete environment variables.

Hierarchy

  • ResourceClient
    • ActorEnvVarClient
const client = new ApifyClient({ token: 'my-token' });
const actorClient = client.actor('my-actor-id');
const versionClient = actorClient.version('0.1');

// Get an environment variable
const envVarClient = versionClient.envVar('MY_VAR');
const envVar = await envVarClient.get();

// Update environment variable
await envVarClient.update({ value: 'new-value' });

See more at https://docs.apify.com/platform/actors/development/programming-interface/environment-variables

Added in 2.1.0

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

Added in 2.17.0

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

delete

  • delete(options): Promise<void>

get

  • get(options): Promise<undefined | EnvVar>

update

  • update(actorEnvVar, options): Promise<EnvVar>
Page Options