Get Confluent | Sign up for Confluent Cloud or download Confluent Platform

Confluent Cloud APIs

Note

This documents the collection of Confluent Cloud APIs. Each API documents its lifecycle phase. APIs marked as Early Access or Preview are not ready for production usage. We're currently working with a select group of customers to get feedback and iterate on these APIs.

Introduction

Confluent Cloud APIs are a core building block of Confluent Cloud. You can use the APIs to manage your own account or to integrate Confluent into your product.

Most of the APIs are organized around REST and the resources which make up Confluent Cloud. The APIs have predictable resource-oriented URLs, transport data using JSON, and use standard HTTP verbs, response codes, authentication, and design principles.

Object Model

Note

This section describes the object model for many Confluent Cloud APIs, but not all. The Connect v1 API group has a different object model. Please review the example request and response bodies in the Connect v1 API documentation below to see its object model.

Confluent Cloud APIs are primarily designed to be declarative and intent-oriented. In other words, tell the API what you want (e.g., throughput or SLOs) and it will figure out how to make it happen (e.g., cluster sizing). A Confluent object acts as a "record of intent" — after you create the object, Confluent Cloud will work tirelessly in the background to ensure that the object exists as specified.

Confluent APIs represent objects in JSON with media-type application/json.

Many objects follow a model consisting of spec and status. An object's spec tells Confluent the desired state (specification) of the resource. The object may not be immediately available or changes may not be immediately applied. For this reason, many objects also have a status property that provides info about the current state of the resource. Confluent Cloud is continuously and actively managing each resource's current state to match it's desired state.

All Confluent objects share a set of common properties:

  • api_version – API objects have an api_version field indicating their API version.
  • kind – API objects have a kind field indicating the kind of object it is.
  • id – Each object in the API will have an identifier, indicated via its id field, and should be treated as an opaque string unless otherwise specified.

There are a number of other standard properties and that you'll encounter used by many API objects. And of course, objects have plenty of non-standard fields that are specific to each object kind... this is what makes them interesting!

Authentication

Confluent uses API keys for integrating with Confluent Cloud. Integrations must be authorized and authenticated before they can access or manage resources in Confluent Cloud. You can manage your API keys in the Confluent Cloud Dashboard or Confluent Cloud CLI. See the docs for details on creating and managing API keys.

Today, you can divide API keys into two classes:

  • Cloud API Keys – These grant access to the Confluent Cloud Control Plane APIs, such as for Provisioning and Metrics integrations.
  • Cluster API Keys – These grant access to a single Confluent cluster, such as a specific Kafka or Schema Registry cluster.

An API key is owned by a User or Service Account and inherits the permissions granted to the owner.

  • For example, if service account Armageddon is granted ACLs on Kafka Cluster neptune, then a Cluster API Key for neptune owned by Armageddon will have these ACLs.
  • Note 1: ACLs aren't currently enforced for users, only service accounts.
  • Note 2: API Keys are automatically deleted when the owning user or service account is deleted (e.g., an employee leaves the company, or moves to a new department and an SSO integration removes their user in Confluent Cloud as they no longer require access)
  • Confluent strongly recommend that you use service accounts for all production-critical access.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

To use your API key, send it as an Authorization: Basic {key} header. Remember that HTTP Basic authorization requires you to colon-separate and base64 encode your key. For example, if your API Key ID is ABCDEFGH123456789 and the corresponding API Key Secret is XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO, then the authorization header will be

Authorization: Basic QUJDREVGR0gxMjM0NTY3ODk6WE5DSVc5M0kyTDFTUVBKU0o4MjNLMUxTOTAyS0xERk1DWlBXRU8=

This example header can be generated from the API key (on Mac OS X) with

$ echo -n "ABCDEFGH123456789:XNCIW93I2L1SQPJSJ823K1LS902KLDFMCZPWEO" | base64

api-key

Authenticate with API Keys using HTTP Basic Auth. Treat the API Key ID as the username and API Key Secret as the password.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

oauth

Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /oauth2/token
Scopes:
  • partner:alter -

    enables partners to alter entitlements

  • partner:create -

    enables partners to create entitlements and signup on behalf of customers

  • partner:delete -

    enables partners to delete entitlements and organizations

  • partner:describe -

    enables partners to read and list entitlements and organizations

Errors

Note

This section describes the structure of error responses for many Confluent Cloud APIs, but not all. The Connect v1 API group has a different set of structures for error responses. Please review the example request and response bodies in the Connect v1 API documentation below to see its error behaviour.

Confluent uses conventional HTTP status codes to indicate the success or failure of an API request.

Failures follow a standard model to tell you about what went wrong. They may include one or more error objects with the following fields:

Field Type Description
id* UUID A unique identifier for this particular occurrence of the problem.
status String The HTTP status code applicable to this problem.
code String An application-specific error code.
title String A short, human-readable summary of the problem that should not change from occurrence to occurrence of the problem, except for purposes of localization.
detail* String A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source Object An object that references the source of the error, and optionally includes any of the following members:
  pointer String A JSON Pointer to the associated entity in the request document (e.g. "/spec/title" for a specific attribute).
  parameter String A string indicating which URI query parameter caused the error.
meta Object A meta object that contains non-standard meta-information about the error.
resolution String Instructions for the end-user for correcting the error.

* indicates a required field

All errors include an id and some detail message. The id is a unique identifier — use it when you're working with Confluent support to debug a problem with a specific API call. The detail describes what went wrong.

Some errors that could be handled programmatically (e.g., a Kafka cluster config is invalid) may include an error code that briefly explains the error reported.

Validation issues and similar errors include a source which tells you exactly what in the request was responsible for the error.

For example, a failure may look like

