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

Computer Notifications Options

  • Last updated on

URI

/v1/accounts/{username}/computers/{computer_id}/notifications/options

URI Parameters

  • username (string)
  • computer_id (string)

Methods

GET, PUT

GET /v1/accounts/{username}/computers/{computer_id}/notifications/options

Gets a computer's notifications options.

Scope

computers_read

Request Body Parameters

  • n/a

Response Attributes

  • backup_finished (object)
    • include_failed_files (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include failed files
    • include_no_files_notice (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include a notice if no files were backed up
    • include_total_usage (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include the computer’s total usage
  • no_recent_backup (object)
  • time_between_backups (object)
    • value (int) – time range where if no backups occurred since to send a No Recent Backup Notification
    • factor (string const) – HOUR|DAY|WEEK

time_between_notifications (object)

    • value (int) – time span to wait before sending additional No Recent Backup Notifications
    • factor (string const) – HOUR|DAY|WEEK

Example JSON

Request:

GET /v1/accounts/barracuda/computers/0000/notifications/options HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

 

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

  "backup_finished": {

   "include_failed_files": true,

   "include_no_files_notice": true,

   "include_total_usage": true

  },

  "no_recent_backup": {

   "time_between_backups": {

     "value": 1,

     "factor": "HOUR"

   },

   "time_between_notifications": {

     "value": 1,

     "factor": "HOUR"

   }

  }

}

Example XML

Request:

GET /v1/accounts/barracuda/computers/0000/notifications/options HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

 

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<options>

  <backup_finished>

   <include_failed_files>true</include_failed_files>

   <include_no_files_notice>true</include_no_files_notice>

   <include_total_usage>true</include_total_usage>

  </backup_finished>

  <no_recent_backup>

   <time_between_backups>

     <value>1</value>

     <factor>HOUR</factor>

   </time_between_backups>

   <time_between_notifications>

     <value>1</value>

     <factor>HOUR</factor>

   </time_between_notifications>

  </no_recent_backup>

</options>

PUT /v1/accounts/{username}/computers/{computer_id}/notifications/options

Edits a computer's notifications options.

Scope

computers_write

Request Body Parameters

  • backup_finished (object)
    • include_failed_files (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include failed files
    • include_no_files_notice (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include a notice if no files were backed up
    • include_total_usage (bool) – If true, the Backup Completed, Warning, and Failed Notifications will include the computer’s total usage

no_recent_backup (object)

  • time_between_backups (object)
    • value (int) – time range where if no backups occurred since to send a No Recent Backup Notification
    • factor (string const) – HOUR|DAY|WEEK
  • time_between_notifications (object)
    • value (int) – time span to wait before sending additional No Recent Backup Notifications
    • factor (string const) – HOUR|DAY|WEEK

Response Attributes

  • n/a

Example JSON

Request:

PUT /v1/accounts/barracuda/computers/0000/notifications/options HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/json

 

{

  "backup_finished": {

   "include_failed_files": true,

   "include_no_files_notice": true,

   "include_total_usage": true

  },

  "no_recent_backup": {

   "time_between_backups": {

     "value": 1,

     "factor": "HOUR"

   },

   "time_between_notifications": {

     "value": 1,

     "factor": "HOUR"

   }

  }

}

Response:

HTTP/1.1 204 No Content

Example XML

Request:

PUT /v1/accounts/barracuda/computers/0000/notifications/options HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/xml

 

<?xml version="1.0" encoding="UTF-8"?>

<options>

  <backup_finished>

   <include_failed_files>true</include_failed_files>

    <include_no_files_notice>true</include_no_files_notice>

   <include_total_usage>true</include_total_usage>

  </backup_finished>

  <no_recent_backup>

   <time_between_backups>

     <value>1</value>

     <factor>HOUR</factor>

   </time_between_backups>

   <time_between_notifications>

     <value>1</value>

     <factor>HOUR</factor>

   </time_between_notifications>

  </no_recent_backup>

</options>

 

Response:

HTTP/1.1 204 No Content