Skip to content

Get committed/soft/hard quota and current burst state

  • Method: GET
  • Path: /v1/orgs/{org}/s3/quota
  • Operation ID: getQuota
  • 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.
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

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/quota" \
  -H "Authorization: Bearer $VIRTSCALE_API_KEY"