{
  "errors": [{
    "status": "422",
    "code": "invalid_configuration",
    "id": "30ce6058-87da-11e4-b116-123b93f75cba",
    "title": "The Kafka cluster configuration is invalid",
    "detail": "The property '/cluster/storage_size' of type string did not match the following type: integer",
    "source": {
      "pointer": "/cluster/storage_size"
    }
  }]
}

If a request fails validation, it will return an HTTP 422 Unprocessable Entity with a list of fields that failed validation.

Pagination

Note

This section describes the pagination behavior of “list” operations for many Confluent Cloud APIs, but not all. The Connect v1 API list operations do not support pagination.

All API resources have support for bulk reads via "list" API operations. For example, you can "list Kafka clusters", "list api keys", and "list environments". These "list" operations require pagination; by requesting smaller subsets of data, API clients receive a response much faster than requesting the entire, potentially large, data set.

All "list" operations follow the same pattern with the following parameters:

  • page_size – client-provided max number of items per page, only valid on the first request.
  • page_token – server-generated token used for traversing through the result set.

A paginated response may include any of the following pagination links. API clients may follow the respective link to page forward or backward through the result set as desired.

Link Relation Description
next A link to the next page of results. A response that does not contain a next link does not have further data to fetch.
prev A link to the previous page of results. A response that does not contain a prev link has no previous data. This link is optional for collections that cannot be traversed backward.
first A link to the first page of results. This link is optional for collections that cannot be indexed directly to a given page.
last A link to the last page of results. This link is optional for collections that cannot be indexed directly to a given page.

API clients must treat pagination links and the page_token parameter in particular as an opaque string.

An example paginated list response may look like

{
    "api_version": "v2",
    "kind": "KafkaClusterList",
    "metadata": {
        "next": "https://api.confluent.cloud/kafka-clusters?page_token=ABCDEFGHIJKLMNOP1234567890"
    }
    "data": [
        {
            "metadata": {
                "id": "lkc-abc123",
                "self": "https://api.confluent.cloud/kafka-clusters/lkc-abc123",
                "resource_name": "crn://confluent.cloud/kafka=lkc-abc123",
            }
            "spec": {
                "display_name": "My Kafka Cluster",
                <snip>
            },
            "status": {
                "phase": "RUNNING",
                <snip>
            }
        },
        <snip>
    ]
}

Rate Limiting

To protect the stability of the API and keep it available to all users, Confluent employs multiple safeguards. If you send too many requests in quick succession or perform too many concurrent operations, you may be throttled or have your request rejected with an error.

When a rate limit is breached, an HTTP 429 Too Many Requests error is returned.

Integrations should gracefully handle these limits by watching for 429 error responses and building in a retry mechanism. This mechanism should follow a capped exponential backoff policy to prevent retry amplification ("retry storms") and also introduce some randomness ("jitter") to avoid the thundering herd effect.

If you’re running into this error and think you need a higher rate limit, contact Confluent at support@confluent.io.

Identifiers and URLs

Most resources have multiple identifiers:

  • id is the "natural identifier" for an object. It is only unique within its parent resource. The id is unique across time: the ID will not be reclaimed and reused after an object is deleted.
  • resource_name is a Uniform Resource Identifier (URI) that is globally unique across all resources. This encompasses all parent resource kinds and ids necessary to uniquely identify a particular instance of this object kind. Because it uses object ids, the CRN will not be reclaimed and reused after an object is deleted. It is represented as a Confluent Resource Name (see below).
  • 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.

To see how these relate to each other, consider KafkaBroker with broker.id=2 in a KafkaCluster in Confluent Cloud identified as lkc-xsi8201. In such an example, the KafkaBroker has id=2, the resource_name is crn://confluent.cloud/kafka=lkc-xsi8201/broker=2 and the self URL may be something like https://pkc-8wlk2n.us-west-2.aws.confluent.cloud. Note that different identifiers carry different information for different purposes, but the resource_name is the most complete and canonical identifier.

Confluent Resource Names (CRNs)

Confluent Resource Names (CRNs) are used to uniquely identify all Confluent resources.

A CRN is a valid URI having an "authority" of confluent.cloud or a self-managed metadata service URL, followed by the minimal hierarchical set of key-value pairs necessary to uniquely identify a resource.

Here are some examples for basic resources in Confluent Cloud:

Resource Example CRN
Environment crn://confluent.cloud/environment=e-xyz1234
User crn://confluent.cloud/user=u-rst9876
API Key crn://confluent.cloud/api-key=ABCDEFG9876543210
Service Account crn://confluent.cloud/service-account=sa-lmn2468
Service Account Key crn://confluent.cloud/service-account-key=HIJKLMN0123456789
Kafka Cluster crn://confluent.cloud/kafka=lkc-abc123

Data Types

Primitive Types

Data Type Representation
Integers Each API may specify the type as int32 or int64. Note that many languages, including JavaScript, are limited to a max size of approx 2**53 and don't correctly handle large int64 values with their default JSON parser.
Dates RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given.
Times RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given.
Durations RFC 3339 formatted string.
Periods RFC 3339 formatted string. UTC timezones are assumed, unless otherwise given.
Ranges All ranges are represented using half-open intervals with naming conventions like [start_XXX, end_XXX) such as [start_time, end_time).
Enums Most APIs use x-extensible-enum as an open-ended list of values. This improves compatibility compared with a standard enum which by definition represents a closed set. All enums have a 0-valued entry which either serves as the default for common cases, or represents UNSPECIFIED when no default exists and results in an error.

Standard Properties

Confluent uses this set of standard properties to ensure common concepts use the same name and semantics across different APIs.

