Skip to main content

site/search/rebuild (GET) (TCS)

Overview

Return rebuild information

  • REST Method: GET
  • Method Access: public

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body

Message Format

Output:

<search>
    <pending>{int}</pending>
</search>

Implementation Notes

Returns the number of pages on queue to be indexed.

Curl Code Sample: Retrieve Rebuild Information

The following command retrieves the number of pages pending in the index queue:

Sample Code

curl -u username:password -i http://mindtouch.address/@api/deki/site/search/rebuild

Sample Response from executing Code

Indicates the site is not being indexed or that indexing has been complete.

Running POST:site/search/rebuild and then this feature in quick succession will most likely yield a number larger than 0.

Content-Type: application/xml

<search>
    <pending>0</pending>
</search>

Implementation notes 

curl flags

-u
Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
-i
Outputs the HTTP response headers. Useful for debugging.
  • Was this article helpful?