Deployments.ai Docs
Automations

List heartbeat fire history

GET /v1/heartbeats/{heartbeatId}/fires · SDK listHeartbeatFires · CLI deployments heartbeat fires

GET
/v1/heartbeats/{heartbeatId}/fires

Requires schedules:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

heartbeatId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListHeartbeatFiresResponse

application/json
  1. response
fires*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/heartbeats/string/fires"
{  "fires": [    {      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "completedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "heartbeatId": "string",      "id": "string",      "object": "heartbeat-run",      "responseKind": "string",      "runId": "string",      "skipReason": "string",      "status": "accepted",      "threadId": "string",      "version": 0    }  ],  "nextCursor": "string"}