Endpoints

The Houdin API Endpoints, explained

You can test our API endpoints on the interactive Swagger User Interface.

Note on polling:

Scanning URLs requires waiting for external services to finish their analysis, so the status returned by /scan/launch should always be "In progress". This implies you should wait approximately 10 seconds before checking results for your scans, as they will never be finished earlier. After this delay it is recommended you poll the /scan/result endpoint every 2 seconds until you get your response.

For any query that does not involve long scanning time on external services, the query to /scan/launch will directly return a status of "Done". This means you can query your results on /scan/result without waiting for the 10 seconds delay.

Last updated