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

Computer Notifications Email List

  • Last updated on

URI

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

URI Parameters

  • username (string)
  • computer_id (string)

Methods

GET, POST

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

Gets a computer's notifications emails.

Scope

computers_read

Query Selector Parameters

  • n/a

Query Pagination Parameters

  • page (int) - the page number to show (min 1, default 1)
  • page_size (int) - the number of emails per page (min 1, max 50, default 10)

Query Sorting Parameters

  • order_by (string const) – EMAIL_ID|EMAIL
  • order_dir (string const) – ASC|DESC

Request Body Parameters

  • n/a

Response Attributes

  • email_id (int)
  • email (string)
  • backup_completed (bool) – If true, the email will receive the Backup Completed Notification
  • backup_warning (bool) – If true, the email will receive the Backup Warning Notification
  • backup_failed (bool) – If true, the email will receive the Backup Failed Notification
  • backup_missed (bool) – If true, the email will receive the Backup Missed Notification
  • no_recent_backup (bool) – If true, the email will receive the No Recent Backup Notification
  • link (link object)

Example JSON

Request:

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

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

 

Response:

HTTP/1.1 200 OK

Content-Type: application/json

 

{

  "page": 1,

  "page_size": 10,

  "count": 2,

  "links": [

   {

     "rel": "first",

     "href": "https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails?page=1"

   },

  ],

  "list": [

   {

     "email_id": 0,

     "email": "jsmith@barracuda.com",

     "backup_completed": true,

     "backup_warning": true,

     "backup_failed": true,

     "backup_missed": true,

     "no_recent_backup": true,

     "link": {

       "rel": "self",

       "href": "https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/0"

     }

   },

   {

     "email_id": 10,

     "email": "support@barracudamspmsp.com",

     "backup_completed": false,

     "backup_warning": false,

     "backup_failed": false,

     "backup_missed": true,

     "no_recent_backup": false,

     "link": {

       "rel": "self",

       "href": "https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/10"

     }

   }

  ]

}

Example XML

Request:

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

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

 

Response:

HTTP/1.1 200 OK

Content-Type: application/json

 

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

<list page="2" page_size="10" count="2">

  <link rel="first" href="https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails?page=1"/>

  <email>

   <email_id>0</email_id>

   <email>jsmith@barracuda.com</email>

   <backup_completed>true</backup_completed>

   <backup_warning>true</backup_warning>

   <backup_failed>true</backup_failed>

   <backup_missed>true</backup_missed>

   <no_recent_backup>true</no_recent_backup>

   <link rel="self" href="https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/0"/>

  </email>

  <email>

   <email_id>10</email_id>

   <email>support@barracudamspmsp.com</email>

   <backup_completed>false</backup_completed>

   <backup_warning>false</backup_warning>

   <backup_failed>false</backup_failed>

   <backup_missed>true</backup_missed>

   <no_recent_backup>false</no_recent_backup>

   <link rel="self" href="https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/10"/>

  </email>

</list>

POST /v1/accounts/{username}/computers/{computer_id}/notifications/emails

Adds a new email to a computer's notifications.

Scope

computers_write

Request Body Parameters

  • email (string)
  • backup_completed (bool) – If true, the email will receive the Backup Completed Notification
  • backup_warning (bool) – If true, the email will receive the Backup Warning Notification
  • backup_failed (bool) – If true, the email will receive the Backup Failed Notification
  • backup_missed (bool) – If true, the email will receive the Backup Missed Notification
  • no_recent_backup (bool) – If true, the email will receive the No Recent Backup Notification

Response Attributes

  • n/a

Example JSON

Request:

POST /v1/accounts/barracuda/computers/0000/notifications/emails HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/json

 

{

  "email": "support@barracudamsp.com",

  "backup_completed": false,

  "backup_warning": false,

  "backup_failed": false,

  "backup_missed": true,

  "no_recent_backup": false,

}

 

Response:

HTTP/1.1 201 Created

Location: https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/10

Example XML

Request:

POST /v1/accounts/barracuda/computers/0000/notifications/emails HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/xml

 

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

<email>

  <email>support@barracudamsp.com</email>

  <backup_completed>false</backup_completed>

  <backup_warning>false</backup_warning>

  <backup_failed>false</backup_failed>

  <backup_missed>true</backup_missing>

  <no_recent_backup>false</no_recent_backup>

</email>

 

Response:

HTTP/1.1 201 Created

Location: https://api.intronis.com/v1/accounts/barracuda/computers/0000/notifications/emails/10