Configuration

Get all configurations

get

Retrieves all configurations of index providers. The returned response contains search and write keys.

Required scopes

This endpoint requires the following scopes:

• : Needed to read an index provider configuration

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

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

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

writeKeystringOptional

API key used for write purposes.

401

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

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

get

/indexing/{tenant}/configurations

HTTPcURLJavaScriptPython

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"
  }
]

Create a new configuration

post

Creates a new index configuration. Currently supported providers:

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

Identifier of a newly created configuration is a provider name.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage an index provider configuration

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Body

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

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

writeKeystringOptional

API key used for write purposes.

Responses

201

Created

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

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

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post

/indexing/{tenant}/configurations

HTTPcURLJavaScriptPython

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"
}

Get configuration by provider name

get

Retrieves a single configuration by a provider name. Currently supported providers:

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

Required scopes

This endpoint requires the following scopes:

• : Needed to read an index provider configuration

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]+$

providerstringRequired

Provider name. Currently supported providers: ALGOLIA

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

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

writeKeystringOptional

API key used for write purposes.

401

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

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

get

/indexing/{tenant}/configurations/{provider}

HTTPcURLJavaScriptPython

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"
}

Update configuration by provider name

put

Updates an existing index configuration.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage an index provider configuration

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]+$

providerstringRequired

Provider name. Currently supported providers: ALGOLIA

Body

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

Possible values:

activebooleanOptional

Indicates if the configuration is active or not.

writeKeystringOptional

API key used for write purposes.

Responses

204

Configuration updated

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

put

/indexing/{tenant}/configurations/{provider}

HTTPcURLJavaScriptPython

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

Delete configuration

delete

Deletes the configuration based on the provider name.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage an index provider configuration

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]+$

providerstringRequired

Provider name. Currently supported providers: ALGOLIA

Responses

204

Configuration deleted

401

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

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

delete

/indexing/{tenant}/configurations/{provider}

HTTPcURLJavaScriptPython

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

No content