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.
agentCLI resource
Resources for creating, editing, and deleting agents.
Get a count of agents along with status
Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission

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.
      - Set an agent unavailable
      - Get an agent maintenance task
      - Get agent maintenance tasks
      - Add a tag to an agent
      - Add an agent to a team
      - Add public key pin for a server host to an agent
        This command requests the agent add a public key pin for a server host, but does not wait for or report the result. The returned maintenance task can be used to query the result.
      - Add public key pins for server hosts to an agents in bulk
        This command requests a set of agent add a public key pin for a server host, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Delete a tag from an agent
      - Delete an agent
        Agents should be shut down before deletion.
      - Get information about all agents
      - Get information about an agent
        This command returns a JSON representation of an agent.
      - Get list of managed Java installations
        This command returns a list of managed Java installations for an agent.
      - Get list of managed Java installations in bulk
        This command returns a list of managed Java installations for a set of agents. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Get the value of a property on an agent
      - Install Java packages as a new managed Java installations in bulk
        This command request a set of agents install Java, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Install a Java package as a new managed Java installation
        This command requests the agent install Java, but does not wait for or report the result. The returned maintenance task can be used to query the result.
      - List all tags on an agent
      - Remove a property from an agent
      - Remove an agent from a team
      - Remove public key pin for a server host from an agent
        This command requests the agent remove a public key pin for a server host, but does not wait for or report the result. The returned maintenance task can be used to query the result.
      - Remove public key pins for server hosts from agents in bulk
        This command requests a set of agent remove a public key pin for a server host, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Rename an agent
        Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.
      - Restart an agent
      - Return high watermarks for agent usage
      - Get a count of agents along with status
        Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission
      - Set a property on a agent
      - Set the configured JAVA_HOME of agents in bulk
        This command requests a set of agents set JAVA_HOME, but does not wait for or report the results. Each new JAVA_HOME will not take effect until the respective agent is restarted. The returned maintenance tasks can be used to query the results.Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Set the configured JAVA_HOME of an agent
        This command requests the agent set JAVA_HOME, but does not wait for or report the result. The new JAVA_HOME will not take effect until the agent is restarted. The returned maintenance task can be used to query the result.
      - Shut down an agent
      - Test the connection from an agent to the server
      - Uninstall a managed Java installation
        This command requests the agent uninstall Java, but does not wait for or report the result. If an installation is the active JAVA_HOME or configured as JAVA_HOME, that installation is not removed.
      - Uninstall a managed Java installations in bulk
        This command requests a set of agents uninstall Java, but does not wait for or report the result. If an installation is the active JAVA_HOME or configured as JAVA_HOME, that installation is not removed. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
      - Update agent settings
      - Upgrade an agent
        The agent will be upgraded to the agent version corresponding with the server version.
    - 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
    - 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.

Get a count of agents along with status

Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission

Request

GET https://{hostname}:{port}
    /cli/agentCLI/statuses
Accept: {contentType}

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

Related CLI command: getAgentStatuses.