runnerHeartbeat
POST
/api/runner/v1/task-runs/{taskRunId}/heartbeat
const url = 'https://example.com/api/runner/v1/task-runs/example/heartbeat';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/runner/v1/task-runs/example/heartbeatParameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”taskRunId
required
string
Responses
Section titled “ Responses ”OK
Media typeapplication/json
object
cancel
required
boolean
key
additional properties
any
Examplegenerated
{ "cancel": true}default
Section titled “default”Error
Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{ "error": { "code": "example", "details": "example", "message": "example" }}