Document pagination options for /events/restSearch

Reference: https://github.com/MISP/MISP/issues/2426#issuecomment-431657077
pull/138/head
Daniel Roethlisberger 2018-11-27 11:34:55 +01:00
parent e8fab67597
commit b8959ca82b
1 changed files with 4 additions and 0 deletions

View File

@ -1407,6 +1407,10 @@ https://<misp url>/events/restSearch/download/null/null/null/null/tag1&&tag2&&!t
<dd>Include the attachments/encrypted samples in the export</dd>
<dt>metadata</dt>
<dd>Only fetch the event metadata (event data, tags, relations) and skip the attributes</dd>
<dt>limit</dt>
<dd>Limit the number of results returned; use together with page.</dd>
<dt>page</dt>
<dd>If a limit is set, sets the page to be returned, starting at 1; page 3, limit 100 will return records 201->300). When requesting a page beyond the number of available pages, the returned results list will be empty.</dd>
</dl>
The keywords false or null should be used for optional empty parameters in the URL.