System Properties

URL:: https://<system-url>/properties
Methods:: GET
Required Capability:: Administrator
Version Introduced:: 10.8

Description

ArcGIS Mission Server has configuration properties that govern some of its intricate behavior. The properties resource is a container for these properties.

Request parameters

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

Server properties

Properties	Details
`allowedOrigins`	An array of up to 100 web application domains to restrict CORS access to ArcGIS Mission Server.
`AuthTokenTimeInSeconds`	The number of seconds that an ArcGIS Mission Server WebSocket token is valid. Default: `180` seconds.
`disableServicesDirectory`	This property controls whether the HTML pages of the services directory should be accessible to the users. The default value for this property is false, meaning the services directory HTML pages are accessible to everyone.
`disableSpaceThresholdGB`	Indicates the threshold of remaining available disk space after which ArcGIS Mission Server will start to log messages about low disk space. The default is 5 GB.
`jsapi.arcgis`	The URL for the ArcGIS API for JavaScript used by the services directory. The default is the URL of the ArcGIS API for JavaScript that is hosted in ArcGIS Online.
`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 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` .
`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.
`WebContextURL`	Defines the web front end as seen by your users. Example Use dark colors for code blocksCopy `1 https://mycompany.com/mission`
`WebSocketContextURL`	The context in which to construct WebSocket connections to ArcGIS Mission Server. Example Use dark colors for code blocksCopy `1 wss://mycompany.com/mission`

Example usage

Below is a sample request URL for the properties resource:

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

JSON Response syntax

Use dark colors for code blocksCopy
{
  "<property1>": <value1>,
  "<property2>": <value1>,
  ...
}

JSON Response example

Use dark colors for code blocksCopy
{
  "AuthTokenTimeInSeconds": 180,
  "WebContextURL": "https://mycompany.com/mission",
		"WebSocketContextURL": "wss://mycompany.com/mission"
}