API overview
The KakaoCloud Object Storage API provides an interface that allows you to manage buckets and objects through code.
It is useful when automating bulk or repetitive tasks that are inconvenient to perform in the console.
- Swift API – OpenStack standard method
- Extension API – Additional extension features provided by KakaoCloud
- S3 compatible API – Method compatible with AWS S3
These APIs are based on the REST architecture and can be easily used in programs or scripts.
Before you start
Before using the API, check and prepare the endpoint, roles and permissions, and authentication information to reduce request errors and call the API smoothly.
Endpoint
The Object Storage API endpoint URL for the kr-central-2 region is as follows.
https://objectstorage.kr-central-2.kakaocloud.com
Roles and permissions
Access to the Object Storage service depends on the user’s IAM role and Object Storage role.
The IAM Object Storage manager and Object Storage viewer roles grant permissions to create buckets and view the bucket list.
In addition, users who have an Object Storage role for the target bucket have permissions for the bucket and objects.
In summary, the permissions required for calling the Object Storage API vary depending on the type of operation.
- Create bucket / view bucket list: Only the IAM role (Object Storage manager or viewer) is required.
- Specific bucket or object operations: Only the permissions for the target bucket are required.
For more information about IAM roles and bucket roles, see Roles and permissions.
Authentication (S3 access key, user authentication token (API authentication token))
For the prerequisites required to call the API, see the Prepare to use APIs document.
Get S3 access key
To call the S3 API, you can issue an S3 access key and use it as the credential for AWS Signature.
An S3 access key can be issued for both service accounts and user accounts. For details, see the guide links below.