Server properties

URL:
https://<root>/system/properties
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The properties resource is a container for ArcGIS Server configuration properties that govern its behavior. The properties are available to all server objects and extensions through the server environment interface.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Server properties

PropertyDetails

allowGPAndExtensionPublishingToPublishers

Allows both publishers and administrators to publish geoprocessing services and extensions if set to true. Only administrators can publish extensions and geoprocessing services by default.

Values: true | false

allowLegacyURLParser

When added and set to true, braces {}, brackets [], pipe |, or double quotation marks " special characters are allowed in URL query strings unencoded. By default, the property is not listed and its value is false. It is recommended that you do not enable this property, as it carries a security vulnerability. If you do add or change the property, manually restart ArcGIS Server for it to take effect.

Values: true | false

CacheSizeForSecureTileRequests

An integer that specifies the number of users whose token information will be cached. This increases the speed of tile retrieval for cached services. If not specified, the default cache size is 200,000. Both REST and SOAP services honor this property. You'll need to manually restart ArcGIS Server for this change to take effect.

defaultJsonResponseContentType

Changes the content-type for responses from application/json, application/javascript, or application/geo+json to text/plain. The default content-type for JSON and JSON with callback responses are application/json and application/javascript, respectively. The default content-type for GeoJSON is application/geo+json.

All three of these content-type properties can be reverted in your ArcGIS Services and Server Administration REST APIs back to text/plain by setting this property to text/plain. Restarting ArcGIS Server will cause the change to take effect. You should carefully consider the security risks of changing the content-type of JSON and GeoJSON responses on your server.

Values: text/plain

DisableAdminDirectoryCache

Disables browser caching of the Administrator Directory pages. The default is false. To disable browser caching, set this property to true.

Values: true | false

disableIPLogging

When a possible cross-site request forgery (CSRF) attack is detected, the server logs a message containing the possible IP address of the attacker. If you do not want IP addresses listed in the logs, set this property to true. Also, HTTP request referrers are logged at FINE level by the REST and SOAP handles unless this property is set to true.

Values: true | false

enableNosniffHeader

When set to true, all network communication from ArcGIS Server includes the X-Content-Type-Options response header with a value of nosniff. This helps protect against MIME confusion attacks by preventing web browsers from MIME sniffing a response away from the declared content-type of an asset. The default value is true.

Values: true | false

featureServiceXSSFilter

This parameter is used to set the value of the xssPreventionRulevfor feature services when they are published. When set to input, an XSS filter is applied to any attribute data input into a feature service for new or updated features. When set to inputOutput, both the input data and the output data are filtered for XSS strings; this is a more secure option but may have a performance impact when applied to some feature services. Changes made to this parameter only apply to new feature services and will not update the xssPreventionRule for existing feature services. The default value is input.

Values: input | inputOutput

httpProxyHost

Specifies the HTTP host name of the proxy server.

httpProxyPort

Specifies the HTTP port number of the proxy server.

httpProxyUser

Specifies the HTTP proxy server user name (if needed).

httpProxyPassword

Specifies the HTTP proxy server password (if needed).

httpsProxyHost

Specifies the HTTPS host name of the proxy server.

httpsProxyPort

Specifies the HTTPS port number of the proxy server.

httpsProxyUser

Specifies the HTTPS port server user name (if needed).

httpsProxyPassword

Specifies the HTTPS proxy server password (if needed).

isHttpProxyPasswordEncrypted

Set this property to false when you are configuring the HTTP proxy server password in plain text. After configuration, the password will be encrypted, and this property will be set to true.

Values: true | false

isHttpsProxyPasswordEncrypted

Set this property to false when you are configuring the HTTPS proxy server password in plain text. After configuration, the password will be encrypted, and this property will be set to true.

Values: true | false

javaExtBeginPort

Specifies a start port of the port range used for debugging Java server object extensions.

Example
Use dark colors for code blocksCopy
1
8000

javaExtsEndPort

Specifies an end port of the port range used for debugging Java server object extensions.

Example
Use dark colors for code blocksCopy
1
8010

ldapCertificateValidation

When set to true, any encrypted LDAP communication (LDAPS) from ArcGIS Server to the user or role identity store will enforce certificate validation. The default value is false. When set to true, if the certificate name does not match or the certificate cannot be validated, ArcGIS Server may attempt to use unencrypted LDAP communication or it may not be able to establish communication at all. If this occurs, a warning message will be logged.

Values: true | false

localTempFolder

Defines the local folder on a machine that can be used by GIS services and objects. If this property is not explicitly set, the services and objects will revert to using the system's default temporary directory. If this property is used, you must create the temporary directory on every server machine in the site.

Example
Use dark colors for code blocksCopy
1
/tmp/arcgis

machineSuspendThreshold

Machines record their status once per minute in the configuration store if they are active. This property defines the time period of inactivity after which a machine will be suspended from receiving administrative and publishing requests. Once a suspended machine records an active status, it will be reinstated to receive such requests. The default value is 60 minutes. See suspendedMachineUnregisterThreshold.

