Skip to content

connections

Manages connections to monitored data sources

bulk_disable_connection_checks

Disables a named check on this connection in the locations specified by filter
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/checks/{checkName}/bulkdisable

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
check_name Check name string

Request body

 Description                       Data type   Required 
Check search filters and table/column selectors. BulkCheckDisableParameters

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/checks/sample_check/bulkdisable^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"check_search_filters\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"column\":\"sample_column\",\"columnDataType\":\"string\"}}"

bulk_enable_connection_checks

Enables a named check on this connection in the locations specified by filter
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/checks/{checkName}/bulkenable

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
check_name Check name string

Request body

 Description                       Data type   Required 
Check search filters and rules configuration AllChecksPatchParameters

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/checks/sample_check/bulkenable^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"check_search_filters\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"column\":\"sample_column\",\"columnDataType\":\"string\"},\"check_model_patch\":{\"check_name\":\"sample_check\",\"help_text\":\"Sample help text\",\"sensor_parameters\":[],\"sensor_name\":\"sample_target/sample_category/sample_sensor\",\"quality_dimension\":\"sample_quality_dimension\",\"supports_grouping\":false,\"disabled\":false,\"exclude_from_kpi\":false,\"include_in_sla\":false,\"configured\":false,\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false},\"override_conflicts\":true}"

create_connection

Creates a new connection
Source code

POST 

http://localhost:8888/api/connections/{connectionName}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Connection specification ConnectionSpec

Usage examples 

curl -X POST http://localhost:8888/api/connections/sample_connection^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"provider_type\":\"postgresql\",\"postgresql\":{\"host\":\"localhost\",\"port\":\"5432\",\"database\":\"db\",\"user\":\"PASSWD\",\"sslmode\":\"disable\"},\"parallel_jobs_limit\":4,\"incident_grouping\":{\"grouping_level\":\"table_dimension_category\",\"minimum_severity\":\"warning\",\"max_incident_length_days\":60,\"mute_for_days\":60}}"

create_connection_basic

Creates a new connection given the basic information.
Source code

POST 

http://localhost:8888/api/connections/{connectionName}/basic

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Basic connection model ConnectionModel

Usage examples 

curl -X POST http://localhost:8888/api/connections/sample_connection/basic^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"connection_name\":\"sample_connection\",\"parallel_runs_limit\":4,\"provider_type\":\"postgresql\",\"postgresql\":{\"host\":\"localhost\",\"port\":\"5432\",\"database\":\"db\",\"user\":\"PASSWD\",\"sslmode\":\"disable\"},\"run_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true},\"run_profiling_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"profiling\"},\"run_monitoring_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"monitoring\"},\"run_partition_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"partitioned\"},\"collect_statistics_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"columnNames\":[]},\"data_clean_job_template\":{\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true},\"can_edit\":false,\"can_collect_statistics\":true,\"can_run_checks\":true,\"can_delete_data\":true}"

delete_connection

Deletes a connection
Source code

DELETE 

http://localhost:8888/api/connections/{connectionName}

Return value

 Property name   Description                       Data type 
dqo_queue_job_id DqoQueueJobId

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl -X DELETE http://localhost:8888/api/connections/sample_connection^
    -H "Accept: application/json"

get_all_connections

Returns a list of connections (data sources)
Source code

GET 

http://localhost:8888/api/connections

Return value

 Property name   Description                       Data type 
connection_model List[ConnectionModel]

Usage examples 

curl http://localhost:8888/api/connections^
    -H "Accept: application/json"

get_connection

Return the full details of a connection given the connection name
Source code

GET 

http://localhost:8888/api/connections/{connectionName}

Return value

 Property name   Description                       Data type 
connection_specification_model ConnectionSpecificationModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection^
    -H "Accept: application/json"

get_connection_basic

Return the basic details of a connection given the connection name
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/basic

Return value

 Property name   Description                       Data type 
connection_model ConnectionModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/basic^
    -H "Accept: application/json"

get_connection_comments

Return the comments for a connection
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/comments

Return value

 Property name   Description                       Data type 
comment_spec List[CommentSpec]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/comments^
    -H "Accept: application/json"

get_connection_common_columns

Finds common column names that are used on one or more tables. The list of columns is sorted in descending order by column name.
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/commoncolumns

Return value

 Property name   Description                       Data type 
