Snapshots

Snapshots recorded against a source or a store.

15 endpoints · Plakar Control Plane v0.20 · Base URL, authentication and errors

List the restore points of the organization with the state of each store

GET /api/v1/account/organizations/{id}/restore/points
Badge

Path parameters

  • id string<uuid> required
    Organization ID, at or below the caller’s.

Query parameters

  • offset integer
    Number of items to skip.
    Default: 0
  • limit integer
    Maximum number of items to return.
    Default: 100 Min: 1 Max: 100
  • source_id string<uuid>
    Only snapshots of this source.
  • store_id string<uuid>
    Only snapshots with a live copy on this store.
  • since string<date-time>
    Only snapshots created at or after this time.
  • before string<date-time>
    Only snapshots created before this time.
  • tag array[string]
    Only snapshots carrying every one of these tags.
  • facets boolean
    Also count the snapshots per source, store and tag, each count ignoring its own filter, and with no filter at all.
    Default: false

Response 200 OK application/json

  • facets object nullable
    • sources array[object]
      • count integer
      • source object
        • id string<uuid>
        • integration object
          • id string<uuid>
          • name string
          • version string
        • name string
    • stores array[object]
      • count integer
      • store object
        • deleted boolean
        • id string<uuid>
        • integration object
          • id string<uuid>
          • name string
          • version string
        • locked boolean
        • name string
        • temperature string
    • tags array[object]
      • count integer
      • tag string
    • unfiltered_total integer
  • items array[object]
    • creation_time string<date-time>
    • items integer nullable
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string
    • source object
      • id string<uuid>
      • integration object
        • id string<uuid>
        • name string
        • version string
      • name string
    • stores array[object]
      • country_detected string nullable
      • deleted boolean
      • id string<uuid>
      • integration object
        • id string<uuid>
        • name string
        • version string
      • legal_hold boolean
      • locked boolean
      • name string
      • residency string nullable
      • temperature string
    • tags array[string] nullable
  • total integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/account/organizations/{id}/restore/points' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "facets": {
    "sources": [
      {
        "count": 0,
        "source": {
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "name": "string"
        }
      }
    ],
    "stores": [
      {
        "count": 0,
        "store": {
          "deleted": true,
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "locked": true,
          "name": "string",
          "temperature": "string"
        }
      }
    ],
    "tags": [
      {
        "count": 0,
        "tag": "string"
      }
    ],
    "unfiltered_total": 0
  },
  "items": [
    {
      "creation_time": "2026-01-01T00:00:00Z",
      "items": 0,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "source": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "integration": {
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "name": "string",
          "version": "string"
        },
        "name": "string"
      },
      "stores": [
        {
          "country_detected": "string",
          "deleted": true,
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "legal_hold": true,
          "locked": true,
          "name": "string",
          "residency": "string",
          "temperature": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "total": 0
}

List the restore points of a source with the state of each store

GET /api/v1/account/organizations/{id}/restore/sources/{source_id}/points
Badge

Path parameters

  • id string<uuid> required
    Organization ID, at or below the caller’s.
  • source_id string required

Query parameters

  • offset integer
    Number of items to skip.
    Default: 0
  • limit integer
    Maximum number of items to return.
    Default: 100 Min: 1 Max: 100
  • store_id string<uuid>
    Only snapshots with a live copy on this store.
  • since string<date-time>
    Only snapshots created at or after this time.
  • before string<date-time>
    Only snapshots created before this time.
  • tag array[string]
    Only snapshots carrying every one of these tags.
  • facets boolean
    Also count the snapshots per store and per tag, each count ignoring its own filter.
    Default: false

Response 200 OK application/json

  • facets object nullable
    • sources array[object]
      • count integer
      • source object
        • id string<uuid>
        • integration object
          • id string<uuid>
          • name string
          • version string
        • name string
    • stores array[object]
      • count integer
      • store object
        • deleted boolean
        • id string<uuid>
        • integration object
          • id string<uuid>
          • name string
          • version string
        • locked boolean
        • name string
        • temperature string
    • tags array[object]
      • count integer
      • tag string
    • unfiltered_total integer
  • items array[object]
    • creation_time string<date-time>
    • items integer nullable
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string
    • source object
      • id string<uuid>
      • integration object
        • id string<uuid>
        • name string
        • version string
      • name string
    • stores array[object]
      • country_detected string nullable
      • deleted boolean
      • id string<uuid>
      • integration object
        • id string<uuid>
        • name string
        • version string
      • legal_hold boolean
      • locked boolean
      • name string
      • residency string nullable
      • temperature string
    • tags array[string] nullable
  • total integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/account/organizations/{id}/restore/sources/{source_id}/points' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "facets": {
    "sources": [
      {
        "count": 0,
        "source": {
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "name": "string"
        }
      }
    ],
    "stores": [
      {
        "count": 0,
        "store": {
          "deleted": true,
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "locked": true,
          "name": "string",
          "temperature": "string"
        }
      }
    ],
    "tags": [
      {
        "count": 0,
        "tag": "string"
      }
    ],
    "unfiltered_total": 0
  },
  "items": [
    {
      "creation_time": "2026-01-01T00:00:00Z",
      "items": 0,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "source": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "integration": {
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "name": "string",
          "version": "string"
        },
        "name": "string"
      },
      "stores": [
        {
          "country_detected": "string",
          "deleted": true,
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "version": "string"
          },
          "legal_hold": true,
          "locked": true,
          "name": "string",
          "residency": "string",
          "temperature": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "total": 0
}

List the snapshots of a source

GET /api/v1/snapshots/source/{source_id}
Badge

Path parameters

  • source_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • offset integer
    Number of items to skip.
    Default: 0
  • limit integer
    Maximum number of items to return.
    Default: 100 Min: 1 Max: 100

Response 200 OK application/json

  • items array[object]
    • category string nullable
    • creation_time string<date-time>
    • data_classes array[string] nullable
    • dataset string nullable
    • environment string nullable
    • items integer nullable
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string
    • stores array[object]
      • country_detected string nullable
      • id string<uuid>
      • integration object
        • created_at string<date-time>
        • fields map[array[object]] nullable
        • id string<uuid>
        • name string nullable
        • protocols array[string] nullable
        • supports array[string] nullable
        • updated_at string<date-time>
        • version string nullable
      • legal_hold boolean
      • name string
      • residency string nullable
      • type string
    • tags array[string] nullable
  • total integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/snapshots/source/{source_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "items": [
    {
      "category": "string",
      "creation_time": "2026-01-01T00:00:00Z",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "items": 0,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "stores": [
        {
          "country_detected": "string",
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "integration": {
            "created_at": "2026-01-01T00:00:00Z",
            "fields": {
              "key": [
                {
                  "default": "string",
                  "description": "string",
                  "display_name": "string",
                  "enum": [
                    "string"
                  ],
                  "inventory_value": "string",
                  "name": "string",
                  "pattern": "string",
                  "required": true,
                  "sensitive": true,
                  "type": "string"
                }
              ]
            },
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "name": "string",
            "protocols": [
              "string"
            ],
            "supports": [
              "string"
            ],
            "updated_at": "2026-01-01T00:00:00Z",
            "version": "string"
          },
          "legal_hold": true,
          "name": "string",
          "residency": "string",
          "type": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "total": 0
}

Get a snapshot of a source

GET /api/v1/snapshots/source/{source_id}/{snapshot_id}
Badge

Path parameters

  • source_id string required
  • snapshot_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

  • category string nullable
  • creation_time string<date-time>
  • data_classes array[string] nullable
  • dataset string nullable
  • environment string nullable
  • items integer nullable
  • name string nullable
  • origin string nullable
  • root string nullable
  • size integer nullable
  • snapshot_id string
  • stores array[object]
    • country_detected string nullable
    • id string<uuid>
    • integration object
      • created_at string<date-time>
      • fields map[array[object]] nullable
      • id string<uuid>
      • name string nullable
      • protocols array[string] nullable
      • supports array[string] nullable
      • updated_at string<date-time>
      • version string nullable
    • legal_hold boolean
    • name string
    • residency string nullable
    • type string
  • tags array[string] nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/snapshots/source/{source_id}/{snapshot_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "category": "string",
  "creation_time": "2026-01-01T00:00:00Z",
  "data_classes": [
    "string"
  ],
  "dataset": "string",
  "environment": "string",
  "items": 0,
  "name": "string",
  "origin": "string",
  "root": "string",
  "size": 0,
  "snapshot_id": "string",
  "stores": [
    {
      "country_detected": "string",
      "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
      "integration": {
        "created_at": "2026-01-01T00:00:00Z",
        "fields": {
          "key": [
            {
              "default": "string",
              "description": "string",
              "display_name": "string",
              "enum": [
                "string"
              ],
              "inventory_value": "string",
              "name": "string",
              "pattern": "string",
              "required": true,
              "sensitive": true,
              "type": "string"
            }
          ]
        },
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "name": "string",
        "protocols": [
          "string"
        ],
        "supports": [
          "string"
        ],
        "updated_at": "2026-01-01T00:00:00Z",
        "version": "string"
      },
      "legal_hold": true,
      "name": "string",
      "residency": "string",
      "type": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

List the snapshots of a store

GET /api/v1/snapshots/store/{store_id}
Badge

Path parameters

  • store_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • offset integer
    Number of items to skip.
    Default: 0
  • limit integer
    Maximum number of items to return.
    Default: 100 Min: 1 Max: 100

Response 200 OK application/json

  • items array[object]
    • category string nullable
    • creation_time string<date-time> required
    • data_classes array[string] nullable
    • dataset string nullable
    • environment string nullable
    • items integer nullable
    • legal_hold boolean
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string required
    • store_id string<uuid>
    • tags array[string] nullable
  • total integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/snapshots/store/{store_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "items": [
    {
      "category": "string",
      "creation_time": "2026-01-01T00:00:00Z",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "items": 0,
      "legal_hold": true,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "store_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
      "tags": [
        "string"
      ]
    }
  ],
  "total": 0
}

Preview a prune of a store

POST /api/v1/snapshots/store/{store_id}/prune/preview
Badge

Path parameters

  • store_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Request body application/json required

  • after integer nullable
    Max: 1.8446744073709552e+19
  • before integer nullable
    Max: 1.8446744073709552e+19
  • day integer nullable
  • exec object
    • concurrency integer
    • cpu integer
  • format string nullable
  • hooks object
    • post_job string nullable
    • pre_job string nullable
  • hour integer nullable
  • ignores array[string] nullable
  • labels array[string] nullable
  • latest boolean nullable
  • locate object
    • filters object
      • before string<date-time> nullable
      • category string nullable
      • data_classes array[string] nullable
      • dataset string nullable
      • environment string nullable
      • ids array[string] nullable
      • ignore_tags array[string] nullable
      • job string nullable
      • latest boolean nullable
      • name string nullable
      • origins array[string] nullable
      • perimeter string nullable
      • roots array[string] nullable
      • since string<date-time> nullable
      • tags array[string] nullable
      • types array[string] nullable
    • group_by string nullable
    • periods object
      • day object
        • cap integer nullable
        • keep integer nullable
      • friday object
        • cap integer nullable
        • keep integer nullable
      • hour object
        • cap integer nullable
        • keep integer nullable
      • minute object
        • cap integer nullable
        • keep integer nullable
      • monday object
        • cap integer nullable
        • keep integer nullable
      • month object
        • cap integer nullable
        • keep integer nullable
      • saturday object
        • cap integer nullable
        • keep integer nullable
      • sunday object
        • cap integer nullable
        • keep integer nullable
      • thursday object
        • cap integer nullable
        • keep integer nullable
      • tuesday object
        • cap integer nullable
        • keep integer nullable
      • wednesday object
        • cap integer nullable
        • keep integer nullable
      • week object
        • cap integer nullable
        • keep integer nullable
      • year object
        • cap integer nullable
        • keep integer nullable
  • minute integer nullable
  • month integer nullable
  • path string nullable
  • per_day integer nullable
  • per_hour integer nullable
  • per_minute integer nullable
  • per_month integer nullable
  • per_week integer nullable
  • per_year integer nullable
  • root string nullable
  • snapshot_id string nullable
  • snapshot_ids array[string] nullable
  • week integer nullable
  • year integer nullable

Response 200 OK application/json

  • floored array[string]
  • held array[string]
  • would_delete array[string]
  • would_keep array[string]

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/snapshots/store/{store_id}/prune/preview' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "after": 0,
  "before": 0,
  "day": 0,
  "exec": {
    "concurrency": 0,
    "cpu": 0
  },
  "format": "string",
  "hooks": {
    "post_job": "string",
    "pre_job": "string"
  },
  "hour": 0,
  "ignores": [
    "string"
  ],
  "labels": [
    "string"
  ],
  "latest": true,
  "locate": {
    "filters": {
      "before": "2026-01-01T00:00:00Z",
      "category": "string",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "ids": [
        "string"
      ],
      "ignore_tags": [
        "string"
      ],
      "job": "string",
      "latest": true,
      "name": "string",
      "origins": [
        "string"
      ],
      "perimeter": "string",
      "roots": [
        "string"
      ],
      "since": "2026-01-01T00:00:00Z",
      "tags": [
        "string"
      ],
      "types": [
        "string"
      ]
    },
    "group_by": "string",
    "periods": {
      "day": {
        "cap": 0,
        "keep": 0
      },
      "friday": {
        "cap": 0,
        "keep": 0
      },
      "hour": {
        "cap": 0,
        "keep": 0
      },
      "minute": {
        "cap": 0,
        "keep": 0
      },
      "monday": {
        "cap": 0,
        "keep": 0
      },
      "month": {
        "cap": 0,
        "keep": 0
      },
      "saturday": {
        "cap": 0,
        "keep": 0
      },
      "sunday": {
        "cap": 0,
        "keep": 0
      },
      "thursday": {
        "cap": 0,
        "keep": 0
      },
      "tuesday": {
        "cap": 0,
        "keep": 0
      },
      "wednesday": {
        "cap": 0,
        "keep": 0
      },
      "week": {
        "cap": 0,
        "keep": 0
      },
      "year": {
        "cap": 0,
        "keep": 0
      }
    }
  },
  "minute": 0,
  "month": 0,
  "path": "string",
  "per_day": 0,
  "per_hour": 0,
  "per_minute": 0,
  "per_month": 0,
  "per_week": 0,
  "per_year": 0,
  "root": "string",
  "snapshot_id": "string",
  "snapshot_ids": [
    "string"
  ],
  "week": 0,
  "year": 0
}'

Response 200

{
  "floored": [
    "string"
  ],
  "held": [
    "string"
  ],
  "would_delete": [
    "string"
  ],
  "would_keep": [
    "string"
  ]
}

Prune a store

POST /api/v1/snapshots/store/{store_id}/prune/run
Badge

Path parameters

  • store_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • actor string
    Scheduler to address. default: tasks created through the UI or the API. policy: tasks created by SLA policies, and their jobs. custom: tasks of integrations that drive the scheduler, such as Kubernetes; deprecated in favor of user:. user: the caller’s personal scheduler; 404 until POST /scheduling/scheduler creates it. user:: the personal scheduler of another user; needs view access on schedulers.
    Default: "default"

Request body application/json required

  • after integer nullable
    Max: 1.8446744073709552e+19
  • before integer nullable
    Max: 1.8446744073709552e+19
  • day integer nullable
  • exec object
    • concurrency integer
    • cpu integer
  • format string nullable
  • hooks object
    • post_job string nullable
    • pre_job string nullable
  • hour integer nullable
  • ignores array[string] nullable
  • labels array[string] nullable
  • latest boolean nullable
  • locate object
    • filters object
      • before string<date-time> nullable
      • category string nullable
      • data_classes array[string] nullable
      • dataset string nullable
      • environment string nullable
      • ids array[string] nullable
      • ignore_tags array[string] nullable
      • job string nullable
      • latest boolean nullable
      • name string nullable
      • origins array[string] nullable
      • perimeter string nullable
      • roots array[string] nullable
      • since string<date-time> nullable
      • tags array[string] nullable
      • types array[string] nullable
    • group_by string nullable
    • periods object
      • day object
        • cap integer nullable
        • keep integer nullable
      • friday object
        • cap integer nullable
        • keep integer nullable
      • hour object
        • cap integer nullable
        • keep integer nullable
      • minute object
        • cap integer nullable
        • keep integer nullable
      • monday object
        • cap integer nullable
        • keep integer nullable
      • month object
        • cap integer nullable
        • keep integer nullable
      • saturday object
        • cap integer nullable
        • keep integer nullable
      • sunday object
        • cap integer nullable
        • keep integer nullable
      • thursday object
        • cap integer nullable
        • keep integer nullable
      • tuesday object
        • cap integer nullable
        • keep integer nullable
      • wednesday object
        • cap integer nullable
        • keep integer nullable
      • week object
        • cap integer nullable
        • keep integer nullable
      • year object
        • cap integer nullable
        • keep integer nullable
  • minute integer nullable
  • month integer nullable
  • path string nullable
  • per_day integer nullable
  • per_hour integer nullable
  • per_minute integer nullable
  • per_month integer nullable
  • per_week integer nullable
  • per_year integer nullable
  • root string nullable
  • snapshot_id string nullable
  • snapshot_ids array[string] nullable
  • week integer nullable
  • year integer nullable

Response 200 OK application/json

  • at_ids array[string<uuid>]
  • deleted array[string]
  • floored array[string]
  • held array[string]

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/snapshots/store/{store_id}/prune/run' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "after": 0,
  "before": 0,
  "day": 0,
  "exec": {
    "concurrency": 0,
    "cpu": 0
  },
  "format": "string",
  "hooks": {
    "post_job": "string",
    "pre_job": "string"
  },
  "hour": 0,
  "ignores": [
    "string"
  ],
  "labels": [
    "string"
  ],
  "latest": true,
  "locate": {
    "filters": {
      "before": "2026-01-01T00:00:00Z",
      "category": "string",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "ids": [
        "string"
      ],
      "ignore_tags": [
        "string"
      ],
      "job": "string",
      "latest": true,
      "name": "string",
      "origins": [
        "string"
      ],
      "perimeter": "string",
      "roots": [
        "string"
      ],
      "since": "2026-01-01T00:00:00Z",
      "tags": [
        "string"
      ],
      "types": [
        "string"
      ]
    },
    "group_by": "string",
    "periods": {
      "day": {
        "cap": 0,
        "keep": 0
      },
      "friday": {
        "cap": 0,
        "keep": 0
      },
      "hour": {
        "cap": 0,
        "keep": 0
      },
      "minute": {
        "cap": 0,
        "keep": 0
      },
      "monday": {
        "cap": 0,
        "keep": 0
      },
      "month": {
        "cap": 0,
        "keep": 0
      },
      "saturday": {
        "cap": 0,
        "keep": 0
      },
      "sunday": {
        "cap": 0,
        "keep": 0
      },
      "thursday": {
        "cap": 0,
        "keep": 0
      },
      "tuesday": {
        "cap": 0,
        "keep": 0
      },
      "wednesday": {
        "cap": 0,
        "keep": 0
      },
      "week": {
        "cap": 0,
        "keep": 0
      },
      "year": {
        "cap": 0,
        "keep": 0
      }
    }
  },
  "minute": 0,
  "month": 0,
  "path": "string",
  "per_day": 0,
  "per_hour": 0,
  "per_minute": 0,
  "per_month": 0,
  "per_week": 0,
  "per_year": 0,
  "root": "string",
  "snapshot_id": "string",
  "snapshot_ids": [
    "string"
  ],
  "week": 0,
  "year": 0
}'

Response 200

{
  "at_ids": [
    "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
  ],
  "deleted": [
    "string"
  ],
  "floored": [
    "string"
  ],
  "held": [
    "string"
  ]
}

Get a snapshot of a store

GET /api/v1/snapshots/store/{store_id}/{snapshot_id}
Badge

Path parameters

  • store_id string required
  • snapshot_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

  • category string nullable
  • creation_time string<date-time> required
  • data_classes array[string] nullable
  • dataset string nullable
  • environment string nullable
  • items integer nullable
  • legal_hold boolean
  • name string nullable
  • origin string nullable
  • root string nullable
  • size integer nullable
  • snapshot_id string required
  • store_id string<uuid>
  • tags array[string] nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/snapshots/store/{store_id}/{snapshot_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "category": "string",
  "creation_time": "2026-01-01T00:00:00Z",
  "data_classes": [
    "string"
  ],
  "dataset": "string",
  "environment": "string",
  "items": 0,
  "legal_hold": true,
  "name": "string",
  "origin": "string",
  "root": "string",
  "size": 0,
  "snapshot_id": "string",
  "store_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "tags": [
    "string"
  ]
}

Update a snapshot in a store

PATCH /api/v1/snapshots/store/{store_id}/{snapshot_id}
Badge

Path parameters

  • store_id string required
  • snapshot_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Request body application/json required

  • legal_hold boolean nullable

Response 200 OK application/json

  • category string nullable
  • creation_time string<date-time> required
  • data_classes array[string] nullable
  • dataset string nullable
  • environment string nullable
  • items integer nullable
  • legal_hold boolean
  • name string nullable
  • origin string nullable
  • root string nullable
  • size integer nullable
  • snapshot_id string required
  • store_id string<uuid>
  • tags array[string] nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl -X PATCH 'https://pcp.example.com/api/v1/snapshots/store/{store_id}/{snapshot_id}' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "legal_hold": true
}'

Response 200

{
  "category": "string",
  "creation_time": "2026-01-01T00:00:00Z",
  "data_classes": [
    "string"
  ],
  "dataset": "string",
  "environment": "string",
  "items": 0,
  "legal_hold": true,
  "name": "string",
  "origin": "string",
  "root": "string",
  "size": 0,
  "snapshot_id": "string",
  "store_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "tags": [
    "string"
  ]
}

List the stores holding a snapshot

GET /api/v1/snapshots/{snapshot_id}
Badge

Path parameters

  • snapshot_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

  • entries array[object]
    • category string nullable
    • creation_time string<date-time> required
    • data_classes array[string] nullable
    • dataset string nullable
    • environment string nullable
    • items integer nullable
    • legal_hold boolean
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string required
    • store_id string<uuid>
    • tags array[string] nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/snapshots/{snapshot_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "entries": [
    {
      "category": "string",
      "creation_time": "2026-01-01T00:00:00Z",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "items": 0,
      "legal_hold": true,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "store_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
      "tags": [
        "string"
      ]
    }
  ]
}

Update a snapshot in every store

PATCH /api/v1/snapshots/{snapshot_id}
Badge

Path parameters

  • snapshot_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Request body application/json required

  • legal_hold boolean nullable

Response 200 OK application/json

  • entries array[object]
    • category string nullable
    • creation_time string<date-time> required
    • data_classes array[string] nullable
    • dataset string nullable
    • environment string nullable
    • items integer nullable
    • legal_hold boolean
    • name string nullable
    • origin string nullable
    • root string nullable
    • size integer nullable
    • snapshot_id string required
    • store_id string<uuid>
    • tags array[string] nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl -X PATCH 'https://pcp.example.com/api/v1/snapshots/{snapshot_id}' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "legal_hold": true
}'

Response 200

{
  "entries": [
    {
      "category": "string",
      "creation_time": "2026-01-01T00:00:00Z",
      "data_classes": [
        "string"
      ],
      "dataset": "string",
      "environment": "string",
      "items": 0,
      "legal_hold": true,
      "name": "string",
      "origin": "string",
      "root": "string",
      "size": 0,
      "snapshot_id": "string",
      "store_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
      "tags": [
        "string"
      ]
    }
  ]
}

Get the daily history of the stores

GET /api/v1/stores/history
Badge
Summed over the stores of the organization the caller can see, oldest first.

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • days integer
    How many days back, today included.
    Default: 30 Min: 1 Max: 365

Response 200 OK application/json

  • days array[object]
    • bytes integer<int64>
    • day string
    • objects integer
    • recorded integer
    • sized integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/stores/history' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "days": [
    {
      "bytes": 0,
      "day": "string",
      "objects": 0,
      "recorded": 0,
      "sized": 0
    }
  ]
}

Sum up the integrity checks of the stores

GET /api/v1/stores/integrity
Badge
Counts only the stores of the organization the caller can see.

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

  • checked integer
  • failing integer
  • failing_stores array[object]
    • failing integer
    • id string
    • name string
  • not_standard integer
  • objects integer
  • off integer
  • off_stores array[object]
    • id string
    • name string
  • passing integer
  • storage_bytes integer<int64>
  • storage_objects integer
  • storage_sized integer
  • store_sizes array[object]
    • bytes integer<int64>
    • id string
    • name string
    • objects integer
    • sized integer
  • stores integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/stores/integrity' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "checked": 0,
  "failing": 0,
  "failing_stores": [
    {
      "failing": 0,
      "id": "string",
      "name": "string"
    }
  ],
  "not_standard": 0,
  "objects": 0,
  "off": 0,
  "off_stores": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "passing": 0,
  "storage_bytes": 0,
  "storage_objects": 0,
  "storage_sized": 0,
  "store_sizes": [
    {
      "bytes": 0,
      "id": "string",
      "name": "string",
      "objects": 0,
      "sized": 0
    }
  ],
  "stores": 0
}

