Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

List Quota Limits

GET
/network/v1/quota-definitions/{quota_definition}/limits
curl --request GET \
--url https://example.com/network/v1/quota-definitions/example/limits

Returns a paginated list of quota limits for a quota definition.

quota_definition
required
string

The quota definition to list limits for.

page_size
integer format: int32

Page Size

Maximum number of quota limits to return. The service may return fewer than this value. If unspecified, at most 20 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token
string

Page Token

A page token, received from a previous ListQuotaLimits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListQuotaLimits must match the call that provided the page token.

filter
string

Filter

AIP-160 filter expression (e.g., “container_id=uuid”).

order_by
string

Order By

AIP-132 ordering expression.

OK

Media type application/json

ListQuotaLimitsResponse

Response message for ListQuotaLimits. Note: This API intentionally omits total_size from list responses. Keyset pagination does not support efficient total count computation (COUNT(*) requires a full table scan). Per AIP-158, total_size is optional.

object
quota_limits

Quota Limits

The list of quota limits.

Array<object>

QuotaLimit — an override of a quota definition’s default limit for a specific container (organisation, workspace, or group) and optional dimensions. Resolution: explicit QuotaLimit > QuotaDefinition.default_limit.

object
id

Unique identifier for this quota limit.

stringOutput only
quota_definition_id

The quota definition this limit overrides.

stringOutput only
container_id
required

The scoped resource (workspace UUID, org UUID, group UUID) this limit applies to.

string
container_type
required

The taxonomy scope type (ORGANISATION, WORKSPACE, or GROUP). Must match the parent quota definition’s container_type.

string
dimensions

Key-value dimension overrides (e.g., {“region”: “us-east-1”}). Empty map means global/unscoped. Keys must be from the parent definition’s dimension_keys list.

object
key
additional properties
string
effective_limit
required

The overridden limit for this container and dimensions.

integer format: int32
created

Created Timestamp

When this quota limit was created.

string format: date-time Output only
updated

Updated Timestamp

When this quota limit was last updated.

string format: date-time Output only
next_page_token

Next Page Token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string
Example generated
{
"quota_limits": [
{
"container_id": "example",
"container_type": "example",
"dimensions": {
"additionalProperty": "example"
},
"effective_limit": 1
}
],
"next_page_token": "example"
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}