arrow-left

All pages
gitbookPowered by GitBook
1 of 9

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Get the list of restore points in Backup Details

Run backup

Start/stop the backup execution schedule

Get backup details

Backup/Restore

Get backup listchevron-right
Get backup detailschevron-right
Get the list of restore points in Backup Detailschevron-right
Run backupchevron-right
Start/stop the backup execution schedulechevron-right
Get restore point detailschevron-right
Get Restore Point Resource Listchevron-right
Get restore point logschevron-right

Get restore point logs

Get Restore Point Resource List

hashtag
Get the list of restore points in Backup Details

get

Get the list of restore points for the specific backup.

Path parameters
backupNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
get
/v1/backups/{backupName}/restorePoint
200

OK

GET /v1/backups/{backupName}/restorePoint?clusterSeq=text HTTP/1.1
Accept: */*
[
  {
    "clusterName": "thingcluster",
    "clusterSeq": 1,
    "created": 1704705510,
    "expiration": 1707297510,
    "jobName": "cocktail-backup",
    "name": "cocktail-backup",
    "size": 329759314,
    "status": "Completed",
    "TTL": 2592000000
  }
]

hashtag
Run backup

post

Execute the specific backup to create a restore point.

Path parameters
backupNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
post
/v1/backups/{backupName}/runNow
200

OK

POST /v1/backups/{backupName}/runNow?clusterSeq=text HTTP/1.1
Accept: */*

Get restore point details

Get backup list

hashtag
Get restore point logs

get

Get the logs for the specific restore point.

Path parameters
restorePointNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
ResponsestringExample: 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"
get
/v1/backups/restore-point/{restorePointName}/logs
200

OK

GET /v1/backups/restore-point/{restorePointName}/logs?clusterSeq=text HTTP/1.1
Accept: */*
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"

hashtag
Start/stop the backup execution schedule

post

Start/stop the execution schedule for the specific backup.

Path parameters
scheduleNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
post
/v1/backups/schedules/{scheduleName}/pause
200

OK

POST /v1/backups/schedules/{scheduleName}/pause?clusterSeq=text HTTP/1.1
Accept: */*

hashtag
Get Restore Point Resource List

get

Get the list of resources for the specific restore point.

Path parameters
restorePointNamestringRequired

restore points name

Query parameters
clusterSeqstringRequired

(required๋ž‘ ํƒ€์ž… ์ˆ˜์ • ํ•„์š”!!!)

Responses
chevron-right
200

OK

*/*
get
/v1/backups/restore-point/{restorePointName}/resource-list
200

OK

GET /v1/backups/restore-point/{restorePointName}/resource-list?clusterSeq=text HTTP/1.1
Accept: */*
[
  {
    "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"
  }
]

hashtag
Get restore point details

get

Get detailed information for the specific restore point.

Path parameters
restorePointNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
get
/v1/backups/restore-point/{restorePointName}
200

OK

GET /v1/backups/restore-point/{restorePointName}?clusterSeq=text HTTP/1.1
Accept: */*
[
  {
    "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
  }
]

hashtag
Get backups list

get

Get the list of backups.

Responses
chevron-right
200

OK

*/*
get
/v1/backups
200

OK

GET /v1/backups HTTP/1.1
Accept: */*
[
  {
    "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"
  }
]

hashtag
Get backup details

get

Get detailed information about the specific backup.

Path parameters
backupNamestringRequired
Query parameters
clusterSeqstringRequired
Responses
chevron-right
200

OK

*/*
get
/v1/backups/{backupName}
200

OK

GET /v1/backups/{backupName}?clusterSeq=text HTTP/1.1
Accept: */*
{
  "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"
}