RestoreDatalakeRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-restore-datalake-request-schema.json",
  "title": "RestoreDatalakeRequest",
  "description": "Request to restore datalake from backup. Restore does not restore the database by default.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-datalake-api-openapi.yml#/components/schemas/RestoreDatalakeRequest",
  "type": "object",
  "required": [
    "datalakeName"
  ],
  "properties": {
    "datalakeName": {
      "type": "string",
      "description": "The name of the datalake to be restored. When backupId is not provided, the most recent successful backup on datalake with the provided name would be used."
    },
    "backupId": {
      "type": "string",
      "description": "The ID of the backup to be used to perform a restore. The ID could refer to backup of any datalake in the same account. This is the only way to restore from a backup that was taken on a datalake with a different name. This field is required if the --backup-location-override field is used."
    },
    "backupName": {
      "type": "string",
      "description": "The name of the backup. When provided, the restore will be performed using the latest successful backup whose name matches the parameter, and that was taken from the datalake that is being restored."
    },
    "includeDatabase": {
      "type": "boolean",
      "description": "DEPRECATED - The database is included in the restore by default. To skip it, use the --skip-ranger-hms-metadata flag."
    },
    "skipRangerHmsMetadata": {
      "type": "boolean",
      "description": "Skips the restore of the databases backing HMS/Ranger services. If this option is not provided, then by default the Atlas lineage will be restored if the backup used includes the Atlas lineage information."
    },
    "skipAtlasMetadata": {
      "type": "boolean",
      "description": "Skips the restore of the Atlas metadata. If this option is not provided, then by default the Atlas metadata will be restored if the backup used includes the Atlas metadata."
    },
    "skipRangerAudits": {
      "type": "boolean",
      "description": "Skips the restore of the Ranger audits. If this option is not provided, then by default the Ranger audits will be restored if the backup used includes the Ranger audits."
    },
    "skipAtlasIndexes": {
      "type": "boolean",
      "description": "Skips the restore of the Atlas indexes. If this option or --skipAtlasMetadata is not provided, then by default the Atlas indexes will be restored if the backup used includes the Atlas indexes. Redundant if --skipAtlasMetadata is included."
    },
    "backupLocationOverride": {
      "type": "string",
      "description": "Backup location. When provided, will be used to lookup the backup. If provided, the --backup-id parameter is required."
    },
    "skipValidation": {
      "type": "boolean",
      "description": "Skips the validation steps that run prior to the restore. If this option is not provided, the validations are performed by default."
    },
    "validationOnly": {
      "type": "boolean",
      "description": "Runs only the validation steps and then returns. If this option is not provided, the restore is performed as normal by default."
    }
  }
}