v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
Workspaces

Test datasource credentials

⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Test datasource credentials without persisting anything.

Validates that the provided credentials can connect to the external source. Returns 200 if the connection succeeds, 400 otherwise. No datasource or import is created. Use this before PATCH /api/v3/workspaces/{id} with a datasource payload to surface connection errors before committing the conversion.

Access: any authenticated user.

Credentials per type:

  • googledrive: service_account_file (JSON string of the service account key file)
  • sharepoint: client_id, client_secret, tenant_id, site_id (optional), site_name (optional)
  • servicenow: instance_url, username, password
  • webscrapper: no credentials required

Filter criteria per type:

  • googledrive: folder_id (required), recursive (optional)
  • sharepoint: folder_path (required), recursive (optional)
  • servicenow: doc_type (required, e.g. knowledge)
  • webscrapper: start_url (required)
post/api/v3/workspaces/datasource/test

Request body

type'googledrive' | 'sharepoint' | 'servicenow' | 'webscrapper' required
namestring required
credentialsobject
filter_criteriaobject

Response

Connection successful