Elastic Path Search Indexes API
Search Indexes represent the indexed data for your catalog releases. Each time a catalog is published with search enabled, a search index is created containing the product data optimized for fast querying.### Index StatusThe Search Indexes API allows you to view the status of your indexes and identify any that are out of sync. An index becomes out of sync when:- Indexable fields have been added, modified, or deleted- The index failed to build during catalog publishing- A reindex is required due to schema changes### Monitoring IndexesUse the list endpoint to:- **View all indexes**: See all search indexes for your store- **Check sync status**: Identify indexes that need reindexing- **Filter by status**: Find only out-of-sync indexes using the `out_of_sync` query parameter### Index InformationEach search index includes:| Property | Description ||---------------|---------------------------------------------------------|| `catalog_id` | The ID of the catalog this index belongs to || `release_id` | The ID of the catalog release this index was built from || `out_of_sync` | Whether the index needs to be rebuilt |### ReindexingWhen indexes are out of sync, use the reindex endpoint in [Jobs](/docs/api/pxm/catalog-search/jobs) to rebuild them. Reindexing ensures your search indexes reflect the current indexable field configuration.
Elastic Path Search Indexes API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search Indexes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Search Indexes API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Search Indexes represent the indexed data for your catalog releases. Each time a catalog is published with search enabled, a search index is created containing the product data op…
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SearchIndexMeta (4 properties), Error (4 properties), SearchIndex (3 properties), ListSearchIndexesResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.