Skip To Content
ArcGIS Developer
Dashboard

Update Notebook Server Properties

  • URL: https://<notebookserveradmin>/system/properties/update(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.7

Description

This operation allows you to update the server properties. The update operation overwrites all existing properties. It will restart the site.

Request parameters

ParameterDetails
properties

The JSON object containing the server properties.

f

The response format. The default response format is html.

Values: html | json | pjson

Server properties

ParameterDetails
applyDefaultUserWorkspacePermissions

(Linux only)

Introduced at 10.7.1. If set to true, reverts to using your 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.

Example

"applyDefaultUserWorkspacePermissions": "false"
containerCreatedThreshold

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

Example

"containerCreatedThreshold": 60
containerStartPort

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

Example

"containersStartPort": 30001
containerStopPort

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

Example

"containersStopPort": 31000
diskSpaceThresholdGB

Introduced at 10.7.1. Indicates the threshold of remaining available disk space after which ArcGIS Notebook Server will start to log messages about low disk space. The default is 5 GB.

Example

"diskSpaceThresholdGB": 5
dockerConnectionHost

The hostname with which your Docker component will communicate with your site. The default is localhost.

Example

"dockerConnectionHost": localhost
dockerConnectionPort

The port through which your server site will communicate with its Docker component.

Example

"dockerConnectionPort": 2375
idleNotebookThreshold

Specifies the time (in minutes) after which idle notebooks are closed automatically. The default is 1440 (one day).

Example

"idleNotebookThreshold": 1440
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 Execute Notebook operation do not count toward this limit.

Example

"maxContainersPerNode": 20
maxExecuteNotebookContainersPerNode

Introduced at 10.8. The maximum number of containers opened through the remote Execute Notebook operation that can be simultaneously active per machine.

Example

"maxExecuteNotebookContainersPerNode": 5
maxExecuteNotebookTimeMinutes

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

Example

"maxExecuteNotebookTimeMinutes": 120
WebContextURL

Defines the web front-end as seen by your users.

Example

"WebContextURL": "https://mydomain.com/gis"
webSocketSize

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

Example

"webSocketSize": 16

Example usage

https://notebookserver:port/arcgis/admin/system/properties/update
	properties={
		"WebContextURL": "https://mydomain.com/gis"
	}