How to paginate when using search APIs

PayloadSecurity / VxAPI

A generic interface and CLI for all endpoints of the Falcon Sandbox API

GNU General Public License v3.0

209 stars 58 forks source link

How to paginate when using search APIs #48

Open arockiachristopher-git opened 2 years ago

arockiachristopher-git commented 2 years ago

I am trying to get Job IDs of samples across pages but the current API support allows only to get 50 items from the first page only. Please suggest a key-value pair that I need to use in the request body to get samples across different pages.

kkochanski commented 2 years ago

Hello, current version of API, does not support pagination. Although that's something that will be introduced in the next major API version - V3.

The number of results, that are returned by API, is 200.

arockiachristopher-git commented 2 years ago

Hello, the current version of /search/terms API returns only 50 results to me. My API key auth level is 'Restricted'. Can you explain why the returned result count is changing for you and me? Also, when can we expect API v3 to go live?

kkochanski commented 2 years ago

For API keys with 'Restricted' auth level we're returning only 50 elements. You can bump auth of your API Key by first, requesting Vetting Process (It will allow you e.g. downloading samples etc.) - https://www.hybrid-analysis.com/knowledge-base/how-to-submit-a-vetting-request.

Then, once you will pass it, you will be allowed to bump privileges of your API Key at the profile page.

Coming back to API v3, there's no ETA.