- URL:
- https://<root>/system/properties/update
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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 |
|---|---|
| The JSON object containing the system properties to be added or updated. Example |
| The response format. The default response is Values: |
System properties
| Parameter | Details |
|---|---|
| Sets the timeout (in seconds) for the start-up of containers during the upgrade process. The default value is 900. |
| Specifies which files are allowed to be uploaded through the file upload API by identifying the allowable extensions. It is a list of comma-separated extensions without dots. If this property is not specified, a default list is used. Default list: |
| Introduced at 11.0. When set as Values: |
| Introduced at 11.2. Specifies the URL to use for the ArcGIS Online Map Viewer preview link that opens a service in Map Viewer. |
| Introduced at 11.2. Modifies the text to use for the ArcGIS Online Map Viewer preview link. |
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:
{
"containerStartUpTimeoutSeconds": 900,
"allowGPAndExtensionPublishingToPublishers": true
}The following is a sample POST request that demonstrates updating the deployment's system properties to include the arcgis.com.map.url and arcgis.com.map.text properties:
POST /<context>/admin/system/properties/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
properties={
"containerStartUpTimeoutSeconds": 900,
"allowGPAndExtensionPublishingToPublishers": true,
"arcgis.com.map.url": "https://organization.example.com/<context>/apps/mapviewer/index.html",
"arcgis.com.map.text": "My Orgainzation's Map Viewer"
}&f=json&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
{"status": "success"}