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.
snapshot resource
Get the list of versions in a snapshot

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
    - application resource
    - applicationProcess resource
      Resources for editing and creating application processes.
    - applicationProcessRequest resource
    - approval/task resource
    - authenticationRealm resource
    - blueprint resource
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - frontendServer resource
    - group resource
    - patternIntegrationProviderCLI resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
      - Add a component version to a snapshot
      - Add a status to a snapshot
      - Create a snapshot
        This command creates a snapshot by specifying the components (optional) for the snapshot, rather than taking a snapshot of an environment.
      - Delete a snapshot
      - Get a list of statuses on a snapshot
      - Get information about a snapshot
      - Get inventory changes for application process run with snapshot in environment
      - Get the list of configuration objects in a snapshot
      - Get the list of versions in a snapshot
      - Lock a snapshot's configuration
        This command locks the configuration included in a snapshot. This prevents the snapshot from being affected by any future changes to the relevant configuration and also prevents users from manually changing which configuration the snapshot is using. This cannot be reversed.
      - Lock a snapshot's version list
        This command locks the list of component versions included in a snapshot. This cannot be reversed and prevents any future changes to the list of versions included in the snapshot.
      - Remove a component version from a snapshot
      - Take a snapshot of an environment
    - sshInstallAgent resource
    - status resource
      Resources for creating and retrieving statuses.
    - systemConfiguration resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
    - user resource
    - version resource
    - 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.

Get the list of versions in a snapshot

Request

GET https://{hostname}:{port}
    /cli/snapshot/getSnapshotVersions?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
snapshot	string	true	Name or ID of the snapshot
application	string	false	Name of the application; this value is required if you specify the snapshot name instead of ID

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

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/snapshot/getSnapshotVersions
  ?application=JPetStore&snapshot=mySnapshot"

Related CLI command: getSnapshotVersions.