- 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
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
System properties
Property | Details |
---|---|
| By default, the property is not listed and its value is Values: |
| Reverts the |
| 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 Values: |
| 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. |
| When set to Values: |
| 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
|
| 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. |
| Specifies the HTTP host name of the proxy server. |
| Specifies the HTTP port number of the proxy server. |
| Specifies the HTTP proxy server username. |
| Specifies the HTTP proxy server password. |
| Set this property to Values: |
| Specifies the HTTPS host name of the proxy server. |
| Specifies the HTTPS port number of the proxy server. |
| Specifies the HTTPS proxy server username. |
| Specifies the HTTPS proxy server password. |
| Set this property to Values: |
| When set to Values: |
| 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, |
| 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 Example
|
| Introduced at ArcGIS Enterprise 10.9. When set to Values: |
| Introduced at ArcGIS Enterprise 10.9. When set to Values: |
| Introduced at ArcGIS Enterprise 10.9. When set to Values: |
| Introduced at ArcGIS Enterprise 10.9. When set to Values: |
| Introduced at ArcGIS Enterprise 10.9.1. When set to Values: |
| 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 Values: |
| 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 |
| 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 Values: |
Example usage
The following is a sample request URL used to access the properties
resource:
https://machine.domain.com/webadaptor/portaladmin/system/properties?f=pjson
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"
}