Configuration (Notebooks)

URL:
https://<root>/notebooks/configuration
Methods:
GET
Operations:
Update
Required Capability:
Access allowed with either the "Servers" or "Security and infrastructure" privileges
Version Introduced:
11.4

Description

The configuration resource provides a list of all properties that control some of a notebook's behavior. This resource is a container for these properties.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails

webSocketSize

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

maxExecuteNotebookTimeMinutes

The maximum amount of time (in minutes) that a notebook web tool or a notebook run through a web hook or executeNotebook operation can take to complete. If any of these operations runs this long, it will be terminated.

The default value is 120 minutes (2 hours).

maxSnapshotsPerNotebookItem

The maximum number of snapshots allowed for a notebook.

The default value is 5.

allowHiddenFileDownloads

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 true to allow the owner of those files to download them.

idleNotebookThreshold

The time (in minutes) after which idle notebooks are closed automatically.

The default is 720 (12 hours).

containerCreatedThreshold

The time (in minutes) after which an idle notebook deployment is closed automatically.

The default is 60 (1 hour).

Example usage

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

1
https://organization.domain.com/context/admin/notebooks/configuration?f=pjson

JSON Response example

1
2
3
4
5
6
7
8
{
  "webSocketSize": 16,
  "maxExecuteNotebookTimeMinutes": 120,
  "maxSnapshotsPerNotebookItem": 5,
  "allowHiddenFileDownloads": false,
  "idleNotebookThreshold": 720,
  "containerCreatedThreshold": 60
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close