Sign in
Client Quotas (kafka-quotas/v1)

Create a Client Quota

General Availability

Make a request to create a client quota.

post/kafka-quotas/v1/client-quotas

Request body

{"stackTrail":"paths:/kafka-quotas/v1/client-quotas:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown","example":{"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"},"principals":[{"id":"sa-xxxxx"}],"environment":{"id":"env-xxxxx"}}}}

Example request

{
  "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"
    },
    "principals": [
      {
        "id": "sa-xxxxx"
      }
    ],
    "environment": {
      "id": "env-xxxxx"
    }
  }
}

Response

A Client Quota is being created.

api_version'kafka-quotas/v1'

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

kind'ClientQuota'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "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.