# Confluent Cloud Confluent Data Catalog API

> Confluent Cloud Confluent Data Catalog API on Apizie: 22 endpoints (Bulk Read Business Metadata Definitions, Bulk Create Business Metadata Definitions, Bulk Update Business Metadata Definitions, Read Business Metadata Definition, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:confluent-data-catalog-v1/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:confluent-data-catalog-v1`
- Category: Cloud
- Status: byok
- Source: https://docs.confluent.io/cloud/current/api.html
- Page: https://apizie.tech/api/cloud/confluent-data-catalog-v1
- OpenAPI: https://apizie.tech/api/cloud/confluent-data-catalog-v1/openapi.json

REST API for the Data Catalog

## Endpoints

### Bulk Read Business Metadata Definitions
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-all-business-metadata-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| prefix | string | no | The prefix of a business metadata definition name |

### Bulk Create Business Metadata Definitions
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/create-business-metadata-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk Update Business Metadata Definitions
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/update-business-metadata-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Read Business Metadata Definition
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-business-metadata-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| bmName | string | yes | The name of the business metadata definition |

### Delete Business Metadata Definition
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/delete-business-metadata-def` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| bmName | string | yes | The name of the business metadata definition |

### Bulk Create Business Metadata
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/create-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk Update Business Metadata
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/update-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Read Business Metadata for an Entity
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| typeName | string | yes | The type of the entity |
| qualifiedName | string | yes | The qualified name of the entity |

### Delete a Business Metadata for an Entity
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/delete-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| typeName | string | yes | The type of the entity |
| qualifiedName | string | yes | The qualified name of the entity |
| bmName | string | yes | The name of the business metadata |

### Bulk Create Tags
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/create-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk Update Tags
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/update-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Read an Entity
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-by-unique-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| typeName | string | yes | The type of the entity |
| qualifiedName | string | yes | The qualified name of the entity |
| minExtInfo | boolean | no | Whether to populate on header and schema attributes |
| ignoreRelationships | boolean | no | Whether to ignore relationships |

### Read Tags for an Entity
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| typeName | string | yes | The type of the entity |
| qualifiedName | string | yes | The qualified name of the entity |

### Update an Entity Attribute
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/partial-entity-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete a Tag for an Entity
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/delete-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| typeName | string | yes | The type of the entity |
| qualifiedName | string | yes | The qualified name of the entity |
| tagName | string | yes | The name of the tag |

### Search by Attribute
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/search-using-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | array | no | Limit the result to only entities of specified types |
| attr | array | no | One of more additional attributes to return in the response |
| attrName | array | no | The attribute to search |
| attrValuePrefix | array | no | The prefix for the attribute value to search |
| tag | string | no | Limit the result to only entities tagged with the given tag |
| sortBy | string | no | An attribute to sort by |
| sortOrder | string | no | Sort order, either ASCENDING (default) or DESCENDING |
| deleted | boolean | no | Whether to include deleted entities |
| limit | integer | no | Limit the result set to only include the specified number of entries (maximum 500) |
| offset | integer | no | Start offset of the result set (useful for pagination) |

### Search by Fulltext Query
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/search-using-basic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | no | The full-text query |
| type | array | no | Limit the result to only entities of specified types |
| attr | array | no | One of more additional attributes to return in the response |
| tag | string | no | Limit the result to only entities tagged with the given tag |
| sortBy | string | no | An attribute to sort by |
| sortOrder | string | no | Sort order, either ASCENDING (default) or DESCENDING |
| deleted | boolean | no | Whether to include deleted entities |
| limit | integer | no | Limit the result set to only include the specified number of entries (maximum 500) |
| offset | integer | no | Start offset of the result set (useful for pagination) |

### Bulk Read Tag Definitions
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-all-tag-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| prefix | string | no | The prefix of a tag definition name |

### Bulk Create Tag Definitions
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/create-tag-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk Update Tag Definitions
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/update-tag-defs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Read Tag Definition
`GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-tag-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagName | string | yes | The name of the tag definiton |

### Delete Tag Definition
`POST https://apizie.tech/v1/cloud:confluent-data-catalog-v1/delete-tag-def` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagName | string | yes | The name of the tag definition |

## Example
```
curl "https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-all-business-metadata-defs" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Confluent Cloud Confluent Data Catalog API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:confluent-data-catalog-v1/get-all-business-metadata-defs with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Confluent Cloud Confluent Data Catalog API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Confluent Cloud Confluent Data Catalog itself also needs your own key from confluent.cloud.

### Can AI agents use the Confluent Cloud Confluent Data Catalog API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:confluent-data-catalog-v1.

### What is the status of the Confluent Cloud Confluent Data Catalog API?
Needs your own provider key (bring your own key)