YaST REST Service Documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled "GNU Free Documentation License".

System Service

Only authenticated users are allowed to access the API. Authentication is done by sending a Basic HTTP Authorisation header.

All names aren't allowed to contain spaces, slashes or colons.

System Actions

GET /system
PUT /system

Formats

The system REST service supports only XML and JSON input/output formats.

Overview

This module provides access to the basic system component. Curretly it provides only reboot and shutdown actions.

The module uses HAL as the backend, HAL daemon must be running to perform reboot/shutdown actions.

PolicyKit Access Rights

The following PolicyKit permissions are needed to execute reboot and shutdown:

Reboot: org.freedesktop.hal.power-management.reboot

Shutdown: org.freedesktop.hal.power-management.shutdown

System Actions

GET /system

Get the list of supported system actions. The list contains actions like reboot or shutdown.

CURL Example: curl -u user http://localhost:4984/system.xml

Result: Example

PUT /system

Trigger a system action. Set active flag to true for the action which should be started - see the XML example file.

CURL example: curl -u user -X PUT -H 'Content-type: text/xml' -d @reboot_request.xml http://localhost:4984/system.xml

Body: Example