ServerBackupListResponse

Successful response with a list of ServerBackup

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items returned by the operation

Array [

server_backup_idintegerrequired

backup_recurrent_idinteger | nullnullablerequired

Id of the run of the recurrent backup that made the backup; null for a one-off backup

backup_server_id_parentinteger | nullnullablerequired

Id of the backup this one is based on, for incremental backups; null otherwise

server_idinteger | nullnullablerequired

Id of the backed up server (GET /api/v3/servers/{server_id})

cluster_id_server_residenceinteger | nullnullablerequired

Id of the cluster where the server resides

cluster_id_backup_residenceinteger | nullnullablerequired

Id of the cluster where the backup is kept

backup_type_idinteger | nullnullablerequired

Id of the backup type

backup_modestring | nullnullablerequired

Strategy of the backup type: FULL, INC (incremental) or DIFF (differential)

backup_frequency_idinteger | nullnullablerequired

Id of the frequency of the backup type

backup_type_codestring | nullnullablerequired

Code of the backup type, for example CLOUD_DAILY, CLOUD_WEEKLY or CLOUD_UNA_TANTUM (one-off)

backup_frequency_codestring | nullnullablerequired

Frequency of the backup type: D daily, W weekly, HM twice a month, M monthly, HY every six months, Y yearly, C one-off, R private cloud replication

backup_datedate-timenullablerequired

Date the backup was taken

backup_sizeinteger | nullnullablerequired

Size of the backup, in MB

backup_durationstring | nullnullablerequired

Duration of the backup, as text in the H:MM:SS form, preceded by the days for longer backups (for example 1 day, 2:03:04)

exit_statusinteger | nullnullablerequired

Exit status of the backup: 0 if it succeeded

error_typestring | nullnullablerequired

Error of the backup, as a code or a message (for example DOWNLOAD_DISK_FAILED); N.A. when it succeeded

date_createddate-timenullablerequired

checksumstring | nullnullablerequired

Checksum of the backup, sent by the backup scripts; null if not sent

backup_user_visibilityboolean | nullnullablerequired

Whether the customer can see the backup: only the most recent successful backups of each type are visible, as many as the retention of the type, and only those are returned

]

metarequired

Always null: only the paginated lists have a meta

Constant value: null

ServerBackupListResponse

{
  "error": 0,
  "message": "string",
  "data": [
    {
      "server_backup_id": 0,
      "backup_recurrent_id": 0,
      "backup_server_id_parent": 0,
      "server_id": 0,
      "cluster_id_server_residence": 0,
      "cluster_id_backup_residence": 0,
      "backup_type_id": 0,
      "backup_mode": "string",
      "backup_frequency_id": 0,
      "backup_type_code": "string",
      "backup_frequency_code": "string",
      "backup_date": "2024-07-29T15:51:28.071Z",
      "backup_size": 0,
      "backup_duration": "string",
      "exit_status": 0,
      "error_type": "string",
      "date_created": "2024-07-29T15:51:28.071Z",
      "checksum": "string",
      "backup_user_visibility": true
    }
  ]
}