ArcGIS REST API

System properties

Description

This resource lists system properties that have been modified to control the portal's environment. The available properties are as follows:

  • allowLegacyURLParser—Beginning at 10.6, any portal URL containing the curly braces ( { } ) or pipe ( | ) special characters is invalid unless the character or characters are URL-encoded. When this property is added as true, these special characters are allowed in URLs unencoded. By default, the property is not listed. It is recommended that you do not enable this property, as it carries a security vulnerability. Adding or changing this property will automatically restart the web server.
  • defaultJsonResponseContentType—At 10.6, the default content-type for JSON and JSON with callback responses has been changed from text/plain to application/json and application/javascript, respectively. To revert the content-type of your Portal Services REST API back to text/plain, insert this parameter: {"defaultJsonResponseContentType": "text/plain"}. The only value this parameter will accept is text/plain. You should carefully consider the security risks of changing the content-type of JSON responses in your portal.
  • disableSignup— If you want to create all accounts manually, this property allows you to disable the sign-up page and prevent users from creating their own accounts.
  • diskThresholdforReceivingCollaboratedContentInGB—This property was introduced at 10.6.1 and controls when, based on available disk space, the 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—This property was introduced at 10.7. When set to true, all network communication from the 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.
  • privatePortalURL—Specifies the internal URL that ArcGIS Server should use to communicate with the portal. This property is typically used when you have a highly available ArcGIS Enterprise deployment, or if the server cannot communicate directly with the portal machine.
  • portalLocalHostname—Informs the 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 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 user name.
  • 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.
  • 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 user name.
  • 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.
  • ldapCertificateValidation Introduced at 10.7. When set to true, any encrypted LDAP communication (LDAPS) made from the portal to the user or group identity store will enforce certificate validation. The default value is false.
    Note:

    When set to true, if the certificate name does not match or the certificate cannot be validated, the portal 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.

  • 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 (|).
  • WebContextURL—If you are using a reverse proxy, set this property to reverse proxy URL.
Note:

If your forward proxy is configured to exclusively use HTTPS, do not include HTTP properties in the request.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json

JSON Response syntax

{
    "propertyName1": "value1",
    "propertyName2": "value2",
    ...
}

JSON Response example

{
    "disableSignup": "true",
    "httpProxyHost": "forwardproxy.domain.com",
    "httpsProxyHost": "forwardproxy.domain.com",
    "httpProxyPort": 80,
    "httpsProxyPort": 443,
    "nonProxyHosts": "localhost|machine012.domain.com|*.domain.com"
}