REST API

The REST Runtme provides a REST API used to run maps and flows that have been deployed.

There are two versions of the APIs available:
  • V1, which only supports running maps.
  • V2, which supports running both maps and flows.

Specific documentation for the APIs in each, including query parameters, path variables, and payload format, can be found at this location:

{host}:{port}/hip-rest/api-docs?url=openapi.json

where {host} and {port} are the IP address, or host name and port number of the REST Runtime installation.