Mode

URL:
https://<notebookserveradmin>/mode
Methods:
GET
Required Capability:
Administrator
Version Introduced:
10.7

Description

ArcGIS Notebook Server has a site mode that allows you to control changes to your site. You can set the site mode to READ_ONLY to prevent the opening of new notebooks and block most administrative operations. The default site mode is EDITABLE , which allows all administrative and notebook operations on the site.

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | pjson

Response properties

PropertyDetails

siteMode

The current mode of the site.

Response: READ_ONLY | EDITABLE .

copyConfigLocal

Indicates whether the site configuration files will be copied to the local repository upon switching to READ_ONLY .

Response: true | false

lastModified

Time stamp that indicates the last time the site mode was modified.

JSON Response syntax

1
2
3
4
5
{
    "siteMode": READ_ONLY or EDITABLE,
    "copyConfigLocal": true or false,
    "lastModified": <timestamp>
}

JSON Response example

1
2
3
4
5
{
    "siteMode": "EDITABLE",
    "copyConfigLocal": false,
    "lastModified": <timestamp>
}

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