System properties

URL:: https://<root>/system/properties
Methods:: GET
Operations:: Update Properties
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.

Manage licenses Security and infrastructure Servers Organization website

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 generateToken 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.

Learn how to generate a token

Description

The properties resource lists system properties that have been modified to control the ArcGIS Enterprise portal environment.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Property	Details
`containerStartUpTimeoutSeconds`	Sets the timeout (in seconds) for the start-up of containers during the upgrade process. The default value is 900.
`uploadFileExtensionAllowedList`	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. Note Updating the list overrides the default list completely. This means that if you set this property to a subset of the default list, only those items in the subset will be accepted for upload. Example: `sd`, `so`, `sde`, `odc`. Default list: `soe` \| `cdpk` \| `sd` \| `sde` \| `odc` \| `csv` \| `txt` \| `zshp` \| `agssite` \| `agssiteservices` \| `zip` \| `geodatabase` \| `kmz` \| `json` \| `geojson` \| `gpx` \| `xlsx` \| `xls`
`allowGPAndExtensionPublishingToPublishers`	Introduced at 11.0. When set as `true`, this property allows administrators and publishers to publish geoprocessing services and deploy service extensions (SOEs). By default, only administrators can publish geoprocessing services and service extensions. Values: `true` \| `false`
`arcgis.com.map.url`	Introduced at 11.2. The URL for the ArcGIS Online Map Viewer preview link that opens a service in Map Viewer.
`arcgis.com.map.text`	Introduced at 11.2. The text for the ArcGIS Online Map Viewer preview link.

Example usage

The following is a sample request URL used to access the properties resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/properties?f=json

JSON Response example

Use dark colors for code blocksCopy
{
  "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"
}