API usage
This page provides an overview of the Iris Detect API endpoints. For a complete description of the API with usage examples, see the API Reference at https://www.domaintools.com/resources/api-documentation/iris-detect/ or the OpenAPI Specification at https://app.swaggerhub.com/apis-docs/DomainToolsLLC/DomainTools_APIs.
Endpoints
Section titled “Endpoints”The Iris Detect API provides the following endpoints:
| Endpoint | Method | Description |
|---|---|---|
/v1/iris-detect/monitors/ | GET | List all monitors |
/v1/iris-detect/monitors/ | POST | Create a new monitor |
/v1/iris-detect/monitors/ | PUT | Update an existing monitor |
/v1/iris-detect/monitors/ | DELETE | Delete a monitor |
/v1/iris-detect/domains/new/ | GET | Retrieve newly discovered domains |
/v1/iris-detect/domains/watched/ | GET | Retrieve watched or changed domains |
For complete endpoint documentation with parameters and examples, see the Iris Detect API Guide.
Authentication
Section titled “Authentication”The Iris Detect API requires an API key with HMAC-signed or header authentication. See Authentication for credential types and auth methods across DomainTools products, and the Iris API authentication reference for Iris-specific HMAC construction.
Monitor IDs and domain IDs
Section titled “Monitor IDs and domain IDs”Iris Detect assigns a unique ID to each monitor and domain. Use these IDs to denote monitors or domains when you interact with the API. The API responds with full monitor and domain names. To display IDs associated with monitors and domain names, visit the general settings within the web interface and select:
Show API IDs for monitors and domainsRate limits
Section titled “Rate limits”The Iris Detect API has a 1 query per hour rate limit. It may be more advantageous to query all monitors, rather than individually.
For complete details on Iris Detect API rate limits, consult the Iris API Rate Limits documentation.
Additional resources
Section titled “Additional resources”See the Iris Detect API Reference at https://www.domaintools.com/resources/api-documentation/iris-detect/ or the OpenAPI Specification at https://app.swaggerhub.com/apis-docs/DomainToolsLLC/DomainTools_APIs for more information.