Backups

Create a new S3 source

Changed on
post/backups/s3-sources

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
  • 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

S3 source created

access_key_idstring required
bucket_namestring required
bucket_pathstring required
created_atinteger required
endpointstring nullable
force_path_styleboolean nullable
idinteger required
is_defaultboolean required
managed_by_cloudboolean required

True when this source was auto-provisioned by a Temps Cloud link rather than entered by an operator. Managed sources cannot be edited or deleted from this API; disconnect Temps Cloud to remove one.

namestring required
regionstring required
secret_keystring required
updated_atinteger required

Example response

{
  "access_key_id": "AKIAXXXXXXXXXXXXXXXX",
  "endpoint": "http://minio.example.com:9000"
}

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