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.
resource resource
Update a resource
To update a resource with this command, you must specify all of the existing data for the resource.

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
      Resources for working with applications, including manipulating the components and environments that are associated with applications.
    - applicationPipeline resource
    - applicationProcess resource
    - applicationProcessRequest resource
      Resources for requesting application processes.
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
    - environment resource
      Resources for creating, editing, and provisioning environments.
    - environmentTemplate resource
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - 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
      - Autodiscover resource
      - Add a resource to a team
      - Add a tag to a resource
      - Copy a resource into a new parent
        To update a resource's parent with this command, you must specify, at a minimum, the resource path or id, and optionally provide info for the resource template, blueprint, and application.
      - Create a resource
      - Delete a resource
      - Delete a resource property
      - Get a resource property
      - Get information about a resource
        This command returns a JSON representation of a resource, including its security settings.
      - List resource properties
      - List resources
        This command returns a JSONArray representation of all top-level resources, or all children of a specified parent resource.
      - List resources that have a specified component version
        This command returns a JSONArray representation of all resources that have the specified component version installed.
      - List the tags on a resource
      - Remove a resource from a team
      - Remove a tag from a resource
      - Set a property on a resource
      - Update a resource
        To update a resource with this command, you must specify all of the existing data for the resource.
      - Update a resource's parent
        To update a resource's parent with this command, you must specify, at a minimum, the resource path or id, and optionally provide info for the resource template, blueprint, and application.
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
      Resources for manipulating component versions.
    - 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.

Update a resource

To update a resource with this command, you must specify all of the existing data for the resource.

Request

PUT https://{hostname}:{port}
    /cli/resource/update?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
resource	string	true	ID or path to the resource, such as /ResourceGroup/Agents/Agent1
template	string	false	Name or ID of the resource template (Optional)
blueprintId	string	false	Name or ID of the blueprint (Optional)
application	string	false	Name or ID of the application (Required to look up blueprint by name)

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

This command takes a JSON request string or file. Use the following template for the request:

{
  "agent": "Name or ID of an agent to use for automation 
  (Optional)",
  "agentPool": "Name or ID of an agent pool to use for 
  automation (Optional)",
  "component": "Name or ID of a component to associate 
  with the resource (Optional)",
  "componentTag": "Name or ID of a component tag to 
  associate with the resource; any components with that tag 
  can be deployed to this resource (Optional)",
  "description": "Description",
  "impersonationForce": "Specify true to prevent children 
  or steps from specifying their own impersonation settings 
  (Optional)",
  "impersonationGroup": "Group for default impersonation 
  (Optional)",
  "impersonationPassword": "Password for default 
  impersonation. Agents running on Linux and Unix machines 
  will ignore this value (Optional)",
  "impersonationUseSudo": "Specify true to use the sudo 
  command for impersonation. Agents running on Windows 
  machines will ignore this value (Optional)",
  "impersonationUser": "User name for default 
  impersonation (Optional)",
  "name": "Name for the new resource; leave blank to 
  inherit the name from an agent, pool, or role",
  "parent": "ID or path to parent resource; leave blank to 
  create a root resource (Optional)",
  "role": "Name or ID of a resource role to associate with 
  the agent; if this resource is for a component, specify 
  the component name instead (Optional)",
  "roleProperties": {"Property name": "Property value 
  (Optional)"}
}

Example JSON request

{
  "name": "New resource name",
  "description": "An updated resource",
}

Related CLI command: updateResource.