Skip to Content
kosemdocs
ReferenceAPIQuota infos

Get quota info in organization

Gets one of an organization's quotas, with its limit and usage.

GET
/v1/organizations/{organization}/quotaInfos/{quotaInfo}

Gets one of an organization's quotas, with its limit and usage.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

organization*string

The organization's ID.

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$
quotaInfo*string

The quota's ID, such as resourcemanager.projects.

Match^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$

Response Body

OK

application/json
  1. response
adjustment*string

How the limit changes: FIXED, the same on every plan; UPGRADE, on Hobby or Pro, where a higher plan gives more; REQUEST, on Team and Enterprise, where kosem changes it for the organization when it asks.

Value in"FIXED""UPGRADE""REQUEST"
displayName*string

Name shown in user interfaces, such as Projects.

enforced*boolean

Whether a request past the limit is refused. A new rate quota only counts at first, and keeps the requests it would refuse, until kosem has reviewed whom it would refuse; quotas of what exists are always enforced.

limit*integer

How many the organization may have: its plan's, or one kosem set for it in its place (overridden).

Formatint64
name*string

Resource name, organizations/{organization_id}/quotaInfos/{quota_id} or projects/{project_id}/quotaInfos/{quota_id}.

overridden*boolean

Whether kosem set the organization's limit, in place of its plan's. It applies while the organization stays on its plan.

planLimit*integer

How many the organization's plan allows, which limit replaces when overridden; the same as limit otherwise.

Formatint64
quotaId*string

The quota's ID: the service, then what it counts, such as resourcemanager.projects.

refreshInterval*string

For a rate quota, how often it counts afresh: minute. Empty for a quota of what exists.

resourceType*string

Empty for a quota of the organization as a whole. For a limit of each of its resources, their type, such as identity.kosem.ai/ServiceAccount.

usage*integer

How many the organization has, or for a limit of each of its resources, the most that any one of them has. It can be above limit after the limit drops; nothing is then removed, but no more can be created. For a project's rate quota, its busiest minute of the last hour. An organization's rate quotas report 0: see each project's.

Formatint64
usageUnavailable*boolean

Set on a project's rate quota whose counters cannot be read right now: usage is then 0, and unknown.

Example Request
curl -X GET 'https://api.kosem.ai/v1/organizations/string/quotaInfos/string'
Example Response
{
  "adjustment": "FIXED",
  "displayName": "string",
  "enforced": true,
  "limit": 0,
  "name": "string",
  "overridden": true,
  "planLimit": 0,
  "quotaId": "string",
  "refreshInterval": "string",
  "resourceType": "string",
  "usage": 0,
  "usageUnavailable": true
}