Cancel a heartbeat run
pc_post_heartbeat_runs_by_run_id_cancelCancel a heartbeat run by providing its run ID to stop the monitoring process.
Instructions
Cancel a heartbeat run
Paperclip operation: POST /api/heartbeat-runs/{runId}/cancel. Authorization class: board_or_agent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Optional JSON compatibility payload. The source OpenAPI operation does not declare a request schema. | |
| path | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| headers | Yes | ||
| encoding | Yes | ||
| status_code | Yes | ||
| content_type | Yes |