Get backup list

Get backups list

Get the list of backups.

GET/v1/backups

Response

Body

clusterNamestring

clusterSeqstring

lastBackupTimeinteger

lastStatusstring

The current backup execution status(New, InProgress, Completed, Failed, Deleting)

locationstring

location_idstring

namestring

providerstring

scheduleobject

schedule information(Applies only to scheduled backups)

pauseboolean

Whether to use schedule (true: stop, false: start)

schedulestring

schedule (Cron expression or @every notation)

statusstring

schedule status(New, Running, Paused, Failed(수정필요!!!!!))

typestring

backup type(backup: Run immediately once, schedule: Run automatically at a specified time)

Request

const response = await fetch('/v1/backups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "lastBackupTime": 1705884540,
    "lastStatus": "Completed",
    "location": "minio",
    "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
    "name": "cocktail-backup",
    "provider": "minio",
    "schedule": {
      "pause": true,
      "schedule": "* * * * *",
      "status": "Enabled"
    },
    "type": "schedule"
  },
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "lastBackupTime": 1704705641,
    "lastStatus": "Completed",
    "location": "azure",
    "location_id": "799d0f7f-e06d-4ec2-b7a4-562abd12d8be",
    "name": "cocktail-schedule",
    "provider": "azure",
    "type": "backup"
  }
]

Get the list of restore points in Backup Details

Get the list of restore points for the specific backup.

GET/v1/backups/{backupName}/restorePoint

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

clusterNamestring

Example: "thingcluster"

clusterSeqinteger

Example: 1

createdinteger

Backup creation time

Example: 1704705510

expirationinteger

expiration date

Example: 1707297510

jobNamestring

backupName

Example: "cocktail-backup"

namestring

restore points name

Example: "cocktail-backup"

sizeinteger

volume size

Example: 329759314

statusstring

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

Example: "Completed"

TTLinteger

Backup retention period (unit: ms)

Example: 2592000000

Request

Response

Get restore point logs

Get the logs for the specific restore point.

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

Path parameters

restorePointName*string

Query parameters

clusterSeq*string

Response

Body

string

Example:

"time=\"2023-12-28T08:03:18Z\" level=info msg=\"Setting up backup temp file\" backup=velero/payment-service-backup-20231228080317 logSource=\"pkg/controller/backup_controller.go:617\""

Request

Response

Get restore point details

Get detailed information for the specific restore point.

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

Path parameters

restorePointName*string

Query parameters

clusterSeq*string

Response

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

itemsstring

includeResourcesarray of string

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

itemsstring

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

Response

Get backups list

Get the list of backups.

GET/v1/backups

Response

Body

clusterNamestring

clusterSeqstring

lastBackupTimeinteger

lastStatusstring

The current backup execution status(New, InProgress, Completed, Failed, Deleting)

locationstring

location_idstring

namestring

providerstring

scheduleobject

schedule information(Applies only to scheduled backups)

pauseboolean

Whether to use schedule (true: stop, false: start)

schedulestring

schedule (Cron expression or @every notation)

statusstring

schedule status(New, Running, Paused, Failed(수정필요!!!!!))

typestring

backup type(backup: Run immediately once, schedule: Run automatically at a specified time)

Request

const response = await fetch('/v1/backups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "lastBackupTime": 1705884540,
    "lastStatus": "Completed",
    "location": "minio",
    "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
    "name": "cocktail-backup",
    "provider": "minio",
    "schedule": {
      "pause": true,
      "schedule": "* * * * *",
      "status": "Enabled"
    },
    "type": "schedule"
  },
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "lastBackupTime": 1704705641,
    "lastStatus": "Completed",
    "location": "azure",
    "location_id": "799d0f7f-e06d-4ec2-b7a4-562abd12d8be",
    "name": "cocktail-schedule",
    "provider": "azure",
    "type": "backup"
  }
]

Start/stop the backup execution schedule

Get the list of restore points in Backup Details

Get the list of restore points for the specific backup.

GET/v1/backups/{backupName}/restorePoint

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

clusterNamestring

Example: "thingcluster"

clusterSeqinteger

Example: 1

createdinteger

Backup creation time

Example: 1704705510

expirationinteger

expiration date

Example: 1707297510

jobNamestring

backupName

Example: "cocktail-backup"

namestring

restore points name

Example: "cocktail-backup"

sizeinteger

volume size

Example: 329759314

statusstring

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

Example: "Completed"

TTLinteger

Backup retention period (unit: ms)

Example: 2592000000

Request

Response

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

[
  {
    "clusterName": "thingcluster",
    "clusterSeq": 1,
    "created": 1704705510,
    "expiration": 1707297510,
    "jobName": "cocktail-backup",
    "name": "cocktail-backup",
    "size": 329759314,
    "status": "Completed",
    "TTL": 2592000000
  }
]

Start/stop the backup execution schedule

Start/stop the execution schedule for the specific backup.

POST/v1/backups/schedules/{scheduleName}/pause

