---
title: "REST API: Rebuild Index"
type: "wiki"
space: "Axero Documentation"
author: "Vladana Garic"
created: 2024-11-28T16:25:22Z
updated: 2026-08-19T00:35:53Z
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/106388/rest-api-rebuild-index"
---

# REST API: Rebuild Index

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=106388)
POST/api/admin/buildindex

Technical reference for the Rebuild Index By Content Type ID endpoint, providing programmatic access to rebuild index by content type id functionality.

## Request

### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). |
| `Content-Type` | YES | `application/json` | Must be set to `application/json` |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `entityTypeIDs` | Array | YES | Body | A JSON array of EntityTypeIDs to rebuild, for example `[3, 4, 5]`. It is not a comma-separated string. See [REST API: System Entity Types](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/25112/rest-api-system-entity-types) for the list. |
### Optional Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `IsRebuildAll` | Boolean | NO | Query | Set it to true to rebuild the entire index; ensure that all entity types are included in entityTypeIDs for a complete index update.Set it to false to reindex only the specified entity types included in the request body |
## Example

### Request Header

```
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
```

### Request URL

`https://your-site.com/api/admin/buildindex?IsRebuildAll=false`

### Request Body

```
[
  3,
  4,
  5
]
```

### Success Response

```
{
  "IsError": false,
  "ResponseMessage": "Success message.",
  "ResponseData": true
}
```

### Error Response

```
{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}
```

## Error Handling

This endpoint does not use status codes to report problems. Every outcome other than an authentication failure is **HTTP 200** with a bare boolean body.

- `true` means the rebuild has started.
- `false` covers several cases and does not distinguish between them: the input was invalid, the caller is not a Site Administrator, a rebuild is already running, or an error was caught internally. A `false` is therefore not necessarily a failure; a rebuild already in progress returns it too.
- **401 Unauthorized** is the only non-200 response, returned by the authentication filter when the token is missing or invalid.

**The caller must be a Site Administrator.** Any other account receives `false` rather than a permissions error.

**Response shape:** a live call returns the bare boolean, not the standard `IsError` / `ResponseData` envelope used elsewhere in this API. Parse it accordingly.

## Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

- **Sustained Request Rate:** Do not exceed 5 API calls per second
- **Sequential Processing:** Wait for each request to complete before sending the next in automated workflows
- **Concurrent Connections:** If parallel processing is required, limit to 3 or fewer simultaneous requests
- **Response Timeout:** Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.