Creating a backup of an index

In this case, we are looking to back up a single search index, say “knowledge”. The call has a little more structure than it’s Graph equivalent due to the increased number of parameters.

To reduce the complexity of call, the optional index, repository and snapshot name parameters have been ignored below, as they will default to suitable values.

Example Call

curl -X POST https://telicent.core.domain/api/search/backups/create \
  -H "Content-Type: application/json" \
  -H "Authorization: ${TC_OIDC_TOKEN}"

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"
}