About Sentinel EMS REST API Reference

For information about specific API methods (or endpoints), you need to refer to the Sentinel EMS REST API Reference. The reference describes the available endpoints, operations on each endpoint, request and response format, and status codes.

Accessing the Sentinel EMS REST API Reference

NOTE   Sentinel EMS REST API Reference is accessible only in the EMS non-production (development) environment.

To access the Sentinel REST API Reference, type the following URL in the address bar of a web browser and press Enter:

http://<Hostname>:<port>/emsWSReference

where:

><Hostname> denotes the IP address or domain name of the EMS server.

><port> denotes the port at which the EMS server has been deployed.

Browser Compatibility

You can view the Sentinel EMS REST API Reference using the following web browsers:

>Mozilla Firefox

>Google Chrome

>Microsoft Internet Explorer version 11 and later

The “Try It Out” Feature

The Sentinel EMS REST API Reference can help you explore the API methods with sample data, by using the Try It Out feature.

This feature provides an interactive documentation experience where you can try out any API endpoint with the sample data, and view the call and response structure for that endpoint. You can explore how your application interacts with the EMS REST API and even copy-and-paste code snippets to use in your application source code.

NOTE   The Try It Out feature is enabled only if the Sentinel EMS REST API Reference is integrated with a back-end Sentinel EMS instance; otherwise, an error message is displayed.