Add Acronis Backup Order

KB Tags associated with this article:
Use all tags
KB Tags
acronis backups
Body

Description

Places an Acronis backup order for a specified VPS or Dedicated hosting order.

HTTP Method

POST

Example Test URL Request

US Location https://test.httpapi.com/api/backup/us/add.json?auth-userid=0&api-key=key&storage-size-gb=0&customer-id=0&hosting-order-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00 
Asia Location https://test.httpapi.com/api/backup/asia/add.json?auth-userid=0&api-key=key&storage-size-gb=0&customer-id=0&hosting-order-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00 

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
storage-size-gb Integer Required Storage Size in GB
customer-id Integer Required Customer ID of the Customer under whom the Order should be added
hosting-order-id Integer Required The order id of the hosting order for which you would want to add the Acronis Backup. 
months Integer Required The number of months for which the Order is to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e., plan-id etc., use this method.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amount Float Optional Discount amount for the order value.

Response

Returns a hash map containing the below details:

  • Order ID of the Backup Order (entityid)

  • Backup Order Name (description)

  • Action Type (actiontype)

  • Description of the Backup Order Add Action (actiontypedesc)

  • Action ID of the Backup Add Action (eaqid)

  • Order Add Action Status (actionstatus)

  • Description of the Backup Add Action Status (actionstatusdesc)

  • Invoice ID of the Backup Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Customer ID associated with the Backup Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.