systemd Power API

The Power API from systemd — 5 operation(s) for power.

Documentation

Specifications

Other Resources

OpenAPI Specification

systemd-power-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: systemd-hostnamed (org.freedesktop.hostname1) Boot Power API
  version: '1.0'
  summary: D-Bus API of systemd-hostnamed modeled as REST operations.
  description: 'Documentation/contract artifact for the `org.freedesktop.hostname1` D-Bus interface on the

    system bus. Manages the system hostname (static, transient, pretty), chassis type, deployment,

    location, icon name, and other machine info.

    '
  license:
    name: LGPL-2.1-or-later
    url: https://github.com/systemd/systemd/blob/main/LICENSES/LGPL-2.1-or-later.txt
servers:
- url: dbus://system/org.freedesktop.hostname1
tags:
- name: Power
paths:
  /power/poweroff:
    post:
      tags:
      - Power
      operationId: PowerOff
      summary: Power Off The System
      description: Mirrors `PowerOff(interactive)`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                interactive:
                  type: boolean
      responses:
        '204':
          description: Shutdown initiated.
  /power/reboot:
    post:
      tags:
      - Power
      operationId: Reboot
      summary: Reboot The System
      description: Mirrors `Reboot(interactive)`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                interactive:
                  type: boolean
      responses:
        '204':
          description: Reboot initiated.
  /power/suspend:
    post:
      tags:
      - Power
      operationId: Suspend
      summary: Suspend The System
      description: Mirrors `Suspend(interactive)`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                interactive:
                  type: boolean
      responses:
        '204':
          description: Suspend initiated.
  /power/hibernate:
    post:
      tags:
      - Power
      operationId: Hibernate
      summary: Hibernate The System
      description: Mirrors `Hibernate(interactive)`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                interactive:
                  type: boolean
      responses:
        '204':
          description: Hibernate initiated.
  /power/hybrid-sleep:
    post:
      tags:
      - Power
      operationId: HybridSleep
      summary: Hybrid Sleep The System
      description: Mirrors `HybridSleep(interactive)`.
      responses:
        '204':
          description: HybridSleep initiated.