Get Quota Definition

GET

/network/v1/quota-definitions/{id}

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

Returns a single quota definition by its unique ID.

Parameters

Path Parameters

id

required

string

Quota Definition ID

The unique identifier of the quota definition to retrieve.

Responses

200

OK

Media type application/json

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

Example ^generated

{}

default

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"
    }
  ]
}