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

Mail Settings 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 is used to configure SMTP server for sending mails

PolicyKit Access Rights

The following PolicyKit permission is needed to perform configutation actions:

org.opensuse.yast.modules.yapi.mailsettings.read

org.opensuse.yast.modules.yapi.mailsettings.write

Actions

GET /mail

Get the information about current system mail settings.

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

Result: Example

PUT /mail

Update current system mail settings. Password must be in plain text.

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

Body: Example

Result: Example