Get Bucket Using GET

Get Bucket Using GET

API code: S3_GET_BUCKET Pre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER

Request
URI
GET
https://{api_host}//localhost/api/v1/s3/{bucketName}
COPY
Path Parameters
string
bucketName
Required

The bucket name. It must be URL encoded.

Header Parameters
string
x-amz-request-payer
Optional

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ListBucketResult of type(s) application/json 
{
    "commonPrefixes": [
        {
            "owner": {
                "displayName": "string",
                "id": "string"
            },
            "prefix": "string"
        }
    ],
    "continuationToken": "string",
    "delimiter": "string",
    "encodingType": "string",
    "keyCount": 0,
    "maxKeys": 0,
    "name": "string",
    "nextContinuationToken": "string",
    "objectBrief": [
        {
            "etag": "string",
            "key": "string",
            "lastModified": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "owner": {
                "displayName": "string",
                "id": "string"
            },
            "ownerId": "string",
            "size": 0,
            "storageClass": "string",
            "versionId": "string"
        }
    ],
    "prefix": "string",
    "startAfter": "string",
    "truncated": false
}
array of CommonPrefixes
commonPrefixes
Optional

commonPrefixes

string
continuationToken
Optional

continuationToken

string
delimiter
Optional

delimiter

string
encodingType
Optional

encodingType

integer As int64 As int64
keyCount
Optional

keyCount

integer As int64 As int64
maxKeys
Optional

maxKeys

string
name
Optional

name

string
nextContinuationToken
Optional

nextContinuationToken

array of ObjectBrief
objectBrief
Optional

objectBrief

string
prefix
Optional

prefix

string
startAfter
Optional

startAfter

boolean
truncated
Optional

truncated


On This Page
Bucket Management Operations
PUT
Create Bucket Using PUT
DELETE
Delete Bucket Cors Using DELETE
DELETE
Delete Bucket Encryption Using DELETE
DELETE
Delete Bucket Lifecycle Using DELETE
DELETE
Delete Bucket Policy Using DELETE
DELETE
Delete Bucket Replication Using DELETE
DELETE
Delete Bucket Tagging Using DELETE
DELETE
Delete Bucket Using DELETE
DELETE
Delete Bucket Website Using DELETE
DELETE
Delete Public Access Block Using DELETE
GET
Get Bucket Acl Using GET
GET
Get Bucket Cors Using GET
GET
Get Bucket Encryption Using GET
GET
Get Bucket Lifecycle Using GET
GET
Get Bucket Location Using GET
GET
Get Bucket Logging Using GET
GET
Get Bucket Notification Configuration Using GET
GET
Get Bucket Policy Status Using GET
GET
Get Bucket Policy Using GET
GET
Get Bucket Replication Using GET
GET
Get Bucket Request Payment Using GET
GET
Get Buckets Using GET 1
GET
Get Bucket Tagging Using GET
GET
Get Bucket Using GET
GET
Get Bucket Versioning Using GET
GET
Get Bucket Website Using GET
GET
Get Object Lock Configuration Using GET
GET
Get Public Access Block Using GET
GET
List Uploads Using GET
GET
List Versions Using GET
PUT
Set Bucke Policy Using PUT
PUT
Set Bucket Acl Using PUT
PUT
Set Bucke Tagging Using PUT
PUT
Set Bucket Cors Using PUT
PUT
Set Bucket Encryption Using PUT
PUT
Set Bucket Lifecycle Using PUT
PUT
Set Bucket Logging Using PUT
PUT
Set Bucket Notification Configuration Using PUT
PUT
Set Bucket Replication Using PUT
PUT
Set Bucket Request Payment Using PUT
PUT
Set Bucket Versioning Using PUT
PUT
Set Bucket Website Using PUT
PUT
Set Object Lock Configuration Using PUT
PUT
Set Public Access Block Using PUT