/indexes/books/settings/synonyms

Update synonyms

/indexes/books/settings/typo-tolerance

Reset typo-tolerance

/indexes/books/settings/typo-tolerance

Get typo-tolerance

/indexes/books/settings/searchable-attributes

Update searchable attributes

/indexes/books/settings/sortable-attributes

Reset sortable attributes

/indexes/books/settings/sortable-attributes

Get sortable attributes

/indexes/books/settings/sortable-attributes

Update sortable attributes

/indexes/books/settings/stop-words

Reset stop-words

/indexes/books/settings/stop-words

Get stop-words

/indexes/books/settings/stop-words

Update stop-words

/indexes/books/settings/synonyms

Reset synonyms

/indexes/books/settings/synonyms

Get synonyms

/dumps

Create a dump

/health

Health

/indexes

Get indexes

• offset (query, offset)
• limit (query, limit)

/indexes

Create index with primary key

/indexes/books

Delete an index

/indexes/books

Show index

/indexes/books

Udpate index

/indexes/books/documents

Delete all documents

/indexes/books/documents

Get documents

• limit (query, limit)
• offset (query, offset)
• fields (query)

/indexes/books/documents

Add or replace documents

• primaryKey (query)

/indexes/books/documents

Add or update documents

• primaryKey (query)

/indexes/books/documents/1

Delete one document

/indexes/books/documents/2

Get one document

• fields (query)

/indexes/books/documents/delete-batch

Delete documents

/indexes/books/search

Search in index

• q (query)
• offset (query, offset)
• limit (query, limit)
• attributesToRetrieve (query)
• attributesToCrop (query)
• attributesToHighlight (query)
• cropLength (query)
• cropMarker (query)
• filter (query)
• showMatchesPosition (query)
• facets (query)
• sort (query)
• highlightPreTag (query)
• highlightPostTag (query)
• matchingStrategy (query)
• page (query, page)
• hitsPerPage (query)

/indexes/books/search

Search in index

/indexes/books/settings

Reset all settings

/indexes/books/settings

Get all settings

/indexes/books/settings

Update settings

/indexes/books/settings/displayed-attributes

Reset displayed attributes

/indexes/books/settings/displayed-attributes

Get displayed attributes

/indexes/books/settings/displayed-attributes

Update displayed attributes

/indexes/books/settings/distinct-attribute

Reset distinct attribute

/indexes/books/settings/distinct-attribute

Get distinct attribute

/indexes/books/settings/distinct-attribute

Update distinct attribute

/indexes/books/settings/faceting

Reset faceting

/indexes/books/settings/faceting

Get faceting

/indexes/books/settings/faceting

Update faceting

/indexes/books/settings/filterable-attributes

Reset filterable attributes

/indexes/books/settings/filterable-attributes

Get filterable attributes

/indexes/books/settings/filterable-attributes

Update filterable attributes

/indexes/books/settings/pagination

Reset pagination

/indexes/books/settings/pagination

Get pagination

/indexes/books/settings/pagination

Update pagination

/indexes/books/settings/ranking-rules

Reset ranking rules

/indexes/books/settings/ranking-rules

Get ranking rules

/indexes/books/settings/ranking-rules

Update ranking rules

/indexes/books/settings/searchable-attributes

Reset searchable attributes

/indexes/books/settings/searchable-attributes

Get searchable attributes

/indexes/books/settings/typo-tolerance

Update typo-tolerance

/indexes/books/stats

Stats of an index

/indexes/swap-indexes

Swap indexes

/keys

Get keys

• offset (query, offset)
• limit (query, limit)

/keys

Create a key

/keys/L8l05tFb188aab693735bbaf1f898b9902fb39f865160d39dddba2b47b940115a0430705

Get one key

/keys/kN2aK9EO8a7b627e425717d9196c8081552ca004e513545ed178f8a56981dbd3080d4a5b

Delete a key

/keys/wYZjGJyBcdb0621b97999c233246a8ec0a35d0fcd9a6417ef8ccee0c8978b64b123af2dd

Update a key

/stats

Global stats

/tasks

Delete tasks

• uids (query)
• indexUids (query)
• types (query)
• statuses (query)
• beforeEnqueuedAt (query)
• afterEnqueuedAt (query)
• beforeStartedAt (query)
• afterStartedAt (query)
• beforeFinishedAt (query)
• afterFinishedAt (query)
• canceledBy (query)
• limit (query, limit)
• from (query)

/tasks

Get all tasks

• uids (query)
• indexUids (query)
• types (query)
• statuses (query)
• beforeEnqueuedAt (query)
• afterEnqueuedAt (query)
• beforeStartedAt (query)
• afterStartedAt (query)
• beforeFinishedAt (query)
• afterFinishedAt (query)
• canceledBy (query)
• limit (query, limit)
• from (query)

/tasks/0

Get one task

/tasks/cancel

Cancel tasks

• uids (query)
• indexUids (query)
• types (query)
• statuses (query)
• beforeEnqueuedAt (query)
• afterEnqueuedAt (query)
• beforeStartedAt (query)
• afterStartedAt (query)
• beforeFinishedAt (query)
• afterFinishedAt (query)
• canceledBy (query)
• limit (query, limit)
• from (query)

/version

Version