Inserting inclusion patterns

Use this API to insert patterns in the inclusion list.

Requirement: OpenSearchServer v1.5

Call parameters

URL: /services/rest/index/{index_name}/crawler/web/patterns/inclusion

Method: PUT

HTTP Header:

  • Content-Type (required): application/json
  • Accept (optional returned type): application/json or application/xml

URL parameters:

  • index_name (required): The name of the index.
  • replace (optional): Set it to true to replace all the patterns already present.
  • inject_urls (optional)=Set it to true to inject the derived URL in the URL database.

Raw data (PUT):
An array of patterns.


Success response

The patterns has been inserted.

HTTP code:

Content (application/json):

"successful": true,
"info": "3 patterns injected"

Error response

The insertion failed. The reason is provided in the content.

HTTP code:

Sample call

Using CURL:

curl -XPUT -H "Content-Type: application/json" \
-d '["*"]' \

View/edit on GitHub