- 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
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The maximum packet size (in megabytes) that can be sent by WebSocket communication with the site. The default is 16 MB. |
| 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). |
| The maximum number of snapshots allowed for a notebook. The default value is 5. |
| 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 |
| The time (in minutes) after which idle notebooks are closed automatically. The default is 720 (12 hours). |
| 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:
https://organization.domain.com/context/admin/notebooks/configuration?f=pjsonJSON Response example
{
"webSocketSize": 16,
"maxExecuteNotebookTimeMinutes": 120,
"maxSnapshotsPerNotebookItem": 5,
"allowHiddenFileDownloads": false,
"idleNotebookThreshold": 720,
"containerCreatedThreshold": 60
}