Skip to main content
Version: Next

ActorStandby

Standby mode configuration, for keeping an Actor warm and responsive.

Hierarchy

  • GeneratedActorStandby
    • ActorStandby

Added in 2.9.5

Index

Properties

Properties

optionalinheritedbuild

build?: null | string

Which build to run in standby mode. Either a build tag or a version number.

optionalinheriteddesiredRequestsPerActorRun

desiredRequestsPerActorRun?: null | number

Target number of concurrent HTTP requests a single run is configured to handle.

optionalinheriteddisableStandbyFieldsOverride

disableStandbyFieldsOverride?: null | boolean

If true, prevents the standby mode configuration from being overridden elsewhere.

optionalinheritedidleTimeoutSecs

idleTimeoutSecs?: null | number

In seconds, how long a run can stay idle without incoming requests before it's terminated.

optionalinheritedisConsoleAuthEnabled

isConsoleAuthEnabled?: null | boolean

Whether standby requests can be authenticated with an Apify Console session. When creating an Actor, omit this field or set it to false. When updating an Actor, only Apify administrators can change it; other users can only send the current value, or false if it's not set yet.

optionalinheritedisEnabled

isEnabled?: null | boolean

Whether standby mode is enabled for the Actor.

optionalinheritedisTokenlessEnabled

isTokenlessEnabled?: null | boolean

Whether standby requests can be made without an API token. When creating an Actor, omit this field or set it to false. When updating an Actor, only Apify administrators can change it; other users can only send the current value, or false if it's not set yet.

optionalinheritedmaxRequestsPerActorRun

maxRequestsPerActorRun?: null | number

Maximum number of concurrent HTTP requests that can be routed to a single run.

optionalinheritedmemoryMbytes

memoryMbytes?: null | number

In MB, the amount of memory allocated to the run.

optionalinheritedshouldPassActorInput

shouldPassActorInput?: null | boolean

Whether to pass the Actor's input to the standby run. If false, the standby runs start with no input.

optionalinheritedtenancy

tenancy?: null | SINGLE_TENANT | MULTI_TENANT
SINGLE_TENANT
@enum {string|null}

Whether each user gets their own standby runs (SINGLE_TENANT) or runs are shared across users (MULTI_TENANT).

Page Options