---
title: "Self-hosted deployment heartbeat"
method: POST
path: "/deployments/heartbeat"
tags: ["Licensing"]
---

# Self-hosted deployment heartbeat

`POST /deployments/heartbeat`

## Request

- Base URL: `https://api.mnemom.ai/v1`
- URL: `https://api.mnemom.ai/v1/deployments/heartbeat`
- Auth: HTTP bearer

Called periodically by a self-hosted Mnemom instance to report liveness, version, and metadata back to the managed control plane. Uses a **License JWT** bearer token (not a user JWT) — the token is issued during license validation. The response includes `next_heartbeat_seconds` telling the instance when to call back.

## Request body

- object
  - `deployment_id` string, required
  - `instance_id` string, required
  - `version` string
  - `heartbeat_data` object: Free-form liveness telemetry (uptime, resource usage, component versions …).

## Response `200`

Heartbeat accepted.

- object
  - `deployment_id` string, required
  - `status` 'active' | 'inactive' | 'degraded', required
  - `next_heartbeat_seconds` integer, required
  - `server_time` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Cross-origin write refused (`cross_origin_rejected`). A state-changing request that carries the browser session cookie must come from a first-party origin (`Origin`, or failing that `Referer`) and must not send a form-style body (text/plain, urlencoded, multipart) the operation does not declare. Bearer and API-key callers are never subject to this check.
- `404`: Resource not found
- `429`: Rate-limit exceeded. The global per-IP limiter (100 requests/minute, applied to every `/v1/*` route) rejected this request. Back off until the window resets — `Retry-After` carries the cooldown in seconds and `X-RateLimit-Reset` the absolute reset time.
- `500`: Server error — request was well-formed but the server failed to fulfill it. Typically a downstream dependency (DB / RPC / external API) returned an unexpected error.
- `503`: An upstream dependency is currently unavailable. The request was not processed; retry after the cooldown window.

---

[API](https://skmtc.dev/mnemom/apis/mnemom-api.md) · [All operations](https://skmtc.dev/mnemom/apis/mnemom-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mnemom/apis/mnemom-api/revisions/274b7a6ea182?raw)