Set a system property

System properties behave like global variables for the server.

Request

PUT https://{hostname}:{port}
    /cli/systemConfiguration/propValue
Accept: {contentType}
Table 1. Header parameters
Parameter Type Required Description
Accept
  • application/json
  • application/yaml
 true
This command takes a JSON request string or file. Use the following template for the request: 
{
  "description": "The description of the property 
  (optional)",
  "isSecure": "Whether the property is secure; the default 
  is the current state of the property, or false if the 
  property is not yet specified (optional)",
  "label": "The label of the property (optional)",
  "name": "Name of the property",
  "value": "Value of the property (optional)"
}

Example response

{
  "id": "f3bec2ee-3f3e-461f-b5b0-e844efafbdbe",
  "name": "System property 1",
  "value": "value001",
  "secure": false
}

Related CLI command: setSystemProperty.