Test import source
curl --request POST \
--url https://api.prequel.co/import/sources/{id}/test-source \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"auth_method": "<string>",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"name": "<string>",
"redshift": {
"auth_method": "<unknown>",
"aws_access_keys": {
"password": "<string>",
"access_id": "<string>",
"secret_key": "<string>"
},
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"cluster": "<string>",
"region": "<string>",
"workgroup": "<string>",
"username": "<string>",
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"redshift_serverless": {
"auth_method": "<unknown>",
"aws_access_keys": {
"password": "<string>",
"access_id": "<string>",
"secret_key": "<string>"
},
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"workgroup": "<string>",
"region": "<string>",
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"bigquery": {
"auth_method": "<unknown>",
"gcp_service_account_role": {
"service_account_email": "jsmith@example.com"
},
"project_id": "<string>",
"region": "<string>"
},
"s3": {
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name"
},
"bucket_name": "<string>",
"region": "<string>",
"bucket_host": "<string>",
"use_ssh_tunnel": true
},
"abs": {
"bucket_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "<string>",
"azure_service_shared_access_signature": {
"shared_access_signature_token": "<string>"
}
},
"sftp": {
"username": "<string>",
"host": "<string>",
"port": 123,
"auth_method": "<string>",
"public_key_auth": {
"public_key": "<string>"
}
},
"gcs": {
"auth_method": "<unknown>",
"gcp_service_account_role": {
"service_account_email": "jsmith@example.com"
},
"bucket_name": "<string>",
"region": "<string>"
},
"s3_compatible": {
"host": "<string>",
"port": 123,
"bucket_name": "<string>",
"auth_method": "<string>",
"aws_access_keys": {
"access_id": "<string>",
"secret_key": "<string>"
},
"disable_ssl": true,
"use_ssh_tunnel": true
},
"snowflake": {
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"username": "<string>",
"auth_method": "<string>",
"public_key_auth": {
"public_key": "<string>"
}
}
}
}
'{
"status": "<string>",
"data": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>"
}Import Sources
Test import source
Probe an import source’s connectivity and credentials. Optionally accepts a partial ‘source’ body to preview a credential change without persisting it.
POST
/
import
/
sources
/
{id}
/
test-source
Test import source
curl --request POST \
--url https://api.prequel.co/import/sources/{id}/test-source \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"postgres": {
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"auth_method": "<string>",
"password_auth": {
"username": "<string>",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": true
},
"name": "<string>",
"redshift": {
"auth_method": "<unknown>",
"aws_access_keys": {
"password": "<string>",
"access_id": "<string>",
"secret_key": "<string>"
},
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"cluster": "<string>",
"region": "<string>",
"workgroup": "<string>",
"username": "<string>",
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"redshift_serverless": {
"auth_method": "<unknown>",
"aws_access_keys": {
"password": "<string>",
"access_id": "<string>",
"secret_key": "<string>"
},
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"workgroup": "<string>",
"region": "<string>",
"use_ssh_tunnel": true,
"disable_ssl": true,
"connection_timeout_in_seconds": 1
},
"bigquery": {
"auth_method": "<unknown>",
"gcp_service_account_role": {
"service_account_email": "jsmith@example.com"
},
"project_id": "<string>",
"region": "<string>"
},
"s3": {
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name"
},
"bucket_name": "<string>",
"region": "<string>",
"bucket_host": "<string>",
"use_ssh_tunnel": true
},
"abs": {
"bucket_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "<string>",
"azure_service_shared_access_signature": {
"shared_access_signature_token": "<string>"
}
},
"sftp": {
"username": "<string>",
"host": "<string>",
"port": 123,
"auth_method": "<string>",
"public_key_auth": {
"public_key": "<string>"
}
},
"gcs": {
"auth_method": "<unknown>",
"gcp_service_account_role": {
"service_account_email": "jsmith@example.com"
},
"bucket_name": "<string>",
"region": "<string>"
},
"s3_compatible": {
"host": "<string>",
"port": 123,
"bucket_name": "<string>",
"auth_method": "<string>",
"aws_access_keys": {
"access_id": "<string>",
"secret_key": "<string>"
},
"disable_ssl": true,
"use_ssh_tunnel": true
},
"snowflake": {
"host": "<string>",
"port": 123,
"database": "<string>",
"schema": "<string>",
"username": "<string>",
"auth_method": "<string>",
"public_key_auth": {
"public_key": "<string>"
}
}
}
}
'{
"status": "<string>",
"data": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://import-docs.prequel.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
Import Source ID.
Body
application/json
Optional partial source patch merged onto the saved source to test connection without persisting.
- Source
- Source
- Source
- Source
- Source
- Source
- Source
- Source
- Source
- Source
Show child attributes
Show child attributes
⌘I