CDP Server API Guide
README
Welcome to the R1Soft — CDP Server API Guide
The purpose of this manual is to provide you with complete instructions on how to use the CDP Server API.
To find a specific topic in a particular section, click on the topic name in the Table of Contents located on the left of every page. This TOC reflects a physical (tree) structure of pages in the "R1Soft Documentation" space. Note that the plus sign before the topic name means that the topic contains subpages. To access the subpages, expand the topic structure by clicking on the plus sign.
You can also use the Guide's Table of Contents located on the Guide's parent page. This TOC provides a logical instead of a physical structure of guides. The links may point to separate pages and to the sections within the pages.
You can do a site search to quickly find what you are looking for. Confluence will search all content, including attachments. To do a quick search, type your keyword into the search box, located in the top bar of every screen and then press <Enter>.
Preface
Please, read the CDP Server API Preface document to understand the CDP Server API 2x.
Common Questions
You may want to view our list of common questions located in the following document:
Common Questions
Table of Contents
- CDP Server API Preface
- CDP Server API - Common Questions
- User API
- user.addAdmin
- user.addBasicUser
- user.addSuperUser
- user.addUser
- user.deleteUser
- user.getMe
- user.getMyId
- user.getUser
- user.getUserByUsername
- user.getUserIds
- user.removeAdmin
- user.removeAllUserAdminPrivileges
- user.setCanAddHost
- user.setCanAddUser
- user.setCanChangePassword
- user.setEmailAddress
- user.setEnabled
- user.setIsSuperUser
- user.setMustChangePassword
- user.setPassword
- user.setUsername
- Storage Pool API
- Host API
- host.addAdmin
- host.addBackupUser
- host.addFullControlUser
- host.addHost
- host.addHostWithDescription
- host.addLinuxControlPanelHost
- host.addLinuxHost
- host.addLinuxHostWithDescription
- host.addRestoreUser
- host.addUnknownHost
- host.addUnknownHostWithDescription
- host.addUser
- host.addWindowsHost
- host.addWindowsHostWithDescription
- host.deleteHost
- host.getDescription
- host.getHost
- host.getHostAsMap
- host.getHostByDescription
- host.getHostByHostname
- host.getHostIds
- host.getHostIdsByVolume
- host.getHostname
- host.getHostType
- host.getLastFinishedBackupTaskInfo
- host.getQuota
- host.getRemotePort
- host.getTimeout
- host.isCdpForMySqlAddonEnabled
- host.isControlPanelModuleEnabled
- host.isEnabled
- host.isHostDiscoveryFinished
- host.removeUser
- host.runHostDiscovery
- host.setDescription
- host.setEnabled
- host.setHostname
- host.setHostType
- host.setLinuxHostType
- host.setQuota
- host.setRemotePort
- host.setsCdpForMySqlAddonEnabled
- host.setsControlPanelModuleEnabled
- host.setTimeout
- host.setWindowsHostType
- Disk Safe API
- diskSafe.addDiskSafe
- diskSafe.addDiskSafeWithEncryption
- diskSafe.deleteDiskSafe
- diskSafe.getActiveDiskSafe
- diskSafe.getActiveDiskSafeAsMap
- diskSafe.getActiveDiskSafeID
- diskSafe.getCompressionLevel
- diskSafe.getDiskSafe
- diskSafe.getDiskSafeAsMap
- diskSafe.getDiskSafeIDs
- diskSafe.getMaxFreeSpace
- diskSafe.getStorageDiskID
- diskSafe.getTimeCreated
- diskSafe.isEncryptionInitDone
- diskSafe.runEncryptionSetup
- diskSafe.setCompressionLevel
- diskSafe.setPassphrase
- Backup Task API
- Volume API
- volume.addUser
- volume.addVolume
- volume.deleteVolume
- volume.getAllowedScheduleFrequencies
- volume.getVolume
- volume.getVolumeByName
- volume.getVolumeIds
- volume.removeUser
- volume.setAllowedScheduleFrequencies
- volume.setControlPanelModuleEnabled
- volume.setMaxCdpForMySqlAddons
- volume.setMaxLinuxHosts
- volume.setMaxWindowsHosts
- volume.setQuota
- volume.setStoragePool
- volume.setVolumeName
- Task Run API
- MySQL API
- mySQL.addLocalMySQLInstance
- mySQL.addRemoteMySQLInstance
- mySQL.deleteMySQLInstance
- mySQL.getMySQLInstance
- mySQL.getMySQLInstanceIds
- mySQL.setCustomInnoDBDataDirectory
- mySQL.setCustomInnoDBLogDirectory
- mySQL.setCustomMySQLDataDirectory
- mySQL.setDescription
- mySQL.setMySQLHost
- mySQL.setMySQLPass
- mySQL.setMySQLPort
- mySQL.setMySQLSocketPath
- mySQL.setMySQLUser
- Connecting to Your XML-RPC Client
- Error Codes
- Frequency Codes For The Backup Task API
- Host Type Codes
- Support
- [Getting Support]
Summary
- CDP Server API Preface — Introductory information, programming environment.
- CDP Server API - Common Questions — A list of common questions specific to the CDP Server API (application programming interface).
- User API — Information about XML-RPC calls deal with Users in the Backup system.
- Storage Pool API — Information about XML-RPC calls deal with Storage Pools in the Backup system.
- Host API — Information about XML-RPC calls deal with Hosts in the Backup system.
- Disk Safe API — Information about XML-RPC calls deal with Disk Safes in the Backup system.
- Backup Task API — Information about XML-RPC calls deal with Backup Tasks in the Backup system.
- Volume API — Information about XML-RPC calls deal with Volumes in the Backup system.
- Task Run API — Information about XML-RPC calls deal with Task Runs in the Backup system.
- MySQL API — Information about XML-RPC calls deal with MySQL Add-On in the Backup system.
- Connecting to Your XML-RPC Client — The CDP Server API supports HTTP and HTTPS and is available by connecting to your Data Center Cluster Control Server.
- Error Codes — The error codes which can be returned by the XML-RPC API.
- Frequency Codes For The Backup Task API — Codes which can be used to specify frequency settings for the Backup Task API.
- Host Type Codes — Codes which can be used to specify Host Type settings.
 | More Information For more information, refer to the "CDP Server 2.0 Knowledge Base" space. There you can find the following topics: |
Labels:
None
Page:
CDP Server API Preface
Page:
CDP Server API - Common Questions
Page:
User API
Page:
Storage Pool API
Page:
Host API
Page:
Disk Safe API
Page:
Backup Task API
Page:
Volume API
Page:
Task Run API
Page:
MySQL API
Page:
Connecting to Your XML-RPC Client
Page:
Error Codes
Page:
Frequency Codes For The Backup Task API
Page:
Host Type Codes