Name Description
api_version Many API objects have an api_version field indicating their API version. See the Object Model.
kind Many API objects have a kind field indicating the kind of object it is. See the Object Model.
id Many objects in the API will have an identifier, indicated via its id field, and should be treated as an opaque string unless otherwise specified. See the Object Model.
name Objects which support a client-provided unique identifier instead of a generated id will indicate this identifier via its name field.
display_name The human-readable display name of an API object.
title The official name of an API object, such as a company name. It should be treated as the formal version of display_name.
description One or more paragraphs of text description of an entity.
created_at The date and time the object was created, represented as a string in RFC 3339 format.
updated_at The date and time the object was last modified, represented as a string in RFC 3339 format.
deleted_at If present, the date and time after which the object was/will be deleted, represented as a string in RFC 3339 format.
page_token The pagination token in the List request. See Pagination.
page_size The pagination size in the List request. See Pagination.
total_size The total count of items in the list irrespective of pagination. See Pagination.
spec The desired state specification of the resource, as observed by Confluent Cloud.
status The current state of the resource, as observed by Confluent Cloud.

Versioning

Confluent APIs ensure stability for your integrations by avoiding the introduction of breaking changes to customers unexpectedly. Confluent will make non-breaking API changes without advance notice. Thus, API clients must follow the Compatibility Policy below to ensure your ingtegration remains stable. All APIs follow the API Lifecycle Policy described below, which describes the guarantees API clients can rely on.

Breaking changes will be widely communicated in advance in accordance with the Confluent Deprecation Policy. Confluent will provide timelines and a migration path for all API changes, where available. Be sure to subscribe to one or more communication channels so you don't miss any updates!

One exception to these guidelines is for critical security issues. Confluent will take any necessary actions to mitigate any critical security issue as soon as possible, which may include disabling the vulnerable functionality until a proper solution is available.

Do not consume any Confluent API unless it is documented in the API Reference. All undocumented endpoints should be considered private, subject to change without notice, and not covered by any agreements.

Note: The version in the URL (e.g. "v1" or "v2") is not a "major version" in the Semantic Versioning sense. It is a "generational version" or "meta version", as seen in APIs like Github API or the Stripe API.

Known Issues

During the Early Access and Preview periods, we have a few known issues.

Issue Description Proposed Resolution
Quota Exceeded Some "Quota Exceeded" errors will be returned as HTTP 400 instead of HTTP 402 Return 402 consistently for "Quota Exceeded" errors

API Lifecycle Policy

The following status labels are applicable to APIs, features, and SDK versions, based on the current support status of each:

  • Early Access – May change at any time. Not recommended for production usage. Not officially supported by Confluent. Intended for user feedback only. Users must be granted explicit access to the API by Confluent.
  • Preview – Unlikely to change between Preview and General Availability. Not recommended for production usage. Officially supported by Confluent for non-production usage. For Closed Previews, users must be granted explicit access to the API by Confluent.
  • Generally Available (GA) – Will not change at short notice. Recommended for production usage. Officially supported by Confluent for non-production and production usage.
  • Deprecated – No longer supported. Will be removed in the future at the announced date. Use is discouraged and migration following the upgrade guide is recommended.
  • Sunset – Removed, and no longer supported or available.

Resources, operations, and individual fields in the OpenAPI spec will be annotated with x-lifecycle-stage, x-deprecated-at, and x-sunset-at. These annotations will appear in the corresponding API Reference Documentation. An API is "Generally Available" unless explicitly marked otherwise.

Compatibility Policy

Confluent Cloud APIs are governed by Confluent Cloud Upgrade Policy, which means that backward incompatible changes and deprecations will be made approximately once per year, and 180 days notice will be provided via email to all registered Confluent Cloud users.

Backward Compatibility

An API version is backward compatible if a program written against the previous version of the API will continue to work the same way, without modification, against this version of the API.

Confluent considers the following changes to be backward compatible:

  • Adding new API resources.
  • Adding new optional parameters to existing API requests (e.g., query string).
  • Adding new properties to existing API resources (e.g., request body).
  • Changing the order of properties in existing API responses.
  • Changing the length or format of object IDs or other opaque strings.
    • Unless otherwise documented, you can safely assume object IDs generated by Confluent will never exceed 255 characters, but you should be able to handle IDs of up to that length. If you're using MySQL, for example, you should store IDs in a VARCHAR(255) COLLATE utf8_bin column.
    • This includes adding or removing fixed prefixes (such as lkc- on Kafka cluster IDs).
    • This includes API keys, API tokens, and similar authentication mechanisms.
    • This includes all strings described as "opaque" in the docs, such as pagination cursors.
  • Adding new API event types.
  • Adding new properties to existing API event types.
  • Omitting properties with null values from existing API responses.

Forward Compatibility

An API version is forward compatible if a program written against the next version of the API will continue to work the same way, without modification, against this version of the API.

In other words, a forward compatible API will accept input intended for a later version of itself.

Confluent does not guarantee the forward compatibility of the APIs, but Confluent does generally follow the guidelines given by the Robustness principle. This means that the API determines what to do with a request based only on the parts that it recognizes.

This is often referred to as the MUST IGNORE rule.

  • Request parameters that are not recognized will be ignored (e.g., query string).
  • Request properties that are not recognized will be ignored (e.g., request body).
  • Request metadata that are not recognized will be ignored (e.g., request headers).

API clients must also follow the MUST IGNORE rule.

  • Response properties that are not recognized must be ignored (e.g., response body).
  • Response metadata that are not recognized must be ignored (e.g., response headers).

