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.
calendar resource
Get a list of all maintenance blackouts
This command returns a list of all maintenance blackouts that start or end within the specified range. If no range is provided then all maintenance blackouts will be 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
    - applicationProcessRequest resource
    - applicationTemplate resource
    - approval/task resource
    - authenticationRealm resource
    - calendar resource
      - Create a maintenance blackout for the given date range
        This command creates a maintenance blackout for the given date range. The date range cannot overlap with any existing maintenance blackout date ranges.
      - Delete the given maintenance blackout
      - Modify time range for a given maintenance blackout
        This command modifies the time range for the given maintenance blackout. A date cannot be modified if it has already occurred.
      - Get a list of all maintenance blackouts
        This command returns a list of all maintenance blackouts that start or end within the specified range. If no range is provided then all maintenance blackouts will be returned.
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
    - teamsecurity resource
    - user 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 a list of all maintenance blackouts

This command returns a list of all maintenance blackouts that start or end within the specified range. If no range is provided then all maintenance blackouts will be returned.

Request

GET https://{hostname}:{port}
    /cli/calendar/maintenanceBlackout?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
rangeStart	string	false	Start time of the search range. In the format MM-dd-yyyy-HH:mm or in milliseconds since the UNIX epoch time. (Optional) If rangeStart is provided then rangeEnd must also be provided
rangeEnd	string	false	End time of the search range. In the format MM-dd-yyyy-HH:mm or in milliseconds since the UNIX epoch time. (Optional)

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

Related CLI command: getMaintenanceBlackouts.