Protect External Kubernetes Cluster

Protect External Kubernetes Cluster

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

Request
URI
POST
https://{api_host}//api/v1/k8s/clusters/protection
COPY
Request Body
ExternalCluster of type(s) application/json
Required 
{
    "name": "string",
    "kubeConfig": "string",
    "tenantId": "string",
    "tenantName": "string",
    "ownerName": "string",
    "ownerId": "string",
    "appName": "string",
    "appId": "string",
    "status": "string",
    "creationDate": "string",
    "backupStorageLocation": {
        "name": "string",
        "bucket": "string",
        "region": "string",
        "caCert": "string",
        "sseS3": false
    },
    "volumeSnapshotLocation": {
        "name": "string",
        "provider": "string"
    },
    "accessKey": "string",
    "schedule": {
        "metadata": {
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string"
        },
        "spec": {
            "template": {
                "includedNamespaces": [
                    "string"
                ],
                "excludedNamespaces": [
                    "string"
                ],
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ],
                "includeClusterResources": "string",
                "orderedResources": "string",
                "snapshotVolumes": false,
                "ttl": "string",
                "storageLocation": "string",
                "volumeSnapshotLocations": [
                    "string"
                ]
            },
            "schedule": "string"
        },
        "status": {
            "phase": "string",
            "lastBackup": "string",
            "validationErrors": [
                "string"
            ]
        }
    },
    "supportSnapshotVolume": false
}
string
name
Optional

name

string
kubeConfig
Optional

kubeConfig

string
tenantId
Optional

tenantId

string
tenantName
Optional

tenantName

string
ownerName
Optional

ownerName

string
ownerId
Optional

ownerId

string
appName
Optional

appName

string
appId
Optional

appId

string
status
Optional

status

Possible values are : UNPROTECTED, ENABLING, PROTECTING, PAUSE, DISABLING,
string As date-time As date-time
creationDate
Optional

creationDate

BackupStorageLocation
backupStorageLocation
Optional

backupStorageLocation

VolumeSnapshotLocation
volumeSnapshotLocation
Optional

volumeSnapshotLocation

string
accessKey
Optional

accessKey

Schedule
schedule
Optional

schedule

boolean
supportSnapshotVolume
Optional

supportSnapshotVolume

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns Cluster of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "location": "string",
    "ownerName": "string",
    "ownerId": "string",
    "health": "string",
    "nodeCount": 0,
    "protectionStatus": "string",
    "bucket": "string",
    "protectedBy": "string",
    "protecting": false,
    "protectingRegion": "string",
    "nextBackup": 0,
    "errorMessages": [
        "string"
    ],
    "restoreStatus": {
        "phase": "string",
        "validationErrors": [
            "string"
        ],
        "warnings": 0,
        "errors": 0,
        "failureReason": "string",
        "startTimestamp": "string",
        "completionTimestamp": "string",
        "totalItems": 0,
        "itemsBackedUp": 0
    },
    "appName": "string",
    "appId": "string",
    "status": "string",
    "creationDate": "string",
    "backupStorageLocation": {
        "name": "string",
        "bucket": "string",
        "region": "string",
        "caCert": "string",
        "sseS3": false
    },
    "volumeSnapshotLocation": {
        "name": "string",
        "provider": "string"
    },
    "accessKey": "string",
    "schedule": {
        "metadata": {
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string"
        },
        "spec": {
            "template": {
                "includedNamespaces": [
                    "string"
                ],
                "excludedNamespaces": [
                    "string"
                ],
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ],
                "includeClusterResources": "string",
                "orderedResources": "string",
                "snapshotVolumes": false,
                "ttl": "string",
                "storageLocation": "string",
                "volumeSnapshotLocations": [
                    "string"
                ]
            },
            "schedule": "string"
        },
        "status": {
            "phase": "string",
            "lastBackup": "string",
            "validationErrors": [
                "string"
            ]
        }
    },
    "supportSnapshotVolume": false,
    "externalCluster": false,
    "orgName": "string",
    "k8sVersion": "string",
    "k8sProvider": "string"
}
string
id
Optional

id

string
name
Optional

name

string
location
Optional

location

string
ownerName
Optional

ownerName

string
ownerId
Optional

ownerId

string
health
Optional

health

Possible values are : GREEN, YELLOW, RED,
integer As int32 As int32
nodeCount
Optional

nodeCount

string
protectionStatus
Optional

protectionStatus

Possible values are : UNPROTECTED, ENABLING, PROTECTING, PAUSE, DISABLING,
string
bucket
Optional

bucket

string
protectedBy
Optional

protectedBy

boolean
protecting
Optional

protecting

string
protectingRegion
Optional

protectingRegion

Possible values are : NONE, LOCAL, REMOTE,
integer As int64 As int64
nextBackup
Optional

nextBackup

array of string
errorMessages
Optional

errorMessages

RestoreStatus
restoreStatus
Optional

restoreStatus

string
appName
Optional

appName

string
appId
Optional

appId

string
status
Optional

status

Possible values are : UNPROTECTED, ENABLING, PROTECTING, PAUSE, DISABLING,
string As date-time As date-time
creationDate
Optional

creationDate

BackupStorageLocation
backupStorageLocation
Optional

backupStorageLocation

VolumeSnapshotLocation
volumeSnapshotLocation
Optional

volumeSnapshotLocation

string
accessKey
Optional

accessKey

Schedule
schedule
Optional

schedule

boolean
supportSnapshotVolume
Optional

supportSnapshotVolume

boolean
externalCluster
Optional

externalCluster

string
orgName
Optional

orgName

string
k8sVersion
Optional

k8sVersion

string
k8sProvider
Optional

k8sProvider

Possible values are : CSE_LEGACY, CSE_NATIVE, TKG, EXTERNAL, CAPVCD,

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
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