Configuration

Get all configurations

get

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

Authorizations
Path parameters
tenantstringRequired
Responses
200Success
application/json
get
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.

Authorizations
Path parameters
tenantstringRequired
Body
all ofOptional
Responses
201
Created
application/json
post
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

Authorizations
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
Responseall of
get
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.

Authorizations
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
all ofOptional
Responses
204
Configuration updated
put
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.

Authorizations
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
delete
DELETE /indexing/{tenant}/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Was this helpful?