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

OpenMetadata Topics API

A `Topic` is a feed or an event stream in a `Messaging Service` into which publishers publish messages and consumed by consumers.

OpenMetadata Topics API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Topics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 20 operations across 13 paths, and defines 33 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

20 operations 13 paths 33 schemas 4 DELETE7 GET2 PATCH1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Topics API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 13 paths, the API surfaces 20 operations — 4 DELETE, 7 GET, 2 PATCH, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Topics 20

A Topic is a feed or an event stream in a Messaging Service into which publishers publish messages and consumed by consumers.

PUT
/v1/topics/{id}/followers
Add a follower
addFollower_13 1 param body → 200404
GET
/v1/topics/{id}/sampleData
Get sample data
getSampleData_4 1 param → 200
PUT
/v1/topics/{id}/sampleData
Add sample data
addSampleData_4 1 param body → 200
PUT
/v1/topics/bulk
Bulk create or update topics
bulkCreateOrUpdateTopics 1 param body → 200202400
GET
/v1/topics
List topics
listTopics 6 params → 200
PUT
/v1/topics
Update topic
createOrUpdateTopic body → 200
POST
/v1/topics
Create a topic
createTopic body → 200400
GET
/v1/topics/name/{fqn}
Get a topic by fully qualified name
getTopicByFQN 4 params → 200404
DELETE
/v1/topics/name/{fqn}
Delete a topic by fully qualified name
deleteTopicByFQN 2 params → 200404
PATCH
/v1/topics/name/{fqn}
Update a topic using name.
patchTopic 1 param body → default
GET
/v1/topics/{id}
Get a topic by id
get_7 4 params → 200404
DELETE
/v1/topics/{id}
Delete a topic by id
deleteTopic 2 params → 200404
PATCH
/v1/topics/{id}
Update a topic
patchTopic_1 1 param body → default
DELETE
/v1/topics/async/{id}
Asynchronously delete a topic by id
deleteTopicAsync 2 params → 200404
DELETE
/v1/topics/{id}/followers/{userId}
Remove a follower
deleteFollower_29 2 params → 200
GET
/v1/topics/{id}/versions/{version}
Get a version of the topic
getSpecificTopicVersion 2 params → 200404
GET
/v1/topics/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_61 5 params → 200
GET
/v1/topics/{id}/versions
List topic versions
listAllTopicVersion 1 param → 200
PUT
/v1/topics/restore
Restore a soft deleted topic
restore_48 body → 200
PUT
/v1/topics/{id}/vote
Update Vote for a Entity
updateVoteForEntity_17 1 param body → 200404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Topic (44 properties), CreateTopic (22 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
BulkOperationResult
object
8 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
TopicSampleData
object
1 property
Paging
object
5 properties 1 required
CreateTopic
object
22 properties 3 required
JsonPatch
object
ChangeDescription
object
5 properties
TopicConfig
object
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
MessageSchema
object
3 properties
Style
object
3 properties
TopicList
object
5 properties 1 required
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
Field
object
8 properties 2 required
EntityReference
object
9 properties 2 required
Topic
object
44 properties 4 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-topics-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Topics 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.