Skip to navigation

Create S3 credential

Creates an access key pair. The secret is returned only once. Requires scope: object-storage.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl -X POST "https://api.ibee.ai/v1/object-storage/credentials?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Default Key", "permission_type": "admin_rw"}'

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
namestringOptional1-128 charactersDefaults to Default Key

Display name of the key pair. Default Default Key.

permission_typeenumOptionalDefaults to admin_rw
  • admin_rw: manage buckets and read/write objects (default).
  • admin_ro: read buckets and objects.
  • object_rw: read and write objects only.
  • object_ro: read objects only.
Allowed values:
bucket_scopeenumOptionalDefaults to all
  • all: the key may use every bucket in the workspace (default).
  • specific: only the buckets in allowed_buckets.
Allowed values:
allowed_bucketslist of stringsOptional

Bucket names the key may use when bucket_scope is specific.

Response

Credential created successfully.
access_key_idstring
S3 access key ID.
namestring
Display name of the key pair.
statusenum
  • active: usable.
  • revoked: no longer accepted.
Allowed values:
created_atdatetime

When the key pair was created (ISO 8601).

secret_access_keystring
Returned once at creation time.
project_idstringOptional
Legacy identifier of the owning project.
last_used_atdatetime or nullOptional

When the key was last used to sign a request (ISO 8601); null if never.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error