Configuration
Retrieves all configurations of index providers. The returned response contains search and write keys.
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"
}
]
Creates a new index configuration. Currently supported providers:
ALGOLIA (https://www.algolia.com)
Identifier of a newly created configuration is a provider name.
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. Currently supported providers:
ALGOLIA
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$
Provider name. Currently supported providers: ALGOLIA
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.
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$
Provider name. Currently supported providers: ALGOLIA
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.
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$
Provider name. Currently supported providers: ALGOLIA
DELETE /indexing/{tenant}/configurations/{provider} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?