- URL:
- https://<root>/system/indexer/reindex
- Methods:
POST- Version Introduced:
- 10.2.1
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
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 |
|---|---|
| The mode in which the indexer should run. Values: |
(Optional) | A comma separated list of elements to include in the index, such as specific items or user accounts. |
| Introduced at 11.5. 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>/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=jsonJSON 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.
{
"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."
}