project-lock

Lock Heartbeat

Refresh the lock TTL. Call every ~30s while holding the lock.

post/api/v1/project/{project_id}/lock/heartbeat

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/project/{project_id}/lock/heartbeat
  • Auth
    HTTP bearer

Response

Successful Response

is_lockedboolean required

Whether the project is currently locked.

locked_by_user_idstring nullable

User ID of the lock holder, if locked.

locked_by_display_namestring nullable

Display name of the lock holder for UI.

locked_by_avatar_colorstring nullable

Avatar color name of the lock holder for UI.

is_current_userboolean

True when the current user holds the lock.

ttl_secondsinteger nullable

Remaining TTL of the lock in seconds, if locked.

Changes

No recorded changes to this operation across all 30 revisions of this API.