Home
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
You can use these REST interfaces to automate tasks.
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
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins 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
  You can use these REST interfaces to automate tasks.
  - 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.
  - 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
      Resources for requesting application processes.
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - calendar resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - postProcessingScript resource
    - process resource
      Resources for editing and creating generic processes.
    - processRequest resource
      Resources for working with generic process requests.
    - relay resource
    - resource resource
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
      - Install an agent
        This command installs an agent over SSH.
    - status resource
    - systemConfiguration resource
    - tags resource
      Resources for listing tags.
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
- 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.
- Process-as-code feature
  Programmatically manage processes with PAC language.

Install an agent

This command installs an agent over SSH.

Request

POST 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	Web socket URI for the Deploy server (e.g. wss://server:7919).
webProxyUri	string	false	Web socket URI for the relay server (e.g. https://relay:20080).
serverHost	string	false	Deprecated. Host name or IP address of the Deploy server or agent relay that the agent connects to
serverPort	int	false	Deprecated. Agent communication port of the Deploy server (7918) or agent relay (7916) the agent connects to
relayWebPort	int	false	Deprecated. HTTP proxy port of the agent relay, if the agent is connecting to an agent relay; the default is 20080
mutualAuth	boolean	false	Deprecated. 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.