SP.Site.readOnly property (sp.js)

Gets or sets a Boolean value that specifies whether the site collection is read-only, locked, and unavailable for write access.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var value = SP.Site.get_readOnly ()

Return value

true if the site collection is read-only, locked, and unavailable for write access; otherwise, false.

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/site/readOnly

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/site/readOnly

GET syntax

GET http://<sitecollection>/<site>/_api/site/readOnly