Skip to content

Function: updateReadOnlyMode() ​

ts
function updateReadOnlyMode(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/readOnlyMode.ts:26

Enables or disables Jira read-only mode.

Available since Jira Data Center 11.3, and in 10.3 LTS.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ enabled?: boolean; endTime?: string; message?: string; timeZone?: string; }-
parameters.enabled?booleanWhether read-only mode should be enabled.
parameters.endTime?stringThe estimated end time as a local date-time (no offset). Omit to leave unchanged; send an empty string to clear it.
parameters.message?stringThe banner message shown to users while read-only mode is active. Omit to leave it unchanged; send an empty string to reset it to the default.
parameters.timeZone?stringThe time zone id the estimated end time is expressed in. Omit to leave unchanged; send an empty string to clear it.
options?RequestOptions-

Returns ​

Promise<void>