Home
Runtimes
Descriptions of Link runtime services.
REST API
The REST Runtme 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 runtme server.
V2 configuration API
The configuration endpoint allows a selection of the configuration parameters of a REST server to be updated without restarting the server.

Runtimes
Descriptions of Link runtime services.
- REST API
  The REST Runtme 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 runtme server.
    - V2 map and deployment APIs
      The deployment endpoints provide ways to manage packages depoyed to the REST Runtime.
    - V2 map and flow run APIs
      The map and flow run endpoints allow directly invokable maps and flows to be run.
    - V2 map and flow instance API
      The instance endpoints are used to get information about an asynchronous map or flow run.
    - V2 configuration API
      The configuration endpoint allows a selection of the configuration parameters of a REST server to be updated without restarting the 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.

V2 configuration API

The configuration endpoint allows a selection of the configuration parameters of a REST server to be updated without restarting the server.

A PUT request at /v2/configuration can be used to update a selection of the configuration parameters of the REST server without restarting the server. The body of the PUT request is YAML data which contains the new values for the chosen parameters. The structure of the YAML data follows the structure of the configuration file. The following parameters may be changed dynamically (in JSON Pointer notation):

/rest/logging/level
/rest/resources/flowThreads
/rest/resources/mapThreads

For example, to change the logging level to ALL, add the following YAML content in the body of the PUT request:


rest:
  logging:
    level: “ALL”