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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Oracle

Oracle Kafka Cluster API

The kafkaCluster API from Oracle — 18 operation(s) for kafkacluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

Oracle Kafka Cluster API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 29 operations across 18 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 20240901.

Requests are made against 2 base URLs: http://127.0.0.1/20240901, https://127.0.0.1/20240901.

29 operations 18 paths 37 schemas 5 DELETE14 GET7 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20240901
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 29

Across 18 paths, the API surfaces 29 operations — 5 DELETE, 14 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

kafkaCluster 29
GET
/addonOptions
Gets a list of supported KafkaClusterAddons.
ListAddonOptions 5 params → 200400401404429500default
GET
/kafkaClusterConfigs
Gets a list of KafkaClusterConfigs.
ListKafkaClusterConfigs 9 params → 200400401404429500default
POST
/kafkaClusterConfigs
Creates a KafkaClusterConfig.
CreateKafkaClusterConfig 2 params body → 200400401404409429500default
DELETE
/kafkaClusterConfigs/{kafkaClusterConfigId}
Deletes a KafkaClusterConfig.
DeleteKafkaClusterConfig 3 params → 204400401404409412429500
GET
/kafkaClusterConfigs/{kafkaClusterConfigId}
Get KafkaClusterConfig
GetKafkaClusterConfig 2 params → 200400401404429500default
PUT
/kafkaClusterConfigs/{kafkaClusterConfigId}
Updates a KafkaClusterConfig.
UpdateKafkaClusterConfig 3 params body → 200400401404409412429500
POST
/kafkaClusterConfigs/{kafkaClusterConfigId}/actions/changeCompartment
Moves a KafkaClusterConfig into a different compartment.
ChangeKafkaClusterConfigCompartment 3 params body → 204401404409412429500
GET
/kafkaClusterConfigs/{kafkaClusterConfigId}/versions
Gets a list of KafkaClusterConfig Versions.
ListKafkaClusterConfigVersions 6 params → 200400401404429500default
DELETE
/kafkaClusterConfigs/{kafkaClusterConfigId}/versions/{versionNumber}
Deletes a KafkaClusterConfig version.
DeleteKafkaClusterConfigVersion 4 params → 204400401404409412429500
GET
/kafkaClusterConfigs/{kafkaClusterConfigId}/versions/{versionNumber}
Get KafkaClusterConfig version
GetKafkaClusterConfigVersion 3 params → 200400401404429500default
GET
/kafkaClusters
Gets a list of KafkaClusters.
ListKafkaClusters 9 params → 200400401404429500default
POST
/kafkaClusters
Creates a KafkaCluster.
CreateKafkaCluster 2 params body → 201400401404409429500default
DELETE
/kafkaClusters/{kafkaClusterId}
Deletes a KafkaCluster.
DeleteKafkaCluster 3 params → 202400401404409412429500
GET
/kafkaClusters/{kafkaClusterId}
Get KafkaCluster
GetKafkaCluster 2 params → 200400401404429500default
PUT
/kafkaClusters/{kafkaClusterId}
Updates a KafkaCluster.
UpdateKafkaCluster 3 params body → 202400401404409412429500
POST
/kafkaClusters/{kafkaClusterId}/actions/changeCompartment
Moves a KafkaCluster into a different compartment.
ChangeKafkaClusterCompartment 3 params body → 202401404409412429500
POST
/kafkaClusters/{kafkaClusterId}/actions/disableSuperuser
Disables the Kafka cluster SASL superuser
DisableSuperuser 4 params → 202401404409412429500
POST
/kafkaClusters/{kafkaClusterId}/actions/enableSuperuser
Enables the Kafka cluster SASL superuser
EnableSuperuser 4 params body → 202401404409412429500
GET
/kafkaClusters/{kafkaClusterId}/addons
Gets a list of KafkaClusterAddons.
ListAddons 8 params → 200400401404429500default
POST
/kafkaClusters/{kafkaClusterId}/addons
Installs a KafkaClusterAddon.
InstallAddon 4 params body → 202400401404409412429500
DELETE
/kafkaClusters/{kafkaClusterId}/addons/{addonName}
Uninstalls a KafkaClusterAddon.
UninstallAddon 4 params → 204400401404409412429500
GET
/kafkaClusters/{kafkaClusterId}/addons/{addonName}
Get KafkaClusterAddon
GetAddon 3 params → 200400401404429500default
PUT
/kafkaClusters/{kafkaClusterId}/addons/{addonName}
Updates a KafkaClusterAddon.
UpdateAddon 4 params body → 202400401404409412429500
GET
/nodeShapes
Gets a list of all possible node shapes
ListNodeShapes 7 params → 200400401404429500default
GET
/workRequests
List work requests
ListWorkRequests 9 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Cancel work request
CancelWorkRequest 3 params → 202400401404429409412500
GET
/workRequests/{workRequestId}
Get work request status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
List work request errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
List work request logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are KafkaCluster (20 properties), KafkaClusterSummary (17 properties), CreateKafkaClusterDetails (12 properties), KafkaClusterConfig (11 properties). Each schema is shown below with its type and property counts.

