Using the SAP Integration Suite, Advanced Event Mesh REST APIs

The REST API for SAP Integration Suite, advanced event mesh (Solace Cloud v2 REST APIs) provides a mechanism for you to manage event broker services, work with Event Portal, manage accounts, and perform a variety of other actions that users can perform in the Cloud Console.

Learn About v2 REST APIs

These REST APIs follow set standards, have full reference documentation, and have consistent interfaces.

About Different Versions of the REST APIs

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.

https://api.solace.cloud/api/v2/audit/logs

When you develop, SAP recommends that you use v2 APIs whenever possible. 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 standards, have full reference documentation, and conform to consistent interfaces and behavior. The APIs have release stages, such as General Availability, Beta, and Early Access. For more information, see the v2 REST API documentation.

  The REST API for advanced event mesh only supports:

  • The base URL for the United States. For this reason, only use the Cloud US East Region for the Base URL in v2 REST API documentation to generate examples or experiment with the REST APIs. For more information, see Considerations for Using API Tokens.
  • General Availability REST APIs. Early Access and Beta REST APIs are not supported in advanced event mesh.

  .

• 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 as is and 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 supports only v2 APIs.

Legacy v0/v1 REST APIs in Advanced Event Mesh

SAP recommends that you use v2 APIs whenever possible. In some cases, you may need to use legacy v0 and v1 APIs to fulfill functionality requirements that v2 APIs do not currently provide.

For information about the legacy REST APIs, see the following sections:

• Managing Client Profiles with the REST API
• Managing Services with the REST API
• Managing Users with the REST API
• Managing Authentication with the REST API
• Managing Certificate Authorities with the REST API

The following REST APIs are v2 REST APIs that currently are not available in the REST API v2 documentation.

• Managing Audit Logs with the REST API

API Rate Limiting

The number of REST API requests from a client session are evaluated every 30 seconds in a rolling window of five minutes. Within any five-minute period, advanced event mesh applies API rate limiting if the rate limit is reached or exceeded. When API rate limiting is applied, your applications:

• Receive 429 error codes as responses 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. If you are subjected to rate limiting, reduce your request rate.