How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluent Version 2 API

![generally-available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%230074A2)Version 2 of the Metrics API adds the ability to query metrics for Kafka Connect, ksqlDB,and Schema Registry.This capability is enabled by the introduction of a [Resource](#section/Object-Model/Resources)abstraction into the API object model. Resources represent the entity against which metricsare collected.### Migration GuideThe following endpoint URLs have changed in version 2:| Endpoint | Version 1 (Sunset) | Version 2 || ----------------------- | -------------------------------- | ---------------------------------------- || Metrics discovery | `/metrics/{dataset}/descriptors` | `/metrics/{dataset}/descriptors/metrics` |The label prefix syntax has changed in version 2:| Label | Version 1 (Sunset) | Version 2 || ----------------------- | ---------------------------- | ----------------------- || Resource labels *(new)* | *N/A* | `resource.` || Kafka cluster ID | `metric.label.cluster_id` | `resource.kafka.id` || All other metric labels | `metric.label.` | `metric.` |This example shows a request to `/v1/metrics/cloud/query` migrated into the new `v2` syntax#### Version 1 Request```json{ "group_by": [ "metric.label.topic" ], "aggregations": [{ "metric": "io.confluent.kafka.server/received_bytes", "agg": "SUM" }], "filter": { "field": "metric.label.cluster_id", "op": "EQ", "value": "lkc-00000" }, "granularity": "ALL", "intervals" : [ "2020-01-01T00:00:00Z/PT1H" ]}```#### Version 2 Request```json{ "group_by": [ "metric.topic" ], "aggregations": [{ "metric": "io.confluent.kafka.server/received_bytes", "agg": "SUM" }], "filter": { "field": "resource.kafka.id", "op": "EQ", "value": "lkc-00000" }, "granularity": "ALL", "intervals" : [ "2020-01-01T00:00:00Z/PT1H" ]}```

Confluent Version 2 API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Version 2. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 6 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.telemetry.confluent.cloud.

6 operations 6 paths 29 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Confluent Version 2 API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (api-key). It accepts HTTP bearer tokens (confluent-sts-access-token). By default, every request must be authenticated.

  • api-key — API keys must be sent as an Authorization: Basic {key} header with the Key ID as the username and the Key Secret as the password. Remember that HTTP Basic auth…
  • confluent-sts-access-token — Confluent Security Token Service (STS) issues access tokens (confluent-sts-access-token) by exchanging an external token (external-access-token) for a confluen…

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Version 2 6

![generally-available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%230074A2) Version 2 of the Metrics API adds the ability to query metrics for Kafka Con…

GET
/v2/metrics/{dataset}/descriptors/metrics
List metric descriptors
4 params → 200429default
GET
/v2/metrics/{dataset}/descriptors/resources
List resource descriptors
3 params → 200429default
POST
/v2/metrics/{dataset}/query
Query metric values
2 params body → 200429default
GET
/v2/metrics/{dataset}/export
Export metric values
15 params → 200429default
POST
/v2/metrics/{dataset}/attributes
Query label values
2 params body → 200429default
GET
/v2/metrics/{dataset}/discovery
Discover target resources
4 params → 200400429default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are QueryRequest (8 properties), MetricDescriptor (8 properties), AttributesRequest (5 properties), Pagination (3 properties). Each schema is shown below with its type and property counts.

QueryResponse
Meta
object
Meta object
1 property 1 required
OrderBy
object
3 properties 1 required
ListMetricDescriptorsResponse
object
The ListMetricDescriptors response.
3 properties 2 required
ErrorResponse
object
1 property 1 required
ListResourceDescriptorsResponse
object
The list of resource descriptors for a dataset
3 properties 2 required
Granularity
string
Defines the time buckets that the aggregation is performed for. Buckets are specified in [ISO-8601 duration syntax](https://en.wikipedia.org/wiki/ISO8601Durati…
PageToken
string
An opaque token that you use to get the next page of results.
LabelDescriptor
object
The description of a label.
3 properties 2 required
Aggregation
object
2 properties 1 required
AttributesResponse
object
3 properties 2 required
UnaryFilter
object
2 properties 2 required
Dataset
string
A logical collection of metrics that can be described and queried. Valid values are cloud and health-plus.
MetricDescriptor
object
Defines a metric type and its schema.
8 properties 8 required
QueryRequest
object
8 properties 3 required
AggregationFunction
string
Filter
Metric filter.
FieldFilter
object
3 properties 2 required
Interval
string
GroupedQueryResponse
object
2 properties 1 required
Point
object
2 properties 2 required
CompoundFilter
object
2 properties 2 required
ResponseFormat
string
Desired response format for query results. FLAT (default): Each item in the response data array represents a data point in the timeseries. Each data point cont…
ResourceType
string
A named type for a resource (e.g. kafka, connector).
FlatQueryResponse
object
2 properties 1 required
Links
object
link information
1 property
AttributesRequest
object
5 properties 1 required
Pagination
object
The pagination information.
3 properties 1 required
ResourceDescriptor
object
A Resource represents the entity producing metrics. For example: a Kafka cluster a Kafka Connector, etc.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-version-2-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
Confluent Managed MCP Servers
Confluent ACLs API
Confluent API Keys API
Confluent Clusters API
Confluent Consumer Groups API
Confluent Environments API
Confluent Partitions API
Confluent Service Accounts API
Confluent Topics API
Confluent Access Points (networking/v1) API
Confluent ACL (v3) API
Where this information came from

This is an independent, third-party profile of Confluent Version 2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.