Understanding the REST API

The REST API for advanced event mesh for SAP Integration Suite provides a mechanism for you to programmatically manage event broker services, work with Event Portal, and manage accounts for advanced event mesh. To use any of the REST APIs, you must have an API token for bearer authentication. For more information, see Managing API Tokens.

Information for the legacy REST APIs are available as follows:

About Different Versions of the REST APIs

In advanced event mesh, there are different versions of the REST APIs for advanced event mesh. The version of the API is found in the API path. For example, you can see that the following endpoint is a v2 API.


The versions of the REST API available in advanced event mesh are as follows:

  • v2—The current (and more modern) v2 REST APIs closely follow set SAP standards, have full reference documentation and provide consistent interfaces and behavior.

  • v1/v0—Legacy versions of the REST APIs aren't as feature rich, and may have inconsistencies. Documentation for v0 and v1 APIs are provided below as tutorials and often are not fully documented.

    In general, you can mix usage of different versions of the API in your application except for Event Portal APIs.  Event Portal APIs align with the version of Event Portal you are using. For example, if you're using Event Portal 2.0, you must use only Event Portalv2 APIs.

API Rate Limiting

The number of REST APIs requests from a client session in advanced event mesh are evaluated every 30 seconds in a rolling window of five minutes. Within that five minute period, API rating limiting is applied if the rate limit is reached or exceeded, and you see 429 responses. When API rating limiting is applied, your applications:

  • Receive 429 error codes as responses to for refused client requests.
  • May experience throttling for client requests.

SAP reserves the right to adjust the rate limits at any time to ensure a high quality service for all users of our platform. If you are subjected to rate limiting, reduce your request rate.