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 Entity (v1) API

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)The API allows you to create, retrieve, update, and delete catalog entities.Related guide: [Catalog API Documentation](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html#catalog-api-documentation).

Confluent Entity (v1) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entity (V1). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 10 operations across 8 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0.

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

10 operations 8 paths 14 schemas 2 DELETE3 GET2 POST3 PUT

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, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Entity (v1) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
  • confluent-sts-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Entity (v1) 10

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…

POST
/catalog/v1/entity/businessmetadata
Bulk Create Business Metadata
createBusinessMetadata body → 200400429500
PUT
/catalog/v1/entity/businessmetadata
Bulk Update Business Metadata
updateBusinessMetadata body → 200400429500
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata
Read Business Metadata for an Entity
getBusinessMetadata 2 params → 200400404429500
DELETE
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}
Delete a Business Metadata for an Entity
deleteBusinessMetadata 3 params → 204400429500
PUT
/catalog/v1/entity/tags
Bulk Update Tags
updateTags body → 200400429500
POST
/catalog/v1/entity/tags
Bulk Create Tags
createTags body → 200400429500
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}
Read an Entity
getByUniqueAttributes 4 params → 200400404429500
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags
Read Tags for an Entity
getTags 2 params → 200400404429500
PUT
/catalog/v1/entity
Update an Entity Attribute
partialEntityUpdate body → 200400404429500
DELETE
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}
Delete a Tag for an Entity
deleteTag 3 params → 204400429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Entity (20 properties), TagResponse (10 properties), TermAssignmentHeader (10 properties), Tag (9 properties). Each schema is shown below with its type and property counts.

Tag
object
9 properties
TermAssignmentHeader
object
10 properties
PartialUpdateParams
object
7 properties
EntityPartialUpdate
object
The updated entities.
1 property
EntityPartialUpdateResponse
object
The type name
1 property
TimeBoundary
object
3 properties
ClassificationHeader
object
5 properties
BusinessMetadata
object
4 properties
EntityWithExtInfo
object
2 properties
Entity
object
The entity
20 properties
Classification
object
7 properties
BusinessMetadataResponse
object
5 properties
ErrorMessage
object
Error message of this operation
2 properties
TagResponse
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-entity-v1-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 Entity (v1) 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.