Backups

All requests go to the gateway. Authentication is not yet documented. Placeholder values in angle brackets (<...>) are yours to fill in.

To restore an instance, use Restore Instance.

List Backup History

Query · db_listUserDbBackupHistoryByDb

Lists the backup history of a database instance, page by page.

Arguments

NameTypeRequired
pagerdb_PagerInputNo
filterdb_DbBackupHistoryFilterInputYes

filter

FieldTypeRequired
dbIdIDYes
subscriptionIdIDYes
statusdb_DbBackupHistoryStatusNo

Variables

{
  "pager": { "page": 1, "limit": 20 },
  "filter": {
    "dbId": "<instance id>",
    "subscriptionId": "<subscription id>"
  }
}

Request

query ListDbBackupHistory(
  $pager: db_PagerInput
  $filter: db_DbBackupHistoryFilterInput!
) {
  db_listUserDbBackupHistoryByDb(pager: $pager, filter: $filter) {
    dbBackupHistories {
      id
      fileName
      fileSize
      fileSizeUnit
      status
      createdAt
    }
    pagination {
      currentPage
      lastPage
      total
    }
  }
}

Response

db_ListDbBackupHistoryResponse!

FieldType
dbBackupHistories[db_DbBackupHistoryResponse!]!
paginationdb_Pagination, nullable

db_DbBackupHistoryResponse

FieldType
idID!
dbIdID!
subscriptionIdID!
mysabayUserIdInt!
fileNameString!
fileSizeFloat!
fileSizeUnitdb_FileSizeUnit!
statusdb_DbBackupHistoryStatus!
createdAtFloat!
updatedAtFloat!

List Backup Log

Query · db_listUserDbBackupLogByDb

Lists the log entries for one backup of a database instance, page by page. Each entry records a backup, restore, expire or delete action.

Arguments

NameTypeRequired
pagerdb_PagerInputNo
filterdb_DbBackupLogFilterInputYes

filter

FieldTypeRequired
dbIdIDYes
subscriptionIdIDYes
dbBackupHistoryIdIDYes

dbBackupHistoryId is the id of an entry from List Backup History.

Variables

{
  "pager": { "page": 1, "limit": 20 },
  "filter": {
    "dbId": "<instance id>",
    "subscriptionId": "<subscription id>",
    "dbBackupHistoryId": "<backup history id>"
  }
}

Request

query ListDbBackupLog(
  $pager: db_PagerInput
  $filter: db_DbBackupLogFilterInput!
) {
  db_listUserDbBackupLogByDb(pager: $pager, filter: $filter) {
    dbBackupLogs {
      id
      actionType
      status
      errorMessage
      initializedAt
      finishedAt
    }
    pagination {
      currentPage
      lastPage
      total
    }
  }
}

Response

db_ListDbBackupLogResponse!

FieldType
dbBackupLogs[db_DbBackupLogResponse!]!
paginationdb_Pagination, nullable

db_DbBackupLogResponse

FieldType
idID!
dbIdID!
subscriptionIdID!
dbBackupHistoryIdID!
mysabayUserIdInt!
actionTypedb_DbBackupLogActionType!
statusdb_DbBackupLogStatus!
errorMessageString
initializedAtFloat!
finishedAtFloat!
createdAtFloat!
updatedAtFloat!