- URL:https://<root>/system/properties/update(POST only)
- Required Capability:Default administrator role | Security and infrastructure
- Version Introduced:10.9
Description
The update operation modifies the system properties for an ArcGIS Enterprise on Kubernetes deployment. When using this operation, all current system properties must be passed through in the request, including both the updated and preexisting property values. The current properties can be retrieved from the JSON view of the properties resource and used as input for this operation's properties parameter. Only new system properties added to the JSON object, or properties with updated values, will be modified by the operation.
Request parameters
Parameter | Details |
---|---|
properties | The JSON object containing the system properties to be added or updated. Note:Currently, no system properties can be updated. |
f | The response format. The default response is html. Values: html | json | pjson |
System properties
Parameter | Details |
---|---|
versionManifestURL | The URL to the version manifest used in the upgrade process. Do not modify this property. |
containerStartUpTimeoutSeconds | The timeout (in seconds) for the start-up of containers during the upgrade process. The default value is 900. |
Example usage
Before calling this operation, gather the current system properties configured for the deployment from the properties resource. The JSON view of the resource is demonstrated below. These properties will be passed in with new properties, or modified values, in the properties parameter:
{
"versionManifestURL": "https://version-manifest.s3-us-west-2.amazonaws.com/versionManifestDev.dat",
"containerStartUpTimeoutSeconds": 900
}
The following is a sample POST request that demonstrates updating the deployment's system properties to include the versionManifestURL and containerStartUpTimeoutSeconds properties:
POST /context/admin/system/properties/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
properties={
"versionManifestURL": "https://version-manifest.s3-us-west-2.amazonaws.com/esriManifestDev.dat",
"containerStartUpTimeoutSeconds": 900
}&f=json&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e
JSON Response example
{"status": "success"}