Get Organization Limits

The limits in force for an organization, and how many blobs and running executions it holds. See Limits for what each limit means and how its value is chosen.

GET /orgs/:id/limits

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The organization’s id or alias.

Access

Requires read access to the organization.

Response

Parameter	Type	Description
groups	array	One object per group this route returns: platform first, then blob types, always in the platform’s order.

Each group:

Field	Type	Description
group	string	platform, or a blob type string such as blobhub.compute.workflow.
label	string	The group’s display name, such as Global or Workflow.
limits	array	The group’s limits, below.

Each limit:

Field	Type	Description
id	string	The limit’s id, <family>.<name>. See the catalog.
label	string	The limit’s display name.
description	string	Display text saying what the limit bounds.
kind	string	quota, ceiling, entitlement or retention.
unit	string	count, bytes, seconds, days, flag or modules.
per	string	What one value applies to: user, org, blob, revision, session, execution, node, write, call, query, schedule, run or upload.
value	integer, boolean, array or null	The value in force for this target. An array lists module names; null is a retention of forever.
default	same as value	The catalog’s default. Absent on a fixed limit.
source	string	Where value came from: default; user, org or blob for an override set at that level; platform for a fixed limit.
held	integer	How many this target holds against the limit. Present only on the quotas this target holds.
fixed	boolean	true on a fixed limit, which no override can change. Absent otherwise.

Labels and descriptions are display text and may change. Key off id.

This view

• Groups: platform without platform.orgs_per_user, and every blob type, each resolved at this organization — the catalog default, then its owner’s overrides, then its own. A type the organization has not enabled still appears, with its <family>.enabled entry false.
• Held: platform.blobs_per_org carries held, the blobs in the organization, and workflow.running_executions_per_org carries held, the executions running across its blobs.

Errors

Status	Error	Cause
403	forbidden	The organization does not exist, or the caller lacks read access to it. The two answer alike.

Example

The response is abridged: every group lists every one of its limits.

Request

curl -X GET https://api.blobhub.io/v1/orgs/acme-corp/limits \
  -H "X-API-Key: $ORG_API_KEY"