Accessing Using the REST API

You can use the REST API to manage Oracle Event Hub Cloud Service — Dedicated clusters and Oracle Event Hub Cloud Service topics.

There are multiple REST API services that help you manage the cluster and topics.

Table describing REST APIs for managing clusters and topics.

Task Description Connection Details More Details
Manage Clusters Create, delete, and/or manage Oracle Event Hub Cloud Service — Dedicated clusters.

Host: The REST Endpoint that was provided during subscription. Alternatively, you can find the REST Endpoint information in the Oracle Event Hub Cloud Service — Dedicated Service Details page. See Viewing Additional Information on the Service Details Page in Managing and Monitoring Oracle Cloud.

Authentication: Your IDCS username and password as provided during subscription.

Example: https://psm.europe.oraclecloud.com

See All REST Endpoints in REST API for Oracle Event Hub Cloud Service - Dedicated.
Manage Topics Create, delete, and/or manage Oracle Event Hub Cloud Service topics.

Host: The REST Endpoint that was provided during subscription. Alternatively, you can find the REST Endpoint information in the Oracle Event Hub Cloud Service Service Details page. See Viewing Additional Information on the Service Details Page in Managing and Monitoring Oracle Cloud.

Authentication: Your IDCS username and password as provided during subscription.

Example: https://psm.europe.oraclecloud.com

See All REST Endpoints in REST API for Oracle Event Hub Cloud Service.

You can work with Oracle Event Hub Cloud Service Topics using REST APIs. Various functionality are supported through REST API. Below table summarizes the REST API operations on a topic.

Table describing REST APIs for various Kafka operations.

Task Description Connection Details — IDCS enabled Connection Details — Non IDCS (NGINX) More Details
Produce and Consume to topic Produce, and/or Consume to an Oracle Event Hub Cloud Service topic.

Host: You can get the Topic URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the restProxyUri which is the host URL.

Authentication: Your IDCS credentials using OAuth 2.0 mechanism. See Making REST API Calls to Topics That Use Identity Cloud Service

Example: https://someidcslink/restproxy/topics/clustername-topicname

Host: You can get the Topic URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the restProxyUri which is the host URL.

Authentication: The username and password that you provided during cluster creation. See Creating a Custom Cluster.

Example: https://10.20.30.40:1080/restproxy/topics/clustername-topicname

See All REST Endpoints in REST API for Oracle Event Hub Cloud Service - Produce/Consume V2.
Kafka Connect Create, delete, and/or manage Kafka Connectors.

Host: You can get the Connect URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the connectUri which is the host URL.

Authentication: Your IDCS credentials using OAuth 2.0 mechanism. See Making REST API Calls to Topics That Use Identity Cloud Service

Example: https://someconnectidcslink/connect

Note: The host is different from the REST Proxy host.

Host: You can get the Connect URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the connectUri which is the host URL.

Authentication: The username and password that you provided during cluster creation. See Creating a Custom Cluster.

Example: https://10.11.12.13:1080/connect

Note: The host is different from the REST Proxy host.

See All REST Endpoints in REST API for Oracle Event Hub Cloud Service - Connect.
Schema Registry Oracle Event Hub Cloud Service confluent schema registry provides a serving layer for your metadata. Store and retrieve Avro schemas using this schema registry REST API.

Host: You can get the Topic URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the restProxyUri which is the host URL.

After you get the host, discard the portion after ‘restproxy’ in the Topic URL and then substitute with ‘schemaregistry’. See the example below.

Authentication: Your IDCS credentials using OAuth 2.0 mechanism. See Making REST API Calls to Topics That Use Identity Cloud Service

Example: In the topic url https://someidcslink/restproxy/topics/clustername-topicname discard the portion after ‘restproxy’ and then substitute with ‘schemaregistry’ as below,https://someidcslink/schemaregistry

Host: You can get the Topic URL in the topic details section. See Viewing Details for a Topic.

To know the host URL using REST API, execute the View a Service Instance REST API. The response will contain the restProxyUri which is the host URL.

After you get the host, discard the portion after ‘restproxy’ in the Topic URL and then substitute with ‘schemaregistry’. See the example below.

Authentication: The username and password that you provided during cluster creation. See Creating a Custom Cluster.

Example: In the topic url https://10.20.30.40:1080/restproxy/topics/clustername-topicname discard the portion after ‘restproxy’ and then substitute with ‘schemaregistry’ as below, https://10.20.30.40:1080/schemaregistry

See All REST Endpoints in REST API for Oracle Event Hub Cloud Service - Schema Registry.