v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB

platformApi

Api Byoc Heartbeat Create

Data-plane heartbeat — authenticated by the deployment service token.

Authenticated by X-Respan-Deployment-Token (not a user JWT), so it has no JWT auth/permission classes; resolve_deployment_by_token is the gate.

post/api/byoc/heartbeat/

X-Respan-Deployment-Tokenstring required

BYOC data-plane deployment service token (issued at registration; not a user JWT)

statestring required

Entitlement state machine value.

is_entitledboolean required

notestring nullable required

license_keystring nullable required

Fresh entitlement token; null when not entitled.

token_expires_atstring date-time nullable required

grace_daysinteger required

next_heartbeat_secondsinteger required