Properties (System)

URL:
https://<root>/system/properties
Methods:
GET
Operations:
Update
Required Capability:
Access allowed with either the "Security and Infrastructure" or "Organization Website" privileges
Version Introduced:
10.3

Description

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

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

System properties

PropertyDetails

allowLegacyURLParser

By default, the property is not listed and its value is false. When added and set to true, braces { }, brackets [ ], pipe |, and double quote " special characters are allowed in unencoded URL query strings.

Values: true | false

defaultJsonResponseContentType

Reverts the content-type value of your Portal Services REST API to text/plain. The default content-type value for JSON and JSON with callback responses has been changed from text/plain to application/json and application/javascript, respectively. The only value this parameter will accept is text/plain. Carefully consider the security risks of changing the content-type value of JSON responses in the Enterprise portal.

disableSignup

To create all accounts manually, you can use this property to disable the sign-up page and prevent users from creating their own accounts. To allow users to create new accounts, set this property to false. To set the property to false, you must have a default user type and role set under Security Configuration.

Values: true | false

diskThresholdforReceivingCollaboratedContentInGB

This property controls when, based on available disk space, the Enterprise portal will stop receiving collaborated content. The default disk space value is 10 GB. The minimum allowed value is 1 GB. The specified size must be in GB.

enableNosniffHeader

When set to true, all network communication from the Enterprise portal 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

privatePortalURL

Specifies the internal URL that ArcGIS Server will use to communicate with the Enterprise portal. This property is typically used when you have a highly available ArcGIS Enterprise deployment or if the server cannot communicate directly with the Enterprise portal machine.

Example
Use dark colors for code blocksCopy
1
"privatePortalURL": "https://privatelb.domain.com:7443/arcgis"

portalLocalHostname

Informs the Enterprise portal back end to present the value of this property as the host name of the local portal machine. This is typically used during federation and when the Enterprise portal machine has one or more public host names.

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

httpProxyPassword

Specifies the HTTP proxy server password.

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

httpsProxyHost

Specifies the HTTPS host name of the proxy server.

httpsProxyPort

Specifies the HTTPS port number of the proxy server.

httpsProxyUser

Specifies the HTTPS proxy server username.

httpsProxyPassword

Specifies the HTTPS proxy server password.

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

ldapCertificateValidation

When set to true, any encrypted LDAP communication (LDAPS) made from the Enterprise portal to the user or group identity store will enforce certificate validation. The default value is false.

Values: true | false

nonProxyHosts

This property should always contain the machine name where Portal for ArcGIS is installed. If you want to federate ArcGIS Server, 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 (|).

WebContextURL

Explicitly defines the organization URL used for client communication. This property is required for sites with reverse proxy implementations and architectures without web adaptors. Using WebContextURL is recommended for sites using a DNS alias for the organization URL.

Example
Use dark colors for code blocksCopy
1
"WebContextURL": "https://dnsalias.domain.com/portal"

enablePrintService

Introduced at ArcGIS Enterprise 10.9. When set to false, the default print service that is distributed with the ArcGIS Enterprise portal is disabled. This change does not impact access to any other configured print service. The default value is true.

Values: true | false

enableLegendsService

Introduced at ArcGIS Enterprise 10.9. When set to true, the legend service used to retrieve legend icons from older maps and feature services is enabled. The default value is false.

Values: true | false

enableRssService

Introduced at ArcGIS Enterprise 10.9. When set to false, the service used by the ArcGIS Enterprise portal to communicate with the live GeoRSS feed is disabled. The default value is true.

Values: true | false

enableKmlService

Introduced at ArcGIS Enterprise 10.9. When set to false, the service used by the ArcGIS Enterprise portal to communicate with the KML endpoint is disabled. The default value is true.

Values: true | false

enableWfsService

Introduced at ArcGIS Enterprise 10.9.1. When set to true, the WFS adaptor that is distributed with the ArcGIS Enterprise portal is enabled. This change does not impact access to WFS services added to, or hosted by, the portal. The default value is false.

Values: true | false

logBackupWarning

Introduced at ArcGIS Enterprise 11.1. Using this property you can disable backup warnings that appear in the Portal for ArcGIS logs when the site's values for fullBackupTimeStamp or backupModeTimeStamp are older than two weeks. For administrators using an external backup mechanism, the backup messages can be disabled by setting logBackupWarning to false. The default value is true.

Values: true | false

diskSpaceThresholdGB

Introduced at ArcGIS Enterprise 11.3. By using this property, you can declare the threshold for usable disk space for drives on a portal machine. If a drive were to exceed the threshold value, exceededDiskSpaceThreshold will return as true, and more disk space may need to be made available on that drive. If this property is not set, the default will be 5 GB.

useROConnectionForQueries

Introduced at ArcGIS Enterprise 11.4. Starting at 11.4, highly available deployments will have both the primary and standby databases receive query requests by default. This behavior can be modified by setting the useROConnectionForQueries property as false, which ensures that both the primary and stanby machines only use the primary database for query requests. If this property is not defined in the system properties, or is set to true, the default behavior will be used.

Values: true | false

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/portaladmin/system/properties?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "propertyName1": "value1",
  "propertyName2": "value2",
  ...
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "disableSignup": "true",
  "httpProxyHost": "forwardproxy.domain.com",
  "httpsProxyHost": "forwardproxy.domain.com",
  "httpProxyPort": 80,
  "httpsProxyPort": 443,
  "nonProxyHosts": "localhost|machine012.domain.com|*.domain.com"
}

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