Get User Limits

The limits a new organization of this user starts with, and how many organizations the user owns. See Limits for what each limit means and how its value is chosen.

GET /users/:id/limits

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The user’s id or alias, or me.

Access

Readable by the user themselves and by anyone with admin standing on the user, such as a service account’s owner. Anyone else gets 403, although Get User is readable by every caller. A user-scoped API key needs the admin role here, since a key never acts above the role it was minted with — see Role Cap.

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 and every blob type, each resolved at this user — the catalog default, then this user’s own overrides. These are the values a new organization of this user starts with.
• Held: platform.orgs_per_user carries held, the organizations this user owns.

Errors

Status	Error	Cause
403	forbidden	The user does not exist, or the caller is neither that user nor holds admin standing on them. 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/users/me/limits \
  -H "X-API-Key: $USER_API_KEY"