- Method:
GET
- Path:
/v1/orgs/{org}
- Operation ID:
getOrgContext
- Tag: Organizations
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 |
org |
string (uuid) |
Yes |
The organization’s id. |
| Field |
Type |
Required |
Enum |
Description |
name |
string |
Yes |
|
|
org_id |
string (uuid) |
Yes |
|
|
quota |
QuotaOut, nullable |
No |
|
|
quota.buckets_used |
integer |
Yes |
|
Buckets occupying a slot against max_buckets. Deliberately not the length of GET /s3/buckets: a soft-deleted bucket is still listed and still restorable, but holds no slot. An org can therefore be shown 2 of 25 while the list returns 3. |
quota.hard_bytes |
integer |
Yes |
|
|
quota.max_buckets |
integer |
Yes |
|
The org’s effective bucket ceiling: the plan’s value with any live quota override folded in, which is what the create check measures against. |
quota.max_objects |
integer |
Yes |
|
|
quota.soft_bytes |
integer |
Yes |
|
|
s3 |
EnrollmentOut, nullable |
No |
|
|
s3.created_at |
string (date-time) |
Yes |
|
|
s3.org_id |
string (uuid) |
Yes |
|
|
s3.state |
string |
Yes |
|
|
s3.updated_at |
string (date-time) |
Yes |
|
|
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" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"