Skip to content
Praxrr

Get PCD snapshot detail

GET
/pcd/{databaseId}/snapshots/{snapshotId}
curl --request GET \
  --url https://example.com/api/v1/pcd/1/snapshots/1

Returns full snapshot detail including computed fields for restore context (opsWrittenSince, isRestorable). Restore support is not yet implemented, so isRestorable is always false.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
databaseId
required
integer

PCD database ID

snapshotId
required
integer

PCD snapshot ID

Responses

Section titled “Responses”

200

Section titled “200”

Snapshot full detail

Media typeapplication/json
object
id
required
integer
databaseId
required
integer
type
required

Whether the snapshot was auto-created or user-initiated

string
Allowed values: auto manual
trigger
required

What event triggered the snapshot creation.

  • pull: before a PCD repository pull/refresh
  • sync: before an Arr instance sync
  • manual: user-initiated via API
string
Allowed values: pull sync manual
description
required
string
nullable
opsSequenceMaxId
required

Maximum pcd_ops ID at snapshot time

integer
opsCountBase
required

Count of published base-origin ops

integer
opsCountUser
required

Count of published user-origin ops

integer
cacheStateHash
required

SHA-256 state fingerprint

string
nullable
targetInstanceIds
required

Arr instance IDs targeted by this operation

Array<integer>
nullable
createdAt
required
string format: date-time
opsWrittenSince
required

Number of ops written after this snapshot (count of pcd_ops rows with id greater than opsSequenceMaxId)

integer
isRestorable
required

Always false in this release. Restore support is not yet implemented.

boolean
Example
{
  "type": "auto",
  "trigger": "pull"
}

400

Section titled “400”

Invalid parameters

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Snapshot not found or doesn’t belong to database

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to fetch snapshot

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}