Get Object Storage bucket list

Prev Next

Available in Classic and VPC

Get the list of Object Storage buckets available for storage of build results.

Note

To get the bucket list, you must first create a bucket in the Object Storage service. See the following for how to create a bucket.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/objectstorage/bucket

Request headers

For information about the headers common to all SourceBuild APIs, see SourceBuild request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://sourcebuild.apigw.ntruss.com/api/v1/objectstorage/bucket' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - API processing result
result.bucket Array - Bucket list

bucket

The following describes bucket.

Field Type Required Description
name String - Bucket name
creationTime Number - Bucket creation date and time (millisecond)
  • Unix timestamp format
permission String - Ownership of permission to view details
  • Allow | Deny
    • Allow: own
    • Deny: not owned
actionName String - Permission name for viewing details
disabled Boolean - Bucket availability
  • true | false
    • true: unavailable
    • false: available

Response status codes

For information about the response status codes common to all SourceBuild APIs, see SourceBuild response status codes.

Response example

The response example is as follows:

{
    "result": {
        "bucket": [
            {
                "name": "repository001",
                "creationTime": 1747023289731,
                "permission": "Allow",
                "actionName": "View/getBucketDetail",
                "disabled": false
            }
        ]
    }
}