List Data Sources
This method allows you to list all data sources that have been configured.
Note that it is not possible to retrieve the configured credentials (if any) of a data source.
Request
URI
GET
https://{api_host}/api/v1/control/data-sources
COPY
Query Parameters
string
after
Optional
after
string
before
Optional
before
integer
limit
Optional
Constraints:
exclusiveMinimum: 0
exclusiveMaximum: 1000
default: 100
limit
integer
offset
Optional
Constraints:
minimum: 0
maximum: 4294967296
default: 0
offset
string
order
Optional
Constraints:
default: asc
order
Possible values are :
asc,
desc,
boolean
set_num_objects
Optional
Constraints:
default: false
set_num_objects
string
name
Optional
name
Responses
200
Successful Response
Returns
DataSourceListResponse
of type(s)
application/json
{
"object": "string",
"has_more": false,
"num_objects": 0,
"data": [
{
"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
}
],
"first_id": "string",
"last_id": "string"
}
string
object
Optional
Constraints:
default: list
Object type, which is always list.
boolean
has_more
Optional
True, if the server may have more objects than returned in the response.
integer
num_objects
Required
Total number of objects that match the request. Note that this field is populated only if requested by the user (see set_num_objects request parameter).
array of
object
data
Required
List of data sources.
string As uuid
As uuid
first_id
Required
ID of the first element in the list (if any)
string As uuid
As uuid
last_id
Required
ID of the last element in the list (if any)
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