SEMP API Reference

You can access the SEMP API Reference in two ways:

  • Enter the following URL in a web browser that has connectivity to your host event broker:
    http://<host>:<port>/SEMP/v2/<api>/help

    Where host and port identify the event broker, and api is config, action, or monitor.

    For information about which port to use, see Default Port Numbers (for appliances and software event brokers) and Client Application Connectivity and Security (for PubSub+ Cloud).

    For example:

    http://192.168.123.45:8080/SEMP/v2/monitor/help
  • Click the appropriate link below to see the Configuration, Action, or Monitoring reference for software event brokers and Cloud event broker services, or for appliances.

 

Software Event Brokers and Event Broker Services
 
Appliances

Configuration Reference

Action Reference

Monitor Reference

 

Configuration Reference

Action Reference

Monitor Reference

There are slight differences between the SEMP API References for cloud and software event brokers and for appliances.

SEMP OpenAPI Definition

If you want to see or download the SEMP OpenAPI definition file (for example, to Generate a SEMP Client Library), enter the following URL in a web browser that has connectivity to your host event broker:

http://<host>:<port>/SEMP/v2/<api>/spec

Where host and port identify the event broker, and api is config, action, or monitor.

For information about which port to use, see Default Port Numbers (for appliances and software event brokers) and Client Application Connectivity and Security (for PubSub+ Cloud).

For example:

http://192.168.123.56:8080/SEMP/v2/action/spec

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 does 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 altogether, 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.