- URL:
- https://<root>/system/indexer/reindex
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The reindex operation allows you to generate or update the indexes for content, such as users, groups, and items stored in the database store.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The mode in which the indexer should run. Values: |
(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. |
(Optional) | Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If Values: |
| The response format. The default value is Values: |
Example usage
The following is a sample POST request for the reindex operation:
POST /<context>/admin/system/indexer/reindex HTTP/1.1
Host: organization.example.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_q17HogMwJSON 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 jobs 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.example.com/<context>/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobStatus": "SUBMITTED"
}