Create on demand cluster backup

POST 
https://api.spectrocloud.com/v1/spectroclusters/:uid/features/backup/onDemand

Create on demand cluster backup

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

backupLocationNamestring
backupLocationUidstring
backupNamestring
backupPrefixstring
durationInHoursint64
includeAllDisksboolean
includeClusterResourcesboolean
locationTypestring
namespacesstring[]

schedule

Cluster feature schedule

scheduledRunTimestring

Responses

201

Created successfully

Response Headers

• AuditUid

  string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.spectrocloud.com/v1/spectroclusters/:uid/features/backup/onDemand' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
-d '{
  "backupLocationName": "string",
  "backupLocationUid": "string",
  "backupName": "string",
  "backupPrefix": "string",
  "durationInHours": 0,
  "includeAllDisks": true,
  "includeClusterResources": true,
  "locationType": "string",
  "namespaces": [
    "string"
  ],
  "schedule": {
    "scheduledRunTime": "string"
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

uid — pathrequired

ProjectUid — header

Body

{
  "backupLocationName": "string",
  "backupLocationUid": "string",
  "backupName": "string",
  "backupPrefix": "string",
  "durationInHours": 0,
  "includeAllDisks": true,
  "includeClusterResources": true,
  "locationType": "string",
  "namespaces": [
    "string"
  ],
  "schedule": {
    "scheduledRunTime": "string"
  }
}