Welcome
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
REST API reference
You can use these REST interfaces to automate tasks.
REST commands for the DevOps Deploy server
The following list shows the commands that are available for the HCL DevOps Deploy (Deploy) server.
calendar resource
Cancel scheduled deployment series
Cancels the entire series for a recurring scheduled deployment.

Release Notes
This section includes what's new, defect fixes, and deprecations and removals in all releases.
System Requirements
This document includes information about the hardware, containers, prerequisite software, supported operating system, and database requirements with component level detail for the HCL DevOps Deploy (Deploy).
Getting Started
Quickly become productive with HCL DevOps Deploy (Deploy).
Installing
A HCL DevOps Deploy (Deploy) installation consists of a Deploy server, a database server, and at least one agent.
Upgrading and Migrating
Stay updated with latest features and functionalities by upgrading HCL DevOps Deploy (Deploy) server, agents, and relays. This section also provides instruction on how to migrate your Deploy instance.
Integrating
HCL DevOps Deploy (Deploy) supports integrations with other IBM® and HCL products, products from others, and certain cloud systems.
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
Managing Security
HCL DevOps Deploy (Deploy) uses a flexible team-based and role-based security model that maps to your organizational structure.
Modeling Software Deployment
Modeling software deployment in HCL DevOps Deploy (Deploy) includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.
Deploying
Learn how to deploy applications in HCL DevOps Deploy (Deploy).
Reporting
Provides several different deployment and security reports.
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- 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.
  - REST commands for the DevOps Deploy server
    The following list shows the commands that are available for the HCL DevOps Deploy (Deploy) server.
    - agentCLI resource
    - agentPool resource
    - application resource
    - applicationPipeline resource
    - applicationProcess resource
    - applicationProcessRequest resource
    - applicationTemplate resource
    - approvalTask resource
    - authenticationRealm resource
    - authorizationRealm resource
    - blueprint resource
    - calendar resource
      - Cancel maintenance blackout
        Cancel the given maintenance blackout. If it is a real event (synthetic=false) in a recurring, only the individual event is canceled. Synthetic events cannot be canceled with this API.
      - Cancel a maintenance blackout series event
        Cancels a single event in the series for a recurring maintenance blackout. (REST API method)
      - Cancel a scheduled deployment series event
        Cancel a single event in the series for a recurring scheduled deployment. (REST API method)
      - Cancel maintenance blackout series
        Cancels the entire series for a recurring maintenance blackout.
      - Cancel scheduled deployment series
        Cancels the entire series for a recurring scheduled deployment.
      - Create a maintenance blackout
        Create a maintenance blackout for the given date range. The date range cannot overlap with any existing maintenance blackout date ranges.
      - Modify maintenance blackout
        Modifies the given maintenance blackout. A date cannot be modified if it has already occurred. For recurring blackouts, only real events (synthetic=false) can be updated. For recurring blackouts, updating the date of the real event also alters the start and duration of future events within each recurrence time interval (day, week, or month).
      - Get maintenance blackout list
        Returns a list of all real and synthetic maintenance blackouts that start or end within the specified range. If no range is provided then all real maintenance blackouts will be returned (synthetic blackouts are not returned as the result would be infinite).
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - create resource
    - delete resource
    - deploymentTrigger resource
      Resources for reading, creating, and deleting deployment triggers.
    - diagnosticsLatency resource
    - environment resource
    - environmentTemplate resource
    - externalApprovalProcess resource
    - frontendServer resource
    - group resource
    - info resource
    - infoAll resource
    - inventory resource
    - javaPackage resource
    - license resource
    - patternIntegrationProviderCLI resource
    - postProcessingScript resource
    - process resource
    - processRequest resource
    - relay resource
    - removeGroupFromTeam resource
    - removeUserFromTeam resource
    - resource resource
    - resourceTemplate resource
    - role resource
    - secretstore resource
    - serverKeystore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - teamsecurity resource
    - update resource
    - user resource
    - vault/appRole resource
    - vault/ldapUser resource
    - version resource
      Resources for manipulating component versions.
    - webhookTemplate resource
    - workflowTrace resource
    - zInventory resource
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) 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.
Troubleshooting and Support
Learn how to troubleshoot some common issues with HCL DevOps Deploy (Deploy).
Security Considerations
You can act to ensure that your installation is secure and set up user access controls.

Cancel scheduled deployment series

Cancels the entire series for a recurring scheduled deployment.

Request

POST https://{hostname}:{port}
    /cli/calendar/cancelScheduledDeploymentSeries?{parameters}

Table 1. Request parameters
Parameter	Type	Required	Description
series	string	true	ID of the series

Related CLI command: cancelScheduledDeploymentSeries.