Sign in

v1

latestOpenAPI 3.1.02026-08-06244570.4 KB
Integrations

Test S3 connection

Test S3 connection with stored credentials.

Authentication: API Key required (x-api-key header)

Usage: Verify your S3 configuration is working correctly. The test will:

  1. Connect to the endpoint
  2. Verify bucket access
  3. Check write permissions by uploading a small test file

Prerequisite: S3 must be configured first using POST /v1/integrations/s3

No credits consumed: This is a diagnostic endpoint.

Rate Limits: 60 requests/min (free), 120 requests/min (paid). Headers included in response.

post/v1/integrations/s3/test

Response

Connection test successful

successboolean required

Whether the connection test succeeded

messagestring required

Test result message

Example response

{
  "message": "Connection successful. Bucket is accessible.",
  "success": true
}