System properties configuration

Edit System Properties Configuration settings for the system.

Request

Security

Table 1. Roles capable of executing the System Properties Configuration API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/systemPropertiesConfiguration.adm HTTP/1.1 Host:{manager.dsnet}

Curl method

Edit online

curl -u {admin}:{password} -k "https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/systemPropertiesConfiguration.adm"

Parameters

Edit online

Table 2. Request Parameters for System Properties Configuration (systemPropertiesConfiguration) API method
Parameter	Type	Usage	Description
coreShutdownTimeout	Long	Optional	Time in milliseconds specifies how long the system process will attempt to stop gracefully when requested to do so. DNS compliant names
rebuilderAgentHungInterval	Long	Optional	Time in milliseconds specifies how long the rebuilder agent will wait before reporting that it has not made progress. Toggles whether new vaults created will be container vaults by default
processStatusThreshold	Integer	Optional	Time in minutes specifies how long all devices will wait before generating process down incidents.
slicestorUnresponsivenessThreshold	Integer	Optional	Time in minutes specifies how long Slicestors will wait before unresponsiveness incidents.
ntpSyncThreshold	Integer	Optional	Time in minutes specifies how long all devices will wait before generating NTP sync incidents.
defaultReallocationRateLimitEnabled	Boolean	Optional	Indicates rate limiting should be enabled by default for future reallocation activities
defaultReallocationRateLimitMB	Integer	Optional	Initial rate limit (in MB/s) to be used for future reallocation activities
accesserApplicationEnabled	Boolean	Optional	Indicates Accesser® Application will be used on this system. This will allow anonymous access to two APIs containing what might be considered sensitive information.
csrfpEnabled	Boolean	Optional	Enable/Disable CSRF Protection on the manager UI and REST API
csrfpBypassEnabled	Boolean	Optional	Allow bypass of CSRF Protection based on the presence of a specified HTTP request header
csrfpBypassHeaderName	String	Optional	When CSRF Protection bypass is enabled, the name of the header which will be checked to allow bypass
csrfpBypassHeaderValue	String	Optional	When CSRF Protection bypass is enabled, the expected value of the header which will be checked to allow bypass.
preferredIpFamily	String	Optional	Preferred Ip Family. Allowed values are [ipv4,ipv6].
bucketReadACLMode	String	Optional	Bucket read ACL mode. Allowed values are [readAndListing, listingOnly]. Read and Listing when granted on a bucket will grant read and list object permissions, where listingOnly is more restricted ACL allows to only list objects.
defaultStorageEngine	String		Default Storage Engine. Allowed values are: file, packed, zone, and systemDefault.

Response

Edit online

On success, the default JSON example response is returned.

However, on failure, one of two responses is returned as shown in JSON response example.

JSON response example

Edit online

The following example is identical to the default JSON failure response, and is returned if there's a simple error.

{
"responseStatus":"fail",
"responseHeader": {
    "now":1588369433692,
    "status":"fail",
    "requestId":"XqyYGQqMZFgAAFKxEFQAAACN"
  },
"responseData": {
    "errors":[
        {
           "field":"accessPoolIds",
           "code":"accessPoolIds.invalid",
           "message":"An access pool with the id 987654321 could not be found"
        },
        {
           "field":"accessPoolIds",
           "code":"accessPoolIds.invalid",
           "message":"An access pool with the id 123456789 could not be found"
        }
     ]
  }
}

The following JSON might be returned if there are more complex validation errors enabling container mode. Each object in the validationErrors array has a category, rule, and an array of objects that are violating the rule, if necessary. Inside the "objects" array are details of each object that is violating the rule. For instance in the above JSON, there is an access pool (id=8) that has an improper API type. All of these errors must be resolved before container mode can be enabled.

{
   "responseStatus": "fail",
   "responseHeader": {
     "now": 1465840430014,
     "status": "fail",
     "requestId": null
   },
   "responseData": {
     "validationErrors": [
       {
         "category": "Vault Existence",
         "rule": "Only service or management vaults may exist",
         "objects": []
       },
       {
         "category": "API",
         "rule": "access pool(s) must change its API type to 'Cloud Storage Object'",
         "objects": [
           {
             "type": "accessPool",
             "id": 8,
             "name": "Access Pool 3"
           }
         ]
       },
       {
         "category": "Mirror",
         "rule": "Container Mode not supported on dsNets with mirrors",
         "objects": []
       }
     ],
     "migrationErrors": []
   }
 }