List system configuration properties#

These properties are available on the System Settings page of the server.

Request#

GET https://{hostname}:{port}
    /cli/systemConfiguration
Accept: application/json

Parameter Type Required Description
Accept application/json true  

Example response#

{
    "vendorName": "ibm",
    "externalURL": "https://192.168.252.157:8443",
    "externalUserURL": "https://192.168.252.157:8443",
    "repoAutoIntegrationPeriod": 300,
    "deployMailHost": "smtp.example.com",
    "deployMailPassword": "****",
    "deployMailPort": 25,
    "deployMailSecure": false,
    "deployMailSender": "sender@example.com",
    "deployMailUsername": "username",
    "snapshotDaysToKeep": -1,
    "cleanupHourOfDay": 0,
    "cleanupDaysToKeep": 15,
    "cleanupCountToKeep": 4,
    "cleanupArchivePath": "",
    "historyCleanupHour": 1,
    "historyCleanupMinute": 0,
    "historyCleanupDaysToKeep": 730,
    "historyCleanupDuration": 23,
    "historyCleanupEnabled": false,
    "auditLogReadEntriesEnabled": true,
    "auditLogCleanupEnabled": false,
    "auditLogCleanupHour": 1,
    "auditLogCleanupMinute": 0,
    "auditLogRetentionLength": 30,
    "enableInactiveLinks": false,
    "enablePromptOnUse": false,
    "enableAllowFailure": false,
    "validateAgentIp": false,
    "skipCollectPropertiesForExistingAgents": false,
    "requireComplexPasswords": false,
    "minimumPasswordLength": 0,
    "enableUIDebugging": false,
    "messageOfTheDay": "",
    "isCreateDefaultChildren": false,
    "requireCommentForProcessChanges": false,
    "requireProcessPromotionApproval": false,
    "failProcessesWithUnresolvedProperties": true,
    "enforceDeployedVersionIntegrity": true,
    "copyToCodestation": true,
    "discoveryExpiry": 300,
    "configureExpiry": 43200,
    "importExpiry": 7200,
    "pluginStepExpiry": 86400,
    "useDefaultATRIfNotSpecified": false,
    "safeEditEnabled": false,
    "licenseServerUrl": "",
    "licenseMode": "UNLICENSED",
    "agentAutoLicenseType": "NONE",
    "defaultLocale": "en_US",
    "defaultSnapshotLockType": "ALL",
    "envCompPropsOverrideEnvProps": false
}

Related CLI command: getSystemConfiguration.

Parent topic: systemConfiguration resource