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.
applicationPipeline resource
Get an application pipeline definition

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
      Resources for creating, editing, and deleting agents.
    - agentPool resource
    - application resource
    - applicationPipeline resource
    - applicationProcess resource
    - applicationProcessRequest resource
    - applicationTemplate resource
      Resources for working with application templates.
    - approval/task resource
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
      Resources for working with components and for retrieving new component versions.
    - componentProcess resource
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
    - deploymentTrigger resource
    - diagnostics/latency resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - postProcessingScript resource
      Resources for working with post processing scripts.
    - process resource
    - processRequest resource
      Resources for working with generic process requests.
    - relay resource
      Resource for relay cli
    - resource resource
      Resource for working with resources.
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
      Resources for manipulating workflows.
    - zInventory 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 an application pipeline definition

Request

GET https://{hostname}:{port}
    /cli/applicationPipeline/info?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
application	string	false	Application name or id. Required if pipeline specified by name.
pipeline	string	true	Pipeline name or id.

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

Related CLI command: getApplicationPipeline.