Reindex

URL:: https://<root>/system/indexer/reindex
Methods:: POST
Required Capability:: Access allowed with the "Security and Infrastructure" privilege
Version Introduced:: 10.2.1

Description

The reindex operation generates or updates the indexes for content, such as the users, groups, and items stored in the database store. You are required to use this operation to update indexes when upgrading from earlier version of Portal for ArcGIS.

Request parameters

Parameter	Details
`mode`	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, such as specific items or user accounts.
`async`	Introduced at 11.5. 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 status of the reindex can be checked using the Status resource. 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:

Use dark colors for code blocksCopy
POST /<context>/portaladmin/system/indexer/reindex HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

mode=FULL_MODE&includes=&async=true&f=json

JSON Response example

The following response is returned when reindexing is complete when async is false.

Use dark colors for code blocksCopy
{"status": "success"}

If async is true, the following response is returned.

Use dark colors for code blocksCopy
{
  "status": "success",
  "message": "A reindex operation is in progress. Portal content and search operations will be unavailable until the reindex is complete. You can monitor the status by refreshing the Status page."
}