It seems like your browser didn't download the required fonts. Please revise your security settings and try again.
Barracuda Intronis Backup
formerly ECHOplatform

Bandwidth Throttling APIs

  • Last updated on

This section provides the following topics:

  • Input Parameters
  • Output Parameters
  • Returned Status Codes
  • Error codes

Input Parameters

The following table provides the input parameters and descriptions.

Input Parameter

Description

enable

Boolean parameter specifying whether to enable or disable the bandwidth throttling. If this parameter is false, the throttling is disabled, it is not necessary to fill in the other parameters.

days

Defines the day interval during which the bandwidth throttling will be enabled. In the example above, throttling is enabled from Monday through Friday.

Can only be specified when "enable" is set to "true".

hours

Used together with the days:  in the example above, bandwidth throttling is enabled during work hours, during work days. (9:00 through 17:00, from Monday until Friday).

Hours are separated by ":" and allowed values are going to be between "00:00" to "23:59" (no AM or PM necessary).

Can only be specified when "enable" is set to "true".

throttling

Integer value, measured in Kb (Kilobits), defining the maximum allowed bandwidth used for Cloud uploads. Allowed ranges are between 64 Kb and 999999 Kb.

Can only be specified when "enable" is set to "true".

 

Command example

POST https://<environment>/v2/accounts/<account>/computers/<computer>/settings/advanced/apply

{

  "bandwidth": {

      "enable":true,

       "days": {

          "start": "monday",

          "end": "friday"

       },

     "hours": {

        "start": "9:00",

        "end": "17:00"

      },

     "throttling": 512

  }

}

Output Parameters

Online operation: Response status: 200 OK.

Offline operation:

The output is an id of the operation, which can be used to track completion status via the command below.

Response status: 202 Accepted.

Response example:

{

  "data": {

    "id": "1"

  }

}

Returned Status Codes

The following table provides the returned status codes.

Returned Status Codes

Description

200

The request was successful.

202

The request was accepted and is processed when the agent is online. The returned id can be used to check the status of the operation.

400

Validation errors.

401

Authentication errors.

 

Result of the operation

Status can be obtained via the command below The status is either success or error, also providing the reason for the failure.

GET https://<environment>/v2/accounts/<account>/computers/<computer>/action/{id}/status

Error Codes

The reason for the failure can be matched to one of the error codes below:

  • Running_Actions_PreventPreferencesUpdate - cannot update preferences while Backups, Restores or Deletes are running
  • Running_Actions_FailedToAcquireLock - critical error, failed to acquire lock for the operation (this never happens)