Additionally, there is a more subtle related rule called the MUST FORWARD rule. Any parts of a request that an API doesn't recognize must be forwarded unchanged.

  • Response properties that are not recognized must be included in any input subsequent updates (e.g., request body)
    • This includes future PUT requests in a read/modify/write operation. (This isn't required for PATCH partial updates, which is why Confluent APIs use PATCH.)
  • Event processors must not strip unknown properties before forwarding messages.

Client Responsibilities

  • Resource and rate limits, and the default and maximum sizes of paginated data are not considered part of the API contract and may change (possibly dynamically). It is the client's responsibility to read the road signs and obey the speed limit.
  • If a property has a primitive type and the API documentation does not explicitly limit its possible values, clients must not assume the values are constrained to a particular set of possible responses.
  • If a property of an object is not explicitly declared as mandatory in the API, clients must not assume it will be present.
  • A resource may be modified to return a "redirection" response (e.g. 301, 307) instead of directly returning the resource. Clients must handle HTTP-level redirects, and respect HTTP headers (e.g. Location).

Deprecation Policy

Confluent will announce deprecations at least 180 days in advance of a breaking change and will continue to maintain the deprecated APIs in their original form during this time.

Exceptions to this policy apply in case of critical security vulnerabilities or functional defects.

Communication

When a deprecation is announced, the details and any relevant migration information will be available on one or more of the following channels:

HTTP Guidelines

Status Codes

Confluent respects the meanings and behavior of HTTP status codes as defined in RFC2616 and elsewhere.

  • Codes in the 2xx range indicate success
  • Codes in the 3xx range indicate redirection
  • Codes in the 4xx range indicate an error caused by the client request (e.g., a required parameter was omitted, an invalid cluster configuration was provided, etc.)
  • Codes in the 5xx range indicate an error with Confluent's servers (these are rare)

The various HTTP status codes that might be returned are listed below.

Code Title Description
200 OK Everything worked as expected.
201 Created The resource was created. Follow the Location header.
204 No Content Everything worked and there is no content to return.
400 Bad Request The request was unacceptable, often due to malformed syntax, or a missing or malformed parameter.
401 Unauthorized No valid credentials provided. or the credentials are unsuitable, invalid, or unauthorized.
402 Over Quota The request was valid, but you've exceeded your plan quota or limits.
404 Not Found The requested resource doesn't exist or you're unauthorized to know it exists.
409 Conflict The request conflicts with another request (perhaps it already exists or was based on a stale version of data).
422 Validation Failed The request was parsed correctly but failed some sort of validation.
429 Too Many Requests Too many requests hit the API too quickly. Confluent recommends an exponential backoff of your requests.
500, 502, 503, 504 Server Errors Something went wrong on Confluent's end. (These are rare.)

This list is not exhaustive; other standard HTTP error codes may be used, including 304, 307, 308, 405, 406, 408, 410, and 415.

For more details, see https://httpstatuses.com.

Environments (v2)

Early Access Request Access To Cloud v2

Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

The API allows you to create, delete, and update your environments. You can retrieve individual environments as well as a list of all your environments.

Related guide: Environments in Confluent Cloud.

Quotas and Limits

This resource is subject to the following quotas:

Quota Description
environments_per_org Environments in one Confluent Cloud organization

List of Environments

Early Access Request Access To Cloud v2

Retrieve a sorted, filtered, paginated list of all environments.

lifecycle-stage: Early Access
Authorizations:
query Parameters
page_size
integer <= 100
Default: 10

A pagination size for collection requests.

page_token
string

An opaque pagination token for collection requests.

Responses

Request samples

curl --request GET \
  --url 'https://api.confluent.cloud/v2/environments?page_size=SOME_INTEGER_VALUE&page_token=SOME_STRING_VALUE' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'

Response samples

Content type
application/json
{}

Create an Environment

Early Access Request Access To Cloud v2

Make a request to create an environment.

lifecycle-stage: Early Access
Authorizations:
Request Body schema: application/json
display_name
string

A human-readable name for the Environment

Responses

Request samples

Content type
application/json
{
  • "display_name": "prod-finance01"
}

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "Environment",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "prod-finance01"
}

Read an Environment

Early Access Request Access To Cloud v2

Make a request to read an environment.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the environment.

Responses

Request samples

curl --request GET \
  --url 'https://api.confluent.cloud/v2/environments/{id}' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "Environment",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "prod-finance01"
}

Update an Environment

Early Access Request Access To Cloud v2

Make a request to update an environment.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the environment.

Request Body schema: application/json
display_name
string

A human-readable name for the Environment

Responses

Request samples

Content type
application/json
{
  • "display_name": "prod-finance01"
}

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "Environment",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "prod-finance01"
}

Delete an Environment

Early Access Request Access To Cloud v2

Make a request to delete an environment.

If successful, this request will also recursively delete all of the environment's associated resources, including all Kafka clusters, connectors, etc.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the environment.

Responses

Request samples

curl --request DELETE \
  --url 'https://api.confluent.cloud/v2/environments/{id}' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Users (v2)

Early Access Request Access To Cloud v2

User objects represent individuals who may access your Confluent resources.

The API allows you to update, and delete your users. You can retrieve individual users as well as a list of all your users.

Related guide: Users in Confluent Cloud.

Quotas and Limits

This resource is subject to the following quotas:

Quota Description
users_per_org Users in one Confluent Cloud organization

List of Users

Early Access Request Access To Cloud v2

Retrieve a sorted, filtered, paginated list of all users.

lifecycle-stage: Early Access
Authorizations:
query Parameters
page_size
integer <= 100
Default: 10

A pagination size for collection requests.

page_token
string

An opaque pagination token for collection requests.

Responses

Response samples

Content type
application/json
{}

Read a User

Early Access Request Access To Cloud v2

Make a request to read a user.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the user.

Responses

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "User",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "email": "marty.mcfly@example.com",
  • "given_name": "Marty",
  • "family_name": "McFly"
}