KafkaClusterConfigVersionSummary
object
Summary information about a KafkaClusterConfigVersion.
3 properties 3 required
AddonCollection
object
Results of a kafkaClusterAddon search. Contains both AddonSummary items and other information.
1 property 1 required
NodeShapeSummary
object
Summary of the shape.
1 property 1 required
WorkRequestErrorCollection
object
A list of work request errors. Can contain both errors and other information, such as metadata.
1 property 1 required
WorkRequestError
object
An error encountered while performing an operation that is tracked by a work request.
3 properties 3 required
EnableSuperuserDetails
object
The configuration details for the enable superuser operation.
2 properties 2 required
WorkRequestSummary
object
Summary information about an asynchronous work request.
10 properties 7 required
WorkRequest
object
An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work reque…
10 properties 7 required
CreateKafkaClusterDetails
object
The data to create a KafkaCluster.
12 properties 8 required
BootstrapUrl
object
Kafka bootstrap URL
2 properties 2 required
SubnetSet
object
Summary information about a KafkaCluster.
1 property 1 required
WorkRequestLogEntryCollection
object
A list of work request logs. Can contain both logs and other information, such as metadata.
1 property 1 required
BrokerShape
object
Configuration of the broker node.
4 properties 2 required
AddonOptionSummary
object
Summary information about a AddonOptions.
2 properties 2 required
KafkaClusterConfig
object
A shared configuration object used by 0 or more kafka clusters. To use any of the API operations, you must be authorized in an IAM policy. If you're not author…
11 properties 8 required
UpdateAddonDetails
object
The data to update a KafkaClusterAddon.
2 properties
KafkaClusterAddon
object
The base data object to represent a KafkaClusterAddon.
6 properties 3 required
KafkaClusterSummary
object
Summary information about a KafkaCluster.
17 properties 13 required
AddonOptionCollection
object
Results of a AddonOptions search. Contains AddonOptionSummary items
1 property 1 required
NodeShapeCollection
object
Results of a NodeShapeCollection search.
1 property 1 required
Error
object
Error information.
2 properties 2 required
WorkRequestLogEntry
object
A log message from performing an operation that is tracked by a work request.
2 properties 2 required
KafkaClusterCollection
object
Results of a kafkaCluster search. Contains both KafkaClusterSummary items and other information, such as metadata.
1 property 1 required
KafkaClusterConfigSummary
object
Summary information about a KafkaClusterConfig.
10 properties 7 required
WorkRequestSummaryCollection
object
A list of work requests. Can contain both work requests and other information, such as metadata.
1 property 1 required
KafkaClusterConfigVersionCollection
object
Results of a kafkaClusterConfigVersion search. Contains both KafkaClusterConfigVersionSummary items.
1 property 1 required
UpdateKafkaClusterDetails
object
The data to update a KafkaCluster.
9 properties
UpdateKafkaClusterConfigDetails
object
The data to update a KafkaClusterConfig.
4 properties
ChangeKafkaClusterCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
AddonSummary
object
Summary information about a KafkaClusterAddon.
6 properties 3 required
KafkaClusterConfigVersion
object
A shared configuration object used by 0 or more kafka clusters.
4 properties 1 required
InstallAddonDetails
object
The data to create a KafkaClusterAddon.
3 properties 2 required
KafkaClusterConfigCollection
object
Results of a kafkaClusterConfig search. Contains both KafkaClusterConfigSummary items and other information, such as metadata.
1 property 1 required
WorkRequestResource
object
A resource created or operated on by a work request.
5 properties 3 required
ChangeKafkaClusterConfigCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
KafkaCluster
object
A KafkaCluster is a description of a KafkaCluster. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to…
20 properties 13 required
CreateKafkaClusterConfigDetails
object
The data to create a KafkaClusterConfig.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-kafkacluster-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
AE Profile APIs.io
Oracle Integration Cloud API
AE Profile APIs.io
Oracle Fusion Cloud Applications API
AE Profile APIs.io
Oracle Fusion Cloud Financials REST API
AE Profile APIs.io
Oracle Fusion Cloud HCM REST API
AE Profile APIs.io
Oracle Fusion Cloud CX Sales and Service REST API
AE Profile APIs.io
Oracle Fusion Cloud SCM REST API
AE Profile APIs.io
Oracle Fusion Cloud Procurement REST API
AE Profile APIs.io
Oracle Content Management API
AE Profile APIs.io
OCI Generative AI API
AE Profile APIs.io
OCI AI Vision API
AE Profile APIs.io
OCI AI Language API
AE Profile APIs.io
← Back to O APIs
API Details
ID
oracle:oracle-kafkacluster-api
Base URL
https://{host}:{port}/ords/
Docs
https://docs.oracle.com/en/database/oracle/oracle-database/
Provider
Oracle
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=oracle-kafkacluster-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/oracle-kafkacluster-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Oracle Kafka Cluster 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.