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:
https://<customer_alias>.dev.sentinelcloud.com/WSReference-ems
where:
><customer_alias> refers to the customer alias defined in the Sentinel EMS vendor portal.
Browser Compatibility
You can view the Sentinel EMS REST API Reference using the following web browsers:
>Google Chrome
>Mozilla Firefox
>Microsoft Edge
>Safari
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.
API Specification
The Sentinel EMS REST API Reference is generated from an OpenAPI 3.0.1 specification file, which is available here:
OpenAPI 3.0.1 Specification File
Use this specification to understand the available APIs, generate client SDKs, automate integration development, and validate API requests and responses with OpenAPI-compatible tools.
Generating OpenAPI Client Libraries
You can generate native client libraries in various programming languages from the Sentinel EMS OpenAPI specification file.
Java Client Library
The generated Java client library works out of the box and requires no post-generation modifications. To generate the Java client library, run:
openapi-generator-cli generate -i sentinel-ems-openapi-v3.json -g java -o ems_java_lib
The generated library compiles cleanly, builds, and works against live Sentinel EMS instances without any additional steps.
Python Client Library
You can generate the Python client library by running the OpenAPI generator command:
openapi-generator-cli generate \ -i sentinel-ems-openapi-v3.json \ -g python \ -o ems_lib \ --additional-properties packageName=ems_client
Depending on the Sentinel EMS API runtime behavior, a post-generation patch script may be required to address compatibility issues with strict type validation. Contact Thales Support for the patch script and instructions for applying it.