Creates a snapshot for a Supabase project.
Operation description
Creates a snapshot for a Supabase project based on a specified point in time or Log Sequence Number (LSN). You must specify either SnapshotTimestamp or Lsn. ClientToken is used to ensure idempotence of the request.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. Specifies the region in which to perform the operation. |
cn-hangzhou |
| ProjectId |
string |
Yes |
The Supabase project ID. |
spb-xxxx |
| SnapshotTimestamp |
string |
No |
The point in time for the snapshot. You must specify either this parameter or Lsn. If this parameter is specified, the snapshot is created based on the specified point in time. |
2026-04-08T09:11:12Z |
| Lsn |
string |
No |
The LSN for the snapshot. You must specify either this parameter or SnapshotTimestamp. If this parameter is specified, the snapshot is created based on the specified LSN. |
0/3522648 |
| ClientToken |
string |
No |
The idempotence token. Ensures that repeated requests do not result in duplicate operations. |
123e4567-e89b-12d3-a456-426655440000 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The request ID. |
B4CAF581-2AC7-41AD-8940-D56DF7AADF5B |
| Lsn |
string |
The LSN for the snapshot. You must specify either this parameter or SnapshotTimestamp. If this parameter is specified, the snapshot is created based on the specified LSN. |
0/3522648 |
| Timestamp |
string |
The actual point in time that corresponds to the created snapshot. |
2026-04-08T09:11:12Z |
| BranchId |
string |
The branch ID to which the snapshot belongs. |
br-xxxx |
Examples
Success response
JSON format
{
"RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
"Lsn": "0/3522648",
"Timestamp": "2026-04-08T09:11:12Z",
"BranchId": "br-xxxx"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.