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.
environment resource
Get the value of a custom property on an environment.

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
      - Add a base resource to an environment
      - Add an environment to a team
      - Create a new environment
      - Create a new environment from template
        This command creates and Environment from a template and attaches it to the specified application.
      - Delete all redundant versions for a component in an environment
        A version is considered redundant if all of its files have been replaced by versions that have been deployed more recently to the same environment.
      - Delete all versions for a component in an environment
      - Delete an environment
      - Delete the environment gate of a given environment
      - Get all artifacts overlapped in the given version
        Get all artifacts that are overlapped by later versions. A version is considered safe to rollback if it does not contain overlapping artifacts. It is risky to roll back a version if that version contains overlapping artifacts. This command applies only to z/OS component versions.
      - Get all base resources for an environment
        This command returns a listing of all resources added as base resources to an environment.
      - Get all of the latest desired inventory for an environment.
        This command returns a JSON array of all of the desired inventory for an environment. It optionally groups the desired inventory by component.
      - Get component environment properties for an environment
        These properties are defined on the component and their values are set on the environment.
      - Get environment property values
      - Get information about an environment
        This command returns a JSON representation of an environment.
      - Get resource tree for an environment
      - Get the compliancy of a given environment
      - Get the environment gate of a given environment
      - Get the latest desired inventory for an environment.
        This command returns a JSON array of all of the desired inventory for an environment.
      - Get the latest snapshot deployed to an environment
      - Get the value of a custom property on an environment.
      - Provision a cloud environment
        This command provisions an instance of an application blueprint and creates an application environment based on that blueprint.
      - Remove a base resource from an environment
      - Remove an environment from a team
      - Removes environment inventory for components with no resources in the enviroment resources.
      - Save the environment gate of a given environment
        Environment gates are JSON objects consisting of operators "OR", "AND", and "NOT", as well as status UUIDs. A valid operator is a JSON Object with a single key corresponding to one of the three operator types, and with a list of operators or UUIDs as its value. A valid gate begins with an enclosing OR operator containing one or more AND operators. AND operators can contain only UUIDs or NOT operators. NOT operators must contain a single UUID which corresponds to a known version or snapshot status.
      - Set a component environment property value
        This command will set a component property value specifically for this environment.
      - Set a property on environment
      - Update an environment
    - 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 the value of a custom property on an environment.

Request

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

Table 1. Request parameters
Parameter	Type	Required	Description
name	string	true	Name of the property
environment	string	true	Name or ID of the environment
application	string	false	Name or ID of the application; this value is required if you specify the environment name instead of ID

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

Related CLI command: getEnvironmentProperty.