Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which data sources are connected to my organization?”
“Can I search my data sources by name?”
Tell an agent
List all my data sources.
Search data sources for {search}.
Ask an LLM
“How do I connect a new data source from a YAML configuration?”
“Can I assign a runner when I add a data source?”
Tell an agent
Create a data source from this configuration: {configurationFileContents}.
Add data source {label} on runner {runnerId} with config {configurationFileContents}.
POST
/api/v1/datasources/actions/testConnection
Test a data source connection · Test datasource connection
#
Ask an LLM
“Can I check that a data source configuration connects before saving it?”
“Which runner is used when testing a connection?”
Tell an agent
Test the connection of {configurationFileContents} using runner {runnerId}.
Start a connection test on runner {runnerId} for config {configurationFileContents}.
GET
/api/v1/datasources/actions/testConnection/{operationId}
Check connection test result · Get status for async connection test
#
Ask an LLM
“Did my data source connection test succeed?”
“What is the state of an asynchronous connection test?”
Tell an agent
Get the result of connection test {operationId}.
Poll connection test {operationId} until it finishes.
Ask an LLM
“What data source-level roles can I assign?”
“Which permission sets exist for individual data sources?”
Tell an agent
List the data source roles in my organization.
Show page {page} of data source roles.
Ask an LLM
“Can I create a data source role that lets people create datasets?”
“How do I define a role limited to viewing a data source?”
Tell an agent
Create a data source role named {name}.
Create data source role {name} with create-datasets {createDatasets} and view-datasource {viewDatasource}.
Ask an LLM
“Can I change what an existing data source role is allowed to do?”
“How do I rename a custom data source role?”
Tell an agent
Rename data source role {roleId} to {name}.
Update data source role {roleId} ({name}) so manage-settings is {manageDatasourceSettings}.
Ask an LLM
“How do I remove a custom data source role?”
“Can I delete a data source permission role that is no longer used?”
Tell an agent destructive · confirm first
Delete data source role {roleId}.
Remove the custom data source role {roleId}.
Ask an LLM
“What are the details of one data source?”
“Can I fetch a single data source by its ID?”
Tell an agent
Get data source {datasourceId}.
Show the configuration details of data source {datasourceId}.
Ask an LLM
“How do I change the connection configuration of an existing data source?”
“Can I move a data source to a different runner?”
Tell an agent
Update data source {datasourceId} with configuration {configurationFileContents}.
Switch data source {datasourceId} to runner {runnerId}.
Ask an LLM
“How do I disconnect a data source and everything under it?”
“Is deleting a data source done asynchronously?”
Tell an agent destructive · confirm first
Delete data source {datasourceId}.
Remove data source {datasourceId} and all its associated resources.
GET
/api/v1/datasources/{datasourceId}/diagnosticsWarehouse
Get a data source's diagnostics warehouse · Get datasource diagnostics warehouse configuration
#
Ask an LLM
“Is a diagnostics warehouse enabled for this data source?”
“Where does a data source store scan results and failed rows?”
Tell an agent
Show the diagnostics warehouse configuration of data source {datasourceId}.
Check the diagnostics warehouse setup on data source {datasourceId}.
POST
/api/v1/datasources/{datasourceId}/diagnosticsWarehouse
Configure a data source's diagnostics warehouse · Update datasource diagnostics warehouse configuration
#
Ask an LLM
“Can I send failed rows and scan results to my own warehouse?”
“How do I choose the table name template for diagnostics data?”
Tell an agent
Enable the diagnostics warehouse on data source {datasourceId}: {enabled}.
Set the diagnostics table name template for data source {datasourceId} to {tableNameTemplate}.
POST
/api/v1/datasources/{datasourceId}/discover
Run discovery on a data source · Trigger datasource discovery
#
Ask an LLM
“Can I detect new tables in a data source without waiting for the schedule?”
“How do I trigger an on-demand discovery scan?”
Tell an agent
Run discovery on data source {datasourceId}.
Scan data source {datasourceId} for new tables and schemas now.
POST
/api/v1/datasources/{datasourceId}/onboardDatasets
Onboard discovered datasets · Onboard discovered datasets
#
Ask an LLM
“How do I turn discovered tables into monitored datasets?”
“Can I onboard several discovered datasets from a data source at once?”
Tell an agent
Onboard discovered datasets {discoveredDatasetIds} in data source {datasourceId}.
Start onboarding {discoveredDatasetIds} as datasets on data source {datasourceId}.
GET
/api/v1/datasources/{datasourceId}/onboardDatasets/{operationId}
Check dataset onboarding status · Get status for async dataset onboarding process
#
Ask an LLM
“Has onboarding of my discovered datasets finished?”
“What state is an onboarding operation in?”
Tell an agent
Get the status of onboarding {operationId} on data source {datasourceId}.
Poll dataset onboarding {operationId} for data source {datasourceId}.
GET
/api/v1/datasources/{datasourceId}/responsibilities
List who has access to a data source · List datasource responsibilities
#
Ask an LLM
“Which users and groups hold roles on a data source?”
“Who is responsible for this data source?”
Tell an agent
List responsibilities on data source {datasourceId}.
Show which users and groups have roles on data source {datasourceId}.
POST
/api/v1/datasources/{datasourceId}/responsibilities
Replace data source access assignments · Update datasource responsibilities
#
Ask an LLM
“How do I give a group a role on a data source?”
“Does updating data source responsibilities overwrite the existing list?”
Tell an agent
Set responsibilities on data source {datasourceId} to {responsibilities}.
Replace who can access data source {datasourceId} with {responsibilities}.