# API Documentation | Halo Security

## Halo Security API

- [Introduction](https://docs.halosecurity.com/api/readme.md): The Halo Security API enables customers and partners to programmatically integrate certain components of Halo Security services into their applications.
- [Data Types](https://docs.halosecurity.com/api/readme/data-types.md)
- [Target Filtering](https://docs.halosecurity.com/api/readme/target-filtering.md)
- [Scan Selection](https://docs.halosecurity.com/api/readme/scan-selection.md): Many endpoints offer the ability to retrieve records as of specific dates.
- [Pagination & Sorting](https://docs.halosecurity.com/api/readme/pagination-and-sorting.md)
- [Permissions](https://docs.halosecurity.com/api/readme/permissions.md)
- [Appendix](https://docs.halosecurity.com/api/readme/appendix.md)
- [Authentication](https://docs.halosecurity.com/api/authentication.md): Authentication is required to access the Halo Security API. This section details how to manage your account API keys and submit a request.
- [Webhooks](https://docs.halosecurity.com/api/webhooks.md): Webhooks allow you to easily be notified as events are triggered in your Halo Security account.
- [Events](https://docs.halosecurity.com/api/events.md)
- [Events (Archive)](https://docs.halosecurity.com/api/events-archive.md)
- [account-apikey-add](https://docs.halosecurity.com/api/events-archive/account-apikey-add.md)
- [account-user-add](https://docs.halosecurity.com/api/events-archive/account-user-add.md)
- [domain-add](https://docs.halosecurity.com/api/events-archive/domain-add.md)
- [domain-host-add](https://docs.halosecurity.com/api/events-archive/domain-host-add.md)
- [domain-scan-finish](https://docs.halosecurity.com/api/events-archive/domain-scan-finish.md)
- [domain-scan-first](https://docs.halosecurity.com/api/events-archive/domain-scan-first.md)
- [domain-scan-start](https://docs.halosecurity.com/api/events-archive/domain-scan-start.md)
- [domain-tld-add](https://docs.halosecurity.com/api/events-archive/domain-tld-add.md)
- [firewall-banner-change](https://docs.halosecurity.com/api/events-archive/firewall-banner-change.md)
- [firewall-port-add](https://docs.halosecurity.com/api/events-archive/firewall-port-add.md)
- [network-add](https://docs.halosecurity.com/api/events-archive/network-add.md)
- [network-ip-add](https://docs.halosecurity.com/api/events-archive/network-ip-add.md)
- [network-ip-remove](https://docs.halosecurity.com/api/events-archive/network-ip-remove.md)
- [network-port-add](https://docs.halosecurity.com/api/events-archive/network-port-add.md)
- [network-port-remove](https://docs.halosecurity.com/api/events-archive/network-port-remove.md)
- [network-scan-finish](https://docs.halosecurity.com/api/events-archive/network-scan-finish.md)
- [network-scan-first](https://docs.halosecurity.com/api/events-archive/network-scan-first.md)
- [network-scan-start](https://docs.halosecurity.com/api/events-archive/network-scan-start.md)
- [pci-report-approved](https://docs.halosecurity.com/api/events-archive/pci-report-approved.md)
- [pci-report-expire-past](https://docs.halosecurity.com/api/events-archive/pci-report-expire-past.md)
- [pci-report-expire-soon](https://docs.halosecurity.com/api/events-archive/pci-report-expire-soon.md)
- [pci-report-expire-today](https://docs.halosecurity.com/api/events-archive/pci-report-expire-today.md)
- [pci-report-rejected](https://docs.halosecurity.com/api/events-archive/pci-report-rejected.md)
- [project-engineer](https://docs.halosecurity.com/api/events-archive/project-engineer.md)
- [project-file](https://docs.halosecurity.com/api/events-archive/project-file.md)
- [project-state](https://docs.halosecurity.com/api/events-archive/project-state.md)
- [target-risk-change](https://docs.halosecurity.com/api/events-archive/riskscore-high.md)
- [target-add](https://docs.halosecurity.com/api/events-archive/target-add.md)
- [target-scan-failed](https://docs.halosecurity.com/api/events-archive/target-scan-failed.md)
- [target-scan-finish](https://docs.halosecurity.com/api/events-archive/target-scan-finish.md)
- [target-scan-first](https://docs.halosecurity.com/api/events-archive/target-scan-first.md)
- [target-scan-start](https://docs.halosecurity.com/api/events-archive/target-scan-start.md)
- [technology-add](https://docs.halosecurity.com/api/events-archive/technology-add.md)
- [technology-add-first-scan](https://docs.halosecurity.com/api/events-archive/technology-add-first-scan.md)
- [issue-add](https://docs.halosecurity.com/api/events-archive/issue-add.md)
- [issue-add-first-scan](https://docs.halosecurity.com/api/events-archive/issue-add-first-scan.md)
- [website-cert-expired](https://docs.halosecurity.com/api/events-archive/website-cert-expired.md)
- [website-cert-expiring](https://docs.halosecurity.com/api/events-archive/website-cert-expiring.md)
- [website-cert-new-country](https://docs.halosecurity.com/api/events-archive/website-cert-new-country.md)
- [website-cert-new-issuer](https://docs.halosecurity.com/api/events-archive/website-cert-new-issuer.md)
- [website-cert-risk](https://docs.halosecurity.com/api/events-archive/website-cert-risk.md)
- [website-cookie-monitor-change](https://docs.halosecurity.com/api/events-archive/website-cookie-monitor-change.md)
- [website-cookie-new-country](https://docs.halosecurity.com/api/events-archive/website-cookie-new-country.md)
- [website-cookie-oos](https://docs.halosecurity.com/api/events-archive/website-cookie-oos.md)
- [website-cookie-risk](https://docs.halosecurity.com/api/events-archive/website-cookie-risk.md)
- [website-download-monitor-change](https://docs.halosecurity.com/api/events-archive/website-download-monitor-change.md)
- [website-download-new-country](https://docs.halosecurity.com/api/events-archive/website-download-new-country.md)
- [website-download-oos](https://docs.halosecurity.com/api/events-archive/website-download-oos.md)
- [website-download-risk](https://docs.halosecurity.com/api/events-archive/website-download-risk.md)
- [website-form-monitor-change](https://docs.halosecurity.com/api/events-archive/website-form-monitor-change.md)
- [website-form-new-country](https://docs.halosecurity.com/api/events-archive/website-form-new-country.md)
- [website-form-oos](https://docs.halosecurity.com/api/events-archive/website-form-oos.md)
- [website-form-risk](https://docs.halosecurity.com/api/events-archive/website-form-risk.md)
- [website-header-monitor-change](https://docs.halosecurity.com/api/events-archive/website-header-monitor-change.md)
- [website-header-risk](https://docs.halosecurity.com/api/events-archive/website-header-risk.md)
- [website-link-new-country](https://docs.halosecurity.com/api/events-archive/website-link-new-country.md)
- [website-link-new-email](https://docs.halosecurity.com/api/events-archive/website-link-new-email.md)
- [website-link-new-phone](https://docs.halosecurity.com/api/events-archive/website-link-new-phone.md)
- [website-link-oos](https://docs.halosecurity.com/api/events-archive/website-link-oos.md)
- [website-link-risk](https://docs.halosecurity.com/api/events-archive/website-link-risk.md)
- [website-script-monitor-change](https://docs.halosecurity.com/api/events-archive/website-script-monitor-change.md)
- [website-script-new-country](https://docs.halosecurity.com/api/events-archive/website-script-new-country.md)
- [website-script-oos](https://docs.halosecurity.com/api/events-archive/website-script-oos.md)
- [website-script-risk](https://docs.halosecurity.com/api/events-archive/website-script-risk.md)
- [website-traffic-new-country](https://docs.halosecurity.com/api/events-archive/website-traffic-new-country.md)
- [website-traffic-oos](https://docs.halosecurity.com/api/events-archive/website-traffic-oos.md)
- [website-whois-change](https://docs.halosecurity.com/api/events-archive/website-whois-change.md)
- [website-whois-expired](https://docs.halosecurity.com/api/events-archive/website-whois-expired.md)
- [website-whois-expiring](https://docs.halosecurity.com/api/events-archive/website-whois-expiring.md)
- [Filter Reference](https://docs.halosecurity.com/api/appendix.md)
- [Targets Filter](https://docs.halosecurity.com/api/appendix/targets-filter.md): The Target Filter string typically sent through the "targets" parameter is described below.
- [Date Match](https://docs.halosecurity.com/api/appendix/date-match.md)
- [IP Range](https://docs.halosecurity.com/api/appendix/ip-range.md)
- [Discovery](https://docs.halosecurity.com/api/endpoints/discovery.md): The discovery endpoints allows you to access the domains and networks being used for discovery, as well as the the discovered hosts and IPs.
- [Target](https://docs.halosecurity.com/api/endpoints/target.md): The Target endpoint allows you to list all targets, get details about targets, and update details of specific targets.
- [Scan](https://docs.halosecurity.com/api/endpoints/scan.md): The Scan endpoint allows you to launch scans, get details about scans, and list/cancel scans that currently in progress.
- [Issue](https://docs.halosecurity.com/api/endpoints/vulnerability.md): The Issue endpoint returns details about discovered issues.
- [Tag](https://docs.halosecurity.com/api/endpoints/tag.md): The Tag endpoint allows you to get a list of tags.
- [Port](https://docs.halosecurity.com/api/endpoints/port.md): The Port endpoint allows you to get a list of port records.
- [DNS](https://docs.halosecurity.com/api/endpoints/dns.md): The DNS endpoint allows you to get a list of DNS records.
- [HTTP](https://docs.halosecurity.com/api/endpoints/http.md): The HTTP endpoint allows you to get a list of HTTP records, and details about specific HTTP records.
- [Whois](https://docs.halosecurity.com/api/endpoints/whois.md): The Whois endpoint allows you to get a list of whois records.
- [Technology](https://docs.halosecurity.com/api/endpoints/technology.md): The Technology endpoint allows you to view information about technology identified on your attack surface.
- [Website](https://docs.halosecurity.com/api/endpoints/website.md): The Website endpoint allows you to list details related to websites
- [Acknowledged](https://docs.halosecurity.com/api/endpoints/acknowledged.md): The Acknowledged endpoint allows you to list, add, and delete acknowledged hostnames, apps, and issues.
- [Event](https://docs.halosecurity.com/api/endpoints/event.md): The Event endpoint allows you to get a list of all events or event types, details about specific events, and delete events.
- [Dark Web](https://docs.halosecurity.com/api/endpoints/dark-web.md)
- [Integration](https://docs.halosecurity.com/api/endpoints/integration.md)
- [PCI](https://docs.halosecurity.com/api/endpoints/pci.md): The PCI endpoint allows you to get a summary of PCI status and start the PCI compliance process.
- [Report](https://docs.halosecurity.com/api/endpoints/report.md): Generate PDF reports.
- [User](https://docs.halosecurity.com/api/endpoints/user.md): The User endpoint provides methods for retrieving and updating information related to your account, as well as inviting new users.
- [Account](https://docs.halosecurity.com/api/endpoints/account.md): The Account endpoint provides methods for listing and adding subscriptions to the current account.
- [Security](https://docs.halosecurity.com/api/endpoints/security.md): The Security endpoint provides methods for viewing various security related metrics over time, such as your risk score.
- [File](https://docs.halosecurity.com/api/endpoints/file.md): The File endpoint allows you to get a list of all files, and delete or retrieve details of a specific file.
- [Work](https://docs.halosecurity.com/api/endpoints/work.md): Get the status of asynchronous work.