Deployments.ai Docs
Automations

List heartbeats

GET /v1/heartbeats · SDK listHeartbeats · CLI deployments heartbeat list

GET
/v1/heartbeats

Requires schedules:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

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

ListHeartbeatsResponse

application/json
  1. response
heartbeats*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/heartbeats"
{  "heartbeats": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "workspaceId": "string",      "activeWindow": {        "daysOfWeek": [          0        ],        "endMinuteOfDay": 0,        "startMinuteOfDay": 1439      },      "agentDeploymentId": "string",      "createdBy": {        "id": "string",        "type": "agent"      },      "id": "string",      "lastRunAt": "2019-08-24T14:15:22Z",      "nextRunAt": "2019-08-24T14:15:22Z",      "object": "heartbeat",      "schedule": {        "instructions": "string",        "intervalMs": 60000,        "skipWhenBusy": true,        "timezone": "string"      },      "status": "active",      "threadId": "string"    }  ],  "nextCursor": "string"}