Configuration
Retrieves all configurations of index providers. The returned response contains search and write keys.
- : Needed to read an index provider configuration
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"
}
]Creates a new index configuration. Currently supported providers:
Algolia - https://www.algolia.com
Identifier of a newly created configuration is a provider name.
- : Needed to manage an index provider configuration
Created
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.
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 - https://www.algolia.com
- : 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. Currently supported providers: ALGOLIA
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.
- : 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. Currently supported providers: ALGOLIA
Configuration updated
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.
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. Currently supported providers: ALGOLIA
Configuration deleted
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?