S3 Get Bucket

S3 Get Bucket

API code: S3_GET_BUCKET
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN | ANONYMOUS

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

The bucket name. It must be URL encoded.

Header Parameters
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 
{
    "truncated": false,
    "continuationToken": "string",
    "nextContinuationToken": "string",
    "name": "string",
    "prefix": "string",
    "delimiter": "string",
    "encodingType": "string",
    "keyCount": 0,
    "maxKeys": 0,
    "commonPrefixes": [
        {
            "prefix": "string",
            "owner": {
                "id": "string",
                "displayName": "string"
            }
        }
    ],
    "objectBrief": [
        {
            "key": "string",
            "versionId": "string",
            "owner": {
                "id": "string",
                "displayName": "string"
            },
            "ownerId": "string",
            "storageClass": "string",
            "etag": "string",
            "size": 0,
            "lastModified": "string"
        }
    ],
    "startAfter": "string"
}
boolean
truncated
Optional

truncated

string
continuationToken
Optional

continuationToken

string
nextContinuationToken
Optional

nextContinuationToken

string
name
Optional

name

string
prefix
Optional

prefix

string
delimiter
Optional

delimiter

string
encodingType
Optional

encodingType

integer As int64 As int64
keyCount
Optional

keyCount

integer As int64 As int64
maxKeys
Optional

maxKeys

array of CommonPrefixes
commonPrefixes
Optional

commonPrefixes

array of ObjectBrief
objectBrief
Optional

objectBrief

string
startAfter
Optional

startAfter


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