Introduction

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API >

Introduction

As of version 4.0, Syncplify.me Server! features a rich set of REST API that cover all management tasks, both as SuperAdmin (creating and manatging administrators and virtual servers) and as Admin (managing every detail of the configuration of a specific virtual server).

 

There are 2 different sets of REST API: one for the SuperAdmin and one for normal Administrators.

 

The SuperAdmin REST API

 

For exclusive use of the SuperAdmin, this is the only REST API that allows the creation and management of new virtual servers, administrative profiles, and nodes. As a general rule, the base URL for such REST API is built like this:

https://your.host.name:the_port_you_chose_during_install/smserver/

 

Example:

If your host is "demo.syncplify.me", and the port you chose is 4443, the URL will be https://demo.syncplify.me:4443/smserver/

 

The Admin REST API

 

The Admin REST API is the real heart of Syncplify.me Server!'s management system. It can be used/invoked by any of the administrators created by the SuperAdmin for a specific virtual server. The URL to access the Admin interface is different for each virtual server, and includes the name of the virtual server itself. As a general rule, the base URL for such REST API is built like this:

https://your.host.name:the_port_you_chose_during_install/smserver-virtual_server_name/

 

Example:

If your host is "demo.syncplify.me", the port you chose is 4443, and the virtual server's name is "default", then the URL will be https://demo.syncplify.me:4443/smserver-default/

 

Notes

 

1.If you chose port 443 (the standard HTTPS port) you may avoid specifying the port in the URLs.

2.The trailing backslash at the end of the above mentioned URLs is mandatory