Create a new backup policy
curl --request POST \
--url http://localhost:3000/api/clusters/{clusterName}/backups/policies/ \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"policyName": "<string>",
"backupRepoName": "<string>"
}
'import requests
url = "http://localhost:3000/api/clusters/{clusterName}/backups/policies/"
payload = {
"policyName": "<string>",
"backupRepoName": "<string>"
}
headers = {
"cookie": "token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'token=', 'Content-Type': 'application/json'},
body: JSON.stringify({policyName: '<string>', backupRepoName: '<string>'})
};
fetch('http://localhost:3000/api/clusters/{clusterName}/backups/policies/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/clusters/{clusterName}/backups/policies/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'policyName' => '<string>',
'backupRepoName' => '<string>'
]),
CURLOPT_COOKIE => "token=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/clusters/{clusterName}/backups/policies/"
payload := strings.NewReader("{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "token=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/clusters/{clusterName}/backups/policies/")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/clusters/{clusterName}/backups/policies/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"cluster": "<string>",
"namespace": "<string>",
"backupMethods": [
{
"name": "<string>",
"snapshotVolumes": true
}
],
"createdAt": "<string>",
"backupRepoName": "<string>",
"pathPrefix": "<string>",
"status": "Available",
"message": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Backup Policies
Create a new backup policy
POST
/
api
/
clusters
/
{clusterName}
/
backups
/
policies
/
Create a new backup policy
curl --request POST \
--url http://localhost:3000/api/clusters/{clusterName}/backups/policies/ \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"policyName": "<string>",
"backupRepoName": "<string>"
}
'import requests
url = "http://localhost:3000/api/clusters/{clusterName}/backups/policies/"
payload = {
"policyName": "<string>",
"backupRepoName": "<string>"
}
headers = {
"cookie": "token=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'token=', 'Content-Type': 'application/json'},
body: JSON.stringify({policyName: '<string>', backupRepoName: '<string>'})
};
fetch('http://localhost:3000/api/clusters/{clusterName}/backups/policies/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/clusters/{clusterName}/backups/policies/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'policyName' => '<string>',
'backupRepoName' => '<string>'
]),
CURLOPT_COOKIE => "token=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/clusters/{clusterName}/backups/policies/"
payload := strings.NewReader("{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "token=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/clusters/{clusterName}/backups/policies/")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/clusters/{clusterName}/backups/policies/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["cookie"] = 'token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"policyName\": \"<string>\",\n \"backupRepoName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"cluster": "<string>",
"namespace": "<string>",
"backupMethods": [
{
"name": "<string>",
"snapshotVolumes": true
}
],
"createdAt": "<string>",
"backupRepoName": "<string>",
"pathPrefix": "<string>",
"status": "Available",
"message": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Authorizations
JWT token stored in HTTP-only cookie
Path Parameters
Query Parameters
Minimum string length:
1Body
application/json
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 - 63Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$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 - 63Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$Response
Default Response
⌘I