Home
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.
version resource
Delete a version from a component

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
      Resources for creating, editing, and deleting agents.
    - agentPool resource
    - application resource
      Resources for working with applications, including manipulating the components and environments that are associated with applications.
    - applicationPipeline resource
    - applicationProcess resource
    - applicationProcessRequest resource
      Resources for requesting application processes.
    - applicationTemplate resource
      Resources for working with application templates.
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - diagnostics/latency resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - license resource
    - login resource
    - postProcessingScript resource
    - process resource
      Resources for editing and creating generic processes.
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
      Resource for working with resource templates.
    - secretstore resource
    - serverKeystore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
      Resources for listing tags.
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
      - Add a link on a version
        This command adds an external link on the specified component version.
      - Add a link on a version
        This command adds an external link on the specified component version.
      - Add a status to a version
      - Archive the given versions of a component
      - Copy a component version with all of its properties
        Do not use the keywords latest, latestVersion, or newest as the version name. Artifacts are not copied to the created component version.
      - Create a component version
        Do not use the keywords latest, latestVersion, or newest as the version name.
      - Create multiple component versions
        Do not use the keywords latest, latestVersion, or newest as the version name.
      - Delete a component version property
      - Delete a version from a component
      - Download the artifacts of a component version
        This command exports the artifacts of a component version into an archive file.
      - Get a link on a component version
      - Get a version ID
      - Get the list of artifacts for a version
      - List links on a version
        This command lists all links that are associated with a specified component version.
      - List the properties on a component version
      - List the version property definitions for a component
        These properties are available to each version of the component.
      - Mark a version as completed importing
        Mark a version as completed importing so it is available for use in deployments
      - Remove a link from a version
      - Remove a link from a version
      - Remove a status from a version
      - Restore artifacts of an archived version
        Restore Artifacts of an archived version
      - Set a property on a component version
    - webhookTemplate resource
    - workflowTrace resource
    - zInventory resource
      Resources for manipulating Z inventory.
- 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.

Delete a version from a component

Request

PUT https://{hostname}:{port}
    /cli/version/deleteVersion?{parameters}
Accept: {contentType}

Table 1. Request parameters
Parameter	Type	Required	Description
component	string	false	Name or ID of the component
version	string	true	Name or ID of the version(s) to be deleted. This option can be repeated to delete multiple versions.

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

Example

curl -k -u jsmith:passwd 
   
  "https://deployserver.example.com:8443/cli/version/deleteVersion
  ?component=MyComponent&version=1.0" -X PUT

Related CLI command: deleteVersion.