Skip to main content

Update status message

PUT 
https://api.apify.com/v2/actor-runs/:runId

You can set a single status message on your run that will be displayed in the Apify Console UI. During an Actor run, you will typically do this in order to inform users of your Actor about the Actor's progress.

The request body must contain runId and statusMessage properties. The isStatusMessageTerminal property is optional and it indicates if the status message is the very last one. In the absence of a status message, the platform will try to substitute sensible defaults.

Request​

Path Parameters

    runId stringrequired

    Run ID.

Bodyrequired

    runIdstringrequired
    Example: 3KH8gEpp4d8uQSe8T
    statusMessagestringrequired
    Example: Actor has finished
    isStatusMessageTerminalboolean
    Example: true

Responses​

Response Headers
    Schema
      data object
      idstringrequired
      Example: HG7ML7M8z78YcAPEB
      actIdstringrequired
      Example: HDSasDasz78YcAPEB
      userIdstringrequired
      Example: 7sT5jcggjjA9fNcxF
      actorTaskIdstringnullable
      Example: KJHSKHausidyaJKHs
      startedAtstringrequired
      Example: 2019-11-30T07:34:24.202Z
      finishedAtstringrequired
      Example: 2019-12-12T09:30:12.202Z
      statusstringrequired
      Example: RUNNING
      statusMessagestringnullable
      Example: Actor is running
      isStatusMessageTerminalbooleannullable
      Example: false
      meta objectrequired
      originstringrequired

      Possible values: [DEVELOPMENT, WEB, API, SCHEDULER, TEST, WEBHOOK, ACTOR, CLI, STANDBY]

      pricingInfo object
      pricingModel

      Possible values: [PAY_PER_EVENT, PRICE_PER_DATASET_ITEM, FLAT_PRICE_PER_MONTH, FREE]

      apifyMarginPercentagenumberrequired

      In [0, 1], fraction of pricePerUnitUsd that goes to Apify

      createdAtdate-timerequired

      When this pricing info record has been created

      startedAtdate-timerequired

      Since when is this pricing info record effective for a given Actor

      notifiedAboutFutureChangeAtdate-timenullable
      notifiedAboutChangeAtdate-timenullable
      reasonForChangestringnullable
      pricingModelstringrequired

      Possible values: [PAY_PER_EVENT]

      pricingPerEvent objectrequired
      actorChargeEvents object
      property name* ActorChargeEvent
      eventPriceUsdnumberrequired
      eventTitlestringrequired
      eventDescriptionstringrequired
      minimalMaxTotalChargeUsdnumbernullable
      stats objectrequired
      inputBodyLennumber
      Example: 240
      migrationCountnumber
      Example: 0
      restartCountnumberrequired
      Example: 0
      resurrectCountnumberrequired
      Example: 2
      memAvgBytesnumber
      Example: 267874071.9
      memMaxBytesnumber
      Example: 404713472
      memCurrentBytesnumber
      Example: 0
      cpuAvgUsagenumber
      Example: 33.7532101107538
      cpuMaxUsagenumber
      Example: 169.650735534941
      cpuCurrentUsagenumber
      Example: 0
      netRxBytesnumber
      Example: 103508042
      netTxBytesnumber
      Example: 4854600
      durationMillisnumber
      Example: 248472
      runTimeSecsnumber
      Example: 248.472
      metamorphnumber
      Example: 0
      computeUnitsnumberrequired
      Example: 0.13804
      chargedEventCounts object
      property name* ActorChargeEvent
      eventPriceUsdnumberrequired
      eventTitlestringrequired
      eventDescriptionstringrequired
      options objectrequired
      buildstringrequired
      Example: latest
      timeoutSecsnumberrequired
      Example: 300
      memoryMbytesnumberrequired
      Example: 1024
      diskMbytesnumberrequired
      Example: 2048
      buildIdstringrequired
      Example: 7sT5jcggjjA9fNcxF
      exitCodenumbernullable
      Example: 0
      defaultKeyValueStoreIdstringrequired
      Example: eJNzqsbPiopwJcgGQ
      defaultDatasetIdstringrequired
      Example: wmKPijuyDnPZAPRMk
      defaultRequestQueueIdstringrequired
      Example: FL35cSF7jrxr3BY39
      buildNumberstringrequired
      Example: 0.0.36
      containerUrlstringrequired
      Example: https://g8kd8kbc5ge8.runs.apify.net
      isContainerServerReadybooleannullable
      Example: true
      gitBranchNamestringnullable
      Example: master
      usage object
      oneOf
      usageTotalUsdnumbernullable
      Example: 0.2654
      usageUsd object
      oneOf

    Authorization: http

    name: httpBearertype: httpscheme: bearerdescription: API authentication token.
    curl -L -X PUT 'https://api.apify.com/v2/actor-runs/:runId' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <token>' \
    -d '{
      "runId": "3KH8gEpp4d8uQSe8T",
      "statusMessage": "Actor has finished",
      "isStatusMessageTerminal": true
    }'
    Request Collapse all
    Base URL
    https://api.apify.com
    Auth
    Parameters
    — pathrequired
    Body required
    {
  "runId": "3KH8gEpp4d8uQSe8T",
  "statusMessage": "Actor has finished",
  "isStatusMessageTerminal": true
}
    ResponseClear

    Click the Send API Request button above and see the response here!