Backups

Update an S3 source

Changed on
patch/backups/s3-sources/{id}

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/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

access_key_idstring nullable

Optional new access key ID

bucket_namestring nullable

Optional new bucket name

bucket_pathstring nullable

Optional new bucket path

endpointstring nullable

Optional new endpoint URL for S3-compatible services

force_path_styleboolean nullable

Optional new path-style addressing setting

namestring nullable

Optional new name for the source

regionstring nullable

Optional new region

secret_keystring nullable

Optional new secret key

Example request

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

Response

S3 source updated

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