common_column_model List[CommonColumnModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/commoncolumns^
    -H "Accept: application/json"

get_connection_default_grouping_configuration

Return the default data grouping configuration for a connection
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/defaultgroupingconfiguration

Return value

 Property name   Description                       Data type 
data_grouping_configuration_spec DataGroupingConfigurationSpec

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/defaultgroupingconfiguration^
    -H "Accept: application/json"

get_connection_incident_grouping

Retrieves the configuration of data quality incident grouping and incident notifications
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/incidentgrouping

Return value

 Property name   Description                       Data type 
connection_incident_grouping_spec ConnectionIncidentGroupingSpec

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/incidentgrouping^
    -H "Accept: application/json"

get_connection_labels

Return the labels for a connection
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/labels

Return value

 Property name   Description                       Data type 
string List[string]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/labels^
    -H "Accept: application/json"

get_connection_scheduling_group

Return the schedule for a connection for a scheduling group
Source code

GET 

http://localhost:8888/api/connections/{connectionName}/schedules/{schedulingGroup}

Return value

 Property name   Description                       Data type 
monitoring_schedule_spec MonitoringScheduleSpec

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
scheduling_group Check scheduling group (named schedule) CheckRunScheduleGroup

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schedules/"partitioned_daily"^
    -H "Accept: application/json"

update_connection

Updates an existing connection
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Connection specification ConnectionSpec

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"provider_type\":\"postgresql\",\"postgresql\":{\"host\":\"localhost\",\"port\":\"5432\",\"database\":\"db\",\"user\":\"PASSWD\",\"sslmode\":\"disable\"},\"parallel_jobs_limit\":4,\"incident_grouping\":{\"grouping_level\":\"table_dimension_category\",\"minimum_severity\":\"warning\",\"max_incident_length_days\":60,\"mute_for_days\":60}}"

update_connection_basic

Updates the basic information of a connection
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/basic

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Connection basic details ConnectionModel

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/basic^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"connection_name\":\"sample_connection\",\"parallel_runs_limit\":4,\"provider_type\":\"postgresql\",\"postgresql\":{\"host\":\"localhost\",\"port\":\"5432\",\"database\":\"db\",\"user\":\"PASSWD\",\"sslmode\":\"disable\"},\"run_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true},\"run_profiling_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"profiling\"},\"run_monitoring_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"monitoring\"},\"run_partition_checks_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"checkType\":\"partitioned\"},\"collect_statistics_job_template\":{\"connection\":\"sample_connection\",\"enabled\":true,\"columnNames\":[]},\"data_clean_job_template\":{\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true},\"can_edit\":false,\"can_collect_statistics\":true,\"can_run_checks\":true,\"can_delete_data\":true}"

update_connection_comments

Updates (replaces) the list of comments of a connection
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/comments

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
List of comments List[CommentSpec]

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/comments^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "[]"

update_connection_default_grouping_configuration

Updates the default data grouping connection of a connection
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/defaultgroupingconfiguration

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Default data grouping configuration to be assigned to a connection DataGroupingConfigurationSpec

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/defaultgroupingconfiguration^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"level_3\":{\"source\":\"column_value\",\"column\":\"sample_column\"}}"

update_connection_incident_grouping

Updates (replaces) configuration of incident grouping and notifications on a connection (data source) level.
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/incidentgrouping

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
Incident grouping and notification configuration ConnectionIncidentGroupingSpec

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/incidentgrouping^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"grouping_level\":\"table_dimension\",\"minimum_severity\":\"warning\",\"divide_by_data_groups\":true,\"max_incident_length_days\":60,\"mute_for_days\":60,\"webhooks\":{\"incident_opened_webhook_url\":\"https://sample_url.com/opened\",\"incident_acknowledged_webhook_url\":\"https://sample_url.com/acknowledged\",\"incident_resolved_webhook_url\":\"https://sample_url.com/resolved\",\"incident_muted_webhook_url\":\"https://sample_url.com/muted\"}}"

update_connection_labels

Updates the list of labels of a connection
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/labels

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Request body

 Description                       Data type   Required 
List of labels List[string]

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/labels^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "[]"

update_connection_scheduling_group

Updates the schedule of a connection for a scheduling group (named schedule for checks with a similar time series configuration)
Source code

PUT 

http://localhost:8888/api/connections/{connectionName}/schedules/{schedulingGroup}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
scheduling_group Check scheduling group (named schedule) CheckRunScheduleGroup

Request body

 Description                       Data type   Required 
Monitoring schedule definition to store MonitoringScheduleSpec

Usage examples 

curl -X PUT http://localhost:8888/api/connections/sample_connection/schedules/"partitioned_daily"^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"cron_expression\":\"0 12 1 * *\"}"