Update a component#

Request#

PUT https://{hostname}:{port}
    /cli/component/update?{parameters}
Accept: application/json

Parameter	Type	Required	Description
component	string	true	The name or id of an existing component

Parameter	Type	Required	Description
Accept	application/json	true

This command takes a JSON request string or file. Use the following template for the request:

{
  "cleanupCountToKeep": "Number of most recent versions to 
  keep; omit this parameter to inherit the system settings 
  (Optional)",
  "cleanupDaysToKeep": "Number of days to keep versions; 
  omit this parameter to inherit the system settings 
  (Optional)",
  "defaultVersionType": "The default type to create 
  versions with; valid values are FULL and INCREMENTAL 
  (Optional)",
  "description": "Description (Optional)",
  "importAutomatically": "Specify true to import new 
  versions automatically (Optional)",
  "integrationAgent": "ID of the Agent to use for 
  importing new component versions (Optional)",
  "integrationTag": "Tag name of the Agent to use for 
  importing new component versions (Optional)",
  "properties": [
    {"Source configuration plugin property name": 
  "Property value"},
    "(Optional)"
  ],
  "sourceConfigPlugin": "The name of the source 
  configuration plug-in to use (Optional)",
  "teamMappings": [
    {
      "resourceRoleId": "Id of Resource Type to apply to 
  this team mapping (optional, can specify either this or 
  resourceRoleLabel",
      "resourceRoleLabel": "Name of Resource Type to apply 
  to this team mapping (optional, can specify either this or 
  resourceRoleId",
      "teamId": "ID of a team, either this field or 
  teamLabel are needed to specify a team",
      "teamLabel": "Name of the team to map the 
  environment to, either this field or teamId are needed to 
  specify a team"
    },
    "(Optional)"
  ],
  "templateId": "ID of the template to use (Optional)",
  "templateName": "Name of a template to use; this 
  parameter is ignored if  templateId is specified 
  (Optional)",
  "templateVersion": "Version number of the specified 
  template (Optional)",
  "useVfs": "Boolean (Optional)"
}

Related CLI command: updateComponent.

Parent topic: component resource