Method: projects.locations.dataStores.siteSearchEngine.recrawlUris

Request on-demand recrawl for a list of URIs.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
siteSearchEngine

string

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "uris": [
    string
  ],
  "siteCredential": string
}
Fields
uris[]

string

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in siteSearchEngine.
siteCredential

string

Optional. Full resource name of the SiteCredential, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*. Only set to crawl private URIs.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the siteSearchEngine resource:

  • discoveryengine.siteSearchEngines.recrawlUris

For more information, see the IAM documentation.