Update Default Template

URL:: https://<notebookserveradmin>/notebooks/updateDefaultTemplate
Methods:: POST
Required Capability:: Administrator
Version Introduced:: 10.8

Description

The upgradeDefaultTemplate operation allows the default notebook template that is provided with ArcGIS Notebook Server to be updated and changed to a new, custom template. Save these templates as JSON .ipynb files in the template location at <ArcGIS Notebook Server install directory>\config-store\system\ipynb_defaults\default_new.ipynb .

Request parameters

Parameter Details

Parameter	Details
`defaultNotebook`	The new custom notebook file that will replace the default template. When the file is added, the original template (`default_new.ipynb` ) is overwritten with the new file and saved in the template file location (`<ArcGIS Notebook Server install directory>\config-store\system\ipynb_defaults\default_new.ipynb` ). All template files must be saved in the JSON IPYNB format.
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

defaultNotebook

The new custom notebook file that will replace the default template. When the file is added, the original template (default_new.ipynb ) is overwritten with the new file and saved in the template file location (<ArcGIS Notebook Server install directory>\config-store\system\ipynb_defaults\default_new.ipynb ). All template files must be saved in the JSON IPYNB format.

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Use dark colors for code blocksCopy
https://notebookserver.domain.com:11433/arcgis/admin/notebooks/updateDefaultTemplate
defaultNotebook=default_new.ipynb
f=pjson

JSON Response example

Use dark colors for code blocksCopy
{"status": "success"}