Sign in
Client Quotas (kafka-quotas/v1)

List of Client Quotas

General Availability

Retrieve a sorted, filtered, paginated list of all client quotas.

get/kafka-quotas/v1/client-quotas

Query parameters

spec.clusterstring required

Filter a collection by a string search

Filter the results by exact match for spec.cluster.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Client Quota.

api_version'kafka-quotas/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'ClientQuotaList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/kafka-quotas/v1/client-quotas",
    "last": "https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/kafka-quotas/v1/client-quotas?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/kafka-quotas/v1/client-quotas/cq-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/client-quota=cq-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "display_name": "QuotaForSA1",
        "description": "This quota defines limits on how much the target principals can use cluster lkc-xxxxx",
        "throughput": {
          "ingress_byte_rate": "5",
          "egress_byte_rate": "5"
        },
        "cluster": {
          "id": "lkc-xxxxx",
          "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-xxxxx",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-xxxxx"
        }
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.