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.
group resource
Create an empty group
Groups can only be created in Internal Storage, LDAP/Active Directory, and OpenID authorization realms.

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
An 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 Deploy plug-ins provide tools for creating component processes and integrations. HCL 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.
  - Deployment with pre-selected parameters
  - 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
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - authorizationRealm resource
      Resources for working with AuthorizationRealms.
    - blueprint resource
      Resources for working with application blueprints, which map application components to resource templates.
    - calendar resource
    - component resource
      Resources for working with components and for retrieving new component versions.
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
      Resources for reading, creating, and deleting deployment triggers.
    - diagnostics/latency resource
    - environment resource
      Resources for creating, editing, and provisioning environments.
    - environmentTemplate resource
    - externalApprovalProcess resource
      Resources for editing and creating generic processes.
    - frontendServer resource
    - group resource
      - Add a user to a group
      - Create an empty group
        Groups can only be created in Internal Storage, LDAP/Active Directory, and OpenID authorization realms.
      - Delete a group
      - Import a group
        Specify the details about the group in the JSON file. You can list one or more members of the new group in the 'users' array, or you can leave the array blank to create an empty group. Groups can be created only in Internal Storage authorization realms.
      - List the members of a group
      - List the members of a group (detailed)
        This command lists the members of a group, including IDs and e-mail addresses.
      - Remove a user from a group
    - inventory resource
      Resource for managing inventory.
    - javaPackage resource
    - license resource
    - llm resource
    - patternIntegrationProviderCLI resource
      Resources for creating, editing, and deleting connections to the blueprint designer.
    - plugin resource
    - postProcessingScript resource
      Resources for working with post processing scripts.
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
      Resource for working with resources.
    - resourceTemplate resource
      Resource for working with resource templates.
    - role resource
      Resources for creating, editing, and deleting roles.
    - secretstore resource
      Resources for managing secret stores.
    - serverKeystore resource
    - snapshot resource
      Resources for creating snapshots.
    - sshInstallAgent resource
      Resource for installing an agent over SSH.
    - status resource
    - systemConfiguration resource
    - tags resource
      Resources for listing tags.
    - team resource
    - teamsecurity resource
      Resources for adding users and groups to teams and for creating authorization tokens.
    - user resource
      Resources for creating, editing, and deleting users.
    - vault/appRole resource
    - vault/certificate resource
    - vault/ldapUser resource
    - version resource
    - 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.
- DevOps Deploy MCP server
  The Model Context Protocol (MCP) server of HCL DevOps Deploy (Deploy) enables AI models (like LLMs) to utilize specialized Deploy MCP tools. By using these tools, you can run crucial deployment tasks on an MCP client simply through chat prompts.
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.

Create an empty group

Groups can only be created in Internal Storage, LDAP/Active Directory, and OpenID authorization realms.

Request

PUT https://{hostname}:{port}
    /cli/group/create?{parameters}
Accept: {contentType}

Table 1. Request parameters
Parameter	Type	Required	Description
group	string	true	Name of the group
description	string	false	Description of the group
authorizationRealm	string	true	Name of the authorization realm. If an OpenID realm, the group name must be properly identified and will not be validated against the OpenID Provider.

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

Example response

{
  "id": "a5be904f-d65a-41ae-9bfd-0a0384c90eeb",
  "name": "group1",
  "enabled": true
}

Related CLI command: createGroup.