Path parameters

scheduleName*string

Query parameters

clusterSeq*string

Response

Body

any

Request

Get backup details

Get detailed information about the specific backup.

GET/v1/backups/{backupName}

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

clusterNamestring

clusterSeqinteger

createdinteger

Backup creation time

expirationinteger

expiration date

includeNamespacesarray of string

List of selected namespaces

itemsstring

includeResourcesarray of string

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

itemsstring

isClusterBackupboolean

Whether to back up the entire cluster

isResourceAllBackupboolean

Whether to back up the entire resources

labelSelectorobject

Label selector (displays as null if not selected)

lastBackupRunningTimeinteger

Working time of the most recently run backup

lastBackupStatusstring

Status of recently run backup(New, InProgress, Completed, Failed, Deleting)

lastBackupTimeinteger

Timestamp of most recent backup run

locationstring

Storage name.

location_idstring

Storage id.

namestring

backup name

providerstring

statusstring

backup state(New, InProgress, Completed, Failed, Deleting)

Example: "Completed"

scheduleobject

schedule information(Applies only to scheduled backups)

pauseboolean

Whether to use schedule (true: stop, false: start)

schedulestring

schedule (Cron expression or @every notation)

statusstring

schedule status(New, Running, Paused, Failed(수정필요!!!!!))

ttlinteger

Backup retention period (unit: ms)

typestring

backup type(backup: Run immediately once, schedule: Run automatically at a specified time)

Request

Response

Run backup

Execute the specific backup to create a restore point.

POST/v1/backups/{backupName}/runNow

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

any

Request

Get Restore Point Resource List

Get the list of resources for the specific restore point.

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

Path parameters

restorePointName*string

restore points name

Query parameters

clusterSeq*string

(required랑 타입 수정 필요!!!)

Response

Body

isClusterResourceboolean

Whether to back up all resources

namestring

resource name

resourceTypestring

Request

Response

Get restore point details

Get detailed information for the specific restore point.

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

Path parameters

restorePointName*string

Query parameters

clusterSeq*string

Response

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

itemsstring

includeResourcesarray of string

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

itemsstring

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

Response

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

[
  {
    "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
  }
]

Get restore point logs

Get the logs for the specific restore point.

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

Path parameters

restorePointName*string

Query parameters

clusterSeq*string

Response

Body

string

Example:

"time=\"2023-12-28T08:03:18Z\" level=info msg=\"Setting up backup temp file\" backup=velero/payment-service-backup-20231228080317 logSource=\"pkg/controller/backup_controller.go:617\""

Request

Response

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

time="2023-12-28T08:03:18Z" level=info msg="Setting up backup temp file" backup=velero/payment-service-backup-20231228080317 logSource="pkg/controller/backup_controller.go:617"

Start/stop the backup execution schedule

Start/stop the execution schedule for the specific backup.

POST/v1/backups/schedules/{scheduleName}/pause

Path parameters

scheduleName*string

Query parameters

clusterSeq*string

Response

Body

any

Request

