Test source connection
curl --request POST \
--url https://api.prequel.co/sources/{source_id}/test-connection \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"name": "<string>",
"max_concurrent_transfers": 123,
"aurora_mysql": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"aurora_postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"databricks": {
"host": "<string>",
"port": 123,
"catalog": "<string>",
"http_path": "<string>",
"oauth_client_secret_auth": {
"client_id": "<string>",
"client_secret": "<string>"
},
"hive": {
"bucket_vendor": "bucket_s3",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>",
"aws_access_keys": {
"access_id": "<string>",
"secret_key": "<string>"
}
}
},
"use_ssh_tunnel": true
},
"mongodb": {
"host": "<string>",
"port": 123,
"authentication_database": "<string>",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"mysql": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"oracle": {
"ssl_options": {
"wallet": "<string>"
},
"disable_ssl": "<unknown>",
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true
},
"postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"singlestore": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"snowflake": {
"username": "<string>",
"host": "<string>",
"port": 123,
"database": "<string>"
},
"sql_server": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
}
}
}
'{
"status": "<string>",
"data": {
"source": {
"athena": {
"workgroup": "<string>",
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
},
"ssh_public_key": "<string>"
},
"message": "<string>"
}Sources
Test source connection
Test the connection to a source.
POST
/
sources
/
{source_id}
/
test-connection
Test source connection
curl --request POST \
--url https://api.prequel.co/sources/{source_id}/test-connection \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"name": "<string>",
"max_concurrent_transfers": 123,
"aurora_mysql": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"aurora_postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"databricks": {
"host": "<string>",
"port": 123,
"catalog": "<string>",
"http_path": "<string>",
"oauth_client_secret_auth": {
"client_id": "<string>",
"client_secret": "<string>"
},
"hive": {
"bucket_vendor": "bucket_s3",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>",
"aws_access_keys": {
"access_id": "<string>",
"secret_key": "<string>"
}
}
},
"use_ssh_tunnel": true
},
"mongodb": {
"host": "<string>",
"port": 123,
"authentication_database": "<string>",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"mysql": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"oracle": {
"ssl_options": {
"wallet": "<string>"
},
"disable_ssl": "<unknown>",
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true
},
"postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"singlestore": {
"host": "<string>",
"port": 123,
"connection_database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"snowflake": {
"username": "<string>",
"host": "<string>",
"port": 123,
"database": "<string>"
},
"sql_server": {
"host": "<string>",
"port": 123,
"database": "<string>",
"auth_method": "password_auth",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
}
}
}
'{
"status": "<string>",
"data": {
"source": {
"athena": {
"workgroup": "<string>",
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
},
"ssh_public_key": "<string>"
},
"message": "<string>"
}⌘I