For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Subscriptions

Create or update a batch of client metrics subscriptions.

Creates or updates a batch of client metrics subscriptions on a virtual cluster. Each entry in the request creates a new subscription if no subscription with that name exists, or replaces the existing one if it does.

Requires admin permissions.

Request

curl https://api.warpstream.com/api/v1/update_client_metrics_subscriptions \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{
  "virtual_cluster_id": "vci_1d4930d7_8e6d_4ad9_b27a_654ed4aaa3ee",
  "client_metrics_subscriptions": [
    {
      "name": "staging-producers",
      "interval_ms": 30000,
      "metrics": "org.apache.kafka.producer.node.request.latency",
      "match": "client_id=staging-.*"
    },
    {
      "name": "all-clients",
      "interval_ms": 60000,
      "metrics": "",
      "match": ""
    }
  ]
}'

The name field is required for each entry. The other fields are optional; omit them to leave them unset on the resulting subscription.

Response

Last updated

Was this helpful?