{"version":1,"pages":[{"id":"C066EvdrfUol8XXG00vc","title":"Introduction","pathname":"/api","siteSpaceId":"sitesp_U3W5A","description":"The Halo Security API enables customers and partners to programmatically integrate certain components of Halo Security services into their applications."},{"id":"CYVPh6Lo37bNyuwcWBbt","title":"Data Types","pathname":"/api/readme/data-types","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"MQh4Tvi8LTT6H9rXnnRq","title":"Target Filtering","pathname":"/api/readme/target-filtering","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"L9tRIi8CXuia2oVHl3vZ","title":"Scan Selection","pathname":"/api/readme/scan-selection","siteSpaceId":"sitesp_U3W5A","description":"Many endpoints offer the ability to retrieve records as of specific dates.","breadcrumbs":[{"label":"Introduction"}]},{"id":"nNG47SfpGGuiKz7uNTuv","title":"Pagination & Sorting","pathname":"/api/readme/pagination-and-sorting","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"jEi1EcGeU4aYpY6Hzql7","title":"Permissions","pathname":"/api/readme/permissions","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"6h8HxhqkUXuT2dgw9flo","title":"Appendix","pathname":"/api/readme/appendix","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"AeMSQSosluBJoPH6t3qn","title":"Authentication","pathname":"/api/authentication","siteSpaceId":"sitesp_U3W5A","description":"Authentication is required to access the Halo Security API. This section details how to manage your account API keys and submit a request."},{"id":"5cPSgxVDTWVH1K4Tm8EX","title":"Webhooks","pathname":"/api/webhooks","siteSpaceId":"sitesp_U3W5A","description":"Webhooks allow you to easily be notified as events are triggered in your Halo Security account."},{"id":"3sLp8f1XuXC1EFWwz2YO","title":"Events","pathname":"/api/events","siteSpaceId":"sitesp_U3W5A"},{"id":"2eL4By6JNoBuZ2x09S3U","title":"Appendix","pathname":"/api/appendix","siteSpaceId":"sitesp_U3W5A"},{"id":"aTwAc9bNQTi4t6lq59CN","title":"Targets Filter","pathname":"/api/appendix/targets-filter","siteSpaceId":"sitesp_U3W5A","description":"The Target Filter string typically sent through the \"targets\" parameter is described below.","breadcrumbs":[{"label":"Appendix"}]},{"id":"8amh1aCjtopWmg9q4RIE","title":"Date Match","pathname":"/api/appendix/date-match","siteSpaceId":"sitesp_U3W5A","breadcrumbs":[{"label":"Appendix"}]},{"id":"Zzw11v0MWr1iICwriYWa","title":"IP Range","pathname":"/api/appendix/ip-range","siteSpaceId":"sitesp_U3W5A","breadcrumbs":[{"label":"Appendix"}]},{"id":"IREgx44imBCjshRF3Wyg","title":"Discovery","pathname":"/api/endpoints/discovery","siteSpaceId":"sitesp_U3W5A","description":"The discovery endpoints allows you to access the domains and networks being used for discovery, as well as the the discovered hosts and IPs.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"WaeYu7cBg0PUY6F1QG9w","title":"Target","pathname":"/api/endpoints/target","siteSpaceId":"sitesp_U3W5A","description":"The Target endpoint allows you to list all targets, get details about targets, and update details of specific targets.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"YDvAz9MtbGprJJSQJ4kj","title":"Scan","pathname":"/api/endpoints/scan","siteSpaceId":"sitesp_U3W5A","description":"The Scan endpoint allows you to launch scans, get details about scans, and list/cancel scans that currently in progress.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"FovrjoxIRi8GgTZL50U0","title":"Issue","pathname":"/api/endpoints/vulnerability","siteSpaceId":"sitesp_U3W5A","description":"The Issue endpoint returns details about discovered issues.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"GcSdJjg2aUYU1iFXbPKd","title":"Tag","pathname":"/api/endpoints/tag","siteSpaceId":"sitesp_U3W5A","description":"The Tag endpoint allows you to get a list of tags.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"sOo58RdJczwpo1oxFJj3","title":"Port","pathname":"/api/endpoints/port","siteSpaceId":"sitesp_U3W5A","description":"The Port endpoint allows you to get a list of port records.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"IOIP0bfsUjE7XEBbBouE","title":"DNS","pathname":"/api/endpoints/dns","siteSpaceId":"sitesp_U3W5A","description":"The DNS endpoint allows you to get a list of DNS records.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"JrkoGVAqPmWotVqmzQsh","title":"HTTP","pathname":"/api/endpoints/http","siteSpaceId":"sitesp_U3W5A","description":"The HTTP endpoint allows you to get a list of HTTP records, and details about specific HTTP records.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"MiKItKCliGwbhrhO7A9y","title":"Whois","pathname":"/api/endpoints/whois","siteSpaceId":"sitesp_U3W5A","description":"The Whois endpoint allows you to get a list of whois records.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"55bp4eV6HJlYQPFR49oG","title":"Technology","pathname":"/api/endpoints/technology","siteSpaceId":"sitesp_U3W5A","description":"The Technology endpoint allows you to view information about technology identified on your attack surface.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"LmE2wc4iJDy6GfIrj9kk","title":"Website","pathname":"/api/endpoints/website","siteSpaceId":"sitesp_U3W5A","description":"The Website endpoint allows you to list details related to websites","breadcrumbs":[{"label":"Endpoints"}]},{"id":"SL4COcO6Nu8J20YxBwPT","title":"Acknowledged","pathname":"/api/endpoints/acknowledged","siteSpaceId":"sitesp_U3W5A","description":"The Acknowledged endpoint allows you to list, add, and delete acknowledged hostnames, apps, and issues.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"2E087YNSuUJo6jLpy7Jx","title":"Event","pathname":"/api/endpoints/event","siteSpaceId":"sitesp_U3W5A","description":"The Event endpoint allows you to get a list of all events or event types, details about specific events, and delete events.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"sq9PR3pjm2GQoUQP6wj5","title":"Dark Web","pathname":"/api/endpoints/dark-web","siteSpaceId":"sitesp_U3W5A","breadcrumbs":[{"label":"Endpoints"}]},{"id":"e81OKA73Z2cBkv6iZoou","title":"Integration","pathname":"/api/endpoints/integration","siteSpaceId":"sitesp_U3W5A","description":"","breadcrumbs":[{"label":"Endpoints"}]},{"id":"vRlZoWo0TdhWqBHBD1Ob","title":"PCI","pathname":"/api/endpoints/pci","siteSpaceId":"sitesp_U3W5A","description":"The PCI endpoint allows you to get a summary of PCI status and start the PCI compliance process.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"u9UrVllwps0OoAFY0QKj","title":"Report","pathname":"/api/endpoints/report","siteSpaceId":"sitesp_U3W5A","description":"Generate PDF reports.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"xOygLlx4ofMLyVHPScua","title":"User","pathname":"/api/endpoints/user","siteSpaceId":"sitesp_U3W5A","description":"The User endpoint provides methods for retrieving and updating information related to your account, as well as inviting new users.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"rfgC12YxdCtpt2Tkdgon","title":"Account","pathname":"/api/endpoints/account","siteSpaceId":"sitesp_U3W5A","description":"The Account endpoint provides methods for listing and adding subscriptions to the current account.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"mNZHxiB9TpTYV1BzpX5u","title":"Security","pathname":"/api/endpoints/security","siteSpaceId":"sitesp_U3W5A","description":"The Security endpoint provides methods for viewing various security related metrics over time, such as your risk score.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"IDE45x83ua9110RdyRj9","title":"File","pathname":"/api/endpoints/file","siteSpaceId":"sitesp_U3W5A","description":"The File endpoint allows you to get a list of all files, and delete or retrieve details of a specific file.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"ES1wnI1E5Y438rrWPWSk","title":"Work","pathname":"/api/endpoints/work","siteSpaceId":"sitesp_U3W5A","description":"Get the status of asynchronous work.","breadcrumbs":[{"label":"Endpoints"}]}]}