Emporix

Emporix Configuration API

The Configuration API from Emporix — 2 operation(s) for configuration.

Documentation GitHub OpenAPI

Operations 5

POST /indexing/{tenant}/configurations Create a new configuration #

GET /indexing/{tenant}/configurations Get all configurations #

GET /indexing/{tenant}/configurations/{provider} Get configuration by provider name #

PUT /indexing/{tenant}/configurations/{provider} Update configuration by provider name #

DELETE /indexing/{tenant}/configurations/{provider} Delete configuration #

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/emporix:emporix-configuration-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Emporix Configuration API
  version: v1
  contact:
    email: documentation@emporix.com
  description: 'Operations tagged Configuration across 2 of this provider''s published API definitions: emporix-indexing-service-openapi.yml, emporix-indexing-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
security:
- OAuth2:
  - indexing.search_manage
  - indexing.search_view
tags:
- name: Configuration
paths:
  /indexing/{tenant}/configurations:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    post:
      summary: Create a new configuration
      description: 'Creates a new index configuration. Supported providers:

        * Algolia - https://www.algolia.com

        * Battery Included - https://www.batteryincluded.io


        Identifier of a newly created configuration is a provider name.

        Only one provider can be active per tenant at a time.


        For `BATTERY_INCLUDED`, the service validates `indexName` and `writeKey` before saving.

        Invalid credentials return `400`. If credential validation is temporarily unavailable,

        the request returns `502`. In both cases, the configuration is not stored.'
      security:
      - OAuth2:
        - indexing.search_manage
      parameters:
      - $ref: '#/components/parameters/trait_tenant'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexConfiguration'
            examples:
              Create Algolia configuration:
                value:
                  active: true
                  searchKey: 84dc4886f81f805c42bdd89d64de751a
                  applicationId: 8AP2HABA2I
                  indexName: exampleTenant
                  writeKey: 51ebe89215dddcf85e5dacd5643d17e7
                  provider: ALGOLIA
              Create Battery Included configuration:
                value:
                  active: true
                  indexName: exampleTenant
                  writeKey: bi-api-key-abc123
                  provider: BATTERY_INCLUDED
                  includedMixinPaths:
                  - '*_siteAware.*.OnlineIsService_P'
                  - '*_siteAware.**'
        description: ''
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexCreationResponse'
              examples:
                Algolia creation response:
                  value:
                    id: ALGOLIA
                Battery Included creation response:
                  value:
                    id: BATTERY_INCLUDED
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '502':
          $ref: '#/components/responses/BadGateway_502'
      operationId: POST-indexing-create-config
      tags:
      - Configuration
    get:
      summary: Get all configurations
      description: Retrieves all configurations of index providers. The returned response contains search and write keys.
      security:
      - OAuth2:
        - indexing.search_view
      parameters:
      - $ref: '#/components/parameters/trait_tenant'
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                Get all configurations:
                  value:
                  - active: true
                    searchKey: 84dc4886f81f805c42bdd89d64de751a
                    applicationId: 8AP2HABA2I
                    indexName: exampleTenant
                    writeKey: 51ebe89215dddcf85e5dacd5643d17e7
                    provider: ALGOLIA
                  - active: false
                    indexName: exampleTenant
                    writeKey: bi-api-key-abc123
                    provider: BATTERY_INCLUDED
                    includedMixinPaths:
                    - '*_siteAware.*.OnlineIsService_P'
                    - '*_siteAware.**'
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
      operationId: GET-indexing-list-configs
      tags:
      - Configuration
    servers:
    - url: https://api.emporix.io
  /indexing/{tenant}/configurations/{provider}:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    - $ref: '#/components/parameters/trait_provider'
    get:
      summary: Get configuration by provider name
      description: 'Retrieves a single configuration by a provider name. Supported providers:

        * Algolia - https://www.algolia.com

        * Battery Included - https://www.batteryincluded.io'
      security:
      - OAuth2:
        - indexing.search_view
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                Get Algolia configuration:
                  value:
                    active: true
                    searchKey: 84dc4886f81f805c42bdd89d64de751a
                    applicationId: 8AP2HABA2I
                    indexName: exampleTenant
                    writeKey: 51ebe89215dddcf85e5dacd5643d17e7
                    provider: ALGOLIA
                Get Battery Included configuration:
                  value:
                    active: true
                    indexName: exampleTenant
                    writeKey: bi-api-key-abc123
                    provider: BATTERY_INCLUDED
                    includedMixinPaths:
                    - '*_siteAware.*.OnlineIsService_P'
                    - '*_siteAware.**'
              schema:
                $ref: '#/components/schemas/IndexConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '404':
          $ref: '#/components/responses/NotFound_404'
      tags:
      - Configuration
      operationId: GET-indexing-retrieve-config
    put:
      summary: Update configuration by provider name
      description: 'Updates an existing index configuration.


        For `BATTERY_INCLUDED`, the service validates `indexName` and `writeKey` before saving.

        Invalid credentials return `400`. If credential validation is temporarily unavailable,

        the request returns `502`. In both cases, the configuration is left unchanged.'
      security:
      - OAuth2:
        - indexing.search_manage
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexConfiguration'
            examples:
              Update Algolia configuration:
                value:
                  active: true
                  searchKey: 84dc4886f81f805c42bdd89d64de751a
                  applicationId: 8AP2HABA2I
                  indexName: exampleTenant
                  writeKey: 51ebe89215dddcf85e5dacd5643d17e7
                  provider: ALGOLIA
              Update Battery Included configuration:
                value:
                  active: true
                  indexName: exampleTenant
                  writeKey: bi-api-key-abc123
                  provider: BATTERY_INCLUDED
                  includedMixinPaths:
                  - '*_siteAware'
                  - catalogAttrs.**.color
      responses:
        '204':
          description: Configuration updated
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '404':
          $ref: '#/components/responses/NotFound_404'
        '502':
          $ref: '#/components/responses/BadGateway_502'
      operationId: PUT-indexing-update-config
      tags:
      - Configuration
    delete:
      summary: Delete configuration
      description: Deletes the configuration based on the provider name.
      security:
      - OAuth2:
        - indexing.search_manage
      parameters:
      - $ref: '#/components/parameters/trait_tenant'
      responses:
        '204':
          description: Configuration deleted
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '404':
          $ref: '#/components/responses/NotFound_404'
      operationId: DELETE-indexing-remove-config
      tags:
      - Configuration
    servers:
    - url: https://api.emporix.io
