Account Backups API


Account Backups let you create a complete off-site backup of your Aha! account. They can be created, listed, and downloaded.

An account backup may only be created once every 24 hours.

The backup file contains a representation of all of the data in the Aha! account, including all relationships. It does not contain user authentication data or integration secrets. The backup does not include any uploaded files.

Custom Tables are an Enterprise+ exclusive feature.

GET /api/v1/account_backups

List account backups

GET /api/v1/account_backups

Example CURL command

curl -g "https://secure.aha.io/api/v1/account_backups" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backups": [

  ]
}

POST /api/v1/account_backups

Trigger creation of an account backup

The backup may take some time to generate (as long as ten minutes in a large account). You should poll the GET endpoint to see when the backup is complete. You should not poll more frequently than once every twenty seconds. Returns an HTTP status of 429 if a backup was already created within the last 24 hours.

POST /api/v1/account_backups

Example CURL command

curl "https://secure.aha.io/api/v1/account_backups" -d '' -X POST \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6453124852177627253",
    "status_code": 0,
    "status_description": "In Queue",
    "created_at": "2017-08-11T21:00:12.908Z"
  }
}

GET /api/v1/account_backups/:id

Show account backup

The status field indicates whether the backup is ready the possible values are: 0=queued, 1=working, 2=completed, 3=error.

Parameters

Name Description
id * Numeric ID of the backup to fetch

GET /api/v1/account_backups/6453124852759701371

Example CURL command

curl -g "https://secure.aha.io/api/v1/account_backups/6453124852759701371" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6453124852759701371",
    "status_code": 3,
    "status_description": "Error",
    "created_at": "2017-08-11T21:00:13.042Z"
  }
}

GET /api/v1/account_backups/:id.tgz

Download account backup

Parameters

Name Description
id * Numeric ID of the backup to download

GET /api/v1/account_backups/6453124853692422935.tgz

Example CURL command

curl -g "https://secure.aha.io/api/v1/account_backups/6453124853692422935.tgz" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/gzip

Overview

API Resources