---
title: "Update a Client Quota"
method: PATCH
path: "/kafka-quotas/v1/client-quotas/{id}"
tags: ["Client Quotas (kafka-quotas/v1)"]
---
# Update a Client Quota
`PATCH /kafka-quotas/v1/client-quotas/{id}`
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update a client quota.
## Path parameters
- `id` string, required
## Request body
- object — `ClientQuota` objects represent Client Quotas you can set at the service account level. The API allows you to list, create, read, update, and delete your client quotas. Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). ## The Client Quotas Model
- `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.
- `id` string — 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").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `spec` object, required — The desired state of the Client Quota
- `display_name` string — The name of the client quota.
- `description` string — A human readable description for the client quota.
- `throughput` KafkaQuotasV1Throughput — Quotas on maximum throughput
- `ingress_byte_rate` string, int64, required — Ingress throughput limit for principals specified in bytes per second.
- `egress_byte_rate` string, int64, required — Egress throughput limit for principals specified in bytes per second.
- `cluster` EnvScopedObjectReference — ObjectReference provides information for you to locate the referred object
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `principals` GlobalObjectReference[] — A list of principals to apply a client quota to. Use `""` to apply a client quota to all service accounts (see [Control application usage with Client Quotas](https://docs.confluent.io/cloud/current/clusters/client-quotas.html#control-application-usage-with-client-quotas) for more details).
- `id` string, required — ID of the referred resource
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `environment` object, required — The environment to which this belongs.
- `id` string, required — ID of the referred resource
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
## Response `200`
Client Quota.
- object — `ClientQuota` objects represent Client Quotas you can set at the service account level. The API allows you to list, create, read, update, and delete your client quotas. Related guide: [Client Quotas in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/client-quotas.html). ## The Client Quotas Model
- `api_version` 'kafka-quotas/v1', required — APIVersion defines the schema version of this representation of a resource.
- `kind` 'ClientQuota', required — Kind defines the object this REST resource represents.
- `id` string, required — 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").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `spec` object, required — The desired state of the Client Quota
- `display_name` string, required — The name of the client quota.
- `description` string — A human readable description for the client quota.
- `throughput` KafkaQuotasV1Throughput, required — Quotas on maximum throughput
- `ingress_byte_rate` string, int64, required — Ingress throughput limit for principals specified in bytes per second.
- `egress_byte_rate` string, int64, required — Egress throughput limit for principals specified in bytes per second.
- `cluster` object, required — The ID of the Dedicated Kafka cluster where the client quota is applied.
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `principals` GlobalObjectReference[], required — A list of principals to apply a client quota to. Use `""` to apply a client quota to all service accounts (see [Control application usage with Client Quotas](https://docs.confluent.io/cloud/current/clusters/client-quotas.html#control-application-usage-with-client-quotas) for more details).
- `id` string, required — ID of the referred resource
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `environment` object, required — The environment to which this belongs.
- `id` string, required — ID of the referred resource
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
## Other responses
- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `409` — The request is in conflict with the current server state
- `422` — Validation Failed
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!
---
[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)