Set a property on a component

Request

PUT https://{hostname}:{port}
    /cli/component/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: 
{
  "component": "Name or ID of the component",
  "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": "3702f391-09e1-4550-903a-d5ae286c94aa",
  "name": "Prop1",
  "value": "value1",
  "secure": false
}

Related CLI command: setComponentProperty.