API Methods

The list of available API methods is grouped as follows:

Provider

Authentication API.

Method	Description
POST API/Provider/Login	Retrieves API authentication information. The authentication parameters are provided to the customer.

Method	Description
GET API/Packages	Retrieves a list of available packages
GET API/Packages {ID}	Retrieves a list of packages by the specified package ID
POST API/Packages	Creates a new package
PUT API/Packages	Changes the values of package properties
DELETE API/Packages/{ID}	Removes a package by the specified package ID

Methods to manage users.

Method	Description
GET API/Users	Retrieves a list of users
GET API/Users/{ID}	Retrieves user metadata by the specified user ID
PUT API/Users/Authenticate	Retrieves a user by user login and password
PUT API/Users	Changes user propertie
POST API/Users	Creates a new user
DELETE API/Users/{id}/Account	Deletes the user account metadata by the specified user ID. Backup data is not deleted from the backup storage
DELETE API/Users/{id}	Deletes the user account metadata along with the backup data by the specified user ID
GET API/Users/{UserID}/Computers	Retrieves a list of user’s computers (endpoints) by the specified user ID
DELETE API/Users/{userId}/Computers	Deletes computer metadata along with backup data by the specified user ID

Methods to return monthly usage report per user and to generate invoices.

Method	Description
GET API/Monitoring	Retrieves status data for the latest plan runs on all endpoints (all users)
GET API/Monitoring/{UserID}	Retrieves status data for the latest plan runs on online endpoints, filtered by the specified user ID

Method	Description
GET API/Companies	Retrieves a list of companies
GET API/Companies/{ID}	Retrieves a company by the specified company ID
DELETE API/Companies/{ID}	Deletes a company by the specified company ID
POST API/Companies	Creates a new company
PUT API/Companies	Changes company properties

Method	Description
GET API/Computers/{offset}/{count}	Retrieves a list of managed computers (endpoints) by provided parameters
GET API/Computers/{hid}	Retrieves computer info by the specified computer HID
GET API/Computers/{hid}/Disks	Retrieves information about disks of a computer by the specified computer HID
GET API/Computers/{hid}/Plans	Retrieves information about backup/restore plans on the computer (endpoint) by the specified computer HID
POST API/Computers/{hid}/authorization	Retrieves information about backup/restore plans on the computer (endpoint) by the specified computer HID
DELETE API/Computers/{hid}/authorization	Removes authorization from the computer by the specified computer HID

Methods to manage licenses.

Method	Description
GET API/Licenses?isAvailable={isAvailable}	Retrieves a list of available licenses
GET API/Licenses/{ID}	Retrieves licenses by the specified license ID
POST API/Licenses/Grant	Grants the license to the existing user
POST API/Licenses/Release	Releases the license from the user
POST API/Licenses/Revoke	Revokes the license (releases info about computer))

Methods to manage backup destinations.

Method	Description
POST API/Destinations	Adds a backup destination to the user
PUT API/Destinations	Changes the backup destination for the user
DELETE API/Destinations/{ID}?UserID={UserID}	Removes the backup destination from the user
GET API/Destinations/{UserEmail}	Retrieves a list of backup destinations for the user by the specified user’s email

Methods to manage storage accounts.

Method	Description
GET API/Accounts	Retrieves a list of accounts
GET API/Accounts/{ID}	Retrieves account properties by the specified account ID
POST API/Accounts	Adds a new account
PUT API/Accounts	Changes the account properties
POST API/Accounts/AddDestination	Adds backup destinations to existing storage accounts. You can add multiple destinations (buckets) to each storage account
POST api/Accounts/CreateDestination	Creates a new backup destination for existing storage accounts.
PUT API/Accounts/EditDestination	Changes the backup destination
PUT API/Accounts/RemoveDestination	Removes a backup destination from the storage account

Methods to return monthly usage reports per user and generates invoices.

Method	Description
GET API/Billing	Retrieves billing information for a reporting month
PUT API/Billing	Retrieves billing information for the specified dates/companies
PUT API/Billing/Details	Retrieves detailed billing information for backup and restore operations

Methods to manage public builds.

Method	Description
GET API/Builds	Retrieves a list of builds that are available to users
POST API/Builds/RequestCustomBuilds	Requests custom builds of specified editions
GET API/Builds/AvailableVersions	Returns the latest available build versions

Methods to create and manage administrators accounts.

Method	Description
GET API/Administrators	Retrieves a list of administrators
GET API/Administrators/{ID}	Retrieves administrator properties by specified administrator ID
POST API/Administrators	Creates a new administrator
PUT API/Administrators	Changes administrator properties
DELETE API/Administrators/{ID}	Deletes an administrator by the specified ID