Sign in
Applied Quotas (service-quota/v1)

List of Applied Quotas

General Availability

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

Shows all quotas for a given scope.

get/service-quota/v1/applied-quotas

Query parameters

scopestring required

Filter a collection by a string search

The applied scope the quota belongs to.

environmentstring

Filter a collection by a string search

The environment ID the quota is associated with.

networkstring

Filter a collection by a string search

The network ID the quota is associated with.

kafka_clusterstring

Filter a collection by a string search

The kafka cluster ID the quota is associated with.

idstring

Filter a collection by a string search

The id (quota code) that this quota belongs to.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Applied Quota.

api_version'service-quota/v1' required

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

kind'AppliedQuotaList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/service-quota/v1/applied-quotas",
    "last": "https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/service-quota/v1/applied-quotas?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/service-quota/v1/applied-quotas/aq-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/applied-quota=aq-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"
      },
      "scope": "ORGANIZATION",
      "display_name": "Kafka Cluster Per Organization",
      "user": {
        "id": "u-4voj5e",
        "related": "https://api.confluent.cloud/v2/users/u-4voj5e",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user=u-4voj5e"
      },
      "organization": {
        "id": "b3a17773-05cc-4431-9560-433fb4613da8",
        "related": "https://api.confluent.cloud/partner/v2/organizations/b3a17773-05cc-4431-9560-433fb4613da8",
        "resource_name": "https://api.confluent.cloud/organization=b3a17773-05cc-4431-9560-433fb4613da8"
      },
      "environment": {
        "id": "env-00000",
        "related": "https://api.confluent.cloud/org/v2/environments/env-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
      },
      "network": {
        "id": "n-12034",
        "related": "https://api.confluent.cloud/networking/v1/networks/n-12034",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-12034"
      },
      "kafka_cluster": {
        "id": "lkc-00000",
        "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
      }
    }
  ]
}

Changes