HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Partially update a connection

PATCH /connection/{id}/ will partially update a single Connection. This method is not allowed for non-virtual BI Servers.

Path Params
integer
required

ID of the containing server

integer
required

The ID of the object

Body Params
string
required

The user-friendly name of the object

string
required

The identifier of the object as generated by the BI Server. This is used as an identifier for bulk create/update operations.

date-time

Date and time of object creation on the BI Server

date-time

Most recent update time of the object on the BI Server

string
required

Path to the object on the BI Server

string
required

The type of the object, as defined by the BI Server

string
required

Object description on the BI Server

string
required

How the connection is gathering data.

string
required

A user-friendly string conveying how the connection is gathering data

string | null
required

The hostname used to build the connection

integer

The port used to build the connection

string | null
required

For TABLE and SQL_QUERY: The type of database being accessed

string | null

For TABLE and SQL_QUERY: The schema name

string | null

For TABLE and SQL_QUERY: The table name

string | null

For SQL_QUERY: The sql query

array of strings | null

For FILES: The file paths

data_files
string | null

external_id of the parent folder. Note that the folder must exist on Alation to properly update this

Responses

Language
Credentials
URL
Choose an example:
application/json