- URL:
- https://<system-url>/properties
- Methods:
GET
- Operations:
- Update Notebook Server Properties
- Required Capability:
- Administrator or Create and Edit
- Version Introduced:
- 10.7
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
Parameter | Description |
---|---|
| The response format. The default response format is Values: |
Properties
Property | Description |
---|---|
| New at 10.7.1. This property applies to Linux machines only. If set to |
| The time (in minutes) after which an empty container is closed automatically. The default is 60 (1 hour). |
| The lowest ephemeral port that containers in the site can use for communication with the server. |
| By default, hidden files—files that have names starting with a dot (.)—stored in a user's workspace cannot be downloaded using the data access download API. Set this property to |
| New at 10.9. By default, the async job cleanup process runs once every 6 hours. Using 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 using the Only jobs in completed or failed states are cleaned up. The value is 6 hours and is not present in System Properties. To override the default setting, provide an appropriate integer value. |
| New at 10.9. This property 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. The default value is 6 hours and is not present in System Properties. To override the default setting, provide an appropriate integer value. |
| The highest ephemeral port that containers in the site can use. Containers will open on ports between this value and the |
| New at 11.2 This property enables ArcGIS Notebook Server to use a specific network with interactive and scheduled notebook containers. To use this system property, you must first create a container network using the following command: Example:
ArcGIS Notebook Server will use the default bridge network when this property is not specified. |
| New at 10.8.1. If |
| 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. |
| The host name the Docker component uses to communicate with the site. The default is |
| The port the server site uses to communicate with its Docker component. |
| New at 11.0. Pass specific portal IP addresses or portal host names in a JSON array that will be added to the If you encounter a connection error while running a notebook cell that includes gis = GIS("home"), it may be due to the ArcGIS Notebook Server container's failure to resolve the portal's DNS name. In such cases, you can configure the Example
|
| (Optional) A directory that will be used as a temporary location during the |
| The time (in minutes) after which idle notebooks are closed automatically. The default is 720 (12 hours). |
| Updates the default JSAPI URL used in a notebook by the ArcGIS API for Python and map widgets. Example
Example
|
| 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 |
| The maximum number of containers opened through the remote |
| The maximum amount of time (in minutes) that a notebook web tool or a notebook run through a web hook or |
| New at 10.9. The maximum number of snapshots allowed for a notebook. The default value is 5. |
| Introduced at 11.1. This property applies to Windows machines only. It specifies whether the notebook server will use a Windows container-based notebook run time or a Linux container-based notebook run time. The default value is Values: |
| The web URL users see. Example
|
| 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": 720,
"containerCreatedThreshold": 60,
"dockerConnectionHost": "localhost"
"applyDefaultUserWorkspacePermissions": "false",
"disableServicesDirectory": true
}