Manage quotas in Aiven for Apache Kafka®

Manage quotas in your Aiven for Apache Kafka® service to control network throughput and CPU usage per client.

Prerequisites

• An Aiven for Apache Kafka® service.
• Access to the Aiven Console or an authenticated Aiven CLI.
• A personal access token for API requests.

Add quota

Aiven Console

1. Log in to Aiven Console and select your Kafka service.

2. Click Access & Control > Quotas in the sidebar.

3. Click Add quota.

4. Enter the Client ID or User.

5. Set one or more quota values:

   • Consumer throttle: Maximum data rate for consumers, in bytes per second.
   • Producer throttle: Maximum data rate for producers, in bytes per second.
   • CPU throttle: Maximum CPU usage for the client, as a percentage.
   note

   Enter default to apply the quota to all clients or users.

6. Click Add.

Aiven CLI

Use avn service quota create with at least one of --client-id or --user, and at least one quota parameter.

Example: Set a 1 MiB/s producer and consumer throttle for user alice:

avn service quota create kafka-doc \
  --user alice \
  --consumer-byte-rate 1048576 \
  --producer-byte-rate 1048576

Example: Set a default quota for all users:

avn service quota create kafka-doc \
  --user default \
  --consumer-byte-rate 5242880

Aiven API

Send a request to the ServiceKafkaQuotaCreate endpoint:

curl -X POST https://api.aiven.io/v1/project/PROJECT_NAME/service/SERVICE_NAME/quota \
  -H "Authorization: Bearer $AIVEN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user": "alice",
    "consumer_byte_rate": 1048576,
    "producer_byte_rate": 1048576
  }'

Replace PROJECT_NAME and SERVICE_NAME with your Aiven project name and Kafka service name.

View quotas

Aiven Console

1. Access the Aiven Console and open your Aiven for Apache Kafka® service.
2. Click Access & Control > Quotas.

The page lists all configured quotas.

Aiven CLI

avn service quota list kafka-doc

Aiven API

Send a request to the ServiceKafkaQuotaList endpoint:

curl https://api.aiven.io/v1/project/PROJECT_NAME/service/SERVICE_NAME/quota \
  -H "Authorization: Bearer $AIVEN_TOKEN"

Replace PROJECT_NAME and SERVICE_NAME with your Aiven project name and Kafka service name.

Update quota

Aiven Console

1. Access the Aiven Console and open your Aiven for Apache Kafka® service.
2. Click Access & Control > Quotas.
3. Find the quota to update.
4. Click Actions > Update.
5. Update the quota values.
6. Click Save changes.

Aiven CLI

Run avn service quota create again with the same --user or --client-id to overwrite existing values:

avn service quota create kafka-doc \
  --user alice \
  --consumer-byte-rate 2097152

Aiven API

Send another request to the ServiceKafkaQuotaCreate endpoint with the updated values to overwrite the existing quota.

Delete quota

Aiven Console

1. Access the Aiven Console and open your Aiven for Apache Kafka® service.
2. Click Access & Control > Quotas.
3. Find the quota to delete.
4. Click Actions > Delete.
5. Click Delete quota to confirm.

Aiven CLI

avn service quota delete kafka-doc --user alice

Aiven API

Send a request to the ServiceKafkaQuotaDelete endpoint:

curl -X DELETE "https://api.aiven.io/v1/project/PROJECT_NAME/service/SERVICE_NAME/quota?user=alice" \
  -H "Authorization: Bearer $AIVEN_TOKEN"

Replace PROJECT_NAME and SERVICE_NAME with your Aiven project name and Kafka service name.

Related pages

• Quotas in Aiven for Apache Kafka®
• avn service quota