Get Data Source

Get Data Source

This method allows you to retrieve the configuration of a data source identified by its ID.

Note that it is not possible to retrieve the configured credentials (if any) of the data source.

Request
URI
GET
https://{api_host}/api/v1/control/data-sources/{data_source_id}
COPY
Path Parameters
string
data_source_id
Required

data_source_id


Authentication
This operation uses the following authentication methods.
Responses
200

Successful Response

Returns DataSourceDetails of type(s) application/json
{
    "id": "string",
    "origin_url": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "object": "string",
    "created_at": 0,
    "last_updated_at": 0,
    "num_linked_knowledge_bases": 0
}
string As uuid As uuid
id
Required

id

string As uri As uri
origin_url
Required
Constraints: minLength: 1

URL of the source of data that can be accessed via this data source.

string
name
Optional

Name of the data source.

string
description
Optional

Description of the data source.

string
type
Required

Type of the Data Source.

Possible values are : GOOGLE_DRIVE, CONFLUENCE, S3, SHAREPOINT,
string
object
Optional
Constraints: default: data_source

Object type, which is always data_source.

integer
created_at
Required

Unix timestamp (in seconds) when the data source was created.

integer
last_updated_at
Required

Unix timestamp (in seconds) when the data source was last updated.

options
Optional

Options used when interacting with the data source.

integer
num_linked_knowledge_bases
Required

Number of linked knowledge bases.


404

Invalid data source ID.

Operation doesn't return any data structure

422

Validation Error

Returns HTTPValidationError of type(s) application/json
"HTTPValidationError Object"
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/data-sources/{data_source_id}