v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Snapshot

Create snapshot

Creates a snapshot from the specified branch. This operation may initiate an asynchronous process.

Note: This endpoint is currently in Beta.

post/projects/{project_id}/branches/{branch_id}/snapshot

Query parameters

lsnstring

The target Log Sequence Number (LSN) to take the snapshot from. Must fall within the restore window. Cannot be used with timestamp

timestampstring

The target timestamp for the snapshot. Must fall within the restore window. Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z). Cannot be used with lsn.

namestring

A name for the snapshot.

expires_atstring

The time at which the snapshot will be automatically deleted. Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z).

Response

Successfully created the snapshot

Example response

{
  "operations": [
    {
      "id": "d8ac46eb-a757-42b1-9907-f78322ee394e",
      "project_id": "spring-example-302709",
      "branch_id": "br-wispy-meadow-118737",
      "endpoint_id": "ep-silent-smoke-806639",
      "action": "start_compute",
      "status": "finished",
      "failures_count": 0,
      "created_at": "2022-11-15T20:02:00Z",
      "updated_at": "2022-11-15T20:02:02Z",
      "total_duration_ms": 200
    }
  ]
}