Create Kubernetes Cluster Backup

Create Kubernetes Cluster Backup

API code: CREATE_KUBERNETES_CLUSTER_BACKUP
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS

Request
URI
POST
https://apaas-29.eng.vmware.com//api/v1/k8s/clusters/{clusterId}/backups
COPY
Path Parameters
string
clusterId
Required

The ID of the protected Kubernetes cluster.

Request Body
Backup of type(s) application/json
Required 
{
    "metadata": {
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "creationTimestamp": "string",
        "annotations": {
            "annotations": "string"
        },
        "labels": {
            "labels": "string"
        }
    },
    "spec": {
        "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"
        }
    },
    "status": {
        "expiration": "string",
        "phase": "string",
        "validationErrors": [
            "string"
        ],
        "startTimestamp": "string",
        "completionTimestamp": "string",
        "warnings": 0,
        "errors": 0,
        "totalItems": 0,
        "itemsBackedUp": 0,
        "failureReason": "string"
    },
    "extension": {
        "extension": {}
    }
}
MetaData
metadata
Optional

metadata

BackupSpec
spec
Optional

spec

BackupStatus
status
Optional

status

object
extension
Optional

extension

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Backup of type(s) */* 
{
    "metadata": {
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "creationTimestamp": "string",
        "annotations": {
            "annotations": "string"
        },
        "labels": {
            "labels": "string"
        }
    },
    "spec": {
        "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"
        }
    },
    "status": {
        "expiration": "string",
        "phase": "string",
        "validationErrors": [
            "string"
        ],
        "startTimestamp": "string",
        "completionTimestamp": "string",
        "warnings": 0,
        "errors": 0,
        "totalItems": 0,
        "itemsBackedUp": 0,
        "failureReason": "string"
    },
    "extension": {
        "extension": {}
    }
}
MetaData
metadata
Optional

metadata

BackupSpec
spec
Optional

spec

BackupStatus
status
Optional

status

object
extension
Optional

extension


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