HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Update a datasource

This API can be used to update an existing datasource. Note: It is encouraged to update the jdbc connection string ie uri field instead of updating host and port information.

Path Params
integer
required

id of the datasource

Body Params
string

The host of the datasource. Note: Host/Port update only possible if data source is undeployed that is deployment_setup_complete == False.

integer

The port of the datasource. Note: Host/Port update only possible if data source is undeployed that is deployment_setup_complete == False.

string

The uri of the data source. Before deployment, data source host and port information can be updated. After deployment, a uri is constructed from the host and port, and instead of the host and port, the uri should be updated.

string

The database type. Certified types are mysql, oracle, postgresql, sqlserver, redshift,
teradata and snowflake.
Note: Cannot update the dbtype if the datasource has been deployed that is
deployment_setup_complete == True.

string

The database name of the datasource. Note: Mandatory for Oracle (service name is dbname), Redshift, Postgresql datasource. Cannot be updated if data source is deployed i.e. deployment_setup_complete == True. Please update the dbname directly in the jdbc uri

string

The service account username. Note: Mandatory only if the value was not previously
provided when the data source was undeployed i.e. deployment_setup_complete was
False.

string

The service account password.

string

The title of the datasource. Note: Mandatory only if the value was not previously
provided when the data source was undeployed i.e. deployment_setup_complete was
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 data source information is required, otherwise, only partial information is
required. After this field is updated to True and data source is deployed, it cannot
be updated to False again. Defaults to True.

boolean
Defaults to false

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

string

Used to update Default Connection uri in Compose for a deployed Data Source i.e. deployment_setup_complete is True.

Responses

Language
Credentials
URL
Choose an example:
application/json