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

ParameterDetails

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

1
2
3
https://notebookserver.domain.com:11433/arcgis/admin/notebooks/updateDefaultTemplate
defaultNotebook=default_new.ipynb
f=pjson

JSON Response example

1
{"status": "success"}

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