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

Network

TODO link to a master API document that contains the common conventions like the authentication below.

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.

TODO how to document errors?

FIXME for PUT requests the XmlBody and XmlResult documents are faked, they need to match the implementation.

Table of Contents

Overview

network...

PolicyKit Access Rights

The following PolicyKit permissions are defined:

org.opensuse.yast.modules.yapi.network.read

org.opensuse.yast.modules.yapi.network.write

Interfaces

Actually currently it operates on the interface configurations (/etc/sysconfig/network/ifcfg-*)

GET /network/interfaces

Get the list of interfaces.

Result: Example

GET /network/interfaces/<id>

Arguments:

Get the details of an interface.

Result: Example

PUT /network/interfaces/<id>

Arguments:

Update an interface config.

Body: Example

Result: Example

Hostname

GET /network/hostname

Get the host name and domain.

Result: Example

PUT /network/hostname

Set the host name and domain.

Body: Example

Result: Example

DNS

GET /network/dns

Get the nameservers and DNS search list.

Result: Example

PUT /network/dns

Set the nameservers and DNS search list.

Body: Example

Result: Example

Routes

GET /network/routes

Get the list of configured routes.

Result: Example

GET /network/routes/<id>

Arguments:

Get the details of a route.

Result: Example

PUT /network/routes/<id>

Arguments:

Update a route.

Body: Example

Result: Example