Skip to main content
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"
}
'
{
  "result": true
}

Authorizations

​
X-BRONTO-API-KEY
string
header
required

Body

application/json
​
destination_type
enum<string>
required

The destination type. Only S3 currently supported

Available options:
S3
Example:

"S3"

​
bucket
string
required

The bucket name

Maximum string length: 255
Example:

"my-archive-bucket"

​
prefix
string

The key prefix for S3 objects

Maximum string length: 255
Example:

"bronto/archives/"

​
storage_class
enum<string>
default:STANDARD

The S3 storage class to use for the objects

Available options:
STANDARD,
STANDARD_IA,
GLACIER_IR
Example:

"STANDARD"

Response

Destination check completed

​
result
boolean

true if the test was successful, Bronto can access the bucket