Skip to main content
POST
/
api
/
datasets
/
{dataset_id}
/
integrations
/
s3
/
test
Test Dataset S3
curl --request POST \
  --url https://api.example.com/api/datasets/{dataset_id}/integrations/s3/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "bucket": "<string>",
  "region": "<string>",
  "prefix": "<string>",
  "endpoint_url": "<string>",
  "use_path_style": true,
  "kms_key_id": "<string>",
  "notify_on_complete": true,
  "notify_on_failure": true,
  "access_key_id": "<string>",
  "secret_access_key": "<string>",
  "session_token": "<string>",
  "write_test": true
}
'
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required

Cookies

antidote_session
string | null

Body

application/json
url
string | null
bucket
string | null
region
string | null
prefix
string | null
endpoint_url
string | null
use_path_style
boolean | null
kms_key_id
string | null
notify_on_complete
boolean | null
notify_on_failure
boolean | null
access_key_id
string | null
secret_access_key
string | null
session_token
string | null
write_test
boolean | null
default:true

Response

Successful Response

The response is of type Response Test Dataset S3 Api Datasets Dataset Id Integrations S3 Test Post · object.