- URL:https://<root>/system/indexer/reindex(POST only)
- Required Capability:Default administrator role
- Version Introduced:10.9
Description
The operation allows you to generate or update the indexes for content, such as users, groups, and items stored in the database store.
Caution:
The reindex operation may take a while to finish. During this time, the index service may not respond correctly to index queries. Portal content and search operations will be unavailable until the reindex is complete. Performing the reindex operation during system maintenance or downtime is recommended.
Request parameters
Parameter | Details |
---|---|
mode (Required) | The mode in which the indexer should run. Values: USER_MODE | GROUP_MODE | SEARCH_MODE | FULL_MODE |
includes (Optional) | A comma-separated list of elements to include in the index. This is useful if you want to only index certain items or user accounts. |
async (Optional) | Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the operation will return a JSON object containing job information that can be used to track the job's status. The default value is false. Values: true | false |
f | The response format. The default value is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the reindex operation:
POST /context/admin/system/indexer/reindex HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
mode=GROUP_MODE&includes=&async=true&f=pjson&&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw
JSON Response example
The following response is returned when reindexing is complete when async is false.
{"status": "success"}
If async is true, the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource topic.
{
"jobsUrl": "https://organization.domain.com/context/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobStatus": "SUBMITTED"
}