Bloomreach Feed indexing API

The Feed indexing API from Bloomreach — 1 operation(s) for feed indexing.

Operations 1

POST /accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/indexes Run an indexing job #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bloomreach-feed-indexing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bloomreach-feed-indexing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Catalog management Feed indexing API
  version: 3.0.0
servers:
- url: https://discovery.bloomreach.com/dataconnect/api/v3
security:
- bearerAuth: []
tags:
- name: Feed indexing
paths:
  /accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/indexes:
    parameters:
    - $ref: '#/components/parameters/AccountName'
    - $ref: '#/components/parameters/CatalogName'
    - $ref: '#/components/parameters/EnvironmentName'
    - $ref: '#/components/parameters/IndexRefreshHeader'
    - $ref: '#/components/parameters/IgnoreCountDropHeader'
    post:
      tags:
      - Feed indexing
      summary: Run an indexing job
      description: Trigger an indexing job to update the catalog's index.
      responses:
        200:
          description: OK. Click to see the response structure.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      job_id:
                        type: string
        400:
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorResponse'
        401:
          description: Unauthorized
        404:
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Response'
        429:
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429Response'
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500Response'
      operationId: postAccountsByAccountNameCatalogsByCatalogNameEnvironmentsByEnvironmentNameIndexes
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        detail:
          type: string
        class:
          type: string
          enum:
          - error
          - warning
    429Response:
      description: Too Many Requests
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponse'
    404Response:
      description: Not Found
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponse'
    500Response:
      description: Internal Server Error
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    IgnoreCountDropHeader:
      description: 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.
      name: BR-Ignore-Document-Count-Drop
      in: header
      schema:
        type: boolean
      required: false
    EnvironmentName:
      description: The type of environment you want to use for the request (Production/Staging).
      name: environment_name
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 64
        enum:
        - production
        - staging
      required: true
    AccountName:
      description: Your unique account name.
      name: account_name
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 64
      required: true
      example: homeoasis
    IndexRefreshHeader:
      description: '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.'
      name: Index-Refresh
      in: header
      schema:
        type: boolean
      required: false
    CatalogName:
      description: '"Catalog name" is also called domain key. Use the same value as your domain key in your search API requests.'
      name: catalog_name
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 64
      required: true
      example: homeoasis_fr
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key