Create and maintain connectors

Create connectors to access external data sources, then query, update, validate, or delete them in later calls. This page does not cover browsing databases, tables, or files in a connector; see Browse connector data sources and Manage connector files instead.

Prerequisites

Prepare credentials that can access the target workspace. For service endpoints, authentication, and general request formats, see Make your first AI Studio API call.

Before updating, validating, or deleting an existing connector, obtain its ID from the connector list or details.

Call sequence

  1. List connectors to check whether an existing connector can be reused and obtain the ID of one to maintain.

  2. To add an external data source, create a connector and retain its returned ID for later browsing or task calls.

  3. Validate the connector configuration before use. If you adjust the configuration, update and validate it again.

  4. Get connector details to confirm the current configuration. Delete the connector only after you determine it is no longer needed.

API operations

Create and check connectors

Task

Use it when

Query connectors

Check for a reusable connector before creating one, or obtain a target ID.

Create a connector

Connect a new external data source.

Validate connector configuration

Check whether the configuration can be used to connect after creation or update.

Query connector details

Confirm current information for a target connector.

Maintain connectors

Task

Use it when

Update a connector

Modify an existing connector configuration.

Delete a connector

You confirmed that the connector is no longer needed.

Confirm the result

After creation or an update, use Get connector details to confirm the target connector. To confirm that its configuration can connect, review the result of Validate connector configuration.

Limitations and notes

  • Before deletion, confirm that no data browsing, import, export, or synchronization task still depends on the connector.

  • Connector validation only checks connection conditions. The objects that can actually be accessed are defined by data-source or file browsing results.

Next steps

Last updated on