# Stop words

The stop-words list is part of the settings category.

TIP

The stop-words list is considered as one resource and has the REST routes in line with this logic.

# Get stop-words list

GET
/indexes/:uid/settings/stop-words

Get the list stop-words.

# Path Variables

Variable Description
uid The index UID

# Example

$ curl \
  -X GET 'http://localhost:7700/indexes/12345678/settings/stop-words'

# Response: 200 Ok

List of all the stop-words in the index.

["of","the","to"]

# Create stop-words list

POST
/indexes/:uid/settings/stop-words

Create the list of stop-words.

WARNING

If one already exists, it will be overridden.

# Path Variables

Variable Description
uid The index UID

# Body

An array of strings containing the stop-words.

# Example

$ curl \
  -X POST 'http://localhost:7700/indexes/12345678/settings/stop-words' \
  --data '["the", "of", "to"]'

# Response: 202 Accepted

{
  "updateId": 1,
}

This updateId allows you to track the current update.

# Delete stop-words list

DELETE
/indexes/:uid/settings/stop-words

Delete the list of stop-words.

# Path Variables

Variable Description
uid The index UID

# Example

$ curl \
  -X DELETE 'http://localhost:7700/indexes/12345678/settings/stop-words' \

# Response: 202 Accepted

{
  "updateId": 1,
}

This updateId allows you to track the current update.