Run an indexing job

post

https://discovery.bloomreach.com/dataconnect/api/v3/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/indexes

Trigger an indexing job to update the catalog's index.

Path Params

account_name

string

required

length between 1 and 64

Your unique account name.

catalog_name

string

required

length between 1 and 64

"Catalog name" is also called domain key. Use the same value as your domain key in your search API requests.

environment_name

string

enum

required

length between 1 and 64

The type of environment you want to use for the request (Production/Staging).

Allowed:

Headers

Index-Refresh

boolean

Optionally triggers a full index refresh, in which all products in the catalog are reindexed with the latest configuration.

This only affects products that were already existing and indexed in the feed. Any newly ingested products will not be affected.

BR-Ignore-Document-Count-Drop

boolean

Optionally ignore any count drops that occur during the job, allowing the index to be updated even if the number of products drops below the allowed threshold.

Responses

401

Unauthorized

Language

Credentials

Bearer

API Key

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. Click to see the response structure.

400Bad request

404Not found

429Too Many Requests

500Internal Server Error