Enable Kubernetes Cluster Protection
API code: ENABLE_KUBERNETES_CLUSTER_PROTECTION
Pre-authorized role(s): TENANT_USER
| TENANT_ADMIN
Platform(s): AMAZON
| CLOUDIAN
Request
URI
POST
https://apaas-29.eng.vmware.com//api/v1/k8s/clusters/{clusterId}/protection
COPY
Path Parameters
string
clusterId
Required
The ID of the protected Kubernetes cluster.
Request Body
ClusterProtection of type(s) application/json
Required
{
"appName": "string",
"appId": "string",
"status": "string",
"creationDate": "string",
"backupStorageLocation": {
"name": "string",
"bucket": "string",
"region": "string",
"caCert": "string",
"sseS3": false,
"status": "string"
},
"volumeSnapshotLocation": {
"name": "string",
"provider": "string",
"config": {
"config": "string"
}
},
"accessKey": "string",
"storageUserId": "string",
"schedule": {
"metadata": {
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"creationTimestamp": "string",
"annotations": {
"annotations": "string"
},
"labels": {
"labels": "string"
}
},
"spec": {
"template": {
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"includedResources": [
"string"
],
"excludedResources": [
"string"
],
"includeClusterResources": "string",
"orderedResources": "string",
"labelSelector": {
"labelSelector": "string"
},
"snapshotVolumes": false,
"ttl": "string",
"storageLocation": "string",
"volumeSnapshotLocations": [
"string"
],
"advancedOptions": {
"advancedOptions": "string"
}
},
"schedule": "string"
},
"status": {
"phase": "string",
"lastBackup": "string",
"validationErrors": [
"string"
]
}
},
"supportSnapshotVolume": false,
"message": "string"
}
string
appName
Optional
appName
string
appId
Optional
appId
string
status
Optional
status
Possible values are : UNPROTECTED, PROTECTING, PROTECTED, FAILED, UNPROTECTING,
string As date-time As date-time
creationDate
Optional
creationDate
string
accessKey
Optional
accessKey
string
storageUserId
Optional
storageUserId
boolean
supportSnapshotVolume
Optional
supportSnapshotVolume
string
message
Optional
message
Responses
202
Accepted
Returns Task of type(s) application/json
{
"id": "string",
"vcdId": "string",
"vcdAssociationId": "string",
"description": "string",
"status": "string",
"resourceType": "string",
"resourceKey": "string",
"progress": 0,
"tenant": "string",
"owner": "string",
"startDate": "string",
"endDate": "string",
"reason": "string",
"metadata": {
"metadata": "string"
}
}
string
id
Optional
id
string
vcdId
Optional
vcdId
string
vcdAssociationId
Optional
vcdAssociationId
string
description
Optional
description
string
status
Optional
status
Possible values are : NOT_STARTED, RUNNING, COMPLETED, FAILED, CANCELLED, HANGING, UNKNOWN,
string
resourceType
Optional
resourceType
string
resourceKey
Optional
resourceKey
integer As int32 As int32
progress
Optional
progress
string
tenant
Optional
tenant
string
owner
Optional
owner
string As date-time As date-time
startDate
Optional
startDate
string As date-time As date-time
endDate
Optional
endDate
string
reason
Optional
reason
object
metadata
Optional
metadata
On This Page
Kubernetes Backup And Restore Operations
POST
Create Kubernetes Cluster Backup
POST
Create Kubernetes Cluster Restore
DELETE
Delete External Kubernetes Cluster
DELETE
Delete Kubernetes Cluster Backup
DELETE
Delete Kubernetes Cluster Restore
DELETE
Disable Kubernetes Cluster Protection
POST
Enable Kubernetes Cluster Protection
GET
Get Kubernetes Cluster
GET
Get Kubernetes Cluster Backup
GET
Get Kubernetes Cluster Protection
GET
Get Kubernetes Cluster Restore
GET
List Kubernetes Cluster Backups
GET
List Kubernetes Cluster Namespaces
GET
List Kubernetes Cluster Restores
GET
List Kubernetes Clusters
POST
Protect External Kubernetes Cluster
PUT
Update Kubernetes Cluster Backup
PUT
Update Kubernetes Cluster Protection