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

List Quota Definitions

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

Returns a paginated list of quota definitions for the network service.

page_size
integer format: int32

Page Size

Maximum number of quota definitions to return. The service may return fewer than this value. If unspecified, at most 20 definitions 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 ListQuotaDefinitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListQuotaDefinitions must match the call that provided the page token.

filter
string

Filter

AIP-160 filter expression (e.g., “container_type=WORKSPACE”).

order_by
string

Order By

AIP-132 ordering expression, e.g. ‘metric asc’.

OK

Media type application/json

ListQuotaDefinitionsResponse

Response message for ListQuotaDefinitions. 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_definitions

Quota Definitions

The list of quota definitions.

Array<object>

QuotaDefinition — metadata describing a quota: what it limits, its unit, type, container scope, applicable dimensions, and platform-wide default. Seeded via Flyway. Each service owns its own quota definitions.

object
id

Unique identifier for this quota definition.

stringOutput only
metric

The human-readable metric identifier following the <service>/<resource>/<measure> convention (e.g., “network/vpc/count”).

stringOutput only
display_name

A human-readable display name (e.g., “VPCs per workspace”).

stringOutput only
description

An optional longer explanation of what this quota limits.

stringOutput only
unit

The unit of measurement (e.g., “count”, “bytes”, “bytes_per_second”).

stringOutput only
quota_type

The quota type: ALLOCATION (concurrent cap) or RATE (time-windowed).

stringOutput only
container_type

The taxonomy scope at which this quota is administered (ORGANISATION, WORKSPACE, or GROUP).

stringOutput only
dimension_keys

Ordered list of applicable dimension names (e.g., [“region”], [“zone”], or [] for global). Quota limits must only use keys from this list.

Array<string>Output only
default_limit

The platform-wide default limit applied when no explicit QuotaLimit override exists for a given container and dimensions.

integer format: int32 Output only
adjustable

Whether administrators can create QuotaLimit overrides for this metric.

booleanOutput only
refresh_interval

For RATE quotas only: the refresh interval as an ISO 8601 duration (e.g., “PT1M”, “PT1H”). Empty for ALLOCATION quotas.

stringOutput only
created

Created Timestamp

When this quota definition was created.

string format: date-time Output only
updated

Updated Timestamp

When this quota definition 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_definitions": [
{}
],
"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"
}
]
}