messageFormat

Defines the transmission protocol supported by the services catalog in the server.

Values: esriServiceCatalogMessageFormatBin | esriServiceCatalogMessageFormatSoap | esriServiceCatalogMessageFormatSoapOrBin

messageVersion

Defines the version supported by the services catalog in the server.

Example
Use dark colors for code blocksCopy
1
esriArcGISVersion107

minutesToCacheUsersAndRoles

Defines the time period, in minutes, for which users and rules from your LDAP or Active Directory will be cached on the server after a request for users or roles form the identity store. This optimizes the performance of your secure services. By default, the time period is 30 minutes. You can modify the time period using this property, or you can disable caching by setting the property to zero.

nonProxyHosts

This property should always contain the machine name where your portal is installed. If you want to federate ArcGIS Server with your portal, this property should also include the name of the machine where ArcGIS Server is installed. If the ArcGIS Server site contains multiple machines, a wildcard can be used for all machines in the domain (for example, *.domain.com). Machine and domain items are separated using a pipe |.

percentageMaxAllowedComputeCores

Sets the maximum percentage of CPI, out of the total CPU available on the machine, that will be used by the compute platform worker process on a single node.

percentageMaxAllowedComputeMemory

Sets the maximum percentage of memory, out of the total amount of memory available on the machine, that will be used by the compute platform worker process on a single node.

PushIdentityToDatabase

Propagates the credentials of the logged-in user to make connections to an Oracle database. This property is only supported for use with Oracle databases.

Values: true | false

readOnlyModeCopyConfigLocal

Determines whether configuration files are copied to the local repository when enabling read-only mode. The default value is true.

Values: true | false

readOnlyModeRestartServices

Determines the service restart behavior when enabling read-only mode. The default is true.

Values: true | false

standardizedQueries

This security property forces developers to use standardized SQL queries in where clauses when working with map, feature, image, and WFS services through REST or SOAP. This makes it easier for developers and applications to query ArcGIS Server services and helps prevent SQL injection attacks. Standardized queries are enforced by default but can be disabled by the server administrator.

Values: true | false

suspendDuration

Specifies the duration the ArcGIS service hosting processes should suspend at startup. This duration is specified in milliseconds. This is an optional property that takes effect when suspendServiceAtStartup is set to true. If the duration is not specified and suspension of service at startup is requested, the default suspend duration is 30 seconds.

Example
Use dark colors for code blocksCopy
1
10000 //duration set for 10 seconds

suspendedMachineUnregisterThreshold

Machines record their status once per minute in the configuration store if they are active. This property defines the time period of inactivity after which a machine will be unregistered from the site. This property is disabled by default, with a value of -1. If used, this threshold should be higher than the machineSuspendThreshold property.

suspendServiceAtStartup

Suspends the ArcGIS service hosting processes at startup. This will enable attaching to those processes and debugging code that run early in the life cycle of server extensions soon after they are instantiated.

Values: true | false

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.

Default list: soe | sd | sde | odc | csv | txt | zshp | kmz | geodatabase

uploadItemInfoFileExtensionAllowedList

Specifies which files are allowed to be uploaded through the service iteminfo 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: xml | img | png | gif | jpg | jpeg | bmp

WebContextURL

Defines the web front end as seen by your users.

Example
Use dark colors for code blocksCopy
1
https://mycompany.com/gis

WebSocketContextURL

If you are using a web socket reverse proxy server for Stream Services, enter the proxy URL here.

maxHttpPostSizeInBytes

Introduced at 10.9.1. This property allows users to change the maximum size in bytes for POST requests sent to ArcGIS Server. The default maxPostSize for ArcGIS Server is 10485760 bytes (10 MB).

webServerMaxRequestThreads

Introduced at 10.9.1. This property allows users to change the maximum number of threads that are available at one time to process requests sent to ArcGIS Server. The maximum number of threads for ArcGIS Server is 150 by default.

zkDebug

Introduced at 11.1. When set to true, the Zookeeper server processes (JVM) uses the -XX:+HeapDumpOnOutOfMemoryError option, which automatically creates a heap dump whenever the JVM receives an OutOfMemoryError error response. The default value is false.

Values: true | false

diskSpaceThresholdGB

Introduced at 11.3. This property declares the threshold (in GB) of usable disk space for server directories. If the threshold is crossed, ArcGIS Server will log messages about low disk space. If this property is not set, the default threshold is 5 GB.

Example usage

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

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/admin/system/properties?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "<property1>": <value1>,
  "<property2>": <value1>,
  ...
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "PushIdentityToDatabase": true,
  "WebContextURL": "https://mycompany.com/gis",
  "messageFormat": "esriServiceCatalogMessageFormatSoapOrBin",
  "uploadItemInfoFileExtensionAllowedList": "soe,sd,sde,csv,txt,kmz",
  "featureServiceXSSFilter": "input",
  "DisableAdminDirectoryCache": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.