Endpoint configuration · GraphQL type

PowerSourceSettings type

Power source settings controlling sleep timers, hibernation, wake behavior, and energy efficiency options for a given power source.

Fields

Field Name Description
darkWakeBackgroundTasks - Boolean! Whether the system can perform background tasks during dark wake (Power Nap).
diskSleepTimer - Duration! Time before disks are put to sleep (in minutes).
displaySleepTimer - Duration! Time before the display is put to sleep (in minutes).
hibernateFile - String! Path to the hibernate image file used for safe sleep.
hibernateMode - HibernateMode! Hibernate mode controlling how the system saves state on sleep.
highPowerMode - Boolean! Whether high power mode is enabled.
lowPowerMode - Boolean! Whether low power mode is enabled to extend battery life.
prioritizeNetworkReachabilityOverSleep - Boolean! Whether to prioritize network reachability over sleep efficiency.
reduceBrightness - Boolean! Whether display brightness is reduced on battery power.
sleepOnPowerButton - Boolean! Whether pressing the power button puts the system to sleep.
standbyEnabled - Boolean! Whether standby mode is enabled for deep idle sleep.
systemSleepTimer - Duration! Time before the system goes to sleep (in minutes).
tcpKeepAlivePref - Boolean! Whether TCP keep-alive is enabled during sleep to maintain connections.
ttysPreventSleep - Boolean! Whether a TTYS assertion prevents system sleep.
wakeOnLAN - Boolean! Whether the system can be woken by network activity (Wake-on-LAN).

Used by

  • PowerProfile type: Power management profile containing settings for both battery and AC power sources.

Example

Example

{
  "darkWakeBackgroundTasks": false,
  "diskSleepTimer": "600000000",
  "displaySleepTimer": "600000000",
  "hibernateFile": "xyz789",
  "hibernateMode": "SLEEP_SUSPEND_TO_RAM",
  "highPowerMode": false,
  "lowPowerMode": true,
  "prioritizeNetworkReachabilityOverSleep": false,
  "reduceBrightness": false,
  "sleepOnPowerButton": false,
  "standbyEnabled": true,
  "systemSleepTimer": "600000000",
  "tcpKeepAlivePref": true,
  "ttysPreventSleep": true,
  "wakeOnLAN": false
}