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.
V2 REST API
The V2 API allows packages built in the HCL Link web UI to be deployed to a runtime server.
V2 map and deployment APIs
The deployment endpoints provide ways to manage packages deployed to the REST Runtime.

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.
    - V2 map and deployment APIs
      The deployment endpoints provide ways to manage packages deployed 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 map and deployment APIs

The deployment endpoints provide ways to manage packages deployed to the REST Runtime.

These APIs can list packages on the server, get detailed information about a package, delete a package, or deploy a new package.

The POST /v2/packages endpoint allows a package contained in an SQLite file to be deployed. The SQLite files for packages are built using the HCL Link web UI. In typical usage, this API is not called directly. It is called automatically when performing a deployment through the UI.