- Method:
PUT
- Path:
/v1/orgs/{org}/s3/quota
- Operation ID:
setQuota
- 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 |
org |
string (uuid) |
Yes |
The organization’s id. |
Content type application/json, schema S3QuotaUpdateRequest, required.
| Field |
Type |
Required |
Enum |
Description |
hard_bytes |
integer |
Yes |
|
The organization’s storage ceiling, in bytes. Must fall between the platform floor and the platform-wide maximum, inclusive. |
| Field |
Type |
Required |
Enum |
Description |
cap_bytes |
integer |
Yes |
|
|
cap_objects |
integer |
Yes |
|
|
enforced_bytes |
integer, nullable |
No |
|
|
enforced_objects |
integer, nullable |
No |
|
|
frozen_reason |
string, nullable |
No |
|
|
soft_bytes |
integer |
Yes |
|
|
usage_bytes |
integer, nullable |
No |
|
|
usage_objects |
integer, nullable |
No |
|
|
warning |
string, nullable |
No |
|
‘below_current_usage’ when the new hard_bytes already sits below this organization’s latest measured usage – the write still succeeds, but new writes to the object store stop until usage falls back under the new ceiling or it is raised again. null on every other successful update, including when there is no usage sample yet to compare against. |
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 400 |
The request is malformed or failed validation. |
| 401 |
The credential is missing or invalid. |
| 403 |
The credential does not have permission to perform this operation. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl -X PUT "https://api.virtscale.nl/v1/orgs/$ORG_ID/s3/quota" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY" \
-H "Content-Type: application/json" \
--data @body.json