MBS Web API 2.0 Help Page

Introduction

Managed Backup enables interaction with backend features using the API. This feature requires API credentials generated

Create and manage the limits to online storage usage

API	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

Create and manage the user accounts and grant them access to online storage

API	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 properties
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

Views monthly usage report per user and generate invoices

API	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

Views monthly usage report per user and generate invoices

API	Description
GET api/apps/domains	Retrieves backup storage information for domains

Create and manage provider companies

API	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

Manage MBS Licenses

API	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)

Manage Backup Destination

API	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

Manage Storage Accounts

API	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

Views monthly usage report per user and generate invoices

API	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

Views public builds

API	Description
GET api/Builds?companyId={companyId}&includeSandbox={includeSandbox}	Retrieves a list of builds that are available to users
POST api/Builds/RequestCustomBuilds	Requests custom builds of specified editions
GET api/Builds/AvailableVersions	Retrieves the latest available build versions

Create and manage the administrators accounts

API	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

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

Manage Computers

API	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?profile={profile}&isOffline={isOffline}	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
GET api/Computers/{hid}/Plans/{id}	Retrieves information about a backup/restore plan on the computer (endpoint) by the specified plan ID
DELETE api/Computers/{hid}/Plans/{id}	Deletes a certain plan by the specified computer HID and plan ID. Backup data will be deleted along with the backup plan according to backup storage policies
POST api/Computers/{hid}/Plans/{id}/start	Starts a certain plan by the specified computer HID and plan ID
POST api/Computers/{hid}/Plans/{id}/stop	Stops a certain plan by the specified computer HID and plan ID
GET api/Computers/{hid}/Plans/{id}/info	Retrieves certain plan info by the specified computer HID and plan ID
POST api/Computers/{hid}/authorization	Creates/updates authorization for endpoints which are currently online by the specified computer HID
DELETE api/Computers/{hid}/authorization	Removes authorization from the computer by the specified computer HID