Skip to main content

S3 Adapter Admin

bgng s3 is the admin client for the S3 adapter. It does not speak the S3 protocol; it calls the adapter's /admin/* endpoints for key lifecycle and multipart session triage.

Configure the target​

Each command needs an adapter URL and an admin bearer token.

export BGDB_S3_ADAPTER_URL=http://127.0.0.1:19001
export BGDB_S3_ADAPTER_ADMIN_TOKEN=...
bgng s3 keys list

Resolution order is flag, then environment variable, then config.s3Adapter in ~/.bgng/config.json. The workspace can be uninitialized if env vars or flags provide both values.

Create and list keys​

bgng s3 keys create --label "ci-runner-prod" --bgdb-bearer "$BGDB_BEARER" --bucket-constraint "42-main" --ttl-days 90
bgng s3 keys list
bgng s3 keys list --json

The adapter returns access_key_id and secret_access_key on create. The secret is shown once; capture it immediately.

Rotate and revoke keys​

bgng s3 keys rotate AKIA0123456789ABCDEF
bgng s3 keys rotate AKIA0123456789ABCDEF --bgdb-bearer "$NEW_BGDB_BEARER"
bgng s3 keys revoke AKIA0123456789ABCDEF

Rotation returns a new secret once. Revocation preserves the key entry for audit but prevents future SigV4 requests with that key id.

Multipart sessions​

bgng s3 sessions list
bgng s3 sessions abort <upload-id>

Use this when multipart uploads are stuck or a client abandoned a session without calling abort.