{ "opencollection": "1.0.0", "info": { "name": "TiDB Cloud API Keys Data Sources API", "version": "v1beta1" }, "items": [ { "info": { "name": "Data Sources", "type": "folder" }, "items": [ { "info": { "name": "List data sources", "type": "http" }, "http": { "method": "GET", "url": "https://dedicated.tidbapi.com/v1beta1/dataApps/:dataAppId/dataSources", "params": [ { "name": "dataAppId", "value": "", "type": "path", "description": "The unique identifier of the Data App." } ] }, "docs": "Returns all TiDB Cloud clusters linked as data sources to a specific Data App. Each data source includes the cluster ID, cluster name, and the databases accessible from this Data App." }, { "info": { "name": "Create a data source", "type": "http" }, "http": { "method": "POST", "url": "https://dedicated.tidbapi.com/v1beta1/dataApps/:dataAppId/dataSources", "params": [ { "name": "dataAppId", "value": "", "type": "path", "description": "The unique identifier of the Data App." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Links a TiDB Cloud cluster to a Data App as a data source. Once linked, endpoints within the Data App can execute SQL queries against databases in the linked cluster. A Data App can be linked to multiple clusters." }, { "info": { "name": "Get a data source", "type": "http" }, "http": { "method": "GET", "url": "https://dedicated.tidbapi.com/v1beta1/dataApps/:dataAppId/dataSources/:clusterId", "params": [ { "name": "dataAppId", "value": "", "type": "path", "description": "The unique identifier of the Data App." }, { "name": "clusterId", "value": "", "type": "path", "description": "The unique identifier of the TiDB Cloud cluster used as a data source." } ] }, "docs": "Returns the configuration of a specific cluster linked as a data source to a Data App, identified by the cluster ID." }, { "info": { "name": "Delete a data source", "type": "http" }, "http": { "method": "DELETE", "url": "https://dedicated.tidbapi.com/v1beta1/dataApps/:dataAppId/dataSources/:clusterId", "params": [ { "name": "dataAppId", "value": "", "type": "path", "description": "The unique identifier of the Data App." }, { "name": "clusterId", "value": "", "type": "path", "description": "The unique identifier of the TiDB Cloud cluster used as a data source." } ] }, "docs": "Unlinks a TiDB Cloud cluster from a Data App. Endpoints that reference this cluster will stop working after the data source is removed." } ] } ], "bundled": true }