Effects

Tell Ratchet you are still working

Extends a lease you still hold. Use it for work that may outrun its lease: keep the lease short so a real crash is caught quickly, and heartbeat while you are alive. An expired or superseded lease cannot be revived — by then the outcome is already recorded as unknown, and erasing that would defeat the point.

post/v1/effects/{effectId}/heartbeat

Request

  • Base URL: https://ratchetgate.com
  • URL: https://ratchetgate.com/v1/effects/{effectId}/heartbeat
  • Auth: HTTP bearer

Path parameters

effectIdstring required

Request body

lease_tokenstring required
extend_secondsinteger

Fresh lease length from now. Clamped to the policy maximum.

Response

Default Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.