Asset Discovery

Sonar Query Search

Changed on Aug 6, 2026

Executes a Sonar query to discover assets with the given search criteria.

post/api/3/sonar_queries/search

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/sonar_queries/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "filters": [
    {
      "domain": "acme.com",
      "type": "domain-contains"
    }
  ]
}

Response

addressstring

The IP address of a discovered asset.

namestring

The host name of a discovered asset.

Example response

[
  {
    "address": "12.83.99.203",
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ],
    "name": "desktop-27.acme.com"
  }
]

Changes

Aug 6, 20263a8197c22d71 Revision changes
- breaking
  added required request body
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status

Operation history