Abort run
POSThttps://api.apify.com/v2/actor-runs/:runId/abort
ClientsAborts an Actor run and returns an object that contains all the details
about the run.
Only runs that are starting or running are aborted. For runs with status
FINISHED
, FAILED
, ABORTING
and TIMED-OUT
this call does nothing.
Request
Path Parameters
runId stringrequired
Run ID.
Query Parameters
gracefully boolean
If true passed, the Actor run will abort gracefully.
It will send aborting
and persistState
event into run and force-stop the run after 30 seconds.
It is helpful in cases where you plan to resurrect the run later.
Responses
- 200
Response Headers
- application/json
- Schema
- Example (auto)
- Example
Schema
data object
{
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "HDSasDasz78YcAPEB",
"userId": "7sT5jcggjjA9fNcxF",
"actorTaskId": "KJHSKHausidyaJKHs",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "RUNNING",
"statusMessage": "Actor is running",
"isStatusMessageTerminal": false,
"meta": {
"origin": "DEVELOPMENT"
},
"pricingInfo": {
"apifyMarginPercentage": 0,
"createdAt": "2024-07-29T15:51:28.071Z",
"startedAt": "2024-07-29T15:51:28.071Z",
"notifiedAboutFutureChangeAt": "2024-07-29T15:51:28.071Z",
"notifiedAboutChangeAt": "2024-07-29T15:51:28.071Z",
"reasonForChange": "string",
"pricingModel": "PAY_PER_EVENT",
"pricingPerEvent": {
"actorChargeEvents": {}
},
"minimalMaxTotalChargeUsd": 0
},
"stats": {
"inputBodyLen": 240,
"restartCount": 0,
"resurrectCount": 2,
"memAvgBytes": 267874071.9,
"memMaxBytes": 404713472,
"memCurrentBytes": 0,
"cpuAvgUsage": 33.7532101107538,
"cpuMaxUsage": 169.650735534941,
"cpuCurrentUsage": 0,
"netRxBytes": 103508042,
"netTxBytes": 4854600,
"durationMillis": 248472,
"runTimeSecs": 248.472,
"metamorph": 0,
"computeUnits": 0.13804
},
"chargedEventCounts": {},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"buildNumber": "0.0.36",
"containerUrl": "https://g8kd8kbc5ge8.runs.apify.net",
"isContainerServerReady": true,
"gitBranchName": "master",
"usageTotalUsd": 0.2654
}
}
{
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "BPWZBd7Z9c746JAng",
"actorTaskId": "rANaydYhUxjsnA3oz",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"statusMessage": "Actor was aborted",
"isStatusMessageTerminal": true,
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"inputBodyLen": 240,
"restartCount": 0,
"resurrectCount": 1,
"memAvgBytes": 35914228.4,
"memMaxBytes": 38244352,
"memCurrentBytes": 0,
"cpuAvgUsage": 0.00955965,
"cpuMaxUsage": 3.1546,
"cpuCurrentUsage": 0,
"netRxBytes": 2652,
"netTxBytes": 1338,
"durationMillis": 26239,
"runTimeSecs": 26.239,
"metamorph": 0,
"computeUnits": 0.0072886
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"isContainerServerReady": false,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES?": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.072,
"DATASET_READS": 0.0004,
"DATASET_WRITES": 0.0002,
"KEY_VALUE_STORE_READS": 0.0006,
"KEY_VALUE_STORE_WRITES": 0.002,
"KEY_VALUE_STORE_LISTS": 0.004,
"REQUEST_QUEUE_READS": 0.005,
"REQUEST_QUEUE_WRITES": 0.02,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.0004,
"DATA_TRANSFER_EXTERNAL_GBYTES?": 0.0002,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16,
"PROXY_SERPS": 0.0006
}
}
}
Authorization: http
name: httpBearertype: httpscheme: bearerdescription: API authentication token.
- CLI
- JavaScript
- Python
- PHP
- Java
- C
- C#
- Go
- Rust
- Node.js
- Ruby
- PowerShell
- Dart
- Objective-C
- OCaml
- R
- Swift
- Kotlin
- Apify CLI
apify runs abort <RUN ID>
- CURL
curl -L -X POST 'https://api.apify.com/v2/actor-runs/:runId/abort' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
ResponseClear