Rapid7 · Schema

SearchRequestCriteria

The criteria for which entities to return.

SecurityVulnerability ManagementSIEMXDRCloud SecuritySOARApplication Security

Properties

Name Type Description
field string The field to search within.
operator string The search operation to perform. All operators are case-insensitive when operating on strings.
value object The value to search for.
View JSON Schema on GitHub

JSON Schema

rapid7-searchrequestcriteria-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchRequestCriteria",
  "title": "SearchRequestCriteria",
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The field to search within.",
      "example": "name"
    },
    "operator": {
      "type": "string",
      "description": "The search operation to perform. All operators are case-insensitive when operating on strings.",
      "enum": [
        "EQUALS",
        "CONTAINS",
        "IN"
      ]
    },
    "value": {
      "type": "object",
      "description": "The value to search for."
    }
  },
  "description": "The criteria for which entities to return."
}