Get an organization's shared-storage quota

GET

/api/v1/admin/organizations/{orgID}/storage-quota

curl --request GET \
  --url https://api.aetherplatform.cloud/api/v1/admin/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/storage-quota \
  --header 'Authorization: Bearer <token>'

Returns the org’s configured shared-storage (CephFS) cap alongside the platform default and, when the management cluster can be reached, the quota ceph is actually enforcing and the bytes already written. The observation is best-effort: an unreachable management cluster leaves both observed members null rather than failing the request. Requires the platform-admin realm role.

Authorizations

• bearerApiToken

Parameters

Path Parameters

orgID

required

string format: uuid

Organization UUID.

Responses

200

The org’s configured, effective and observed quota figures.

Media typeapplication/json

An organization’s shared-storage (CephFS) cap: what is configured, what applies, and what the cluster actually reports. Every optional member is nullable rather than absent — a 0 quota would read as “unlimited”, and a 0 observed pair would claim the org has no cap and has written nothing, neither of which can be asserted without a figure.

object

configured_gb

required

The per-org cap in GiB, or null when none is set and the platform default applies.

integer | null

effective_gb

required

The cap in force — configured_gb when set, otherwise default_gb.

integer

default_gb

required

The platform default cap in GiB.

integer

observed_quota_bytes

required

The quota ceph is currently ENFORCING on the org’s CephFS data pool — the configured-vs-observed drift readout. null when the management cluster has published no figure or could not be reached.

integer | null format: int64

observed_used_bytes

required

Bytes already written to that pool. null under the same conditions as observed_quota_bytes.

integer | null format: int64

Example^generated

{
  "configured_gb": 1,
  "effective_gb": 1,
  "default_gb": 1,
  "observed_quota_bytes": 1,
  "observed_used_bytes": 1
}

400

Malformed request — e.g. an invalid path UUID or an unparseable JSON body.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

403

The credential was accepted but lacks the required role or access (e.g. a non-platform-admin calling an /api/v1/admin endpoint).

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

The requested resource was not found.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}