Backups

Test S3 connectivity against a prospective source configuration (before creating it). The credentials are NOT persisted. Useful for validating the form in the UI.

Changed on
post/backups/s3-sources/test

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/backups/s3-sources/test
  • Auth: HTTP bearer

Request body

access_key_idstring required
backing_service_idinteger nullable

Managed RustFS/S3 service that supplies this destination. When set, schedules using this source can never target that service itself.

bucket_namestring required
bucket_pathstring required
endpointstring nullable

Optional endpoint URL for S3-compatible services like MinIO

force_path_styleboolean nullable

Whether to use path-style addressing (default: true)

is_defaultboolean nullable

When true, make this the default source (will swap out any existing default). The very first S3 source is always created as default regardless of this flag.

namestring required
regionstring required
secret_keystring required

Example request

{
  "endpoint": "http://minio.example.com:9000",
  "force_path_style": true
}

Response

Connection test result

messagestring required

Human-readable message (success confirmation or error detail).

okboolean required

Whether the connection and credentials worked.

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status