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.
javaPackage resource
Get the preferred Java package compatible with an agent.
This command gets the preferred Java package compatible with the platform of an agent. If no such package is currently defined, then no content is returned.

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
      - Delete a java package.
      - Get Java packages compatible with a specific agent.
      - Get available Java packages.
      - Get available Java packages.
      - Get the preferred Java package compatible with an agent.
        This command gets the preferred Java package compatible with the platform of an agent. If no such package is currently defined, then no content is returned.
      - Get the preferred Java packages compatible with agents in bulk.
        This command gets the preferred Java packages compatible with the platforms of a set of agents. If no such package is currently defined for an agent, then no content is returned for the respective sub-request. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Sets a package as preferred for its OS and CPU, unsetting the previously preferred package if there was one.
      - Unsets a package as preferred for its OS and CPU, leaving no package as preferred.
      - Upload a Java package.
    - 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
    - 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.

Get the preferred Java package compatible with an agent.

This command gets the preferred Java package compatible with the platform of an agent. If no such package is currently defined, then no content is returned.

Request

GET https://{hostname}:{port}
    /cli/javaPackage/getPreferredJavaPackageForAgent?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
agent	string	true	Name or ID of the agent

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

Related CLI command: getPreferredJavaPackageForAgent.