Hybrid Cloud Console APIs

Hybrid Cloud Console APIs are publicly available and can be queried from any authenticated client (role-based access controlled).

• For more information about the available endpoints for applications and services, refer to the Hybrid Cloud Console API documentation.
• For an example of CSV-formatted API responses, see the System Comparison API Documentation.
• For examples to help you to get started quickly with authentication and with querying API endpoints, see Red Hat Lightspeed API cheat sheet.

Webhooks

Copy link

Webhooks work in a similar way to APIs, except that they enable one-way data sharing when events trigger them. APIs share data in both directions.

Third-party applications can be configured to allow inbound data requests by exposing webhooks and using them to listen for incoming events. The Hybrid Cloud Console integrations service uses this functionality to send events and associated data from each service.

You can configure the Hybrid Cloud Console notifications service to send POST messages to those third-party application webhook endpoints. For example, you can configure the Hybrid Cloud Console to automatically forward events triggered when a new Advisor recommendation is found. The event and its data are sent as an HTTP POST message to the third-party application on its incoming webhook endpoint.

After you configure the endpoints in the notifications service, you can subscribe to a stream of Hybrid Cloud Console events and automatically forward that stream to the webhooks of your choice. Each event contains additional metadata, which you can use to process the event, for example, to perform specific actions or trigger responses, as part of your operational workflow. You configure the implementation and data handling within your application.

For more information about how to configure and use webhooks, refer to Manage notifications with external tools.

Third-party application integrations

Copy link

You can use Hybrid Cloud Console third-party application integrations in two ways, depending on your use case:

• Use Hybrid Cloud Console APIs to collect data and perform tasks.
• Subscribe to streams of Hybrid Cloud Console events.

You can use Hybrid Cloud Console integrations to forward events to specific third-party applications. The Red Hat Lightspeed application for Splunk forwards selected Hybrid Cloud Console events to Splunk. This allows you to view and use data from Hybrid Cloud Console in your existing workflows from the Red Hat Lightspeed application for Splunk dashboard.