Sign in
Applied Quotas (service-quota/v1)

Read an Applied Quota

General Availability

Make a request to read an applied quota.

get/service-quota/v1/applied-quotas/{id}

Path parameters

idstring required

The unique identifier for the applied quota.

Query parameters

environmentstring

Filter a collection by a string search

The environment ID the quota is associated with. This field is only required when retrieving a single quota and the scope of quota is "ENVIRONMENT" or "NETWORK" or "KAFKA_CLUSTER".

networkstring

Filter a collection by a string search

The network ID the quota is associated with. This field is only required when retrieving a single quota and the scope of quota is "NETWORK".

kafka_clusterstring

Filter a collection by a string search

The kafka cluster ID the quota is associated with. This field is required only when the scope of quota is "KAFKA_CLUSTER".

Response

Applied Quota.

api_version'service-quota/v1' required

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

kind'AppliedQuota' required

Kind defines the object this REST resource represents.

idstring 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").

scopestring required

The applied scope that this quota belongs to.

display_namestring required

A human-readable name for the quota type name.

default_limitinteger required

The default service quota value.

applied_limitinteger required

The latest applied service quota value, taking into account any limit adjustments.

usageinteger

Show the quota usage value if the quota usage is available for this quota.

Example response

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

No recorded changes to this endpoint across all 4 revisions of this API.