Skip to navigation

Get S3 credential

Returns credential metadata without the secret key. Requires scope: object-storage.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# ACCESS_KEY_ID: S3 access key ID
curl "https://api.ibee.ai/v1/object-storage/credentials/$ACCESS_KEY_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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.

Path parameters

access_key_idstringRequired
S3 access key ID.

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.

Response

Credential returned 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).

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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error