Update a User

Early Access Request Access To Cloud v2

Make a request to update a user.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the user.

Request Body schema: application/json
email
string <email>

The user's email address

given_name
string

The user's given name

family_name
string

The user's family name

Responses

Request samples

Content type
application/json
{
  • "email": "marty.mcfly@example.com",
  • "given_name": "Marty",
  • "family_name": "McFly"
}

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "User",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "email": "marty.mcfly@example.com",
  • "given_name": "Marty",
  • "family_name": "McFly"
}

Delete a User

Early Access Request Access To Cloud v2

Make a request to delete a user.

If successful, this request will also recursively delete all of the user's associated resources, including its cloud and cluster API keys.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the user.

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Service Accounts (v2)

Early Access Request Access To Cloud v2

ServiceAccount something

Related guide: Service Accounts in Confluent Cloud.

Quotas and Limits

This resource is subject to the following quotas:

Quota Description
service_accounts_per_org Service Accounts in one Confluent Cloud organization

List of Service Accounts

Early Access Request Access To Cloud v2

Retrieve a sorted, filtered, paginated list of all service accounts.

lifecycle-stage: Early Access
Authorizations:
query Parameters
page_size
integer <= 100
Default: 10

A pagination size for collection requests.

page_token
string

An opaque pagination token for collection requests.

Responses

Response samples

Content type
application/json
{}

Create a Service Account

Early Access Request Access To Cloud v2

Make a request to create a service account.

lifecycle-stage: Early Access
Authorizations:
Request Body schema: application/json
display_name
required
string

A human-readable name for the Service Account

description
string

A free-form description of the Service Account

Responses

Request samples

Content type
application/json
{
  • "display_name": "DeLorean_auto_repair",
  • "description": "Doc's repair bot for the DeLorean"
}

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "ServiceAccount",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "DeLorean_auto_repair",
  • "description": "Doc's repair bot for the DeLorean"
}

Read a Service Account

Early Access Request Access To Cloud v2

Make a request to read a service account.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the service account.

Responses

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "ServiceAccount",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "DeLorean_auto_repair",
  • "description": "Doc's repair bot for the DeLorean"
}

Update a Service Account

Early Access Request Access To Cloud v2

Make a request to update a service account.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the service account.

Request Body schema: application/json
display_name
string

A human-readable name for the Service Account

description
string

A free-form description of the Service Account

Responses

Request samples

Content type
application/json
{
  • "display_name": "DeLorean_auto_repair",
  • "description": "Doc's repair bot for the DeLorean"
}

Response samples

Content type
application/json
{
  • "api_version": "v2",
  • "kind": "ServiceAccount",
  • "id": "dlz-f3a90de",
  • "metadata":
    {},
  • "display_name": "DeLorean_auto_repair",
  • "description": "Doc's repair bot for the DeLorean"
}

Delete a Service Account

Early Access Request Access To Cloud v2

Make a request to delete a service account.

If successful, this request will also recursively delete all of the service account's associated resources, including its cloud and cluster API keys.

lifecycle-stage: Early Access
Authorizations:
path Parameters
id
required
string

The unique identifier for the service account.

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Clusters (cmk/v2)

Generally Available

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.

Quotas and Limits

This resource is subject to the following quotas:

Quota Description
kafka_clusters_per_environment Number of clusters in one Confluent Cloud environment

List of Clusters

Generally Available

Retrieve a sorted, filtered, paginated list of all clusters.

lifecycle-stage: Generally Available
Authorizations:
query Parameters
environment
required
string (SearchFilter)
Example: environment=env-00000

Filter the results by exact match for environment.

page_size
integer <= 100
Default: 10

A pagination size for collection requests.

page_token
string

An opaque pagination token for collection requests.

Responses

Response samples

Content type
application/json
{}

Create a Cluster

Generally Available

Make a request to create a cluster.

lifecycle-stage: Generally Available
Authorizations:
Request Body schema: application/json
required
object

The desired state of the Cluster

Responses

Request samples

Content type
application/json
{
  • "spec":
    {
    }
}

Response samples

Content type
application/json
{
  • "api_version": "cmk/v2",
  • "kind": "Cluster",
  • "id": "dlz-f3a90de",
  • "metadata":
    {
    },
  • "spec":
    {},
  • "status":
    {
    }
}

Read a Cluster

Generally Available

Make a request to read a cluster.

lifecycle-stage: Generally Available
Authorizations:
path Parameters
id
required
string

The unique identifier for the cluster.

query Parameters
environment
required
string (SearchFilter)
Example: environment=env-00000

Scope the operation to the given environment.

Responses

Response samples

Content type
application/json
{
  • "api_version": "cmk/v2",
  • "kind": "Cluster",
  • "id": "dlz-f3a90de",
  • "metadata":
    {
    },
  • "spec":
    {},
  • "status":
    {
    }
}

Update a Cluster

Generally Available

Make a request to update a cluster.

lifecycle-stage: Generally Available
Authorizations:
path Parameters
id
required
string

The unique identifier for the cluster.

Request Body schema: application/json
required
object

The desired state of the Cluster

Responses

Request samples

Content type
application/json
{
  • "spec":
    {
    }
}

Response samples

Content type
application/json
{
  • "api_version": "cmk/v2",
  • "kind": "Cluster",
  • "id": "dlz-f3a90de",
  • "metadata":
    {
    },
  • "spec":
    {},
  • "status":
    {
    }
}

Delete a Cluster

Generally Available

Make a request to delete a cluster.

lifecycle-stage: Generally Available
Authorizations:
path Parameters
id
required
string

The unique identifier for the cluster.

query Parameters
environment
required
string (SearchFilter)
Example: environment=env-00000

