Public Configuration

Get all public configurations

get

Retrieves all configurations of index providers. The returned response contains only search keys. Write keys are not returned.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

200Success

application/json

searchKeystringOptional

API Key used for search purposes.

applicationIdstringOptional

Application id of an indexer provider.

indexNamestringOptional

Identifier of an index.

providerstring · enumOptional

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.

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

401

Unauthorized

get/indexing/{tenant}/public/configurations

HTTPcURLJavaScriptPython

GET /indexing/{tenant}/public/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "active": true,
    "searchKey": "84dc4886f81f805c42bdd89d64de751a",
    "applicationId": "8AP2HABA2I",
    "indexName": "exampleTenant",
    "provider": "ALGOLIA"
  },
  {
    "active": false,
    "indexName": "exampleTenant",
    "provider": "BATTERY_INCLUDED"
  }
]

Get public configuration

get

Retrieves a single public configuration by a provider name. Supported providers:

• Algolia - https://www.algolia.com
• Battery Included - https://www.batteryincluded.io

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$

providerstring · enumRequired

Provider name. Supported values: ALGOLIA, BATTERY_INCLUDED

Possible values:

Responses

200

OK

application/json

searchKeystringOptional

API Key used for search purposes.

applicationIdstringOptional

Application id of an indexer provider.

indexNamestringOptional

Identifier of an index.

providerstring · enumOptional

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.

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

404

Resource has not been found.

application/json

get/indexing/{tenant}/public/configurations/{provider}

HTTPcURLJavaScriptPython

GET /indexing/{tenant}/public/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "active": true,
  "searchKey": "84dc4886f81f805c42bdd89d64de751a",
  "applicationId": "8AP2HABA2I",
  "indexName": "exampleTenant",
  "provider": "ALGOLIA"
}