Test access to the destination
curl --request POST \
--url https://api.eu.bronto.io/forward-configs/test-destination \
--header 'Content-Type: application/json' \
--header 'X-BRONTO-API-KEY: <api-key>' \
--data '
{
"destination_type": "S3",
"bucket": "my-archive-bucket",
"prefix": "bronto/archives/",
"storage_class": "STANDARD"
}
'import requests
url = "https://api.eu.bronto.io/forward-configs/test-destination"
payload = {
"destination_type": "S3",
"bucket": "my-archive-bucket",
"prefix": "bronto/archives/",
"storage_class": "STANDARD"
}
headers = {
"X-BRONTO-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BRONTO-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination_type: 'S3',
bucket: 'my-archive-bucket',
prefix: 'bronto/archives/',
storage_class: 'STANDARD'
})
};
fetch('https://api.eu.bronto.io/forward-configs/test-destination', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.bronto.io/forward-configs/test-destination",
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([
'destination_type' => 'S3',
'bucket' => 'my-archive-bucket',
'prefix' => 'bronto/archives/',
'storage_class' => 'STANDARD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-BRONTO-API-KEY: <api-key>"
],
]);
$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 := "https://api.eu.bronto.io/forward-configs/test-destination"
payload := strings.NewReader("{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-BRONTO-API-KEY", "<api-key>")
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("https://api.eu.bronto.io/forward-configs/test-destination")
.header("X-BRONTO-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.bronto.io/forward-configs/test-destination")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}"
response = http.request(request)
puts response.read_body{
"result": true
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}Test access to the destination
Check access to the destination. A test file will be created and deleted to make sure Bronto can access your destination
POST
/
forward-configs
/
test-destination
Test access to the destination
curl --request POST \
--url https://api.eu.bronto.io/forward-configs/test-destination \
--header 'Content-Type: application/json' \
--header 'X-BRONTO-API-KEY: <api-key>' \
--data '
{
"destination_type": "S3",
"bucket": "my-archive-bucket",
"prefix": "bronto/archives/",
"storage_class": "STANDARD"
}
'import requests
url = "https://api.eu.bronto.io/forward-configs/test-destination"
payload = {
"destination_type": "S3",
"bucket": "my-archive-bucket",
"prefix": "bronto/archives/",
"storage_class": "STANDARD"
}
headers = {
"X-BRONTO-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BRONTO-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination_type: 'S3',
bucket: 'my-archive-bucket',
prefix: 'bronto/archives/',
storage_class: 'STANDARD'
})
};
fetch('https://api.eu.bronto.io/forward-configs/test-destination', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.bronto.io/forward-configs/test-destination",
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([
'destination_type' => 'S3',
'bucket' => 'my-archive-bucket',
'prefix' => 'bronto/archives/',
'storage_class' => 'STANDARD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-BRONTO-API-KEY: <api-key>"
],
]);
$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 := "https://api.eu.bronto.io/forward-configs/test-destination"
payload := strings.NewReader("{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-BRONTO-API-KEY", "<api-key>")
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("https://api.eu.bronto.io/forward-configs/test-destination")
.header("X-BRONTO-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.bronto.io/forward-configs/test-destination")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination_type\": \"S3\",\n \"bucket\": \"my-archive-bucket\",\n \"prefix\": \"bronto/archives/\",\n \"storage_class\": \"STANDARD\"\n}"
response = http.request(request)
puts response.read_body{
"result": true
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}{
"code": 201,
"correlation_id": "<string>",
"message": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
Body
application/json
The destination type. Only S3 currently supported
Available options:
S3 Example:
"S3"
The bucket name
Maximum string length:
255Example:
"my-archive-bucket"
The key prefix for S3 objects
Maximum string length:
255Example:
"bronto/archives/"
The S3 storage class to use for the objects
Available options:
STANDARD, STANDARD_IA, GLACIER_IR Example:
"STANDARD"
Response
Destination check completed
true if the test was successful, Bronto can access the bucket
⌘I