Scope the operation to the given environment.

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Connectors (v1)

General Availability

API for managing connectors.

The API allows you to list, create, get, update and delete your connectors.

Connect metrics are available through Metrics v2 API.

Related guide: Connectors in Confluent Cloud.

List of Connectors

General Availability

Retrieve a list of "names" of the active connectors. You can then make a read request for a specific connector by name.

lifecycle-stage: General Availability
Authorizations:
path Parameters
environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
[
  • "MyGcsLogsBucketConnector"
]

Create a Connector

General Availability

Create a new connector. Returns the new connector information if successful.

lifecycle-stage: General Availability
Authorizations:
path Parameters
environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Request Body schema: application/json
name
string

Name of the connector to create.

object

Configuration parameters for the connector. All values should be strings.

Responses

Request samples

Content type
application/json
{
  • "name": "MyGcsLogsBucketConnector",
  • "config":
    {
    }
}

Response samples

Content type
application/json
{
  • "name": "MyGcsLogsBucketConnector",
  • "config":
    {
    },
  • "tasks":
    [
    ],
  • "type": "sink"
}

Read a Connector Configuration

General Availability

Get the configuration for the connector.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "cloud.environment": "prod",
  • "cloud.provider": "aws",
  • "connector.class": "GcsSink",
  • "data.format": "BYTES",
  • "flush.size": "1000",
  • "gcs.bucket.name": "APILogsBucket",
  • "gcs.credentials.config": "****************",
  • "kafka.api.key": "****************",
  • "kafka.api.secret": "****************",
  • "kafka.endpoint": "SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092",
  • "kafka.region": "us-west-2",
  • "name": "MyGcsLogsBucketConnector",
  • "tasks.max": "2",
  • "time.interval": "DAILY",
  • "topics": "APILogsTopic"
}

Create or Update a Connector Configuration

Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Request Body schema: application/json

Configuration parameters for the connector. All values should be strings.

connector.class
required
string

The connector class name. E.g. BigQuerySink, GcsSink, etc.

name
required
string

Name or alias of the class (plugin) for this connector.

kafka.api.key
required
string

The kafka cluster api key.

kafka.api.secret
required
string

The kafka cluster api secret key.

property name*
string

Other configuration parameters for the connector. All values should be strings. See the connector's docs for details.

Responses

Request samples

Content type
application/json
{
  • "connector.class": "GcsSink",
  • "data.format": "BYTES",
  • "flush.size": "1000",
  • "gcs.bucket.name": "APILogsBucket",
  • "gcs.credentials.config": "****************",
  • "kafka.api.key": "****************",
  • "kafka.api.secret": "****************",
  • "name": "MyGcsLogsBucketConnector",
  • "tasks.max": "2",
  • "time.interval": "DAILY",
  • "topics": "APILogsTopic"
}

Response samples

Content type
application/json
{
  • "name": "MyGcsLogsBucketConnector",
  • "config":
    {
    },
  • "tasks":
    [
    ],
  • "type": "sink"
}

Read a Connector

General Availability

Get information about the connector.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "name": "MyGcsLogsBucketConnector",
  • "config":
    {
    },
  • "tasks":
    [
    ],
  • "type": "sink"
}

Delete a Connector

General Availability

Delete a connector. Halts all tasks and deletes the connector configuration.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "error": null
}

Lifecycle (v1)

General Availability

API for managing lifecycle of connectors. Operations currently supported are Pause and Resume.

Pause a Connector

General Availability

Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "error":
    {
    }
}

Resume a Connector

General Availability

Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "error":
    {
    }
}

Status (v1)

General Availability

API for requesting the status of a connector or the tasks of a connector.

Read a Connector Status

Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
{
  • "name": "MyGcsLogsBucketConnector",
  • "connector":
    {
    },
  • "tasks": [ ],
  • "type": "source"
}

List of Connector Tasks

General Availability

Get a list of tasks currently running for the connector.

lifecycle-stage: General Availability
Authorizations:
path Parameters
connector_name
required
string

The unique name of the connector.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Plugins (v1)

General Availability

API for managing connector plugins.

List of Connector Plugins

General Availability

Return a list of connector plugins installed in the Kafka Connect cluster.

lifecycle-stage: General Availability
Authorizations:
path Parameters
environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Validate a Connector Plugin

General Availability

Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages.

lifecycle-stage: General Availability
Authorizations:
path Parameters
plugin_name
required
string

The unique name of the connector plugin.

environment_id
required
string

The unique identifier of the environment this resource belongs to.

kafka_cluster_id
required
string

The unique identifier for the Kafka cluster.

Request Body schema: application/json

Configuration parameters for the connector. All values should be strings.

property name*
string

Other configuration parameters for the connector. All values should be strings. See the connector's docs for the list of options.

Responses

Request samples

Content type
application/json
{
  • "cloud.environment": "prod",
  • "cloud.provider": "aws",
  • "connector.class": "GcsSink",
  • "data.format": "BYTES",
  • "flush.size": "500",
  • "gcs.bucket.name": "APILogsBucket",
  • "gcs.credentials.config": "****************",
  • "kafka.api.key": "****************",
  • "kafka.api.secret": "****************",
  • "kafka.endpoint": "SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092",
  • "kafka.region": "us-west-2",
  • "name": "MyGcsLogsBucketConnector",
  • "tasks.max": "2",
  • "time.interval": "DAILY",
  • "topics": "APILogsTopic"
}

Response samples

Content type
application/json
{
  • "name": "io.confluent.connect.gcs.GcsSinkConnector",
  • "groups":
    [
    ],
  • "error_count": 1,
  • "configs":
    [
    ]
}

Cluster (v3)

Generally Available

Get Cluster

Generally Available

