Read a Cluster
GET/cmk/v2/clusters/:id
Make a request to read a cluster.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Cluster.
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Bad Request
Response Headers
X-Request-Id
The unique identifier for the API request.
The request lacks valid authentication credentials for this resource.
Response Headers
X-Request-Id
The unique identifier for the API request.
WWW-Authenticate
The unique identifier for the API request.
Example:
Basic error="invalid_key", error_description="The API Key is invalid"The access credentials were considered insufficient to grant access
Response Headers
X-Request-Id
The unique identifier for the API request.
Not Found
Response Headers
X-Request-Id
The unique identifier for the API request.
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Retry-After
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Oops, something went wrong!
Response Headers
X-Request-Id
The unique identifier for the API request.
OpenAPI definition (YAML)
paths:
/cmk/v2/clusters/{id}:
get:
x-lifecycle-stage: General Availability
x-self-access: true
operationId: getCmkV2Cluster
description: '[](#section/Versioning/API-Lifecycle-Policy)
Make a request to read a cluster.'
parameters:
- name: environment
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: env-00000
description: Scope the operation to the given environment.
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the cluster.
tags:
- Clusters (cmk/v2)
security:
- cloud-api-key: []
- global-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Cluster.
content:
application/json:
schema:
allOf:
- type: object
description: '`Clusters` objects represent Apache Kafka Clusters on Confluent Cloud.
The API allows you to list, create, read, update, and delete your Kafka clusters.
Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html).
## The Clusters Model
<SchemaDefinition schemaRef="#/components/schemas/cmk.v2.Cluster" />
## Quotas and Limits
This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):
| Quota | Description |
| --- | --- |
| `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment
|'
properties:
api_version:
type: string
enum:
- cmk/v2
description: APIVersion defines the schema version of this representation of a resource.
readOnly: true
kind:
type: string
description: Kind defines the object this REST resource represents.
readOnly: true
enum:
- Cluster
id:
description: 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").
type: string
maxLength: 255
readOnly: true
example: dlz-f3a90de
metadata:
allOf:
- description: ObjectMeta is metadata that all persisted resources must have, which
includes all objects users must create.
required:
- self
properties:
self:
description: 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
type: string
format: uri
readOnly: true
example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
resource_name:
description: Resource Name is a Uniform Resource Identifier (URI) that is
globally unique across space and time. It is represented as a Confluent
Resource Name
type: string
format: uri
readOnly: true
example: crn://confluent.cloud/kafka=lkc-f3a90de
created_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was created. It is represented
in RFC3339 format and is in UTC.
updated_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was last updated. It is
represented in RFC3339 format and is in UTC.
deleted_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was (or will be) deleted.
It is represented in RFC3339 format and is in UTC.
readOnly: true
title: ObjectMeta
- properties:
self:
example: https://api.confluent.cloud/cmk/v2/clusters/lkc-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345
spec:
type: object
description: The desired state of the Cluster
properties:
display_name:
type: string
description: The name of the cluster.
example: ProdKafkaCluster
availability:
type: string
description: 'The availability zone configuration of the cluster
'
example: SINGLE_ZONE
enum:
- MULTI_ZONE
- SINGLE_ZONE
- HIGH
- LOW
cloud:
type: string
description: The cloud service provider in which the cluster is running.
example: GCP
x-immutable: true
enum:
- AWS
- GCP
- AZURE
region:
type: string
description: The cloud service provider region where the cluster is running.
example: us-east4
x-immutable: true
config:
description: 'The configuration of the Kafka cluster.
Note: Clusters can be upgraded from Basic to Standard, but cannot be downgraded
from Standard to Basic.
'
default:
kind: Basic
example:
kind: Basic
discriminator:
propertyName: kind
mapping:
Basic:
type: object
description: 'The basic cluster type.
'
properties:
kind:
description: 'Basic cluster type.
'
type: string
enum:
- Basic
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units
(eCKUs) that Kafka clusters should auto-scale to.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Basic
Standard:
type: object
description: 'The standard cluster type.
'
properties:
kind:
description: 'Standard cluster type.
'
type: string
enum:
- Standard
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units
(eCKUs) that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Standard
Dedicated:
type: object
description: 'A dedicated cluster with its parameters.
'
properties:
kind:
type: string
enum:
- Dedicated
description: 'Dedicated cluster type.
'
cku:
description: 'The number of Confluent Kafka Units (CKUs) for Dedicated
cluster types.
MULTI_ZONE dedicated clusters must have at least two CKUs.
'
type: integer
format: int32
minimum: 1
example: 2
encryption_key:
type: string
description: 'The id of the encryption key that is used to encrypt
the data in the Kafka cluster.
(e.g. for Amazon Web Services, the Amazon Resource Name of the key).
'
example: arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx
deprecated: true
x-immutable: true
zones:
type: array
items:
type: string
uniqueItems: true
minItems: 1
maxItems: 3
description: "The list of zones the cluster is in.\n\nOn AWS, zones\
\ are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n\
\ (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n\
\ (e.g. us-central1-c).\n"
readOnly: false
example:
- us-central1-a
- us-central1-b
- us-central1-c
x-immutable: true
release_priority:
type: string
description: 'Specifies the release priority for cluster updates.
Defaults to REGULAR. Clusters with PRIORITY are updated before clusters
with REGULAR.
'
default: REGULAR
example: REGULAR
enum:
- REGULAR
- PRIORITY
required:
- kind
- cku
title: cmk.v2.Dedicated
Enterprise:
type: object
description: 'The enterprise cluster type.
'
properties:
kind:
description: 'Enterprise cluster type.
'
type: string
enum:
- Enterprise
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units
(eCKUs) that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Enterprise
Freight:
type: object
description: 'A freight cluster with its parameters.
'
properties:
kind:
type: string
enum:
- Freight
description: 'Freight cluster type.
'
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units
(eCKUs) that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
zones:
type: array
items:
type: string
uniqueItems: true
minItems: 1
maxItems: 3
description: "The list of zones the cluster is in.\n\nOn AWS, zones\
\ are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n\
\ (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n\
\ (e.g. us-central1-c).\n"
readOnly: true
example:
- us-central1-a
- us-central1-b
- us-central1-c
x-immutable: true
required:
- kind
title: cmk.v2.Freight
oneOf:
- type: object
description: 'The basic cluster type.
'
properties:
kind:
description: 'Basic cluster type.
'
type: string
enum:
- Basic
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units (eCKUs)
that Kafka clusters should auto-scale to.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Basic
- type: object
description: 'The standard cluster type.
'
properties:
kind:
description: 'Standard cluster type.
'
type: string
enum:
- Standard
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units (eCKUs)
that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Standard
- type: object
description: 'A dedicated cluster with its parameters.
'
properties:
kind:
type: string
enum:
- Dedicated
description: 'Dedicated cluster type.
'
cku:
description: 'The number of Confluent Kafka Units (CKUs) for Dedicated
cluster types.
MULTI_ZONE dedicated clusters must have at least two CKUs.
'
type: integer
format: int32
minimum: 1
example: 2
encryption_key:
type: string
description: 'The id of the encryption key that is used to encrypt the
data in the Kafka cluster.
(e.g. for Amazon Web Services, the Amazon Resource Name of the key).
'
example: arn:aws:kms:us-west-2:000000000000:key/0000xxxx-00xx-00xx-00xx-0000000000xx
deprecated: true
x-immutable: true
zones:
type: array
items:
type: string
uniqueItems: true
minItems: 1
maxItems: 3
description: "The list of zones the cluster is in.\n\nOn AWS, zones are\
\ AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n\
\ (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n\
\ (e.g. us-central1-c).\n"
readOnly: false
example:
- us-central1-a
- us-central1-b
- us-central1-c
x-immutable: true
release_priority:
type: string
description: 'Specifies the release priority for cluster updates. Defaults
to REGULAR. Clusters with PRIORITY are updated before clusters with
REGULAR.
'
default: REGULAR
example: REGULAR
enum:
- REGULAR
- PRIORITY
required:
- kind
- cku
title: cmk.v2.Dedicated
- type: object
description: 'The enterprise cluster type.
'
properties:
kind:
description: 'Enterprise cluster type.
'
type: string
enum:
- Enterprise
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units (eCKUs)
that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
required:
- kind
title: cmk.v2.Enterprise
- type: object
description: 'A freight cluster with its parameters.
'
properties:
kind:
type: string
enum:
- Freight
description: 'Freight cluster type.
'
max_ecku:
description: 'The maximum number of Elastic Confluent Kafka Units (eCKUs)
that Kafka clusters should auto-scale to.
Kafka clusters with `HIGH` availability must have at least two eCKUs.
For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
'
type: integer
format: int32
minimum: 1
example: 2
zones:
type: array
items:
type: string
uniqueItems: true
minItems: 1
maxItems: 3
description: "The list of zones the cluster is in.\n\nOn AWS, zones are\
\ AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html)\n\
\ (e.g. use1-az3)\n\nOn GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones)\n\
\ (e.g. us-central1-c).\n"
readOnly: true
example:
- us-central1-a
- us-central1-b
- us-central1-c
x-immutable: true
required:
- kind
title: cmk.v2.Freight
kafka_bootstrap_endpoint:
type: string
description: 'The bootstrap endpoint used by Kafka clients to connect to the
cluster.
DEPRECATED - Please use the `endpoints` attribute instead.
'
example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092
deprecated: true
x-immutable: true
readOnly: true
http_endpoint:
type: string
description: 'The cluster HTTP request URL.
DEPRECATED - Please use the `endpoints` attribute instead.
'
format: uri
example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud
deprecated: true
x-immutable: true
readOnly: true
api_endpoint:
type: string
description: 'The Kafka API cluster endpoint used by Kafka clients to connect
to the cluster.
DEPRECATED - Please use the `endpoints` attribute instead.
'
example: https://pkac-00000.us-west-2.aws.confluent.cloud
deprecated: true
x-immutable: true
readOnly: true
endpoints:
description: 'A map of endpoints for connecting to the Kafka cluster,
keyed by access_point_id. Access Point ID ''PUBLIC'' and ''PRIVATE_LINK''
are reserved.
These can be used for different network access methods or regions.
'
example:
ap1pni123:
kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092
http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443
connection_type: PRIVATENETWORKINTERFACE
ap2platt67890:
kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092
http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud
connection_type: PRIVATELINK
allOf:
- type: object
description: 'Map of endpoints for a Kafka cluster, keyed by access point
ID.
'
additionalProperties:
type: object
description: 'Given a gateway type, endpoints to connect to the Kafka cluster.
'
properties:
kafka_bootstrap_endpoint:
type: string
description: 'The bootstrap endpoint used by Kafka clients to connect
to the cluster.
'
example: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092
http_endpoint:
type: string
description: 'The REST endpoint for the Kafka cluster.
'
format: uri
example: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:443
connection_type:
type: string
description: 'The type of connection used for the endpoint.
'
example: PRIVATE_NETWORK_INTERFACE
enum:
- PUBLIC
- PRIVATE_LINK
- PRIVATE_NETWORK_INTERFACE
required:
- kafka_bootstrap_endpoint
- http_endpoint
- connection_type
readOnly: true
title: cmk.v2.Endpoints
readOnly: true
example:
ap1pni123:
kafka_bootstrap_endpoint: lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092
http_endpoint: https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443
connection_type: PRIVATE_NETWORK_INTERFACE
ap2platt67890:
kafka_bootstrap_endpoint: lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092
http_endpoint: https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud
connection_type: PRIVATE_LINK
title: cmk.v2.EndpointsMap
readOnly: true
environment:
allOf:
- type: object
description: ObjectReference provides information for you to locate the referred
object
required:
- id
- related
- resource_name
properties:
id:
type: string
description: ID of the referred resource
minLength: 1
maxLength: 255
environment:
type: string
description: Environment of the referred resource, if env-scoped
minLength: 1
maxLength: 255
related:
type: string
format: uri
description: API URL for accessing or modifying the referred object
minLength: 1
readOnly: true
resource_name:
type: string
format: uri
description: CRN reference to the referred resource
minLength: 1
readOnly: true
title: EnvScopedObjectReference
description: The environment to which this belongs.
network:
allOf:
- type: object
description: ObjectReference provides information for you to locate the referred
object
required:
- id
- related
- resource_name
properties:
id:
type: string
description: ID of the referred resource
minLength: 1
maxLength: 255
environment:
type: string
description: Environment of the referred resource, if env-scoped
minLength: 1
maxLength: 255
related:
type: string
format: uri
description: API URL for accessing or modifying the referred object
minLength: 1
readOnly: true
resource_name:
type: string
format: uri
description: CRN reference to the referred resource
minLength: 1
readOnly: true
title: EnvScopedObjectReference
description: The network associated with this object.
x-immutable: true
byok:
allOf:
- type: object
description: ObjectReference provides information for you to locate the referred
object
required:
- id
- related
- resource_name
properties:
id:
type: string
description: ID of the referred resource
minLength: 1
maxLength: 255
related:
type: string
format: uri
description: API URL for accessing or modifying the referred object
minLength: 1
readOnly: true
resource_name:
type: string
format: uri
description: CRN reference to the referred resource
minLength: 1
readOnly: true
title: GlobalObjectReference
description: 'Note: For Pre-BYOK v1 clusters, API responses might show both
`encryption_key` and `byok`.
To manage Pre-BYOK v1 keys, refer to:
https://docs.confluent.io/cloud/current/security/encrypt/byok/legacy-byok.html
#manage-pre-byok-api-v1-self-managed-encryption-keys
'
x-immutable: true
x-enable-id: true
x-enable-listmeta: true
x-enable-objectmeta: true
title: cmk.v2.ClusterSpec
status:
type: object
required:
- phase
description: The status of the Cluster
properties:
phase:
type: string
description: "The lifecyle phase of the cluster:\n PROVISIONED: cluster is\
\ provisioned;\n PROVISIONING: cluster provisioning is in progress;\n FAILED:\
\ provisioning failed\n"
readOnly: true
example: PROVISIONED
enum:
- PROVISIONING
- PROVISIONED
- FAILED
cku:
description: 'The number of Confluent Kafka Units (CKUs) the Dedicated cluster
currently has.
'
readOnly: true
type: integer
format: int32
minimum: 1
example: 2
readOnly: true
title: cmk.v2.ClusterStatus
title: cmk.v2.Cluster
- type: object
required:
- api_version
- kind
- id
- spec
- status
properties:
spec:
type: object
required:
- display_name
- availability
- cloud
- region
- config
- environment
- type: object
properties:
spec:
type: object
properties:
environment:
example:
id: env-00000
related: https://api.confluent.cloud/v2/environments/env-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000
network:
example:
id: n-00000
related: https://api.confluent.cloud/networking/v1/networks/n-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000
byok:
example:
id: cck-00000
related: https://api.confluent.cloud/byok/v1/keys/cck-00000
resource_name: https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \
\ \n \n**Important:** This differs from Github and Twitter's same-named header which\
\ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
\ issues."
'400':
description: Bad Request
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
type: object
description: Provides information about problems encountered while performing an operation.
required:
- errors
properties:
errors:
description: List of errors which caused this operation to fail
type: array
items:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a
string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT**
change from occurrence to occurrence of the problem, except for purposes of
localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the
problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request,
the source will point to the query string parameter or request body property
that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request
document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type: string
nullable: true
additionalProperties: false
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '400'
code: invalid_filter
title: Invalid Filter
detail: The 'delorean' resource can't be filtered by 'num_doors'
source:
parameter: num_doors
'401':
x-summary: Unauthorized
description: The request lacks valid authentication credentials for this resource.
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
WWW-Authenticate:
schema:
type: string
description: The unique identifier for the API request.
example: Basic error="invalid_key", error_description="The API Key is invalid"
content:
application/json:
schema:
type: object
description: Provides information about problems encountered while performing an operation.
required:
- errors
properties:
errors:
description: List of errors which caused this operation to fail
type: array
items:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a
string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT**
change from occurrence to occurrence of the problem, except for purposes of
localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the
problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request,
the source will point to the query string parameter or request body property
that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request
document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type: string
nullable: true
additionalProperties: false
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '401'
code: user_unauthenticated
title: Authentication Required
detail: Valid authentication credentials must be provided
'403':
x-summary: Forbidden
description: The access credentials were considered insufficient to grant access
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
type: object
description: Provides information about problems encountered while performing an operation.
required:
- errors
properties:
errors:
description: List of errors which caused this operation to fail
type: array
items:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a
string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT**
change from occurrence to occurrence of the problem, except for purposes of
localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the
problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request,
the source will point to the query string parameter or request body property
that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request
document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type: string
nullable: true
additionalProperties: false
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '403'
code: user_unauthorized
title: User Access Unauthorized
detail: The user 'mcfly' is not allowed to access the 'delorean' resource without the
'plutonium' role.
'404':
description: Not Found
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
type: object
description: Provides information about problems encountered while performing an operation.
required:
- errors
properties:
errors:
description: List of errors which caused this operation to fail
type: array
items:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a
string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT**
change from occurrence to occurrence of the problem, except for purposes of
localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the
problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request,
the source will point to the query string parameter or request body property
that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request
document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type: string
nullable: true
additionalProperties: false
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '404'
title: Not Found
'429':
description: Rate Limit Exceeded
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \
\ \n \n**Important:** This differs from Github and Twitter's same-named header which\
\ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
\ issues."
Retry-After:
schema:
type: integer
description: The number of seconds to wait until the rate limit window resets. Only sent
when the rate limit is reached.
'500':
description: Oops, something went wrong!
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/json:
schema:
type: object
description: Provides information about problems encountered while performing an operation.
required:
- errors
properties:
errors:
description: List of errors which caused this operation to fail
type: array
items:
type: object
description: Describes a particular error encountered while performing an operation.
properties:
id:
description: A unique identifier for this particular occurrence of the problem.
type: string
maxLength: 255
status:
description: The HTTP status code applicable to this problem, expressed as a
string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
description: A short, human-readable summary of the problem. It **SHOULD NOT**
change from occurrence to occurrence of the problem, except for purposes of
localization.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the
problem.
type: string
source:
type: object
description: If this error was caused by a particular part of the API request,
the source will point to the query string parameter or request body property
that caused it.
properties:
pointer:
description: A JSON Pointer [RFC6901] to the associated entity in the request
document [e.g. "/spec" for a spec object, or "/spec/title" for a specific
field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
type: string
error_code:
type: integer
format: int32
message:
type: string
nullable: true
additionalProperties: false
title: Error
uniqueItems: true
title: Failure
example:
errors:
- id: ed42afdc-f0d5-4c0d-b428-9fc6ed6e279d
status: '500'
code: out_of_gas
title: DeLorean Out Of Gas
detail: The DeLorean has run out of gas, but Doc Brown will fill 'er up for you asap
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API