Skip to main content
Version: Next

ApifyEnv

Parsed representation of the Apify environment variables. This object is returned by the Actor.getEnv function.

Index

Properties

Properties

actorBuildId

actorBuildId: null | string

ID of the Actor build used in the run. (ACTOR_BUILD_ID)

actorBuildNumber

actorBuildNumber: null | string

actorEventsWsUrl

actorEventsWsUrl: null | string

actorId

actorId: null | string

ID of the Actor (ACTOR_ID)

actorMaxPaidDatasetItems

actorMaxPaidDatasetItems: null | number

actorRunId

actorRunId: null | string

ID of the Actor run (ACTOR_RUN_ID)

actorTaskId

actorTaskId: null | string

ID of the Actor task (ACTOR_TASK_ID)

apiBaseUrl

apiBaseUrl: null | string

apiPublicBaseUrl

apiPublicBaseUrl: null | string

chromeExecutablePath

chromeExecutablePath: null | string

containerPort

containerPort: null | number

containerUrl

containerUrl: null | string

dedicatedCpus

dedicatedCpus: null | string

defaultDatasetId

defaultDatasetId: null | string

ID of the dataset where input and output data of this Actor is stored (ACTOR_DEFAULT_DATASET_ID)

defaultKeyValueStoreId

defaultKeyValueStoreId: null | string

ID of the key-value store where input and output data of this Actor is stored (ACTOR_DEFAULT_KEY_VALUE_STORE_ID)

defaultRequestQueueId

defaultRequestQueueId: null | string

disableOutdatedWarning

disableOutdatedWarning: null | 1

fact

fact: null | string

headless

headless: null | string

If set to "1", the web browsers inside the Actor should run in headless mode because there is no windowing system available. (APIFY_HEADLESS)

inputKey

inputKey: null | string

The key of the input record in the Actor’s default key-value store (ACTOR_INPUT_KEY)

inputSecretsPrivateKeyFile

inputSecretsPrivateKeyFile: null | string

inputSecretsPrivateKeyPassphrase

inputSecretsPrivateKeyPassphrase: null | string

isAtHome

isAtHome: null | string

Is set to "1" if the Actor is running on Apify servers. (APIFY_IS_AT_HOME)

localStorageDir

localStorageDir: null | string

Defines the path to a local directory where KeyValueStore, Dataset, and RequestQueue store their data. Typically, it is set to ./storage. If omitted, you should define the APIFY_TOKEN environment variable instead. See more info on combination of this and APIFY_TOKEN here(CRAWLEE_STORAGE_DIR)

logFormat

logFormat: null | string

logLevel

logLevel: null | string

Specifies the minimum log level, which can be one of the following values (in order of severity): DEBUG, INFO, WARNING and ERROR (APIFY_LOG_LEVEL)

memoryMbytes

memoryMbytes: null | number

Amount of memory allocated for the Actor, in megabytes (ACTOR_MEMORY_MBYTES)

metaOrigin

metaOrigin: null | string

Origin for the Actor run, i.e. how it was started. See here for more details. (APIFY_META_ORIGIN)

proxyHostname

proxyHostname: null | string

proxyPassword

proxyPassword: null | string

The Apify Proxy password of the user who started the Actor. (APIFY_PROXY_PASSWORD)

proxyPort

proxyPort: null | string

proxyStatusUrl

proxyStatusUrl: null | string

You can visit this page to troubleshoot your proxy connection. (APIFY_PROXY_STATUS_URL)

sdkLatestVersion

sdkLatestVersion: null | string

startedAt

startedAt: null | Date

Date when the Actor was started (ACTOR_STARTED_AT)

systemInfoIntervalMillis

systemInfoIntervalMillis: null | string

timeoutAt

timeoutAt: null | Date

Date when the Actor will time out (ACTOR_TIMEOUT_AT)

token

token: null | string

Authentication token representing privileges given to the Actor run, it can be passed to various Apify APIs (APIFY_TOKEN)

userId

userId: null | string

ID of the user who started the Actor - note that it might be different than the owner of the Actor (APIFY_USER_ID)

workflowKey

workflowKey: null | string
Page Options