Returns the Kafka cluster with the specified cluster_id.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Responses

Response samples

Configs (v3)

Generally Available

List Cluster Configs

Generally Available

Returns a list of configuration parameters for the specified Kafka cluster.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Responses

Response samples

Content type
application/json
{}

Batch Alter Cluster Configs

Generally Available

Updates or deletes a set of Kafka cluster configuration parameters.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Request Body schema: application/json

The alter cluster configuration parameter batch request.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Get Cluster Config

Generally Available

Returns the configuration parameter specified by name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

name
required
string
Example: compression.type

The configuration parameter name.

Responses

Response samples

Content type
application/json
{
  • "kind": "KafkaClusterConfig",
  • "metadata":
    {},
  • "cluster_id": "cluster-1",
  • "config_type": "BROKER",
  • "name": "compression.type",
  • "value": "gzip",
  • "is_default": false,
  • "is_read_only": false,
  • "is_sensitive": false,
  • "source": "DYNAMIC_DEFAULT_BROKER_CONFIG",
  • "synonyms":
    [
    ]
}

Update Cluster Config

Generally Available

Updates the configuration parameter specified by name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

name
required
string
Example: compression.type

The configuration parameter name.

Request Body schema: application/json

The cluster configuration parameter update request.

value
string Nullable

Responses

Request samples

Content type
application/json
{
  • "value": "gzip"
}

Reset Cluster Config

Generally Available

Resets the configuration parameter specified by name to its default value.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

name
required
string
Example: compression.type

The configuration parameter name.

Responses

List Topic Configs

Generally Available

Return the list of configs that belong to the specified topic.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

Responses

Response samples

Content type
application/json
{}

Batch Alter Topic Configs

Generally Available

Updates or deletes a set of topic configs.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

Request Body schema: application/json

The alter topic configuration parameter batch request.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Get Topic Config

Generally Available

Return the config with the given name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

name
required
string
Example: compression.type

The configuration parameter name.

Responses

Response samples

Content type
application/json
{
  • "kind": "KafkaTopicConfig",
  • "metadata":
    {},
  • "cluster_id": "cluster-1",
  • "topic_name": "topic-1",
  • "name": "compression.type",
  • "value": "gzip",
  • "is_default": false,
  • "is_read_only": false,
  • "is_sensitive": false,
  • "source": "DYNAMIC_TOPIC_CONFIG",
  • "synonyms":
    [
    ]
}

Update Topic Config

Generally Available

Updates the config with given name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

name
required
string
Example: compression.type

The configuration parameter name.

Request Body schema: application/json

The topic configuration parameter update request.

value
string Nullable

Responses

Request samples

Content type
application/json
{
  • "value": "gzip"
}

Reset Topic Config

Generally Available

Resets the config with given name to its default value.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

name
required
string
Example: compression.type

The configuration parameter name.

Responses

Get All Topic Configs

Generally Available

Returns all topic configurations for topics hosted by the specified cluster.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Responses

Response samples

Content type
application/json
{}

ACL (v3)

Generally Available

Search ACLs

Generally Available

Returns a list of ACLs that match the search criteria.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

query Parameters
resource_type
string (AclResourceType)
Enum: "UNKNOWN" "ANY" "TOPIC" "GROUP" "CLUSTER" "TRANSACTIONAL_ID" "DELEGATION_TOKEN"

The ACL resource type.

resource_name
string

The ACL resource name.

pattern_type
string (AclPatternType)
extensible-enum: ["UNKNOWN","ANY","MATCH","LITERAL","PREFIXED"]

The ACL pattern type.

principal
string

The ACL principal.

host
string

The ACL host.

operation
string (AclOperation)
extensible-enum: ["UNKNOWN","ANY","ALL","READ","WRITE","CREATE","DELETE","ALTER","DESCRIBE","CLUSTER_ACTION","DESCRIBE_CONFIGS","ALTER_CONFIGS","IDEMPOTENT_WRITE"]

The ACL operation.

permission
string (AclPermission)
extensible-enum: ["UNKNOWN","ANY","DENY","ALLOW"]

The ACL permission.

Responses

Response samples

Content type
application/json
{}

Create ACLs

Generally Available

Creates an ACL.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Request Body schema: application/json

The ACL creation request.

resource_type
required
string (AclResourceType)
Enum: "UNKNOWN" "ANY" "TOPIC" "GROUP" "CLUSTER" "TRANSACTIONAL_ID" "DELEGATION_TOKEN"
resource_name
required
string
pattern_type
required
string (AclPatternType)
extensible-enum: ["UNKNOWN","ANY","MATCH","LITERAL","PREFIXED"]
principal
required
string
host
required
string
operation
required
string (AclOperation)
extensible-enum: ["UNKNOWN","ANY","ALL","READ","WRITE","CREATE","DELETE","ALTER","DESCRIBE","CLUSTER_ACTION","DESCRIBE_CONFIGS","ALTER_CONFIGS","IDEMPOTENT_WRITE"]
permission
required
string (AclPermission)
extensible-enum: ["UNKNOWN","ANY","DENY","ALLOW"]

Responses

Request samples

Content type
application/json
{}

Delete ACLs

Generally Available

Deletes the list of ACLs that matches the search criteria.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

query Parameters
resource_type
string (AclResourceType)
Enum: "UNKNOWN" "ANY" "TOPIC" "GROUP" "CLUSTER" "TRANSACTIONAL_ID" "DELEGATION_TOKEN"

The ACL resource type.

resource_name
string

The ACL resource name.

pattern_type
string (AclPatternType)
extensible-enum: ["UNKNOWN","ANY","MATCH","LITERAL","PREFIXED"]

The ACL pattern type.

principal
string

The ACL principal.

