Skip to content

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

Introduced at 11.4.

An integer value in minutes for the maximum amount of time 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 minimum value is 15 minutes.

maxSnapshotsPerNotebookItem

The maximum number of snapshots allowed for a notebook.

The default value is 5.

asyncJobsCleanAgeHours

Introduced at 11.4.

The interval that completed (succeeded or failed) interactive and automated notebook jobs are cleaned.

Default value is 6 hours.

The minimum value is 6.

notebookEgressNetworkPolicy

Introduced at 11.5.

Specifies how notebook pods are allowed to communicate with external network endpoints according to an organization's security needs.

Default value is:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{"egress": [
  {"to": [{"namespaceSelector":
      {"matchExpressions":[],
      "matchLabels":{"kubernetes.io/metadata.name":"<your namespace>"}}}],
    "ports":[]
  },
  {"to":[],
    "ports":[
      {"protocol":"TCP","port":53},
       {"protocol":"UDP","port":53}]
  },
  {"to":
    [{"ipBlock":{"cidr":"0.0.0.0/0",
    "except":["169.254.169.254/32"]}}],
    "ports":[]
  }
]}

Example usage:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{"egress": [
  {
    "to": [{"namespaceSelector": {
      "matchExpressions": [],
      "matchLabels": {"kubernetes.io/metadata.name": "<your namespace>"}}}],
    "ports": []
  },
  { "to": [],
    "ports": [
      {"protocol": "TCP", "port": 53},
      {"protocol": "UDP", "port": 53}]
  },
  {"to": [{"ipBlock": {
      "cidr": "0.0.0.0/0",
      "except": ["169.254.169.254/32"]}}],
      "ports": []
  }
]}

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).

maxAutomatedNotebookJobsPerManager

Introduced at 11.4.

An integer of the maximum number of active automated notebook jobs allowed per each Notebooks Automation Manager deployment. This limit applies to notebooks opened through scheduled tasks, webhooks, web tools, and the executeNotebook API.

Default value is 5.

Minimum value is 5.

Example usage

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

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/notebooks/configuration?f=pjson

JSON Response example

Use dark colors for code blocksCopy
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.