Run
Certified
Start an Apify Task run
Run
Certified
Start an Apify Task run
yaml
type: io.kestra.plugin.apify.task.RunExamples
yaml
id: run_apify_task
namespace: company.team
tasks:
- id: run_task
type: io.kestra.plugin.apify.task.Run
taskId: my_username~my-task
apiToken: "{{ secret('APIFY_API_TOKEN') }}"
yaml
id: run_apify_task_with_input
namespace: company.team
tasks:
- id: run_task
type: io.kestra.plugin.apify.task.Run
taskId: my_username~my-task
apiToken: "{{ secret('APIFY_API_TOKEN') }}"
maxItems: 100
waitForFinish: 60
input:
startUrls:
- url: "https://example.com"
Properties
apiToken *Requiredstring
taskId *Requiredstring
build string
input object
maxItems integerstring
maxTotalChargeUsd numberstring
memory string
Possible Values
MB_128MB_256MB_512MB_1024MB_2048MB_4096MB_8192MB_16384MB_32768options Non-dynamic
Definitions
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
io.kestra.core.http.client.configurations.DigestAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
readIdleTimeoutstring
Default
PT5MrequestTimeout numberstring
waitForFinish integerstring
webhooks string
Outputs
actId string
actorTaskId string
buildId string
buildNumber string
chargedEventCounts object
SubTypenumber
containerUrl string
defaultDatasetId string
defaultKeyValueStoreId string
defaultRequestQueueId string
exitCode number
finishedAt string
generalAccess string
Possible Values
FOLLOW_USER_SETTINGRESTRICTEDANYONE_WITH_ID_CAN_READgitBranchName string
id string
isContainerServerReady boolean
meta
Definitions
io.kestra.plugin.apify.actor.ActorRunMeta
clientIpstring
originstring
userAgentstring
options
Definitions
io.kestra.plugin.apify.actor.ActorRunOptions
maxTotalChargeUsdnumber
pricingInfo
Definitions
io.kestra.plugin.apify.actor.pricinginfo.PricePerEventActorPricingInfo
apifyMarginPercentagenumber
createdAtstring
minimalMaxTotalChargeUsdnumber
notifiedAboutChangeAtstring
notifiedAboutFutureChangeAtstring
pricingModelstring
pricingPerEvent
io.kestra.plugin.apify.actor.pricinginfo.PricingPerEvent
actorChargeEventsobject
io.kestra.plugin.apify.actor.pricinginfo.ActorChargeEvent
eventDescriptionstring
eventPriceUsdnumber
eventTitlestring
reasonForChangestring
startedAtstring
io.kestra.plugin.apify.actor.pricinginfo.PricePerDatasetItemActorPricingInfo
apifyMarginPercentagenumber
createdAtstring
notifiedAboutChangeAtstring
notifiedAboutFutureChangeAtstring
pricePerUnitUsdnumber
pricingModelstring
reasonForChangestring
startedAtstring
unitNamestring
io.kestra.plugin.apify.actor.pricinginfo.FlatPricePerMonthActorPricingInfo
apifyMarginPercentagenumber
createdAtstring
notifiedAboutChangeAtstring
notifiedAboutFutureChangeAtstring
pricePerUnitUsdnumber
pricingModelstring
reasonForChangestring
startedAtstring
trialMinutesnumber
io.kestra.plugin.apify.actor.pricinginfo.FreeActorPricingInfo
apifyMarginPercentagenumber
createdAtstring
notifiedAboutChangeAtstring
notifiedAboutFutureChangeAtstring
pricingModelstring
reasonForChangestring
startedAtstring
startedAt string
stats
Definitions
io.kestra.plugin.apify.actor.ActorRunStats
computeUnitsnumber
cpuAvgUsagenumber
cpuCurrentUsagenumber
cpuMaxUsagenumber
durationMillisnumber
inputBodyLennumber
memAvgBytesnumber
memCurrentBytesnumber
memMaxBytesnumber
metamorphnumber
netRxBytesnumber
netTxBytesnumber
restartCountnumber
resurrectCountnumber
runTimeSecsnumber
status string
Possible Values
READYRUNNINGSUCCEEDEDFAILEDTIMING_OUTTIMED_OUTABORTINGABORTEDstatusMessage string
usage
Definitions
io.kestra.plugin.apify.actor.ActorRunUsage
ACTOR_COMPUTE_UNITSnumber
DATASET_READSnumber
DATASET_WRITESnumber
DATA_TRANSFER_EXTERNAL_GBYTESnumber
DATA_TRANSFER_INTERNAL_GBYTESnumber
KEY_VALUE_STORE_LISTSnumber
KEY_VALUE_STORE_READSnumber
KEY_VALUE_STORE_WRITESnumber
PROXY_RESIDENTIAL_TRANSFER_GBYTESnumber
PROXY_SERPSnumber
REQUEST_QUEUE_READSnumber
REQUEST_QUEUE_WRITESnumber
usageTotalUsd string
usageUsd
Definitions
io.kestra.plugin.apify.actor.ActorRunUsage
ACTOR_COMPUTE_UNITSnumber
DATASET_READSnumber
DATASET_WRITESnumber
DATA_TRANSFER_EXTERNAL_GBYTESnumber
DATA_TRANSFER_INTERNAL_GBYTESnumber
KEY_VALUE_STORE_LISTSnumber
KEY_VALUE_STORE_READSnumber
KEY_VALUE_STORE_WRITESnumber
PROXY_RESIDENTIAL_TRANSFER_GBYTESnumber
PROXY_SERPSnumber
REQUEST_QUEUE_READSnumber
REQUEST_QUEUE_WRITESnumber
