Home
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
REST commands for the HCL Launch server
The following list shows the commands that are available for the HCL Launch server.
sshInstallAgent resource
Install an agent
This command installs an agent over SSH.

Extending product function
Learn how to extend the function of HCL Launch.
- Plug-ins
  UrbanCode plug-ins provide tools for creating component processes and integrations. IBM UrbanCode provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
  - Running REST commands
    Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
  - Examples of REST API commands
    Many REST and command-line client commands have examples in their help topics. A few more examples using various programming languages and scenarios are provided here. The commands are similar for the server and for the blueprint design server.
  - Authenticating for REST commands
    The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
  - Deploying applications by using REST commands: An example
    The following example describes how to use the REST commands to deploy an application.
  - REST commands for the HCL Launch server
    The following list shows the commands that are available for the HCL Launch server.
    - agentCLI resource
    - agentPool resource
    - application resource
    - applicationProcess resource
      Resources for editing and creating application processes.
    - applicationProcessRequest resource
    - approval/task resource
    - authenticationRealm resource
    - blueprint resource
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - frontendServer resource
    - group resource
    - patternIntegrationProviderCLI resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
      - Install an agent
        This command installs an agent over SSH.
    - status resource
      Resources for creating and retrieving statuses.
    - systemConfiguration resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
    - user resource
    - version resource
    - workflowTrace resource
      Resources for manipulating workflows.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL Launch server. It can be used to find or set properties and to run numerous functions.

Install an agent

This command installs an agent over SSH.

Request

PUT https://{hostname}:{port}
    /cli/sshInstallAgent/installNewAgent?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
name	string	true	Name of the agent resource
host	string	true	Host name or IP address of the system to install the agent on
port	int	true	SSH port of the agent system; the default port is 22
sshUsername	string	true	SSH user name to use to connect to the agent system
sshPassword	string	false	SSH password for the agent system; leave blank to use public key authentication instead
installDir	string	true	Installation directory for the agent
javaHomePath	string	true	Path to Java on the agent system
tempDirPath	string	true	Path to directory to install from on the agent system
webUri	string	false	Introduced in V7.1.0.2. Web socket URI for the Deploy server (e.g. wss://sever:7919).
webProxyUri	string	false	Introduced in V7.1.0.2. Web socket URI for the relay server (e.g. https://relay:20080).
mutualAuth	boolean	false	Specify true to enforce certificate validation for mutual authentication

Table 2. Header parameters
Parameter	Type	Required	Description
Accept	`application/json`	true

Related CLI command: installAgent.