Listing backups

Listing available backups

In this case, we are looking to find out what backups have already been created and when for a given repository.

Example Call

This example lists backups in scs-snapshots-repo. Use /backups/list without a repository suffix to list snapshots across repositories.

curl -X GET https://telicent.core.domain/api/search/backups/list/scs-snapshots-repo \
  -H "Content-Type: application/json" \
  -H "Authorization: ${TC_OIDC_TOKEN}"

Response

{
  "success": true,
  "description": "Available snapshots in repository 'scs-snapshots-repo'",
  "snapshots": [
    {
      "name": "backup_snapshot_1751032972929",
      "repositoryName": "scs-snapshots-repo",
      "state": "SUCCESS",
      "indices": "knowledge",
      "startTime": "2025-06-27T14:02:53.227Z",
      "endTime": "2025-06-27T14:02:53.227Z",
      "shardStatistics": {"successful": 1, "failed": 0}
    }
  ],
  "latestSnapshotName": "backup_snapshot_1751032972929"
}

Response (empty)

An existing repository with no snapshots returns a successful response with an empty list:

{
  "success": true,
  "description": "No snapshots found in repository 'scs-snapshots-repo'",
  "snapshots": [],
  "latestSnapshotName": null
}