Home
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
REST commands for the HCL Launch server
The following list shows the commands that are available for the HCL Launch server.
environment resource
Resources for creating, editing, and provisioning environments.
Delete all versions for a component in an environment

Extending product function
Learn how to extend the function of HCL Launch.
- Plug-ins
  UrbanCode plug-ins provide tools for creating component processes and integrations. IBM UrbanCode 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
  The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
  - 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 and for the blueprint design 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
      Resources for working with agent pools.
    - application resource
      Resources for working with applications, including manipulating the components and environments that are associated with applications.
    - applicationProcess resource
      Resources for editing and creating application processes.
    - applicationProcessRequest resource
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - blueprint resource
      Resources for working with application blueprints, which map application components to resource templates.
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
      Resources for reading, creating, and deleting deployment triggers.
    - environment resource
      Resources for creating, editing, and provisioning environments.
      - Add a base resource to an environment
      - Add an environment to a team
      - Create a new environment
      - Create a new environment from template
        This command creates and Environment from a template and attaches it to the specified application.
      - Delete all redundant versions for a component in an environment
        A version is considered redundant if all of its files have been replaced by versions that have been deployed more recently to the same environment.
      - Delete all versions for a component in an environment
      - Delete an environment
      - Get all artifacts overlapped in the given version
        Get all artifacts that are overlapped by later versions. A version is considered safe to rollback if it does not contain overlapping artifacts. It is risky to roll back a version if that version contains overlapping artifacts. This command applies only to z/OS component versions.
      - Get all base resources for an environment
        This command returns a listing of all resources added as base resources to an environment.
      - Get all of the latest desired inventory for an environment.
        This command returns a JSON array of all of the desired inventory for an environment. It optionally groups the desired inventory by component.
      - Get component environment properties for an environment
        These properties are defined on the component and their values are set on the environment.
      - Get environment property values
      - Get information about an environment
        This command returns a JSON representation of an environment.
      - Get resource tree for an environment
      - Get the latest desired inventory for an environment.
        This command returns a JSON array of all of the desired inventory for an environment.
      - Get the latest snapshot deployed to an environment
      - Get the value of a custom property on an environment.
      - Provision a cloud environment
        This command provisions an instance of an application blueprint and creates an application environment based on that blueprint.
      - Remove a base resource from an environment
      - Remove an environment from a team
      - Set a component environment property value
        This command will set a component property value specifically for this environment.
      - Set a property on environment
      - Update an environment
    - environmentTemplate resource
      Resources for working with environment templates.
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - group resource
    - inventory resource
      Resource for managing inventory.
    - process resource
    - processRequest resource
      Resources for working with generic process requests.
    - relay resource
      Resource for relay cli
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
      Resources for changing system properties and for updating system configuration settings.
    - tags resource
    - team resource
    - teamsecurity resource
      Resources for adding users and groups to teams and for creating authorization tokens.
    - user resource
    - version resource
      Resources for manipulating component versions.
    - workflowTrace resource
      Resources for manipulating workflows.
- 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.

Delete all versions for a component in an environment

Request

DELETE https://{hostname}:{port}
    /cli/environment/{environmentId}/versions/{componentId}?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
deleteVersions	boolean	false	If set to true, versions will be removed from the environment's inventory.

Table 2. URL parameters
Parameter	Type	Required	Description
environmentId	string	true
componentId	string	true	Name or ID of the component

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

Related CLI command: deleteAllDesiredInventoryVersions.