--- title: "Get Data Source" method: GET path: "/api/v1/data-sources/{data_source_id}" tags: ["Data Sources"] --- # Get Data Source `GET /api/v1/data-sources/{data_source_id}` Get a data source by ID. ## Path parameters - `data_source_id` string, uuid, required ## Cookies - `session` string, nullable ## Response `200` Successful Response - DataSource — Schema for a data source. - `id` string, uuid, required — Unique identifier - `created_at` string, date-time, nullable — Creation datetime - `updated_at` string, date-time, nullable — Update datetime - `name` string, required — The name of the data source. - `source_type` 'S3' | 'AZURE_STORAGE_BLOB' | 'GOOGLE_DRIVE' | 'MICROSOFT_ONEDRIVE' | 'MICROSOFT_SHAREPOINT' | 'SLACK' | 'NOTION_PAGE' | 'CONFLUENCE' | 'JIRA' | 'JIRA_V2' | 'BOX', required - `custom_metadata` object, nullable — Custom metadata that will be present on all data loaded from the data source - `component` union, required — Component that implements the data source - object - CloudS3DataSource - `supports_access_control` boolean - `bucket` string, required — The name of the S3 bucket to read from. - `prefix` string, nullable — The prefix of the S3 objects to read from. - `regex_pattern` string, nullable — The regex pattern to filter S3 objects. Must be a valid regex pattern. - `aws_access_id` string, nullable — The AWS access ID to use for authentication. - `aws_access_secret` string, password, nullable — The AWS access secret to use for authentication. - `s3_endpoint_url` string, nullable — The S3 endpoint URL to use for authentication. - `class_name` string - CloudAzStorageBlobDataSource - `supports_access_control` boolean - `container_name` string, required — The name of the Azure Storage Blob container to read from. - `account_url` string, required — The Azure Storage Blob account URL to use for authentication. - `blob` string, nullable — The blob name to read from. - `prefix` string, nullable — The prefix of the Azure Storage Blob objects to read from. - `account_name` string, nullable — The Azure Storage Blob account name to use for authentication. - `account_key` string, password, nullable — The Azure Storage Blob account key to use for authentication. - `tenant_id` string, nullable — The Azure AD tenant ID to use for authentication. - `client_id` string, nullable — The Azure AD client ID to use for authentication. - `client_secret` string, password, nullable — The Azure AD client secret to use for authentication. - `class_name` string - CloudGoogleDriveDataSource - `supports_access_control` boolean - `folder_id` string, required — The ID of the Google Drive folder to read from. - `service_account_key` object, nullable — A dictionary containing secret values - `class_name` string - CloudOneDriveDataSource - `supports_access_control` true - `user_principal_name` string, required — The user principal name to use for authentication. - `folder_path` string, nullable — The path of the OneDrive folder to read from. - `folder_id` string, nullable — The ID of the OneDrive folder to read from. - `client_id` string, required — The client ID to use for authentication. - `client_secret` string, password, required — The client secret to use for authentication. - `tenant_id` string, required — The tenant ID to use for authentication. - `required_exts` string[], nullable — The list of required file extensions. - `class_name` string - CloudSharepointDataSource - `supports_access_control` true - `site_name` string, nullable — The name of the SharePoint site to download from. - `site_id` string, nullable — The ID of the SharePoint site to download from. - `folder_path` string, nullable — The path of the Sharepoint folder to read from. - `folder_id` string, nullable — The ID of the Sharepoint folder to read from. - `drive_name` string, nullable — The name of the Sharepoint drive to read from. - `client_id` string, required — The client ID to use for authentication. - `client_secret` string, password, required — The client secret to use for authentication. - `tenant_id` string, required — The tenant ID to use for authentication. - `required_exts` string[], nullable — The list of required file extensions. - `get_permissions` boolean — Whether to get permissions for the sharepoint site. - `include_path_patterns` string[], nullable — List of regex patterns for file paths to include. Full paths (including filename) must match at least one pattern to be included. Example: ['/reports/', '/docs/.*\.pdf$', '^Report.*\.pdf$'] - `exclude_path_patterns` string[], nullable — List of regex patterns for file paths to exclude. Files whose paths (including filename) match any pattern will be excluded. Example: ['/temp/', '/backup/', '\.git/', '\.tmp$', '^~'] - `class_name` string - CloudSlackDataSource - `supports_access_control` boolean - `slack_token` string, password, required — Slack Bot Token. - `channel_ids` string, nullable — Slack Channel. - `latest_date` string, nullable — Latest date. - `earliest_date` string, nullable — Earliest date. - `earliest_date_timestamp` number, nullable — Earliest date timestamp. - `latest_date_timestamp` number, nullable — Latest date timestamp. - `channel_patterns` string, nullable — Slack Channel name pattern. - `class_name` string - CloudNotionPageDataSource - `supports_access_control` boolean - `integration_token` string, password, required — The integration token to use for authentication. - `database_ids` string, nullable — The Notion Database Id to read content from. - `page_ids` string, nullable — The Page ID's of the Notion to read from. - `class_name` string - CloudConfluenceDataSource - `supports_access_control` boolean - `server_url` string, required — The server URL of the Confluence instance. - `authentication_mechanism` string, required — Type of Authentication for connecting to Confluence APIs. - `user_name` string, nullable — The username to use for authentication. - `api_token` string, password, nullable — The API token to use for authentication. - `space_key` string, nullable — The space key to read from. - `page_ids` string, nullable — The page IDs of the Confluence to read from. - `cql` string, nullable — The CQL query to use for fetching pages. - `label` string, nullable — The label to use for fetching pages. - `index_restricted_pages` boolean — Whether to index restricted pages. - `keep_markdown_format` boolean — Whether to keep the markdown format. - `failure_handling` FailureHandlingConfig — Configuration for handling different types of failures during data source processing. - `skip_list_failures` boolean — Whether to skip failed batches/lists and continue processing - `class_name` string - CloudJiraDataSource — Cloud Jira Data Source integrating JiraReader. - `supports_access_control` boolean - `email` string, nullable — The email address to use for authentication. - `api_token` string, password, nullable — The API/ Access Token used for Basic, PAT and OAuth2 authentication. - `server_url` string, nullable — The server url for Jira Cloud. - `cloud_id` string, nullable — The cloud ID, used in case of OAuth2. - `authentication_mechanism` string, required — Type of Authentication for connecting to Jira APIs. - `query` string, required — JQL (Jira Query Language) query to search. - `class_name` string - CloudJiraDataSourceV2 — Cloud Jira Data Source integrating JiraReaderV2. - `supports_access_control` boolean - `email` string, nullable — The email address to use for authentication. - `api_token` string, password, nullable — The API Access Token used for Basic, PAT and OAuth2 authentication. - `server_url` string, required — The server url for Jira Cloud. - `cloud_id` string, nullable — The cloud ID, used in case of OAuth2. - `authentication_mechanism` string, required — Type of Authentication for connecting to Jira APIs. - `api_version` '2' | '3' — Jira REST API version to use (2 or 3). 3 supports Atlassian Document Format (ADF). - `query` string, required — JQL (Jira Query Language) query to search. - `fields` string[], nullable — List of fields to retrieve from Jira. If None, retrieves all fields. - `expand` string, nullable — Fields to expand in the response. - `requests_per_minute` integer, nullable — Rate limit for Jira API requests per minute. - `get_permissions` boolean — Whether to fetch project role permissions and issue-level security - `class_name` string - CloudBoxDataSource - `supports_access_control` boolean - `folder_id` string, nullable — The ID of the Box folder to read from. - `authentication_mechanism` 'developer_token' | 'ccg', required - `developer_token` string, password, nullable — Developer token for authentication if authentication_mechanism is 'developer_token'. - `client_id` string, nullable — Box API key used for identifying the application the user is authenticating with - `client_secret` string, password, nullable — Box API secret used for making auth requests. - `user_id` string, nullable — Box User ID, if provided authenticates as user. - `enterprise_id` string, nullable — Box Enterprise ID, if provided authenticates as service. - `class_name` string - `version_metadata` DataSourceReaderVersionMetadata - `reader_version` '1.0' | '2.0' | '2.1', nullable — The version of the reader to use for this data source. - `project_id` string, uuid, required ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/run-llama/apis/llama-platform.md) · [All operations](https://skmtc.net/run-llama/apis/llama-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/run-llama/llama-platform/revisions/b17341164de9/schema)