Enable or disable anonymous access to the public surface

PATCH

/admin/system/public-mode

• Local development behind nginx (port 8088 by default)

Turns anonymous access to the public read surface on or off. Requires the system.config.write capability. The change takes effect on the next request without a restart, and is recorded as an admin.system.public_mode_updated audit event.

Authorizations

• cookieAuth
• bearerAuth

Request Body ^required

object

enabled

required

When true, anonymous callers may reach the public read surface (assets, collections, search, IIIF). When false — the default, and the state of any install that has never set it — those routes return 401 to anonymous callers.

boolean

Responses

200

Updated public-mode state

object

enabled

required

When true, anonymous callers may reach the public read surface (assets, collections, search, IIIF). When false — the default, and the state of any install that has never set it — those routes return 401 to anonymous callers.

boolean

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed