Event Portal REST API

Using the Event Portal's RESTful API, you can integrate other applications, systems, or client applications with Event Portal, and model or retrieve your event-driven architectures from your own client applications.

Getting Started

You can access the REST API by communicating with the host at https://api.solace.cloud//api/v1/eventPortal. Note that the URL is used to perform REST API calls and cannot be accessed from the browser.

As Event API Product (EAPs) is a Beta feature, REST API for retrieving an EAP’s AsyncAPI document is currently not available through the above mentioned URL. To retrive an EAP's AsycnAPI document, refer to Retrieving an EAP's AsyncAPI Document using REST . Note that EAP is currently in Beta stage, and the feature including its API version (v0) will undergo changes that may not be backwards compatible.

To perform REST API calls, you will need an API token. Use your PubSub+ Cloud account to generate an API token. For more information, see Creating an API Token.

OpenAPI Specification

The Event Portal REST API has an OpenAPI specification document to help you navigate your way through the REST APIs. Click the button below to access the OpenAPI spec.