List the contents of a store

GET /api/v1/stores/{store_id}/contents
Badge
The states and packfiles the last scan found in the store, states first, newest first.

Path parameters

  • store_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • type string
    Only resources of this type.
    Allowed: packfile, state
  • failing boolean
    Only the resources whose last integrity check failed.
  • offset integer
    Number of items to skip.
    Default: 0
  • limit integer
    Maximum number of items to return.
    Default: 100 Min: 1 Max: 100

Response 200 OK application/json

  • bytes integer<int64>
  • coverage array[object]
    • bytes integer<int64>
    • checked integer
    • oldest string<date-time> nullable
    • seconds integer<int64>
  • daily_budget integer<int64> nullable
  • error string nullable
  • failing integer
  • full_cycle_days number<double> nullable
  • integrity_check_every integer<int64> nullable
  • integrity_check_sample object nullable
    • order string nullable
      Allowed: random, oldest, newest
    • percent integer
  • items array[object]
    • check_error string nullable
    • checked_at string<date-time> nullable
    • created_at string<date-time>
    • mac string
    • size integer<int64> nullable
    • type string
  • last_check_passed integer
  • listed_at string<date-time> nullable
  • never_checked integer
  • packfiles integer
  • passing integer
  • sampled integer
  • sized integer
  • states integer
  • total integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/stores/{store_id}/contents' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "bytes": 0,
  "coverage": [
    {
      "bytes": 0,
      "checked": 0,
      "oldest": "2026-01-01T00:00:00Z",
      "seconds": 0
    }
  ],
  "daily_budget": 0,
  "error": "string",
  "failing": 0,
  "full_cycle_days": 0,
  "integrity_check_every": 0,
  "integrity_check_sample": {
    "order": "random",
    "percent": 0
  },
  "items": [
    {
      "check_error": "string",
      "checked_at": "2026-01-01T00:00:00Z",
      "created_at": "2026-01-01T00:00:00Z",
      "mac": "string",
      "size": 0,
      "type": "string"
    }
  ],
  "last_check_passed": 0,
  "listed_at": "2026-01-01T00:00:00Z",
  "never_checked": 0,
  "packfiles": 0,
  "passing": 0,
  "sampled": 0,
  "sized": 0,
  "states": 0,
  "total": 0
}

Get the daily history of a store

GET /api/v1/stores/{store_id}/history
Badge
One entry per day, oldest first: what the store held, and the integrity checks run that day.

Path parameters

  • store_id string required

Query parameters

  • organization_id string<uuid>
    Organization to act on, at or below the caller’s. Defaults to the caller’s.
  • days integer
    How many days back, today included.
    Default: 30 Min: 1 Max: 365

Response 200 OK application/json

  • days array[object]
    • bytes integer<int64>
    • checked integer
    • day string
    • failed integer
    • packfiles integer
    • recorded boolean
    • sized integer
    • states integer

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/stores/{store_id}/history' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "days": [
    {
      "bytes": 0,
      "checked": 0,
      "day": "string",
      "failed": 0,
      "packfiles": 0,
      "recorded": true,
      "sized": 0,
      "states": 0
    }
  ]
}

Product

Integrations

Resources

Company

Newsletter