View Source

Use the following steps to access the Server Backup Manager API documentation.

1. Open a web browser and type in one of the following addresses: {{https://<backupmanageraddress>/apidoc}} or {{http://<backupmanageraddress>/apidoc}}.
{info:title=Note}You can configure the HTTP and SSL connections for API in "Configuration." There, you can enable/disable HTTP and SSL connections and specify ports and maximum allowed connections. For an SSL connection, you can define the keystore path. See [Configuring API Server Options].
!apidoc in address bar_English.png!

You can find instructions on how to find the <backupmanageraddress> in [Access Server Backup Manager Web interface].

2. Once you have established a connection to the Backup Manager, you will see the main page of the Server Backup API Documentation.

!API documentation_main page_English.png!

3. To find the Class List in the API Documentation, in the Main menu, click *Classes*.

!API documentation_main page_Clases_English.png!

4. In the sub-menu of "Classes," you can access the following sections:
* *Class List (opens by default)*&nbsp;\- Shows the classes, structs, unions, and interfaces with brief descriptions.
* *Class Index* \- Lists the classes in alphabetical order.
* *Class Hierarchy* \- Shows the inheritance list of classes in alphabetical order.
* *Class Members* \- Lists all documented class members with links to the class documentation for each member.

!API documentation_main page_Clases_sub-menu_English.png!

You can use the Search window to find the necessary class in the API Documentation.

!API documentation_main page_Clases_search field_English.png!


You can use the "detail level" option and choose which level of detailing is needed by clicking on icons from "1" to "8". The "8" level is more complete.

!API documentation_main page_Clases_Detail level option_English.png!

In our example the "8" level has been choose to see the whole tree.


You can click on any link of blue color and access the full information on this item.

!API documentation_main page_Clases_links outlined_English.png!
{excerpt:hidden=true}Instructions on how to access the Server Backup Manager API documentation.{excerpt}