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.
resource resource
Get a resource property

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
      - Autodiscover resource
      - Add a resource to a team
      - Add a tag to a resource
      - Copy a resource into a new parent
        To update a resource's parent with this command, you must specify, at a minimum, the resource path or id, and optionally provide info for the resource template, blueprint, and application.
      - Create a resource
      - Delete a resource
      - Delete a resource property
      - Delete a resource role property
      - Get a resource property
      - Get a resource role property
      - Get information about a resource
        This command returns a JSON representation of a resource, including its security settings.
      - List resource properties
      - List resource role properties
      - List resources
        This command returns a JSONArray representation of all top-level resources, or all children of a specified parent resource.
      - List resources in the recycle bin.
      - List resources that have a specified component version
        This command returns a JSONArray representation of all resources that have the specified component version installed.
      - List the tags on a resource
      - Remove a resource from a team
      - Remove a tag from a resource
      - Restore from recycle bin.
      - Set a property on a resource
      - Set a property on a resource
      - Update a resource
        To update a resource with this command, you must specify all of the existing data for the resource.
      - Update a resource's parent
        To update a resource's parent with this command, you must specify, at a minimum, the resource path or id, and optionally provide info for the resource template, blueprint, and application.
    - 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 resource property

Request

GET https://{hostname}:{port}
    /cli/resource/getProperty?{parameters}
Accept: text/plain

Table 1. Request parameters
Parameter	Type	Required	Description
resource	string	true	ID or path to the resource, such as /ResourceGroup/Agents/Agent1
template	string	false	Name or ID of the resource template (Optional)
blueprintId	string	false	Name or ID of the blueprint (Optional)
application	string	false	Name or ID of the application (Required to look up blueprint by name)
name	string	true	Name of the property

Table 2. Header parameters
Parameter	Type	Required	Description
Accept	`text/plain`	true

Related CLI command: getResourceProperty.