SEMP API Reference

You can access the SEMP API Reference in two ways:

  • Enter this URL in a Web browser that has connectivity to your host event broker:
    http://<HOST>/SEMP/v2/config/help

    Where: <HOST> is the IP address of your event broker. If the host is a Solace PubSub+ software event broker, append :8080 to the IP address.

  • Click these links to access the Configuration, Action, and Monitoring API References:

If you want to access the SEMP Swagger specification file (for example, to Generate a SEMP Client Library), enter the following URL:

http://<HOST>/SEMP/v2/config/spec

Searching the API References

You can expand all the entries in the API Reference to allow a browser-based search (CTRL + F) to find items that would otherwise be hidden. To do this, append the following to the to the URL of the API Reference:

?docExpansion=full

For example:

https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/config/index.html?docExpansion=full

The fully-expanded API References may take several minutes to load in the browser, and may also cause the browser to display a warning that the page is loading slowly.

Migrating swagger-codegen Java client code from before v9.6 to v9.6 or later

In version 9.6, SEMP version 2.17 added a new query parameter called opaquePassword. When a new client library is generated for this version using swagger-codegen, the method signatures for API calls may have changed in a backwards-incompatible way for some languages.

In Java libraries generated from SEMP version 2.17, all API calls have a new parameter for opaquePassword. Existing code using the new generated library will not compile until a value is provided for this new parameter. You must provide a value of null for each instance of this parameter to preserve the behavior of the existing code.

Alternatively, to avoid these changes to method signatures all together, you can manually delete the section of the Swagger specification describing the opaquePassword query parameter. However, until your code is updated, you must perform this editing every time you upgrade and regenerate the client library.