Creating an index backup

Creating a backup of an index

In this case, we are looking to back up a single search index, say “knowledge”. The request below explicitly selects the knowledge index and the scs-snapshots-repo repository. The repository must be available to the search backend.

If indexName is omitted, Search selects all eligible current indices, excluding system indices and recognised restore artifacts. snapshotPrefix is optional and defaults to backup_snapshot; description can record the purpose of the backup. If repositoryName is omitted, the request defaults to scs-snapshots-repo.

Example Call

curl -X POST https://telicent.core.domain/api/search/backups/create \
  -H "Content-Type: application/json" \
  -H "Authorization: ${TC_OIDC_TOKEN}" \
  -d '{"indexName":"knowledge","repositoryName":"scs-snapshots-repo"}'

Response

A successful response confirms the creation of the snapshot and provides its generated name:

{
  "created": true,
  "snapshotName": "backup_snapshot_1751030282819",
  "message": "Snapshot 'backup_snapshot_1751030282819' created successfully"
}

For background execution and polling, see asynchronous jobs.