Skip To Content

Update (mode)

  • URL: https://<notebookserveradmin>/mode/update(POST only)
  • 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:

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

{"status": "success"}