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.
agentCLI resource
Rename an agent
Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.

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
      - Get agent maintenance tasks
      - Get agent maintenance tasks
      - Add a tag to an agent
      - Add an agent to a team
      - Delete a tag from an agent
      - Delete an agent
        Agents should be shut down before deletion.
      - Get information about all agents
      - Get information about an agent
        This command returns a JSON representation of an agent.
      - Get the value of a property on an agent
      - Install a java package as a new managed java installation
        This command requests the agent install java, but does not wait for or report the result. The returned maintenance task can be used to query the result.
      - List all tags on an agent
      - Remove a property from an agent
      - Remove an agent from a team
      - Rename an agent
        Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.
      - Restart an agent
      - Return high watermarks for agent usage
      - Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission
      - Set a property on a agent
      - Set the configure JAVA_HOME of an agent
        This command requests the agent set JAVA_HOME, but does not wait for or report the result. The new JAVA_HOME will not take effect until the agent is restarted.
      - Shut down an agent
      - Test the connection from an agent to the server
        The agent's HTTP connections to the server will be tested.
      - Uninstall managed java installation
        This command requests the agent uninstall java, but does not wait for or report the result. If an installation is the active JAVA_HOME or configured as JAVA_HOME, that installation is not removed.
      - Update agent settings
      - Upgrade an agent
        The agent will be upgraded to the agent version corresponding with the HCL Launch server version.
    - agentPool resource
    - application resource
    - applicationProcess resource
    - applicationProcessRequest resource
      Resources for requesting application processes.
    - applicationTemplate resource
    - approval/task resource
    - authenticationRealm resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
    - teamsecurity resource
    - user 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.

Rename an agent

Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.

Request

PUT https://{hostname}:{port}
    /cli/agentCLI/rename?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
agent	string	true	Name or ID of the agent to rename
name	string	true	The new name for the agent

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

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/agentCLI/rename?
  agent=MyAgent&name=NewAgentName" -X PUT

Related CLI command: forceRenameAgent.