YaST REST Service Documentation

Copyright © 2009-10 Novell, Inc.

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".

Administrator 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.

Table of Contents

Formats

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

Overview

This module provides access to system administrator's configuration.

Curretly it is possible to set administrator's password and define email addresses for notifications.

PolicyKit Access Rights

The following PolicyKit permission is needed to perform configutation actions:

org.opensuse.yast.modules.yapi.administrator.write

For read access (currently reading list of mail aliases), it is needed

org.opensuse.yast.modules.yapi.administrator.read

Actions

GET /administrator

Get the list of current mail aliases. Password is never returned in the GET request.

CURL Example: curl -u <user> http://localhost:4984/administrator.xml

Result: Example

PUT /administrator

Update the administrator's configuration. It is possible to save both password and mail aliases or just one part. Password must be in plain text.

To remove all mail aliases, special 'NONE' string must be passed as a value.

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

Body: Example

Result: Example

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

Body: Example

Result: Example