setMaintenanceMode()

setMaintenanceMode(request: SetMaintenanceModeRequest): Promise<MaintenanceModeStatus>

Defined in: packages/core/src/index.ts:2956

Enable or disable maintenance mode

Parameters

Parameter	Type	Description
request	SetMaintenanceModeRequest	Maintenance mode settings

Returns

Promise<MaintenanceModeStatus>

Updated maintenance mode status

Throws

401 - Not authenticated

Throws

403 - Admin privileges required

Example

import { setMaintenanceMode } from "@cpod/sdk";

// Enable maintenance mode
await setMaintenanceMode({
  enabled: true,
  message: "Scheduled maintenance in progress",
});

// Disable maintenance mode
await setMaintenanceMode({ enabled: false });