Method: settings.datasources.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists datasources.
Note: This API requires an admin account to execute.
HTTP request
GET https://cloudsearch.googleapis.com/v1/settings/datasources
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageToken |
string
Starting index of the results.
|
pageSize |
integer
Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000.
|
debugOptions |
object (DebugOptions)
Common debug options.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"sources": [
{
object (DataSource)
}
],
"nextPageToken": string
} |
| Fields |
sources[] |
object (DataSource)
|
nextPageToken |
string
Token to retrieve the next page of results, or empty if there are no more results in the list.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud_search.settings.indexinghttps://www.googleapis.com/auth/cloud_search.settingshttps://www.googleapis.com/auth/cloud_search
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: settings.datasources.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDataSourceResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists datasources.\n\n**Note:** This API requires an admin account to execute.\n\n### HTTP request\n\n`GET https://cloudsearch.googleapis.com/v1/settings/datasources`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` Starting index of the results. |\n| `pageSize` | `integer` Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sources\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/settings.datasources#DataSource) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------|\n| `sources[]` | `object (`[DataSource](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources#DataSource)`)` |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.settings.indexing`\n- `https://www.googleapis.com/auth/cloud_search.settings`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
