Create a new backup repository
curl --request POST \
--url http://localhost:3000/api/backups/repositories/ \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"name": "<string>",
"storageProviderRef": "<string>",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": true,
"noCheckBucket": true,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"isDefault": true
}
'import requests
url = "http://localhost:3000/api/backups/repositories/"
payload = {
"name": "<string>",
"storageProviderRef": "<string>",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": True,
"noCheckBucket": True,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"isDefault": True
}
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({
name: '<string>',
storageProviderRef: '<string>',
type: 's3',
config: {
bucket: '<string>',
region: '<string>',
endpoint: '<string>',
insecure: true,
noCheckBucket: true,
geesefsMemoryLimit: 123,
geesefsReadAheadLarge: 123,
mountOptions: '<string>'
},
isDefault: true
})
};
fetch('http://localhost:3000/api/backups/repositories/', 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/backups/repositories/",
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([
'name' => '<string>',
'storageProviderRef' => '<string>',
'type' => 's3',
'config' => [
'bucket' => '<string>',
'region' => '<string>',
'endpoint' => '<string>',
'insecure' => true,
'noCheckBucket' => true,
'geesefsMemoryLimit' => 123,
'geesefsReadAheadLarge' => 123,
'mountOptions' => '<string>'
],
'isDefault' => true
]),
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/backups/repositories/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\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/backups/repositories/")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/backups/repositories/")
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 \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"isDefault": true,
"createdAt": "<string>",
"status": "ready",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": true,
"noCheckBucket": true,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"storageProviderRef": "<string>",
"statusMessage": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Backup Repositories
Create a new backup repository
POST
/
api
/
backups
/
repositories
/
Create a new backup repository
curl --request POST \
--url http://localhost:3000/api/backups/repositories/ \
--header 'Content-Type: application/json' \
--cookie token= \
--data '
{
"name": "<string>",
"storageProviderRef": "<string>",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": true,
"noCheckBucket": true,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"isDefault": true
}
'import requests
url = "http://localhost:3000/api/backups/repositories/"
payload = {
"name": "<string>",
"storageProviderRef": "<string>",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": True,
"noCheckBucket": True,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"isDefault": True
}
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({
name: '<string>',
storageProviderRef: '<string>',
type: 's3',
config: {
bucket: '<string>',
region: '<string>',
endpoint: '<string>',
insecure: true,
noCheckBucket: true,
geesefsMemoryLimit: 123,
geesefsReadAheadLarge: 123,
mountOptions: '<string>'
},
isDefault: true
})
};
fetch('http://localhost:3000/api/backups/repositories/', 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/backups/repositories/",
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([
'name' => '<string>',
'storageProviderRef' => '<string>',
'type' => 's3',
'config' => [
'bucket' => '<string>',
'region' => '<string>',
'endpoint' => '<string>',
'insecure' => true,
'noCheckBucket' => true,
'geesefsMemoryLimit' => 123,
'geesefsReadAheadLarge' => 123,
'mountOptions' => '<string>'
],
'isDefault' => true
]),
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/backups/repositories/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\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/backups/repositories/")
.header("cookie", "token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/backups/repositories/")
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 \"name\": \"<string>\",\n \"storageProviderRef\": \"<string>\",\n \"type\": \"s3\",\n \"config\": {\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"insecure\": true,\n \"noCheckBucket\": true,\n \"geesefsMemoryLimit\": 123,\n \"geesefsReadAheadLarge\": 123,\n \"mountOptions\": \"<string>\"\n },\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"isDefault": true,
"createdAt": "<string>",
"status": "ready",
"type": "s3",
"config": {
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"insecure": true,
"noCheckBucket": true,
"geesefsMemoryLimit": 123,
"geesefsReadAheadLarge": 123,
"mountOptions": "<string>"
},
"storageProviderRef": "<string>",
"statusMessage": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}{
"error": "<string>",
"statusCode": 123,
"message": "<string>"
}Authorizations
JWT token stored in HTTP-only cookie
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
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])?$Available options:
s3 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Default Response
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Available options:
ready Available options:
s3 Show child attributes
Show child attributes
⌘I