const response = await fetch('/v1/backups/schedules/{scheduleName}/pause?clusterSeq=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Run backup

Execute the specific backup to create a restore point.

POST/v1/backups/{backupName}/runNow

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

any

Request

const response = await fetch('/v1/backups/{backupName}/runNow?clusterSeq=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Get Restore Point Resource List

Get the list of resources for the specific restore point.

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

Path parameters

restorePointName*string

restore points name

Query parameters

clusterSeq*string

(required랑 타입 수정 필요!!!)

Response

Body

isClusterResourceboolean

Whether to back up all resources

namestring

resource name

resourceTypestring

Request

Response

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

[
  {
    "isClusterResource": true,
    "name": "pvc-0fae5718-0cf7-43b3-a51d-1181304b71d2",
    "resourceType": "persistentvolume.core"
  },
  {
    "isClusterResource": true,
    "name": "pvc-c67b5c65-7925-4d74-8ffb-725da8f9c54e",
    "resourceType": "persistentvolume.core"
  },
  {
    "isClusterResource": false,
    "name": "license-api",
    "namespace": "license",
    "resourceType": "secret.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db-secret",
    "namespace": "license",
    "resourceType": "secret.core"
  },
  {
    "isClusterResource": false,
    "name": "master-cocktail-1ji7as5a79yzm",
    "namespace": "license",
    "resourceType": "secret.core"
  },
  {
    "isClusterResource": false,
    "name": "license-api",
    "namespace": "license",
    "resourceType": "service.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db",
    "namespace": "license",
    "resourceType": "service.core"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy",
    "namespace": "license",
    "resourceType": "service.core"
  },
  {
    "isClusterResource": false,
    "name": "default",
    "namespace": "license",
    "resourceType": "serviceaccount.core"
  },
  {
    "isClusterResource": false,
    "name": "license-api",
    "namespace": "license",
    "resourceType": "deployment.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy",
    "namespace": "license",
    "resourceType": "deployment.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-569cc48bcd",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-57cc5fc9f4",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-5996478758",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-5c557d5b69",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-64f8d5bff9",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-6b44dbf9b",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-749d7c484b",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-7658cbbd99",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-7f9f84bd7",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-9f68c7c46",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-f46b6c574",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy-7865fdc896",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy-7c58576f5c",
    "namespace": "license",
    "resourceType": "replicaset.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-6b44dbf9b-ddp8d",
    "namespace": "license",
    "resourceType": "pod.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db-0",
    "namespace": "license",
    "resourceType": "pod.core"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy-7c58576f5c-cj6f9",
    "namespace": "license",
    "resourceType": "pod.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db-76644dcb99",
    "namespace": "license",
    "resourceType": "controllerrevision.apps"
  },
  {
    "isClusterResource": false,
    "name": "license-api-mvkww",
    "namespace": "license",
    "resourceType": "endpointslice.discovery.k8s.io"
  },
  {
    "isClusterResource": false,
    "name": "license-db-v889f",
    "namespace": "license",
    "resourceType": "endpointslice.discovery.k8s.io"
  },
  {
    "isClusterResource": false,
    "name": "license-proxy-fxqf9",
    "namespace": "license",
    "resourceType": "endpointslice.discovery.k8s.io"
  },
  {
    "isClusterResource": true,
    "name": "license",
    "resourceType": "namespace.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db",
    "namespace": "license",
    "resourceType": "statefulset.apps"
  },
  {
    "isClusterResource": false,
    "name": "kube-root-ca.crt",
    "namespace": "license",
    "resourceType": "configmap.core"
  },
  {
    "isClusterResource": false,
    "name": "license-api-server",
    "namespace": "license",
    "resourceType": "configmap.core"
  },
  {
    "isClusterResource": false,
    "name": "license-api-server-init",
    "namespace": "license",
    "resourceType": "configmap.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db",
    "resourceType": "configmap.core"
  },
  {
    "isClusterResource": false,
    "name": "license-db-init",
    "namespace": "license",
    "resourceType": "configmap.core"
  }
]

Get backup details

Get detailed information about the specific backup.

GET/v1/backups/{backupName}

Path parameters

backupName*string

Query parameters

clusterSeq*string

Response

Body

clusterNamestring

clusterSeqinteger

createdinteger

Backup creation time

expirationinteger

expiration date

includeNamespacesarray of string

List of selected namespaces

itemsstring

includeResourcesarray of string

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

itemsstring

isClusterBackupboolean

Whether to back up the entire cluster

isResourceAllBackupboolean

Whether to back up the entire resources

labelSelectorobject

Label selector (displays as null if not selected)

lastBackupRunningTimeinteger

Working time of the most recently run backup

lastBackupStatusstring

Status of recently run backup(New, InProgress, Completed, Failed, Deleting)

lastBackupTimeinteger

Timestamp of most recent backup run

locationstring

Storage name.

location_idstring

Storage id.

namestring

backup name

providerstring

statusstring

backup state(New, InProgress, Completed, Failed, Deleting)

Example: "Completed"

scheduleobject

schedule information(Applies only to scheduled backups)

pauseboolean

Whether to use schedule (true: stop, false: start)

schedulestring

schedule (Cron expression or @every notation)

statusstring

schedule status(New, Running, Paused, Failed(수정필요!!!!!))

ttlinteger

Backup retention period (unit: ms)

typestring

backup type(backup: Run immediately once, schedule: Run automatically at a specified time)

Request

Response

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

{
  "clusterName": "thingcluster",
  "clusterSeq": "1",
  "created": 1704705510,
  "expiration": 1707297510,
  "includeNamespaces": [
    "cocktail-license",
    "cocktail-system"
  ],
  "includeResources": [],
  "isClusterBackup": false,
  "isResourceAllBackup": true,
  "labelSelector": {
    "name": "value"
  },
  "lastBackupRunningTime": 132,
  "lastBackupStatus": "Completed",
  "lastBackupTime": 1706002826,
  "location": "minio",
  "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
  "name": "cocktail-backup",
  "provider": "minio",
  "status": "Completed",
  "ttl": 2592000000,
  "type": "backup"
}

Backup/Restore

Get backup list

Get backup details

Get the list of restore points in Backup Details

Run backup

Start/stop the backup execution schedule

Get restore point details

Get Restore Point Resource List

Get restore point logs

Get backup list

Get backups list

Get the list of restore points in Backup Details

Get the list of restore points in Backup Details

Backup/Restore

Get restore point logs

Get restore point logs

Get restore point details

Get restore point details

Get backups list

Start/stop the backup execution schedule

Get the list of restore points in Backup Details

Get backup details

Start/stop the backup execution schedule

Get backup details

Run backup

Run backup

Get Restore Point Resource List

Get Restore Point Resource List

Get restore point details

Get restore point logs

Start/stop the backup execution schedule

Run backup

Get Restore Point Resource List

Get backup details