API Credentials
An S3 credential is a pair of keys — an Access Key ID and a Secret Access Key — that lets a program use your buckets. The AWS CLI, rclone, backup tools, and the S3 SDKs for Python, Node.js, Go and other languages all sign in with one. Think of the Access Key ID as a username and the Secret Access Key as its password.
Each credential belongs to one workspace and has one permission level. It works only with that workspace’s buckets.
S3 credentials are not the same as platform API tokens. An S3 credential reads and writes files through the S3 endpoint. A platform API token manages resources (VMs, buckets, networks) through the IBEE API.
Choose a permission level
Pick the lowest level that does the job:
A credential limited to bucket A can’t read or write bucket B. For an app that uses one bucket, create an Object credential for just that bucket.
Before you begin
- A workspace with at least one bucket. See Create a bucket.
- Access to Organization → API Tokens in the portal.
- For organizations billed in India: a verified payment method and, if the ₹1 was your only payment, a first top-up of at least ₹500. Until then the S3 credentials tab shows Verify payment method or Top up ₹500 in place of the create button. See Verify a payment method.
- The tool you will use: the AWS CLI version 2, rclone, or an S3 SDK.
Create a credential
Open S3 Credentials
In the portal sidebar, open Organization → API Tokens, then the S3 Credentials tab. (The S3 API Credentials button on the Object Storage page opens the same tab.)
Fill in the form
Click Create S3 Credential. Enter a name that says what uses it (for example backup-server), choose the workspace, and choose the permission level. For an Object level, under Specify bucket(s), choose Apply to all buckets in this organization (including newly created buckets) or Apply to specific buckets only and pick the buckets.
The Secret Access Key is shown once only. If you lose it, you can’t see it again: revoke the credential and create a new one.
The first credential in a workspace also sets up the workspace’s S3 endpoint. A brand-new endpoint can take a few minutes to start answering.
The three settings every tool needs
Tools that use us-east-1 as their default region make requests that fail with Invalid region scope, so always set the region to auto.
AWS CLI
Save the credential as a profile named ibee:
Then pass the endpoint and profile with each command:
rclone
Add this to your rclone config (rclone config file shows where it is):
Test it with rclone lsd ibee:, which lists your buckets.
SDKs
Set the same three values in the client. For example, in Python (boto3):
In Node.js (AWS SDK v3), use region: "auto" and forcePathStyle: true.
Manage credentials
The S3 Credentials tab lists credentials from every workspace you can access; use the workspace filter to show one. Each row shows Access (the workspace), Permissions, Created, Last Used and Status (Active or Revoked).
- Revoke stops a credential working immediately, including every presigned URL it signed. The row stays in the list as Revoked. This can’t be undone.
- Delete removes a revoked credential from the list. Click Delete permanently to confirm.
To rotate a credential (replace its keys without downtime): create a new credential, update your apps to use it, check that Last Used shows the new one in use, then revoke the old one.
In the public API, credentials are per workspace: GET /object-storage/credentials, POST /object-storage/credentials (name, permission_type, bucket_scope, allowed_buckets), GET /object-storage/credentials/{access_key_id}, and DELETE /object-storage/credentials/{access_key_id} to stop a credential working.
Limits and timing
Troubleshooting
Related pages
- Presigned URLs: share one file with a link that expires
- Bucket Policies: public access and permission levels
- Using the S3 API: which operations the S3 endpoint serves
- API Tokens: platform API tokens for managing resources
