Home
Runtimes
Descriptions of Link runtime services.
REST API
The REST Runtime provides a REST API used to run maps and flows that have been deployed.

Runtimes
Descriptions of Link runtime services.
- REST API
  The REST Runtime provides a REST API used to run maps and flows that have been deployed.
  - V2 REST API
    The V2 API allows packages built in the HCL Link web UI to be deployed to a runtime server.
  - V1 REST API
    The V1 API has two different modes it can use to run maps. It can run maps directly, or it can run cataloged maps.
- Flow Command Server
  Deploy a flow from the HCL Link to the local filesystem using Execution flow server definition.
- Map Command Server
  To use the Map Command Server to execute a map, you will prepare the maps for execution.
- SDK
  The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.

REST API

The REST Runtime 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.