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.

Request

PUT https://{hostname}:{port}
  /cli/systemConfiguration
This command takes a JSON request string or file. Use the following template for the request:
{
  "agentAutoLicense": "Specify true to automatically 
  assign licenses to agents",
  "cleanupArchivePath": "The path for archived component 
  versions",
  "cleanupCountToKeep": "The number of component versions 
  to keep",
  "cleanupDaysToKeep": "The number of days component 
  versions are kept",
  "cleanupHourOfDay": "The time when versions are cleaned; 
  the value must be an integer from 0 (midnight) to 23 (11 
  pm)",
  "deployMailHost": "The host name of the mail server that 
  is used for notifications",
  "deployMailPassword": "The user password for sending 
  email notifications",
  "deployMailPort": "The SMTP port that is used by the 
  notifications mail server",
  "deployMailSecure": "Specifies whether the SMTP 
  connection is secure",
  "deployMailSender": "The sender address for email 
  notifications",
  "deployMailUsername": "The user name for sending email 
  notifications",
  "enableInactiveLinks": "Specify true to show links to 
  inactive objects",
  "enablePromptOnUse": "Controls whether user-entered 
  values can be specified at process run time",
  "externalURL": "The URL that agents use to connect to 
  the server",
  "externalUserURL": "The URL that users enter to connect 
  to the server",
  "minimumPasswordLength": "Determines the minimum length 
  for passwords",
  "rclServerUrl": "The host name and port of the license 
  server",
  "repoAutoIntegrationPeriod": "The number of seconds 
  between the times that the server polls components for new 
  versions",
  "requireComplexPasswords": "If selected, passwords must 
  contain at least two of the four character classes and 
  must be at least as long as the specified minimum length"
}

Example JSON request

{
  "minimumPasswordLength": "9",
  "requireComplexPasswords": "true"
}

Related CLI command: setSystemConfiguration.


Feedback