- Method:
GET
- Path:
/v1/orgs/{org}/s3/buckets/{bucket_id}
- Operation ID:
getBucket
- Tag: Object storage
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
bucket_id |
string (uuid) |
Yes |
|
org |
string (uuid) |
Yes |
The organization’s id. |
| Field |
Type |
Required |
Enum |
Description |
created_at |
string (date-time) |
Yes |
|
|
id |
string (uuid) |
Yes |
|
|
name |
string |
Yes |
|
|
observed_at |
string (date-time), nullable |
No |
|
|
observed_exists |
boolean, nullable |
No |
|
|
observed_quota |
BucketQuotaOut, nullable |
No |
|
|
observed_quota.max_objects |
integer, nullable |
No |
|
Objects this bucket may hold. null = no per-bucket cap. |
observed_quota.max_size_bytes |
integer, nullable |
No |
|
Bytes this bucket may hold. null = no per-bucket cap. |
observed_versioning |
boolean, nullable |
No |
|
Versioning as the object store last reported it. null means no observation has been recorded – not that versioning is off. |
operation_id |
string (uuid), nullable |
No |
|
|
purge_after |
string (date-time), nullable |
No |
|
|
quota |
BucketQuotaOut |
Yes |
|
|
quota.max_objects |
integer, nullable |
No |
|
Objects this bucket may hold. null = no per-bucket cap. |
quota.max_size_bytes |
integer, nullable |
No |
|
Bytes this bucket may hold. null = no per-bucket cap. |
soft_deleted_at |
string (date-time), nullable |
No |
|
|
state |
string |
Yes |
|
|
updated_at |
string (date-time) |
Yes |
|
|
versioning |
boolean |
Yes |
|
Whether previous versions of overwritten objects are kept, as requested when the bucket was created. This is desired state; observed_versioning is what the object store last reported. |
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/s3/buckets/$BUCKET_ID" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"