Properties | ArcGIS REST APIs

URL:: https://<root>/system/properties
Methods:: GET
Operations:: Update
Version Introduced:: 12.0

Description

The properties resource is a container for ArcGIS Video Server configuration properties that govern its behavior.

Request parameters

Parameter Details

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

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

Server properties

Property	Details
`maxFrameCount`	Sets the maximum number of frames allowed in an uploaded video layer as an integer. Defaults to `1000` and has no strict limit.
`maxFileUploadSize`	Sets the maximum uploadable file size to the server site in MB. Defaults to `5000` and has no strict limit.
`disableServicesDirectory`	Enables or disables the Services directory. If `true`, administrators can access the full list of services via `/admin/services/`. If `false`, this directory will be blocked for security purposes. Values: `true` \| `false`
`maxFileUploadSize`	Alters the maximum accepted file size that can be uploaded. The default value is `5000`, and it must fall between `0` and `100000` MB.
`maxRequestSize`	Alters the maximum allowed request size. This value is an integer between `0` and `100` MB, with a default value of `100`.
`elevationSources`	Assigns a specific elevation service as the source elevation for services. The `elevationSource` accepts Item IDs, separated by commas, for input.
`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.example.com/video"`
`LivestreamGatewayHostname`	Changes the IP address or hostname which appears at the beginning of livestream URLs. These will default to the name of the machine hosting ArcGIS Video Server, but can be altered to meet users' needs.
`allowedOrigins`	An array of up to 100 web application domains to restrict CORS access to ArcGIS Video Server.
`exportTempDir`	Defines an alternate location to use when building a site export zip.
`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`.
`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.
`diskSpaceThresholdGB`	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.
`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`

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/properties?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "<property1>": <value1>,
  "<property2>": <value2>,
  "disableServicesDirectory>": "<true | false>",
  ...
}

JSON Response example

Use dark colors for code blocksCopy
{
  "maxFrameCount": 1000,
  "maxFileUploadSize": 5000,
  "disableServicesDirectory": false
}