components:
  parameters:
    trait_provider:
      name: provider
      in: path
      required: true
      schema:
        type: string
        enum:
        - ALGOLIA
        - BATTERY_INCLUDED
      description: 'Provider name. Supported values: `ALGOLIA`, `BATTERY_INCLUDED`'
    trait_tenant:
      name: tenant
      in: path
      required: true
      description: 'The tenant that the caller is acting upon.


        Please note that this value is always lowercase.

        '
      schema:
        pattern: ^[a-z][a-z0-9]+$
        minLength: 3
        maxLength: 16
        type: string
  responses:
    BadGateway_502:
      description: Upstream dependency was unavailable. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Battery Included credential validation unavailable:
              value:
                code: 502
                status: Bad Gateway
                message: Battery Included credential validation is temporarily unavailable. Try again later.
    Unauthorized_401:
      description: Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            UnauthorizedExample:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            AccessTokenExpiredExample:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    BadRequest_400:
      description: Request was syntactically incorrect. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Unsupported provider:
              value:
                code: 400
                status: Bad Request
                message: The provider UNKNOWN_PROVIDER is not supported.
            Battery Included invalid credentials:
              value:
                code: 400
                status: Bad Request
                message: Battery Included credentials are invalid. Verify the write key and index name.
    Forbidden_403:
      description: Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            ForbiddenExample:
              value:
                status: Forbidden
                details:
                - Missing required scopes '[indexing.search_view]'
                code: 403
                message: Scope validation failed
    NotFound_404:
      description: Resource has not been found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Not found:
              value:
                code: 404
                status: Not Found
                message: The provider UNKNOWN_PROVIDER is not supported.
  schemas:
    errorMessage:
      title: error
      description: Schema for API specified errors.
      type: object
      properties:
        code:
          description: Original HTTP error code, should be consistent with the response HTTP code
          type: integer
        status:
          description: Classification of the error type
          type: string
        message:
          description: Descriptive error message for debugging
          type: string
        details:
          type: array
          description: Error details
          items:
            type: string
    IndexConfiguration:
      title: IndexConfiguration
      allOf:
      - $ref: '#/components/schemas/IndexPublicConfiguration'
      - type: object
        properties:
          writeKey:
            type: string
            description: API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated.
          excludedMixinKeys:
            type: array
            items:
              type: string
            description: Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider.
          includedMixinPaths:
            type: array
            items:
              type: string
            description: 'Optional allowlist of product mixin paths to include in indexing for the `BATTERY_INCLUDED` provider. Patterns are matched against full dot-notation paths rooted at the mixin key, for example `class_EA673_toolsClassification.sk.OnlineIsService_P`.

              `*` matches within a single path segment, `**` matches across one or more path segments, and matching is case sensitive.

              If a matched path points to an object, the entire subtree under that object is included. When this field is absent or an empty list, path filtering is inactive and existing `excludedMixinKeys` behavior applies.

              `includedMixinPaths` and `excludedMixinKeys` are mutually exclusive when `includedMixinPaths` is non-empty. Malformed glob patterns are rejected with a validation error on configuration writes.'
        required:
        - provider
    IndexPublicConfiguration:
      title: IndexPublicConfiguration
      type: object
      properties:
        searchKey:
          type: string
          description: API Key used for search purposes.
        applicationId:
          type: string
          description: Application id of an indexer provider.
        indexName:
          type: string
          description: Identifier of an index.
        provider:
          type: string
          description: 'Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.'
          enum:
          - ALGOLIA
          - BATTERY_INCLUDED
        active:
          type: boolean
          description: Indicates if the configuration is active or not.
    IndexCreationResponse:
      title: IndexCreationResponse
      type: object
      properties:
        id:
          type: string
          description: Identifier of a newly created configuration.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.emporix.io/oauth/token
          scopes:
            indexing.search_view: Needed to read an index provider configuration
            indexing.search_manage: Needed to manage an index provider configuration
x-refined-from:
- emporix-indexing-service-openapi.yml
- emporix-indexing-service-openapi.yml