Get restore point details

Get restore point details

Get detailed information for the specific restore point.

GET/v1/backups/restore-point/{restorePointName}

Path parameters

restorePointName*string

Query parameters

Response

200

OK

Body

*/*

clusterNamestring

Example: "thingcluster"

clusterSeqstring

Example: "1"

createdinteger

Backup creation time

Example: 1704705510

errorsinteger

number of errors

Example: 0

expirationinteger

expiration date

Example: 1707297510

hasJobboolean

Backup existence status

Example: true

includeNamespacesarray of string

List of selected namespaces

includeResourcesarray of string

List of selected resources (if the value is empty, all resources are selected)

isClusterBackupboolean

Whether to back up the entire cluster

Example: false

isResourceAllBackupboolean

Whether to back up the entire resources

Example: true

itemsBackupedUpinteger

Number of resources for which backup has been completed

Example: 45

jobNamestring

backup name

Example: "cocktail-backup"

labelSelectorobject

Label selector (displays as null if not selected)

locationstring

storage name

Example: "minio"

location_idstring

storage id

Example: "43f9ffdd-5763-400d-8bae-8289dfa1bfae"

namestring

restore points name

Example: "cocktail-backup"

providerstring

Example: "minio"

runningTimeinteger

runningtime (unit: s)

Example: 154

sizeinteger

volume size

Example: 329759314

statusstring

restore points status(New, InProgress, Completed, Failed, Deleting)

Example: "Completed"

TTLinteger

Backup retention period (unit: ms)

Example: 2592000000

totalItemsinteger

Total number of backup resources

Example: 45

warningsinteger

number of warnings

Example: 0

Request

JavaScriptCurlPython

const response = await fetch('/v1/backups/restore-point/{restorePointName}?clusterSeq=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "created": 1704705510,
    "errors": 0,
    "expiration": 1707297510,
    "hasJob": true,
    "includeNamespaces": [
      "cocktail-license",
      "cocktail-system"
    ],
    "includeResources": [],
    "isClusterBackup": false,
    "isResourceAllBackup": true,
    "itemsBackupedUp": 45,
    "jobName": "cocktail-backup",
    "labelSelector": null,
    "location": "minio",
    "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
    "name": "cocktail-backup",
    "provider": "minio",
    "runningTime": 154,
    "size": 329759314,
    "status": "Completed",
    "TTL": 2592000000,
    "totalItems": 45,
    "warnings": 0
  }
]