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.
externalApprovalProcess resource
Resources for working with external approval process.
Get information about an external approval process

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
      Resources for working with agents.
    - agentPool resource
      Resources for working with agent pools.
    - application resource
      Resources for working with applications.
    - applicationPipeline resource
      Resources for working with application pipeline.
    - applicationProcess resource
      Resources for working with application process.
    - applicationProcessRequest resource
      Resources for working with application process request.
    - applicationTemplate resource
      Resources for working with application templates.
    - approval/task resource
      Resources for working with approval tasks.
    - authenticationRealm resource
      Resources for working with authentication realms.
    - authorizationRealm resource
      Resources for working with authorization realms.
    - blueprint resource
      Resources for working with blueprints.
    - calendar resource
      Resources for working with calendar.
    - component resource
      Resources for working with components and for retrieving new component versions.
    - componentProcess resource
      Resources for working with component process.
    - componentProcessRequest resource
      Resources for working with component process request.
    - componentTemplate resource
      Resources for working with component template.
    - deploymentTrigger resource
      Resources for working with deployment trigger.
    - diagnostics/latency resource
      Resources for working with database latency.
    - environment resource
      Resources for working with environments.
    - environmentTemplate resource
      Resources for working with environment templates.
    - externalApprovalProcess resource
      Resources for working with external approval process.
    - frontendServer resource
      Resources for working with frontend servers.
    - group resource
      Resources for working with user groups.
    - inventory resource
      Resources for working with inventory.
    - javaPackage resource
      Resources for working with Java packages.
    - license resource
      Resources for working with licenses.
    - login resource
      Resources for working with user login.
    - postProcessingScript resource
      Resources for working with post processing script.
    - process resource
      Resources for working with processes.
    - processRequest resource
      Resources for working with process request.
    - relay resource
      Resources for working with relays.
    - resource resource
      Resources for working with Deploy resources.
    - resourceTemplate resource
      Resources for working with Deploy resource templates.
    - secretstore resource
      Resources for working with secret store.
    - serverKeystore resource
      Resources for working with server keystore.
    - snapshot resource
      Resources for working with snapshots.
    - sshInstallAgent resource
      Resources for working with agent installation over SSH.
    - status resource
      Resources for working with statuses.
    - systemConfiguration resource
      Resources for working with system configuration.
    - tags resource
      Resources for working with tags.
    - team resource
      Resources for working with teams.
    - tokens resource
      Resources for working with tokens.
    - user resource
      Resources for working with Deploy user.
    - users resource
      Resources for working with users.
    - vault/appRole resource
      Resources for working with Vault AppRole.
    - vault/ldapUser resource
      Resources for working with Vault LDAP user.
    - version resource
      Resources for working with component version.
    - webhookTemplate resource
      Resources for working with webhook templates.
    - workflowTrace resource
      Resources for working with workflow.
    - zInventory resource
      Resources for working with 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.
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.

Get information about an external approval process

Request

GET https://{hostname}:{port}
    /cli/externalApprovalProcess/info?{parameters}
Accept: {contentType}

Table 1. Request parameters
Parameter	Type	Required	Description
externalApprovalProcess	string	true	Name or ID of the external approval process

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

Related CLI command: getExternalApprovalProcess.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.