Skip to main content
POST
/
deployments
/
heartbeat
Self-hosted deployment heartbeat
curl --request POST \
  --url https://api.mnemom.ai/v1/deployments/heartbeat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deployment_id": "<string>",
  "instance_id": "<string>",
  "version": "<string>",
  "heartbeat_data": {}
}
'
{
  "deployment_id": "<string>",
  "next_heartbeat_seconds": 300,
  "server_time": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

License JWT (HS256, HMAC-signed with LICENSE_SIGNING_SECRET). Used by self-hosted deployment instances to authenticate /v1/deployments/heartbeat. Not interchangeable with the Supabase user JWT.

Body

application/json
deployment_id
string
required
instance_id
string
required
version
string
heartbeat_data
object

Free-form liveness telemetry (uptime, resource usage, component versions …).

Response

Heartbeat accepted.

deployment_id
string
required
status
enum<string>
required
Available options:
active,
inactive,
degraded
next_heartbeat_seconds
integer
default:300
required
server_time
string<date-time>
required