Interactive documentation

The fastest way to learn about the Endpoint Security REST API's calls and parameters is to use the interactive Swagger based documentation included with the install. Within a web browser you can specify inputs to an operation, call that operation, and inspect the results of calling that operation.

  1. Open a browser and enter one of the following URLs:

    • Without SSL: http://<host>:<port>/docs/index
    • With SSL: https://<host>:<port>/docs/index

    The HEAT REST API Swagger documentation appears:

    Endpoint Security REST API Swagger overview

  2. Expand Endpoints > GET /api/v2/Endpoints:

    'GET /api/v2/Endpoints' displaying Implementation Notes and Response Class (Status 200)

  3. Click Try it out!

    Highlighting the location of the 'Try it out' button

Some API endpoints use nested classes in their Model Schema, which cannot be displayed in the current implementation of Swagger.
For a full reference for these API endpoints, see Endpoints with Nested Classes.