signaloid-cli buckets get
Get a single S3 bucket configuration by ID.
Synopsis
signaloid-cli buckets get --bucket-id <id> [options]
Options
| Option | Required | Description |
|---|---|---|
--bucket-id <id> | Yes | Bucket ID |
--format <type> | No | Output format: table or json (default: json) |
Description
Returns the full configuration of one cloud storage S3 bucket. The configuration contains its name, the account it belongs to, the mount path it is exposed at, and its read and write permissions.
Use buckets list to get the available S3 bucket identifiers.
Examples
Get a bucket as JSON:
signaloid-cli buckets get --bucket-id bkt_abc123
Get a bucket as a table:
signaloid-cli buckets get --bucket-id bkt_abc123 --format table
Check whether a bucket is writable:
signaloid-cli buckets get --bucket-id bkt_abc123 | jq -r '.Write'
Exit Codes
| Code | Description |
|---|---|
0 | Success |
1 | Failed to get the bucket |
3 | Not authenticated, or the session has expired |
4 | Bucket not found |
See Also
- signaloid-cli buckets - Buckets command overview
- signaloid-cli buckets list - List configured buckets
- signaloid-cli buckets update - Update bucket configuration
- signaloid-cli buckets delete - Delete a bucket configuration