Deployments.ai Docs
Automations

Fire a heartbeat now

POST /v1/heartbeats/{heartbeatId}/fire · SDK fireHeartbeat · CLI deployments heartbeat fire

POST
/v1/heartbeats/{heartbeatId}/fire

Requires schedules:write.

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}$

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}$
idempotency-key?string

Required unless the request body supplies a stable fireKey. Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.

Match^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$
Length1 <= length <= 256

Request Body

application/json
  1. body
agentDeploymentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
fireKey?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length

Response Body

FireHeartbeatResponse

application/json
  1. response
duplicate*boolean
heartbeatRun*
run?
curl -X POST "https://example.com/v1/heartbeats/string/fire" \  -H "Content-Type: application/json" \  -d '{    "agentDeploymentId": "string"  }'
{  "duplicate": true,  "heartbeatRun": {    "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  },  "run": {    "runId": "string",    "threadId": "string"  }}