Hosted storage: whether it is offered, the quota, and how much is locked

get/api/v1/orgs/{org_id}/storage

Request

  • Base URL: https://safegrd.dev
  • URL: https://safegrd.dev/api/v1/orgs/{org_id}/storage
  • Auth: HTTP bearer

Path parameters

org_idstring required

Response

Usage

offeredboolean
quota_bytesinteger

Hosted storage the plan includes

used_bytesinteger

Locked, or granted to an upload in flight

regime'quota' | 'metered' | 'lapsed'

quota: refused at quota_bytes (free plan, trial). metered: never refused for size; the period's average above quota_bytes is billed per GB-month. lapsed: refused past limit_bytes

limit_bytesinteger

Where uploads are refused, when that differs from quota_bytes

overage_cents_per_gb_monthinteger

Metered plans: the price of a GB-month above the quota, in US cents

period_startstring date-time
period_overage_gb_monthsinteger

Metered plans: GB-months above the quota this period so far, rounded down

period_overage_centsinteger

Metered plans: what this period's overage comes to so far, in US cents

lapsed_planstring

Lapsed: the last plan paid for, whose quota sets limit_bytes

last_lock_expires_atstring date-time

When the last byte held stops being locked

Changes

No recorded changes to this operation across all 1 revision of this API.