> ## Documentation Index > Fetch the complete documentation index at: https://docs.infrawatch.com/llms.txt > Use this file to discover all available pages before exploring further. # Search WHOIS domain records ## OpenAPI ````yaml https://api.infrawatch.com/openapi.json?contract=d15375c get /search/whois openapi: 3.1.0 info: description: >- Customer-facing Infrawatch APIs. Authenticate with an API key unless an operation documents another supported credential. ### Infrawatch Public API Public API authenticated exclusively with Infrawatch API keys. ### Infrawatch Customer Alerting API Project alert rules, destinations, silences, inbox state, and delivery history. ### Infrawatch Remote Browser API Project-scoped interactive browser sessions owned by Platform Core. Session admission, lifecycle, RBAC, audit, usage, screenshot history, and stream tickets are Platform Core resources. The browser master is private infrastructure and its identifiers, proxy routes, process options, and credentials are never exposed by this API. A session and all of its evidence are private to the credential that created it. Project managers may list project session metadata, inspect one session's metadata, and terminate it, but cannot access its live stream, screenshots, or network events. Terminal session metadata and screenshots are retained indefinitely. A creator can replay a terminal session as a new queued resource while preserving a durable link to the source session. ### Infrawatch ESI API Customer-facing External Surface Intelligence API for project-scoped product data authenticated by an Infrawatch API key. API keys are constrained to their immutable owner's project ceiling and assigned ESI scopes; human project-manager fallback never expands an API key. Authorised API-key requests are rate-limited and consume monthly quota. ### Infrawatch Reports API Threat report discovery API authenticated by an Infrawatch API key. ### Infrawatch Public Rules API Account-aware rule authoring, taxonomy, catalogue, and runtime observations for API clients. ### Infrawatch Search API Search hosts, services, DNS records, and certificates. Complete percent-encoded query strings are limited to 65536 bytes. title: Infrawatch Customer API version: 1.0.0 servers: - description: Infrawatch customer API url: https://api.infrawatch.com/api/v1 security: [] tags: - name: API Usage - name: Projects - name: Alert destinations - name: Alert rules - name: Alert silences - name: Alerts - name: Browser sessions - name: Browser evidence - name: Browser streaming - name: Access - name: Inventory - name: Dangling DNS - name: Findings - name: Secrets - name: Typosquatting - name: Services - name: AI Surface - description: Search hosts, services, DNS records, certificates, and open directories. name: Search - name: Dashboard - name: Reports - name: Rules - name: Rule tags - name: Rule observations paths: /search/whois: servers: - url: https://api.infrawatch.com/api/v1 get: tags: - Search summary: Search WHOIS domain records operationId: searchWhois parameters: - $ref: '#/components/parameters/search_v1_SearchQuery' - $ref: '#/components/parameters/search_v1_SearchLimit' - $ref: '#/components/parameters/search_v1_SearchOffset' - $ref: '#/components/parameters/search_v1_SearchCursor' responses: '200': content: application/json: example: domains: - dates: created: '2001-03-01T12:00:00Z' expires: '2031-03-01T12:00:00Z' dnssec: true domain: example.test found: true nameservers: - ns1.example.test - ns2.example.test registrant: country: US organization: Example Inc redacted: true registrar: id: '292' name: MarkMonitor Inc. status: - clientTransferProhibited pagination: has_more: false limit: 50 offset: 0 total: 1 total_relation: eq query: whois.registrar:"MarkMonitor" schema: $ref: '#/components/schemas/search_v1_WhoisSearchResponse' description: Matching WHOIS domain records. '400': $ref: '#/components/responses/search_v1_BadRequest' '401': $ref: '#/components/responses/search_v1_Unauthorized' '403': $ref: '#/components/responses/search_v1_Forbidden' '404': $ref: '#/components/responses/search_v1_NotFound' '429': $ref: '#/components/responses/search_v1_RateLimited' '502': $ref: '#/components/responses/search_v1_UpstreamFailed' '503': $ref: '#/components/responses/search_v1_SearchUnavailable' security: - apiKeyAuth: [] components: parameters: search_v1_SearchQuery: description: >- InfraQL expression, limited to 8192 UTF-8 bytes after URL decoding. Omit for the dataset default query. String operators pair positive with negative: `:` contains and `:~` does NOT contain; `=` is exact and `!=` is not exact. `=~` is a regular expression, which must be anchored with `^` and `$` and begin with a literal prefix of at least three characters. in: query name: q schema: maxLength: 8192 type: string x-max-bytes: 8192 search_v1_SearchLimit: description: Page size. example: 50 in: query name: limit schema: default: 50 maximum: 200 minimum: 1 type: integer search_v1_SearchOffset: description: >- Offset within the first 10,000 results; offset + limit must not exceed 10,000. Cannot be combined with cursor. example: 0 in: query name: offset schema: default: 0 maximum: 9999 minimum: 0 type: integer search_v1_SearchCursor: description: >- Opaque continuation token that expires 15 minutes after the first page and is bound to the dataset, normalized query, and resolved visibility context. Cannot be combined with offset. If it is invalid or expired, restart pagination without a cursor. Clients must not parse or persist it as a durable bookmark. example: eyJ2IjoxLCJkYXRhc2V0IjoiaG9zdHMifQ.signature in: query name: cursor schema: maxLength: 4096 minLength: 1 type: string x-max-bytes: 4096 schemas: search_v1_WhoisSearchResponse: additionalProperties: false properties: domains: items: $ref: '#/components/schemas/search_v1_WhoisDomain' maxItems: 200 type: array pagination: $ref: '#/components/schemas/search_v1_Pagination' query: maxLength: 8192 type: string x-max-bytes: 8192 required: - query - domains - pagination type: object search_v1_WhoisDomain: additionalProperties: false properties: admin: $ref: '#/components/schemas/search_v1_WhoisContact' billing: $ref: '#/components/schemas/search_v1_WhoisContact' dates: $ref: '#/components/schemas/search_v1_WhoisDates' dnssec: type: boolean domain: maxLength: 253 minLength: 1 type: string found: description: Whether a WHOIS record was found for this domain. type: boolean nameservers: items: maxLength: 253 minLength: 1 type: string maxItems: 64 type: array record_id: maxLength: 128 minLength: 1 type: string registrant: $ref: '#/components/schemas/search_v1_WhoisContact' registrar: $ref: '#/components/schemas/search_v1_WhoisRegistrar' source: maxLength: 128 minLength: 1 type: string status: description: EPP status codes published by the registry. items: maxLength: 128 minLength: 1 type: string maxItems: 64 type: array tech: $ref: '#/components/schemas/search_v1_WhoisContact' required: - domain - found - status - dnssec - nameservers - registrar - dates type: object search_v1_Pagination: additionalProperties: false allOf: - else: not: required: - next_cursor if: properties: has_more: const: true required: - has_more then: required: - next_cursor properties: has_more: description: >- True when a continuation cursor is available. At the 10,000-result handoff this is conservative and the terminal cursor page may be empty. type: boolean limit: maximum: 200 minimum: 1 type: integer next_cursor: description: Present exactly when has_more is true. maxLength: 4096 minLength: 1 type: string offset: description: Zero-based number of results preceding this page. format: int64 maximum: 9007199254740991 minimum: 0 type: integer total: description: Exact total or honest lower bound according to total_relation. format: int64 maximum: 9007199254740991 minimum: 0 type: integer total_relation: description: >- eq is exact and gte is an honest lower bound from the retrieval path. enum: - eq - gte type: string required: - limit - offset - total - total_relation - has_more type: object search_v1_ErrorResponse: additionalProperties: false properties: error: $ref: '#/components/schemas/search_v1_ErrorDetail' required: - error type: object search_v1_WhoisContact: additionalProperties: false description: >- A registry contact. Values are reproduced as the registrar publishes them; this API never un-redacts a withheld field. A contact the registrar published in redacted form carries redacted true, and the remaining fields are whatever survived that redaction. properties: city: maxLength: 512 minLength: 1 type: string country: maxLength: 128 minLength: 1 type: string email: maxLength: 512 minLength: 1 type: string name: maxLength: 512 minLength: 1 type: string organization: maxLength: 512 minLength: 1 type: string phone: maxLength: 128 minLength: 1 type: string postal_code: maxLength: 128 minLength: 1 type: string province: maxLength: 512 minLength: 1 type: string redacted: type: boolean street: maxLength: 512 minLength: 1 type: string type: object search_v1_WhoisDates: additionalProperties: false description: >- Registry timestamps. Each is absent rather than zero-valued when the registry does not publish it. properties: created: format: date-time type: string expires: format: date-time type: string updated: format: date-time type: string type: object search_v1_WhoisRegistrar: additionalProperties: false properties: email: maxLength: 512 minLength: 1 type: string id: description: IANA registrar identifier. maxLength: 128 minLength: 1 type: string name: maxLength: 512 minLength: 1 type: string url: maxLength: 512 minLength: 1 type: string type: object search_v1_ErrorDetail: additionalProperties: false properties: code: description: >- Stable machine-readable category; clients should branch on HTTP status and this value, never on message text. maxLength: 128 minLength: 1 pattern: ^[a-z][a-z0-9_]*$ type: string message: maxLength: 512 minLength: 1 type: string request_id: maxLength: 128 minLength: 1 pattern: ^[A-Za-z0-9_.:-]+$ type: string required: - code - message type: object responses: search_v1_BadRequest: content: application/json: examples: apiKeyAccountOverride: value: error: code: api_key_account_override message: API keys use their owning account. request_id: req_01JSEARCH countTooExpensive: value: error: code: search_count_too_expensive message: Exact count exceeds the bounded work limit. request_id: req_01JSEARCH invalidAggregation: value: error: code: invalid_aggregation message: Invalid search aggregation. request_id: req_01JSEARCH invalidCursor: value: error: code: invalid_search_cursor message: Search cursor is invalid or expired. request_id: req_01JSEARCH invalidIPBatch: value: error: code: invalid_ip_batch message: Choose between 1 and 100 IP addresses. request_id: req_01JSEARCH invalidJSON: value: error: code: invalid_json message: Invalid JSON request body. request_id: req_01JSEARCH invalidLimitPerIP: value: error: code: invalid_limit_per_ip message: limit_per_ip must be between 1 and 25. request_id: req_01JSEARCH invalidOrganisation: value: error: code: invalid_org_uuid message: Invalid organisation UUID. request_id: req_01JSEARCH invalidPagination: value: error: code: invalid_pagination message: Invalid search pagination. request_id: req_01JSEARCH invalidParameter: value: error: code: invalid_search_parameter message: Unsupported search parameter. request_id: req_01JSEARCH invalidQuery: value: error: code: invalid_search_query message: Invalid search query. request_id: req_01JSEARCH invalidRequest: value: error: code: invalid_request message: >- Dashboard counts do not accept query parameters or a request body. request_id: req_01JSEARCH organisationRequired: value: error: code: organisation_required message: Organisation UUID is required. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: >- Invalid organisation selection, query parameters, pagination, aggregation, JSON body, or IP batch; or an exact count that exceeds its bounded work limit. search_v1_Unauthorized: content: application/json: examples: authentication: value: error: code: unauthorized message: Authentication required. request_id: req_01JSEARCH reauthentication: value: error: code: reauthentication_required message: Reauthentication required. request_id: req_01JSEARCH sessionExpired: value: error: code: session_expired message: Session expired. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: Authentication is missing, invalid, expired, or requires a fresh login. search_v1_Forbidden: content: application/json: examples: csrf: value: error: code: csrf_required message: CSRF token required. request_id: req_01JSEARCH permission: value: error: code: permission_denied message: Permission denied. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: >- The required search scope, active account state, or browser-session CSRF proof is missing. search_v1_NotFound: content: application/json: example: error: code: organisation_not_found message: Organisation not found. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: Selected organisation not found or not visible to the caller. search_v1_RateLimited: content: application/json: examples: account: value: error: code: account_rate_limit_exceeded message: Account rate limit exceeded. request_id: req_01JSEARCH accountQuota: value: error: code: account_api_quota_exceeded message: Monthly API request quota exceeded. request_id: req_01JSEARCH apiKey: value: error: code: api_key_rate_limit_exceeded message: API key rate limit exceeded. request_id: req_01JSEARCH groupQuota: value: error: code: group_api_quota_exceeded message: Monthly group API request quota exceeded. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: >- API-key operational rate limit, human account search rate limit, or API-key monthly account/group quota exceeded. headers: Retry-After: description: Minimum delay in seconds before the active rate-limit window resets. schema: pattern: ^[1-9][0-9]*$ type: string search_v1_UpstreamFailed: content: application/json: example: error: code: search_upstream_failed message: Search service returned an invalid response. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: >- Search service communication failed or returned a malformed, oversized, unexpected, or otherwise invalid response. search_v1_SearchUnavailable: content: application/json: examples: authentication: value: error: code: authentication_unavailable message: Authentication unavailable. request_id: req_01JSEARCH busy: value: error: code: search_busy message: Search is temporarily busy. request_id: req_01JSEARCH configuration: value: error: code: search_service_misconfigured message: Search service is not configured. request_id: req_01JSEARCH entitlement: value: error: code: entitlement_required message: Product unavailable. request_id: req_01JSEARCH metering: value: error: code: api_metering_unavailable message: API metering is temporarily unavailable. request_id: req_01JSEARCH timeout: value: error: code: search_timeout message: Search timed out. request_id: req_01JSEARCH upstreamUnavailable: value: error: code: search_upstream_failed message: Search service is temporarily unavailable. request_id: req_01JSEARCH schema: $ref: '#/components/schemas/search_v1_ErrorResponse' description: >- Search is busy, timed out, unavailable, misconfigured, not enabled for the organisation, or blocked by an unavailable authentication/metering dependency. headers: Retry-After: description: >- Conservative delay in seconds before retrying when the error code is search_busy. schema: pattern: ^[1-9][0-9]*$ type: string securitySchemes: apiKeyAuth: description: >- Infrawatch API key. Supply the complete key directly as the header value. in: header name: X-API-Key type: apiKey ````