NSX-T Data Center REST API

BackupOverview (type)

{
  "description": "Data for a single backup/restore card",
  "extends": {
    "$ref": "ClusterBackupInfoListResult"
  },
  "id": "BackupOverview",
  "module_id": "BackupConfiguration",
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "backup_config": {
      "$ref": "BackupConfiguration",
      "description": "Configuration to generate a manual/automated backup",
      "required": true,
      "title": "Backup configuration"
    },
    "backup_operation_history": {
      "$ref": "BackupOperationHistory",
      "description": "Status of the last backup execution per component",
      "required": true,
      "title": "Last backup status"
    },
    "current_backup_operation_status": {
      "$ref": "CurrentBackupOperationStatus",
      "description": "Backup status decribes type, phase, success/failure and time of a | latest backup execution",
      "required": true,
      "title": "Current backup status"
    },
    "cursor": {
      "readonly": true,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "restore_status": {
      "$ref": "ClusterRestoreStatus",
      "description": "Status of restore process executing/executed on appliance",
      "required": true,
      "title": "Current restore status"
    },
    "result_count": {
      "readonly": true,
      "title": "Count of results found (across all pages), set only on first page",
      "type": "integer"
    },
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo"
      },
      "readonly": true,
      "required": true,
      "title": "List of timestamps of backed-up cluster files",
      "type": "array"
    },
    "sort_ascending": {
      "readonly": true,
      "title": "If true, results are sorted in ascending order",
      "type": "boolean"
    },
    "sort_by": {
      "readonly": true,
      "title": "Field by which records are sorted",
      "type": "string"
    }
  },
  "title": "Backup overview",
  "type": "object"
}