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.
systemConfiguration resource
Get logging configuration
Returns the current logging configuration. The output is suitable for input to the setLoggingConfig command.

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
    - 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
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - diagnostics/latency resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - postProcessingScript resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
      - Get logging configuration
        Returns the current logging configuration. The output is suitable for input to the setLoggingConfig command.
      - Get logging configuration
        Sets the current logging configuration. The output of the getLoggingConfig command is acceptable input. To support this, several elements of the input template are optional and ignored, but must be valid if supplied. Regardless, the input is still subject to the constraints reported by these ignored elements. For example, objects for which 'deletable' is false must be present in the input as their absense is interpreted as a request for deletion.
      - Get the value of a system property
      - List system configuration properties
        These properties are available on the System Settings page of the server.
      - List system properties
        This command returns a JSONArray representation of the system properties, which behave like global variables for the server.
      - Set a system property
        System properties behave like global variables for the server.
      - Update the system configuration
        Use this command to set any of the properties on the System Settings page of the server. The JSON template for this command lists all of the properties that you can change, but you can omit properties that you are not changing.
    - tags resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
      Resources for adding users and groups to teams and for creating authorization tokens.
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
      Resources for manipulating workflows.
    - 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.

Get logging configuration

Returns the current logging configuration. The output is suitable for input to the setLoggingConfig command.

Request

GET https://{hostname}:{port}
    /cli/systemConfiguration/loggingConfig
Accept: {contentType}

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

Related CLI command: getLoggingConfig.