- Method:
PUT
- Path:
/v1/orgs/{org}/notifications/quota
- Operation ID:
setNotificationPreferences
- Tag: Notifications
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 NotificationPreferencesRequest, required.
| Field |
Type |
Required |
Enum |
Description |
quota_emails_enabled |
boolean |
Yes |
|
True to receive the storage-quota emails, false to stop them. Covers both the 80% advisory and the 100% limit notice. |
| Field |
Type |
Required |
Enum |
Description |
quota_emails_enabled |
boolean |
Yes |
|
Whether this organization wants the storage-quota emails: the ‘your bucket is 80% full’ advisory and the ‘your bucket has reached its limit’ notice. One switch covers both. True unless somebody here has turned it off, and true for an organization that has never expressed a preference. |
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/notifications/quota" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY" \
-H "Content-Type: application/json" \
--data @body.json