dots.v2.harnessRuntime.sessions.bySession_id().checkpoints.post()
Generated on 18 Nov 2026
from DoTs version
v1.25.0
Usage
client.v2.harnessRuntime.sessions.bySession_id(session_id).checkpoints.post(body: Create_checkpoint_request, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Create_checkpoint_response>Description
Synchronous: blocks until the capture reaches READY and returns the terminal Checkpoint, clients never see PENDING on this endpoint and need no poll loop. The checkpoint binds the machine-state capture to the event-log cursor at the cut, so it can later seed forks (POST …/fork) and rollback. Checkpoints are taken between turns; a session with an active turn in flight returns 409. A checkpoint captures machine state only: the files of a persistent workspace the session has are not in it, and are saved by the workspace itself.
Parameters
Path Parameters
session_idstring requiredExample:
a1b2c3d4-e5f6-7890-abcd-ef1234567890The session UUID.
Request Body
labelstring optionalOptional human-readable label stored on the checkpoint; "" if omitted.
Request Sample
Response Example
More Information
See /v2/harness-runtime/sessions/{session_id}/checkpoints in the API reference for additional detail on responses, headers, parameters, and more.