> ## 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. # Get public service search fields ## OpenAPI ````yaml https://api.infrawatch.com/openapi.json?contract=d15375c get /search/services/schema 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/services/schema: servers: - url: https://api.infrawatch.com/api/v1 get: tags: - Search summary: Get public service search fields operationId: getServicesSearchSchema parameters: - $ref: '#/components/parameters/search_v1_SchemaFilter' - $ref: '#/components/parameters/search_v1_SchemaNamespace' - $ref: '#/components/parameters/search_v1_SchemaView' - $ref: '#/components/parameters/search_v1_SchemaLimit' responses: '200': $ref: '#/components/responses/search_v1_ServicesSchemaResponse' '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_SchemaFilter: description: >- Return only fields whose name or description contains this text, case-insensitively. A dataset can expose thousands of fields, so narrowing is usually faster than downloading the whole document. in: query name: q schema: maxLength: 128 type: string search_v1_SchemaNamespace: description: >- Return only fields under this leading name segment, such as tls or http. Use view=namespaces to discover the available segments. in: query name: namespace schema: maxLength: 128 type: string search_v1_SchemaView: description: >- Set to namespaces to return the field-name segments and how many fields each holds, instead of the fields themselves. Answers what a dataset covers without transferring the full schema. in: query name: view schema: enum: - namespaces type: string search_v1_SchemaLimit: description: >- Maximum fields to return when filtering. The response sets truncated when more matched than were returned. in: query name: limit schema: default: 100 maximum: 1000 minimum: 1 type: integer responses: search_v1_ServicesSchemaResponse: content: application/json: example: aggregate_fields: - count_unit: service name: port type: integer - count_unit: service name: tags type: string - count_unit: host name: tags.category type: string - count_unit: service name: http.capabilities type: string dataset: services language: infraql query_fields: - description: Observed service port. name: port operators: - ':' - '=' - '!=' - < - <= - '>' - '>=' type: integer schema: $ref: '#/components/schemas/search_v1_ServicesSearchSchemaResponse' description: Public service query schema. headers: Cache-Control: description: >- Allows a private client cache to reuse this immutable schema for five minutes. schema: enum: - private, max-age=300 type: string 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 schemas: search_v1_ServicesSearchSchemaResponse: allOf: - $ref: '#/components/schemas/search_v1_SearchSchemaResponse' - properties: dataset: const: services search_v1_ErrorResponse: additionalProperties: false properties: error: $ref: '#/components/schemas/search_v1_ErrorDetail' required: - error type: object search_v1_SearchSchemaResponse: additionalProperties: false allOf: - properties: aggregate_fields: minItems: 1 description: >- Public InfraQL fields and aggregation capabilities for one v1 search dataset. properties: aggregate_fields: description: Public fields accepted by the dataset aggregate operation. items: $ref: '#/components/schemas/search_v1_AggregateField' maxItems: 32 type: array dataset: $ref: '#/components/schemas/search_v1_SearchDataset' language: description: >- Query language accepted by the dataset's search, count, and aggregate operations where available. enum: - infraql type: string query_fields: description: >- Canonical public fields accepted in InfraQL expressions for this dataset. items: $ref: '#/components/schemas/search_v1_QueryField' maxItems: 4096 minItems: 1 type: array required: - dataset - language - query_fields - aggregate_fields 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 search_v1_AggregateField: additionalProperties: false properties: count_unit: enum: - host - service - dns_record - whois_domain - certificate - report type: string name: maxLength: 128 minLength: 1 type: string type: $ref: '#/components/schemas/search_v1_AggregateValueType' required: - name - type - count_unit type: object search_v1_SearchDataset: description: >- Public dataset identifier. Search API v1 contains exactly hosts, services, DNS, WHOIS, and certificates. enum: - hosts - services - dns - whois - certificates type: string search_v1_QueryField: additionalProperties: false properties: description: maxLength: 2048 minLength: 1 type: string name: maxLength: 512 minLength: 1 type: string operators: description: >- Operators this field accepts in an InfraQL expression. 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. The comparators `<`, `<=`, `>` and `>=` apply to numeric and timestamp fields. items: enum: - ':' - '=' - '!=' - '=~' - ':~' - < - <= - '>' - '>=' type: string maxItems: 9 minItems: 1 type: array uniqueItems: true type: enum: - string - integer - number - boolean - ip - timestamp - array type: string required: - name - type - operators type: object search_v1_AggregateValueType: description: Scalar JSON type used by every bucket value in an aggregate group. enum: - string - integer - number - boolean 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 ````