Account Backup Status Report

Last updated on 2022-06-10 13:37:25

URI	/v1/accounts/{username}/computers/{computer_id}/reports/backup_status
URI Parameters	username (string) computer_id (string)
Methods	GET

GET /v1/accounts/{username}/reports/backup_status

Gets an account's backup status report.

Scope	accounts_read
Query Selector Parameters	condition_status (string const) – one or more of COMPLETED, RUNNING, WARNING, or FAILURE
Query Pagination Parameters	n/a – will always return report on one page
Query Sorting Parameters	order_by (string const) – USERNAME order_dir (string const) – ASC\|DESC
Request Body Parameters	n/a
Response Attributes	report_date (date) username (string) computer_id (string) computer_name (string) backupset_name (string) - name of the backup set local_start (date) - local computer's start date local_end (date) - local computer's last update/end date condition_status (string const) - COMPLETED\|RUNNING\|WARNING\|FAILURE condition_types (array of string consts) - 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/reports/backup_status 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": 100,

"count": 100,

"links": [

{

"rel": "first",

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

}

"list": [

{

"report_date": "2011-01-01T10:00:00-05:00",

"username": "barracuda_a",

"computer_id": "0000",

"computer_name": "Mail Server",

"backupset_name": "Exchange",

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

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

"condition_status": "COMPLETED",

"condition_types": [

"COMPLETED"

"errors": 0,

"warnings": 0

{

"report_date": "2011-01-01T10:00:00-05:00",

"username": "barracuda_a",

"computer_id": "0001",

"computer_name": "Personal Computer",

"backupset_name": "My Docs",

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

"local_end": "2011-01-01T01:03:00-05:00",

"condition_status": "WARNING",

"condition_types": [

"WARNINGS",

"CANCELED"

"errors": 0,

"warnings": 2

}

]

}

Example XML

Request:

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

<backup_status>

<report_date>2011-01-01T10:00:00-05:00</report_date>

<username>barracuda_a</username>

<computer_id>0000</computer_id>

<computer_name>Mail Server</computer_name>

<backupset_name>Exchange</backupset_name>

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

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

<condition_status>COMPLETED</condition_status>

<condition_type>COMPLETED</condition_types>

</backup_status>

<backup_status>

<report_date>2011-01-01T10:00:00-05:00</report_date>

<username>barracuda_a</username>

<computer_id>0001</computer_id>

<computer_name>Personal Computer</computer_name>

<backupset_name>My Docs</backupset_name>

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

<local_end>2011-01-01T01:03:00-05:00</local_end>

<condition_status>WARNING</condition_status>

<condition_type>WARNINGS</condition_types>

<condition_type>CANCELED</condition_types>

</backup_status>

</list>