Workspaces

Test datasource credentials

Changed on

⚠️ 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. Succeeds when the connection can be established; returns an error 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
  • smb: instance_url (smb://host[:port]), username, password

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)
  • smb: share_name (required), path (optional), recursive (optional)
post/api/v3/workspaces/datasource/test

Request

  • Base URL
    https://api.lighton.ai
  • URL
    https://api.lighton.ai/api/v3/workspaces/datasource/test
  • Auth
    HTTP bearer

Request body

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

Response

Connection successful

Changes

    • info

      added the new smb enum value to the request property //// (media type: application/json)

    • info

      added the new smb enum value to the request property //// (media type: application/x-www-form-urlencoded)

    • info

      added the new smb enum value to the request property //// (media type: multipart/form-data)

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status