Skip to main content
GET
/
api
/
s3
/
buckets
/
{bucket_name}
Get bucket
curl --request GET \
  --url https://api.example.com/api/s3/buckets/{bucket_name} \
  --header 'Authorization: Bearer <token>'
{
  "bucket": "<string>",
  "endpoint": "<string>",
  "accesskey": "<string>",
  "secretkey": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
bucket_name
string
required

The unique name of the S3 bucket to retrieve.

Response

S3 bucket retrieved successfully.

​
bucket
string
required

The unique name of the S3 bucket.

​
endpoint
string
required

The endpoint URL used to connect to the S3 bucket.

​
accesskey
string
required

The access key used for authentication.

​
secretkey
string
required

The secret key used for authentication.

​
id
string<uuid>

Unique ID for the bucket.

​
created_at
string<date-time>

Timestamp when the bucket record was created.

​
updated_at
string<date-time>

Timestamp when the bucket record was last updated.