Loading ...

REST API: Rebuild Index | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Administration » REST API: Rebuild Index
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 20

REST API: Rebuild Index

0 
 /5
0 (0votes)
Open API Guide
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

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
EntityTypeCSVStringYESBodyA comma-separated string of EntityTypeIDs to rebuild. Check the list of Entity types in REST API: System Entity Types.

Optional Parameters

ParameterTypeRequiredLocationDescription
IsRebuildAllBooleanNOQuerySet it to true to rebuild the entire index; ensure that all entity types are included in EntityTypeCSV 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

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (entityTypeIDs)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

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.

Wiki Index

Pages