Delete a configuration

Deletes a Query Suggestions configuration.

DELETE /1/configs/{indexName}

curl

cURL

curl --request DELETE \
  --url https://query-suggestions.us.algolia.com/1/configs/ALGOLIA_INDEX_NAME \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

Created

{
  "status": 200,
  "message": "Configuration was deleted with success."
}

Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the Delete an index operation.

Required ACL: editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName · string · required

Query Suggestions index name. Name of the Query Suggestions index (case-sensitive).

Example:

"ALGOLIA_INDEX_NAME"

Response

200

application/json

OK

message · string

Details about the response, such as error messages.

status · integer

HTTP status code.