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

Account Action History List

  • Last updated on

URI

/v1/accounts/{username}/action_history

URI Parameters

  • username (string)

Methods

GET

GET /v1/accounts/{username}/action_history

Gets an account’s action history (version 3.0+ only).

Scope

accounts_read

Query Selector Parameters

  • since (date)
  • type (string const) – BACKUP|RESTORE|DELETE – If no type is specified, then all types will be returned
  • status (string const) – UNINITIALIZED|RUNNING|PAUSED|SUCCESS| CANCELING|CANCELED|ERROR – If no status is specified, then all statuses will be returned

Query Pagination Parameters

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

Query Sorting Parameters

  • order_by (string const) – LOCAL_START|TYPE|STATUS
  • order_dir (string const) – ASC|DESC

Request Body Parameters

  • n/a

Response Attributes

  • action_id (int)
  • username (string)
  • computer_id (string)
  • type (string const) – BACKUP|RESTORE|DELETE
  • backupset_name (string) – name of the backup set for BACKUP action types
  • plugin (string const) – FILE|SQL|EXCHANGE
  • status (string const) – UNINITIALIZED|RUNNING|PAUSED|SUCCESS| CANCELING|CANCELED|ERROR
  • local_start (date) – local computer’s start date
  • local_end (date) – local computer’s last update/end date
  • total_files (int) – number of files to be processed
  • processed_files (int) – number of files that have been processed
  • bytes (int) – number of bytes transferred
  • condition_status (string const) – COMPLETED|RUNNING|WARNING|FAILURE
  • condition_types (array of strings) – one or more of COMPLETED, RUNNING, WARNINGS, CANCELED, ERRORS, MISSED, EXCEPTION, NO_DATA_RESTORED, NO_DATA_DELETED, NO_FILE_DATA_BACKED_UP, or NO_EXCHANGE_OR_SQL_DATA_BACKED_UP
  • errors (int) – number of logged errors
  • warnings (int) – number of logged warnings

Example JSON

Request:

GET /v1/accounts/barracuda/action_history 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": 100,

  "links": [

   {

     "rel": "first",

     "href": "https://api.intronis.com/v1/accounts/barracuda/action_history?page=1"

   },

   {

     "rel": "next",

     "href": "https://api.intronis.com/v1/accounts/barracuda/action_history?page=2"

   }

  ],

  "list": [

   {

     "action_id": 10,

     "username": “barracuda”,

     "computer_id": "0000",

     "type": "RESTORE",

     "backupset_name": "",

     "plugin": "FILE",

     "status": "RUNNING",

     "local_start": "2011-01-01T09:00:00-05:00",

     "local_end": "",

     "total_files": 100,

     "processed_files": 50,

     "bytes": 2147483648,

     "condition_status": "RUNNING",

     "condition_types ": [

       "RUNNING"

     ],

     "errors": 0,

     "warnings": 0

   },

   {

     "action_id": 10,

     "username": “barracuda”,

     "computer_id": "0001",

     "type": "BACKUP",

     "backupset_name": "My Docs",

     "plugin": "FILE",

     "status": "COMPLETED",

     "local_start": "2011-01-01T03:00:00-05:00",

     "local_end": "2011-01-01T04:00:00-05:00",

     "total_files": 100,

     "processed_files": 100,

     "bytes": 5368709120,

     "condition_status": "WARNING",

     "condition_types ": [

       "WARNINGS",

       "CANCELED"

     ],

     "errors": 0,

     "warnings": 2

   }

  ]

}

Example XML

Request:

GET /v1/accounts/barracuda/action_history 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"?>

<list page="1" page_size="10" count="100">

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

  <link rel="next" href="https://api.intronis.com/v1/accounts/barracuda/action_history?page=2"/>

  <action>

   <action_id>10</action_id>

   <username>barracuda</username>

   <computer_id>0000</computer_id>

   <type>RESTORE</type>

   <backupset_name/>

   <plugin>FILE</plugin>

   <status>RUNNING</status>

   <local_start>2011-01-01T09:00:00-05:00</local_start>

   <local_end/>

   <total_files>100</total_files>

   <processed_files>50</processed_files>

   <bytes>2147483648</bytes>

   <condition_status>RUNNING</condition_status>

   <condition_types>RUNNING</condition_types>

   <errors>0</errors>

   <warnings>0</warnings>

  </action>

  <action>

   <action_id>10</action_id>

   <username>barracuda</username>

   <computer_id>0001</computer_id>

   <type>BACKUP</type>

   <backupset_name>My Docs</backupset_name>

   <plugin>FILE</plugin>

   <status>COMPLETED</status>

   <local_start>2011-01-01T03:00:00-05:00</local_start>

   <local_end>2011-01-01T04:00:00-05:00</local_end>

   <total_files>100</total_files>

   <processed_files>100</processed_files>

   <bytes>5368709120</bytes>

   <condition_status>WARNING</condition_status>

   <condition_types>WARNINGS</condition_types>

   <condition_types>CANCELED</condition_types>

   <errors>0</errors>

   <warnings>2</warnings>

  </action>

</list>

Previous Article Next Article