Using the PubSub+ Cloud REST APIs
The REST API for
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 PubSub+ Cloud. 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, Solace recommends that you use v2 APIs whenever possible. The versions of the REST API available in PubSub+ Cloud 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. -
v1
/v0
—Legacy versions of the REST APIs aren't as feature rich and may have inconsistencies. Documentation forv0
andv1
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 PubSub+ Cloud
Solace 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 PubSub+ Cloud REST API
- Managing Services with the PubSub+ Cloud REST API
- Managing Users with the PubSub+ Cloud REST API
- Managing Authentication with the PubSub+ Cloud REST API
- Managing Certificate Authorities with the PubSub+ Cloud REST API
The following REST APIs are v2
REST APIs that currently are not available in theREST API v2 documentation.
- Managing Single Sign-On for Event Broker Services with the PubSub+ Cloud REST API
- Managing Audit Logs with the PubSub+ Cloud 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, PubSub+ Cloud 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.
Solace 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.