Skip To Content
ArcGIS Developer
Dashboard

System properties

Description

ArcGIS Notebook Server includes configuration properties that control some of its behavior. This resource is a container for these properties. The properties are available to all server objects and extensions through the server environment interface.

Request parameters

ParameterDescription
f

The response format. The default response format is html.

Values: html | json | pjson

System properties

PropertyDescription
applyDefaultUserWorkspacePermissions

Linux machines only. New at 10.7.1. If set to true, it reverts to using the OS default permission settings when creating users' private workspace directories. The default is false. If you set this property to true, the OS user running the ArcGIS Notebook Server daemon must have a UID of 1050 and a GID of 100 to match that of the container user. See Configure ArcGIS Notebook Server directories for more information.

containerCreatedThreshold

The time (in minutes) after which an empty container is closed automatically. The default is 60 (1 hour).

containersStartPort

The lowest ephemeral port that containers in the site can use for communication with the server.

allowHiddenFileDownloads

Hidden files—files that have names starting with a dot (.)—stored in a user's workspace can not be downloaded using the data access download API by default. Set this property to true to allow downloads of hidden files by the owner of those files.

asyncJobsCleanIntervalHours

New at 10.9. By default, the async job cleanup process runs once every 6 hours. With this property, administrators can set custom intervals to clean up jobs.

The async job cleanup process runs once in the specified time (in hours). It only cleans up jobs that are older than 6 hours (this default age can be changed with the asyncJobsCleanupAgeHours property).

Only jobs in completed or failed states are cleaned up.

By default, the value is 6 hours and is not present in System Properties.

To override the default setting, include an appropriate integer value.

asyncJobsCleanAgeHours

New at 10.9. This setting controls the age (in hours) at which jobs are cleaned up. By default, jobs that are 6 hours or older are cleaned up. Administrators can set custom ages (in hours) that a job must be before it is cleaned up.

By default, the value is 6 hours and is not present in System Properties.

To override the default setting, include an appropriate integer value.

containersStopPort

The highest ephemeral port that containers in the site can use. Containers will open on ports between this value and the containersStartPort value.

disableServicesDirectory

New at 10.8.1. If true, HTML access to the REST Services Directory is disabled for ArcGIS Notebook Server.

diskSpaceThresholdGB

New at 10.8. The threshold of remaining available disk space after which ArcGIS Notebook Server logs messages about low disk space. The default is 5 GB.

dockerConnectionHost

The host name the Docker component uses to communicate with the site. The default is localhost.

dockerConnectionPort

The port the server site uses to communicate with its Docker component.

idleNotebookThreshold

The time (in minutes) after which idle notebooks are closed automatically. The default is 1440 (24 hours).

jsapiCDN

Updates the default JSAPI URL used in a notebook by the ArcGIS API for Python and map widgets.

maxContainersPerNode

The maximum number of user-opened containers that can be simultaneously active per machine, assuming the machine has the necessary CPU and memory resources to support the containers. Containers opened by the executeNotebook operation do not count toward this limit.

maxExecuteNotebookContainersPerNode

The maximum number of containers opened through the remote executeNotebook operation that can be simultaneously active per machine. The default value is 10. This limit applies to notebooks opened through scheduled tasks, webhooks, web tools, and the executeNotebook API.

maxExecuteNotebookTimeMinutes

New at 10.8. The maximum amount of time (in minutes) that a notebook run by the executeNotebook operation can take to execute. If the notebook runs this long, it will be terminated. The default value is 120 minutes (2 hours).

maxSnapshotsPerNotebookItem

New at 10.9. Use this property to configure the maximum number of snapshots allowed for a notebook. The default value is 5.

WebContextURL

The web URL users see.

Example

https://mydomain.com/gis
webSocketSize

The maximum packet size (in megabytes) that can be sent by WebSocket communication with the server site. The default is 16 MB.

Example usage

https://gisserver.domain.com:11443/arcgis/admin/system/properties

f=json

JSON Response syntax

{
  "dockerConnectionPort": <port number>,
  "webSocketSize": <size in MB>,
  "maxContainersPerNode": <integer>,
  "maxExecuteNotebookContainersPerNode": <integer>,
  "maxExecuteNotebookTimeMinutes": <time in minutes>,
  "maxSnapshotsPerNotebookItem": <integer>,
  "diskSpaceThresholdGB": <integer>,
  "containersStartPort": <port number>,
  "asyncJobsCleanIntervalHours": <time in hours>,
  "asyncJobsCleanAgeHours": <time in hours>,
  "containersStopPort": <port number>,
  "idleNotebookThreshold": <time in minutes>,
  "containerCreatedThreshold": <time in minutes>,
  "dockerConnectionHost": "<host machine>",
  "applyDefaultUserWorkspacePermissions": "<true | false>",
  "disableServicesDirectory": <true | false>
}

JSON Response example

{
  "dockerConnectionPort": 2375,
  "webSocketSize": 64,
  "maxContainersPerNode": 20,
  "maxExecuteNotebookContainersPerNode": 5,
  "maxExecuteNotebookTimeMinutes": 120,
  "maxSnapshotsPerNotebookItem": 10,
  "diskSpaceThresholdGB": 5,
  "containersStartPort": 30001,
  "asyncJobsCleanIntervalHours": 2,
  "asyncJobsCleanAgeHours": 1,
  "containersStopPort": 31000,
  "idleNotebookThreshold": 1440,
  "containerCreatedThreshold": 60,
  "dockerConnectionHost": "localhost"
  "applyDefaultUserWorkspacePermissions": "false",
  "disableServicesDirectory": true
}