Update Data Source

Update Data Source

This method allows you to update a previously created data source using its ID.

You can obtain the ID of the data source to update either from the API response when you created the data source, or by listing the available data sources.

It is sufficient to provide the fields that should be changed. To reset/remove a property from the data source, use the null value.

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

data_source_id

Request Body
DataSourceUpdateRequest of type(s) application/json
Required 
{
    "name": "string",
    "description": "string"
}
string
name
Optional

Name of the data source.

string
description
Optional

Description of the Data Dource.

credentials
Optional

Credentials used when accessing the data source.

options
Optional

Options used when interacting with the data source.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful Response

Returns DataSource of type(s) application/json 
"DataSource Object"
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.


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 -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Data Sources Operations
GET
Test Data Source Configuration
POST
Test Connectivity
GET
List Data Sources
POST
Create Data Source
GET
Get Data Source
PATCH
Update Data Source
DELETE
Delete Data Source
GET
List Knowledge Bases Linked To Data Source