Update (mode)

URL:
https://<notebookserveradmin>/mode/update
Methods:
POST
Required Capability:
Default administrator role
Version Introduced:
10.7

Description

The update (mode) operation allows you to switch between the READ_ONLY and EDITABLE site modes.

Request parameters

ParameterDetails

siteMode

The mode you want to set your site to.

Values: READ_ONLY | EDITABLE .

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample POST request for the update (mode) operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/mode/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

siteMode=READ_ONLY&f=json

JSON Response example

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