GET

/{Bucket}#requestPayment

http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}#requestPayment

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>. The following operations are related to <code>GetBucketRequestPayment</code>: <ul> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> </li> </ul>

Access Token Required: API Key

Path Parameters

Bucketstringrequired

The name of the bucket for which to get the payment request configuration

Query Params

requestPaymentbooleanrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}#requestPayment' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}