Domains

Test custom S3 connection

Tests the custom S3 storage connection for the specified domain. Verifies that the configured credentials are valid, the bucket exists, and write permissions are available. The domain must have custom S3 storage enabled and configured before testing.

post/v1/domains/{domain_id}/test-s3-connection

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/test-s3-connection
  • Auth: HTTP basic

Path parameters

domain_idstring required

Fully qualified domain name (FQDN) or domain ID

Response

S3 connection test successful

messagestring

Example response

{
  "message": "Successfully connected to your custom S3 storage. Credentials are valid and the bucket is accessible."
}

Changes

No recorded changes to this operation across all 1 revision of this API.