POST /1/indexes/{indexName}/rules/search

Searches for rules in your index.

Servers

https://{appId}.algolia.net
https://{appId}-1.algolianet.com
https://{appId}-2.algolianet.com
https://{appId}-3.algolianet.com
https://{appId}-dsn.algolia.net

Path parameters

Name	Type	Required	Description
`indexName`	String	Yes	Name of the index on which to perform the operation.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`page`	Integer	No	Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed (paginated). `hitsPerPage`: sets the number of search results (hits) displayed per page. `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
`query`	String	No	Search query for rules.
`anchoring`	String	No	Which part of the search query the pattern should match: `startsWith`. The pattern must match the beginning of the query. `endsWith`. The pattern must match the end of the query. `is`. The pattern must match the query exactly. `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. Possible values: `"startsWith"` `"contains"` `"is"` `"endsWith"`
`context`	String	No	Only return rules that match the context (exact match).
`hitsPerPage`	Integer	No	Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed (paginated). `hitsPerPage`: sets the number of search results (hits) displayed per page. `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. Default value: 20
`enabled`		No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.