Censys · JSON Structure

Platform Searchqueryinputbody Structure

SearchQueryInputBody schema from Censys Platform API

Type: object Properties: 4 Required: 1
SecurityInternet IntelligenceAttack Surface ManagementThreat HuntingCyber Threat IntelligenceOSINTInternet ScanningCertificatesAsset Discovery

SearchQueryInputBody is a JSON Structure definition published by Censys, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

fields page_size page_token query

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/censys/refs/heads/main/json-structure/platform-searchqueryinputbody-structure.json",
  "name": "SearchQueryInputBody",
  "description": "SearchQueryInputBody schema from Censys Platform API",
  "type": "object",
  "required": [
    "query"
  ],
  "additionalProperties": false,
  "properties": {
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "description": "Specify fields to only return in the response. If you provide fields and omit `host.services.port`, `host.services.transport_protocol`, and `host.services.protocol`, then `matched_services` will not be returned in the response.",
      "items": {
        "type": "string"
      }
    },
    "page_size": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Number of results to return to per page. The default and maximum is 100.",
      "minimum": 0
    },
    "page_token": {
      "type": "string",
      "description": "page token for the requested page of search results"
    },
    "query": {
      "type": "string",
      "description": "CenQL query string to search upon"
    }
  }
}