HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Create a datasource

This API can be used to create a new datasource. Currently the certified types are MySQL, Oracle, Postgres, SQL Server, Redshift, Teradata and Snowflake. Note: Use the host/port or uri field to setup the datasource. The uri field can be used to store the jdbc uri connection string.

Body Params
string
required

The database type. Currently the certified types are mysql, oracle, postgresql,
sqlserver, redshift, teradata and snowflake.

string
required

The host of the datasource. Note: Not required if is_virtual == True or if the 'uri' parameter is provided.

integer
required

The port of the datasource. Note: Not required if is_virtual == True or if the 'uri' parameter is provided.

string

Jdbc uri for connecting to datasources. Please ensure you either give host, port or just uri parameter. Please do not enter both the parameters.

string

The database name of the datasource. Note: Mandatory for Oracle (service name is dbname), Redshift and Postgresql datasource.

string
required

The service account username. Note: Not required if deployment_setup_complete == False
or is_virtual == True.

string

The service account password.

string
required

The title of the datasource. Note: Not required if deployment_setup_complete == False.

string

The description of the datasource.

boolean
Defaults to true

Boolean flag determining if the deployment setup is complete. When set to true, complete datasource information is required, else, only partial information is required. Defaults to True.

boolean
Defaults to false

Boolean flag determining if the datasource is private. Defaults to False.

boolean
Defaults to false

Boolean flag determining if the datasource is virtual. Defaults to False.

boolean
Defaults to false

Boolean flag determining if the datasource is hidden. Defaults to False.

string

The instance or warehouse name is required for Snowflake (when used with host/port) and optional for SQL Server. This is parsed and attached to the uri field.

Responses

Language
Credentials
URL
Choose an example:
application/json