Skip to main content
POST
/
api
/
migration
/
data-migration
/
validate
Validate a migration request without creating a run
curl --request POST \
  --url https://api.example.com/api/migration/data-migration/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_s3_bucket": "<string>",
  "tracking_database": "<string>",
  "tracking_location": "<string>",
  "report_output_location": "<string>",
  "s3_access_key": "<string>",
  "s3_secret_key": "<string>",
  "s3_endpoint": "<string>",
  "distcp_mappers": 50,
  "distcp_bandwidth": 100,
  "email_recipients": "<string>",
  "mapr_user": "<string>",
  "mapr_ticketfile_location": "<string>",
  "kinit_principal": "<string>",
  "kinit_keytab": "<string>",
  "kinit_password": "<string>",
  "inplace_iceberg_migration": false,
  "migration_tables": [
    {
      "database": "<string>",
      "table": "*",
      "dest_database": "<string>",
      "bucket": "<string>",
      "endpoint": "<string>",
      "partition_filter": "<string>"
    }
  ],
  "metadata_tables": [
    {
      "database": "<string>",
      "table": "*",
      "inplace_migration": true,
      "destination_iceberg_database": "<string>"
    }
  ],
  "folder_tables": [
    {
      "source_path": "<string>",
      "target_bucket": "<string>",
      "dest_folder": "<string>",
      "endpoint": "<string>"
    }
  ]
}
'
{
  "valid": true,
  "migration_type": "<string>",
  "table_count": 123,
  "source_format": "<string>",
  "message": "Request is valid."
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request to create a data migration run.

source_format
enum<string>
required
Available options:
mapr,
hdfs,
s3
migration_type
enum<string>
required
Available options:
file_only,
data_hive_to_hive,
data_hive_to_iceberg,
metadata_hive_to_iceberg
default_s3_bucket
string
required
tracking_database
string
required
tracking_location
string
required
report_output_location
string
required
s3_access_key
string | null
s3_secret_key
string | null
s3_endpoint
string | null
distcp_mappers
integer
default:50
distcp_bandwidth
integer
default:100
email_recipients
string | null
mapr_user
string | null
mapr_ticketfile_location
string | null
kinit_principal
string | null
kinit_keytab
string | null
kinit_password
string | null
inplace_iceberg_migration
boolean
default:false
migration_tables
DataMigrationTableRow · object[] | null
metadata_tables
MetadataMigrationTableRow · object[] | null
folder_tables
FolderCopyTableRow · object[] | null

Response

Successful Response

Validation-only response that doesn't create a run.

valid
boolean
required
migration_type
string
required
table_count
integer
required
source_format
string
required
message
string
default:Request is valid.