Skip to main content
POST
Create a new backup

Authorizations

token
string
cookie
required

JWT token stored in HTTP-only cookie

Path Parameters

clusterName
string
required

Body

application/json
backupName
string
required

Must be a valid Kubernetes object name: lowercase letters, numbers, and hyphens; must start and end with a letter or number; max 63 characters.

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
backupMethod
required
Available options:
datafile
backupPolicyName
string

Must be a valid Kubernetes object name: lowercase letters, numbers, and hyphens; must start and end with a letter or number; max 63 characters.

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
backupRepoName
string
retentionPeriod
string
deletionPolicy
Available options:
Delete
parentBackupName
string
parameters
object
tags
object

Response

Default Response

name
string
required
cluster
string
required
namespace
string
required
status
required
Available options:
pending
source
required
Available options:
manual
repository
string
required
startTime
string
required
canRestore
boolean
required
backupPolicyName
string
backupMethodName
Available options:
datafile
type
Available options:
snapshot
size
string
completionTime
string
expirationDate
string
retentionPeriod
string
deletionPolicy
string
parentBackupName
string
parameters
object
restoreNotReadyReason
string