host
string

The ACL host.

operation
string (AclOperation)
extensible-enum: ["UNKNOWN","ANY","ALL","READ","WRITE","CREATE","DELETE","ALTER","DESCRIBE","CLUSTER_ACTION","DESCRIBE_CONFIGS","ALTER_CONFIGS","IDEMPOTENT_WRITE"]

The ACL operation.

permission
string (AclPermission)
extensible-enum: ["UNKNOWN","ANY","DENY","ALLOW"]

The ACL permission.

Responses

Response samples

Content type
application/json
{}

Consumer Group (v3)

Generally Available

List Consumer Groups

Generally Available

Returns the list of consumer groups that belong to the specified Kafka cluster.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Responses

Response samples

Content type
application/json
{}

Get Consumer Group

Generally Available

Returns the consumer group specified by the consumer_group_id.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

Responses

Response samples

Content type
application/json
{}

List Consumers

Generally Available

Returns a list of consumers that belong to the specified consumer group.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

Responses

Response samples

Content type
application/json
{}

Get Consumer Group Lag Summary.

Early Access Request Access To Cluster Admin for Kafka (v3)

Returns the max and total lag of the consumers belonging to the specified consumer group.

lifecycle-stage: Early Access
path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

Responses

Response samples

Content type
application/json
{}

List Consumer Lags

Early Access Request Access To Cluster Admin for Kafka (v3)

Returns a list of consumer lags of the consumers belonging to the specified consumer group.

lifecycle-stage: Early Access
path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

Responses

Response samples

Content type
application/json
{}

Get Consumer

Early Access Request Access To Cluster Admin for Kafka (v3)

Returns the consumer specified by the consumer_id.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

consumer_id
required
string
Example: consumer-1

The consumer ID.

Responses

Response samples

Content type
application/json
{}

Partition (v3)

Generally Available

Get Consumer Lag

Early Access Request Access To Cluster Admin for Kafka (v3)

Returns the consumer lag on a partition with the given partition_id.

lifecycle-stage: Early Access
path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

consumer_group_id
required
string
Example: consumer-group-1

The consumer group ID.

topic_name
required
string
Example: topic-1

The topic name.

partition_id
required
integer

The partition ID.

Responses

Response samples

Content type
application/json
{}

List Partitions

Generally Available

Returns the list of partitions that belong to the specified topic.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

Responses

Response samples

Content type
application/json
{}

Get Partition

Generally Available

Returns the partition with the given partition_id.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

partition_id
required
integer

The partition ID.

Responses

Response samples

Content type
application/json

Topic (v3)

Generally Available

List Topics

Generally Available

Returns the list of topics that belong to the specified Kafka cluster.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Responses

Response samples

Content type
application/json
{}

Create Topic

Generally Available

Creates a topic.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

Request Body schema: application/json

The topic creation request.

topic_name
required
string
partitions_count
integer
replication_factor
integer
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "topic_name": "topic-X",
  • "partitions_count": 64,
  • "replication_factor": 3,
  • "configs":
    [
    ]
}

Response samples

Content type
application/json
{}

Get Topic

Generally Available

Returns the topic with the given topic_name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

Responses

Response samples

Content type
application/json
{}

Delete Topic

Generally Available

Deletes the topic with the given topic_name.

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

topic_name
required
string
Example: topic-1

The topic name.

Responses

Cluster Linking (v3)

Generally Available

List all configs of the cluster link

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

Responses

Response samples

Content type
application/json
{}

Describe the config under the cluster link

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

config_name
required
string
Example: consumer.offset.sync.enable

The link config name

Responses

Response samples

Content type
application/json
{}

Alter the config under the cluster link

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

config_name
required
string
Example: consumer.offset.sync.enable

The link config name

Request Body schema: application/json

Link config value to update

value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "300000"
}

Reset the given config to default value

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

config_name
required
string
Example: consumer.offset.sync.enable

The link config name

Responses

Batch Alter Topic Configs

Generally Available

Batch Alter Link Configs

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Create a mirror topic

Generally Available

Create a topic in the destination cluster mirroring a topic in the source cluster

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

Request Body schema: application/json

Name and configs of the topics mirroring from and mirroring to

source_topic_name
required
string
replication_factor
integer
Array of objects (ConfigData)

Responses

Request samples

Content type
application/json
{
  • "source_topic_name": "topic-1",
  • "configs":
    [
    ],
  • "replication_factor": 1
}

List mirror topics

Generally Available

List all mirror topics in the cluster

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

query Parameters
mirror_status
string (MirrorTopicStatus)
Enum: "active" "failed" "paused" "stopped" "pending_stopped"
Example: mirror_status=active

The status of the mirror topic. If not specified, all mirror topics will be returned.

Responses

Response samples

Content type
application/json
{}

Describe the mirror topic

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

mirror_topic_name
required
string
Example: topic-1

Cluster Linking mirror topic name

Responses

Response samples

Content type
application/json
{
  • "kind": "KafkaMirrorData",
  • "link_name": "link-sb-1",
  • "mirror_topic_name": "topic-1",
  • "source_topic_name": "topic-1",
  • "num_partitions": 3,
  • "mirror_lags":
    [
    ],
  • "mirror_topic_status": "active",
  • "state_time_ms": 1612550939300
}

Promote the mirror topics

Generally Available

path Parameters
cluster_id
required
string
Example: cluster-1

The Kafka cluster ID.

link_name
required
string
Example: link-sb1

The link name

query Parameters
validate_only
boolean

To validate if the link can be created or not, but not to create it. Default: false

Request Body schema: application/json

Name of the topics to apply the changes

mirror_topic_names
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mirror_topic_names":
    [
    ]
}

Response samples

Content type
application/json
{