Configuration
Retrieves all configurations of index providers. The returned response contains search and write keys.
- : Needed to read an index provider configuration
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$API Key used for search purposes.
Application id of an indexer provider.
Identifier of an index.
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.
Indicates if the configuration is active or not.
API key used for write purposes. For BATTERY_INCLUDED, this key is validated before the configuration is created or updated.
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.
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.
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
GET /indexing/{tenant}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"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.**"
]
}
]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.
- : Needed to manage an index provider configuration
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$API Key used for search purposes.
Application id of an indexer provider.
Identifier of an index.
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.
Indicates if the configuration is active or not.
API key used for write purposes. For BATTERY_INCLUDED, this key is validated before the configuration is created or updated.
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.
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.
Created
Identifier of a newly created configuration.
Request was syntactically incorrect. Details will be provided in the response payload.
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Upstream dependency was unavailable. Details will be provided in the response payload.
POST /indexing/{tenant}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"active": true,
"searchKey": "84dc4886f81f805c42bdd89d64de751a",
"applicationId": "8AP2HABA2I",
"indexName": "exampleTenant",
"writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
"provider": "ALGOLIA"
}{
"id": "ALGOLIA"
}Retrieves a single configuration by a provider name. Supported providers:
Algolia - https://www.algolia.com
Battery Included - https://www.batteryincluded.io
- : Needed to read an index provider configuration
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$Provider name. Supported values: ALGOLIA, BATTERY_INCLUDED
API Key used for search purposes.
Application id of an indexer provider.
Identifier of an index.
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.
Indicates if the configuration is active or not.
API key used for write purposes. For BATTERY_INCLUDED, this key is validated before the configuration is created or updated.
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.
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.
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Resource has not been found.
GET /indexing/{tenant}/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"active": true,
"searchKey": "84dc4886f81f805c42bdd89d64de751a",
"applicationId": "8AP2HABA2I",
"indexName": "exampleTenant",
"writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
"provider": "ALGOLIA"
}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.
- : Needed to manage an index provider configuration
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$Provider name. Supported values: ALGOLIA, BATTERY_INCLUDED
API Key used for search purposes.
Application id of an indexer provider.
Identifier of an index.
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.
Indicates if the configuration is active or not.
API key used for write purposes. For BATTERY_INCLUDED, this key is validated before the configuration is created or updated.
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.
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.
Configuration updated
No content
Request was syntactically incorrect. Details will be provided in the response payload.
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Resource has not been found.
Upstream dependency was unavailable. Details will be provided in the response payload.
PUT /indexing/{tenant}/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"active": true,
"searchKey": "84dc4886f81f805c42bdd89d64de751a",
"applicationId": "8AP2HABA2I",
"indexName": "exampleTenant",
"writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
"provider": "ALGOLIA"
}No content
Deletes the configuration based on the provider name.
- : Needed to manage an index provider configuration
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$Provider name. Supported values: ALGOLIA, BATTERY_INCLUDED
Configuration deleted
No content
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Resource has not been found.
DELETE /indexing/{tenant}/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated
Was this helpful?