Rapid7 Insight VM

the rapid7 insight vm connector facilitates seamless integration with swimlane turbine, enabling automated vulnerability management and security processes rapid7 insightvm is a powerful vulnerability management tool that provides comprehensive visibility into the security posture of your assets this connector enables swimlane turbine users to automate asset discovery, vulnerability assessment, and reporting tasks within their security workflows by integrating with rapid7 insightvm, users can streamline vulnerability management processes, enhance asset visibility, and expedite remediation efforts, all from within the swimlane platform the connector's actions facilitate real time security analytics and proactive risk management, empowering users to maintain a robust security posture prerequisites to effectively utilize the rapid7 insight vm connector with swimlane turbine, ensure you have the following prerequisites http basic authentication with the following parameters url the base endpoint for the rapid7 insight vm api username your insight vm account username password your insight vm account password capabilities the rapid7 insightvm connector has the following capabilities get scan details create tag get tag get tags create report for report generation report download report generation get affected assets get all assets get all vulnerabilities get asset vulnerabilities get solution get vulnerability get vulnerability solutions create report for report generation notes filters the following filter elements may be defined for non templatized report formats format categories severity statuses arf xm csv export ✓ ✓ ✓ cyberscope xml database export nexpose simple xml ✓ ✓ oval xml qualys xml ✓ ✓ scap xml ✓ ✓ sql query ✓ ✓ ✓ xccdf csv xccdf xml ✓ ✓ xml export ✓ ✓ ✓ xml export v2 ✓ ✓ ✓ the following filter elements may be defined for templatized report formats template categories severity statuses audit report ✓ ✓ baseline comparison basic vulnerability check results ✓ ✓ ✓ executive overview highest risk vulns pci attestation v12 pci executive summary v12 pci vuln details v12 policy details ✓ ✓ ✓ policy eval policy summary ✓ ✓ ✓ prioritized remediations ✓ ✓ ✓ prioritized remediations with details ✓ ✓ ✓ r7 discovered assets ✓ ✓ ✓ r7 vulnerability exceptions ✓ ✓ ✓ remediation plan ✓ ✓ report card ✓ ✓ risk scorecard ✓ ✓ ✓ rule breakdown summary ✓ ✓ ✓ top policy remediations ✓ ✓ ✓ top policy remediations with details ✓ ✓ ✓ top riskiest assets ✓ ✓ ✓ top vulnerable assets ✓ ✓ ✓ vulnerability trends ✓ ✓ ✓ scope the following scope elements may be defined for non templatized report formats format assets sites asset groups tags scans arf xml ✓ ✓ ✓ ✓ ✓ csv export ✓ ✓ ✓ ✓ ✓ cyberscope xml ✓ ✓ ✓ ✓ ✓ database export ✓ nexpose simple xml ✓ ✓ ✓ ✓ ✓ oval xml ✓ ✓ ✓ ✓ qualys xml ✓ ✓ ✓ ✓ ✓ scap xml ✓ ✓ ✓ ✓ ✓ xccdf csv ✓ xccdf xml ✓ ✓ ✓ ✓ ✓ xml export ✓ ✓ ✓ ✓ ✓ xml export v2 ✓ ✓ ✓ ✓ ✓ the following scope elements may be defined for templatized report formats template assets sites asset groups tags scans audit report ✓ ✓ ✓ ✓ ✓ baseline comparison ✓ ✓ ✓ ✓ basic vulnerability check results ✓ ✓ ✓ ✓ ✓ executive overview ✓ ✓ ✓ ✓ highest risk vulns ✓ ✓ ✓ ✓ pci attestation v12 ✓ ✓ ✓ ✓ ✓ pci executive summary v12 ✓ ✓ ✓ ✓ ✓ pci vuln details v12 ✓ ✓ ✓ ✓ ✓ policy details ✓ ✓ ✓ ✓ policy eval ✓ ✓ ✓ ✓ policy summary ✓ ✓ ✓ ✓ ✓ prioritized remediations ✓ ✓ ✓ ✓ ✓ prioritized remediations with details ✓ ✓ ✓ ✓ ✓ r7 discovered assets ✓ ✓ ✓ ✓ ✓ r7 vulnerability exceptions ✓ ✓ ✓ ✓ ✓ remediation plan ✓ ✓ ✓ ✓ ✓ report card ✓ ✓ ✓ ✓ ✓ risk scorecard ✓ ✓ ✓ ✓ rule breakdown summary ✓ ✓ ✓ ✓ top policy remediations ✓ ✓ ✓ ✓ top policy remediations with details ✓ ✓ ✓ ✓ top riskiest assets ✓ ✓ ✓ ✓ ✓ top vulnerable assets ✓ ✓ ✓ ✓ ✓ vulnerability trends ✓ ✓ ✓ ✓ if a report supports specifying a scan as the scope and a scan is specified, no other scope elements can be defined in all other cases, many different types of supported scope elements can be specified in any combination all reports except the sql query format require at least one element to be specified as the scope template assets sites asset groups tags scan ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ create tag action notes create tag receives two optional inputs that requires a specific format filters this input receives a string/text than can be converted to json a reference from rapid7 with all the posibilities can be found here https //help rapid7 com/insightvm/en us/api/#section/responses/searchcriteria e g \[{"field" "","lower" "","operator" "","upper" "","value" "","values" \["string"]}] configurations http basic authentication authenticates using username and password configuration parameters parameter description type required url a url to the target host string required username username string required password password string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions assets search conducts a comprehensive search for assets in rapid7 insightvm, enabling quick retrieval of specific asset information endpoint url api/3/assets/search method post input argument name type required description match string optional parameter for assets search filters array optional parameter for assets search field string optional parameter for assets search operator string optional parameter for assets search value string optional value for the parameter output parameter type description status code number http status code of the response reason string response reason phrase resources array output field resources addresses array output field addresses ip string output field ip mac string output field mac assessedforpolicies boolean output field assessedforpolicies assessedforvulnerabilities boolean output field assessedforvulnerabilities history array output field history date string date value scanid number unique identifier type string type of the resource version number output field version hostname string name of the resource hostnames array name of the resource name string name of the resource source string output field source id number unique identifier ip string output field ip links array output field links href string output field href rel string output field rel mac string output field mac os string output field os oscertainty string output field oscertainty example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "fri, 06 jan 2023 19 19 17 gmt", "server" "security console" }, "reason" "ok", "json body" { "resources" \[], "page" {}, "links" \[] } } ] create report for report generation generates a customizable report within rapid7 insight vm to facilitate subsequent reporting processes endpoint url api/3/reports method post input argument name type required description bureau string optional parameter for create report for report generation component string optional parameter for create report for report generation database object optional response data credentials object optional parameter for create report for report generation username string optional name of the resource host string optional parameter for create report for report generation name string optional name of the resource port number optional parameter for create report for report generation vendor string optional parameter for create report for report generation email object optional parameter for create report for report generation access string optional parameter for create report for report generation additional string optional parameter for create report for report generation additionalrecipients array optional parameter for create report for report generation assetaccess boolean optional parameter for create report for report generation owner string optional parameter for create report for report generation smtp object optional parameter for create report for report generation global boolean optional parameter for create report for report generation relay string optional parameter for create report for report generation sender string optional parameter for create report for report generation enclave string optional parameter for create report for report generation filters object optional parameter for create report for report generation categories object optional parameter for create report for report generation excluded array optional parameter for create report for report generation included array optional parameter for create report for report generation links array optional parameter for create report for report generation output parameter type description status code number http status code of the response reason string response reason phrase status number status value message string response message links array output field links href string output field href rel string output field rel example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "status" 123, "message" "string", "links" \[] } } ] create tag creates a new asset tag in rapid7 insight vm for effective organization and categorization of assets endpoint url api/3/tags method post input argument name type required description name string optional name of the resource type string optional type of the resource output parameter type description status code number http status code of the response reason string response reason phrase status number status value message string response message links array output field links href string output field href rel string output field rel example \[ { "status code" 500, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "tue, 09 may 2023 17 19 56 gmt", "connection" "close", "server" "security console" }, "reason" "internal server error", "json body" { "status" 500, "message" "an unexpected error occurred see the log file for more information or contact s ", "links" \[] } } ] get affected assets retrieve a list of assets affected by a specified vulnerability using its unique identifier in rapid7 insight vm endpoint url api/3/vulnerabilities/{{id}}/assets method get input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links array output field links href string output field href rel string output field rel example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 16 40 56 gmt", "server" "security console" }, "reason" "ok", "json body" { "links" \[] } } ] get all assets fetches a comprehensive list of all assets within the rapid7 insight vm environment, providing an overview of networked devices endpoint url api/3/assets method get input argument name type required description page number optional the index of the page (zero based) to retrieve size number optional the number of records per page to retrieve sort string optional the criteria to sort the records by, in the format property\[,asc desc] output parameter type description status code number http status code of the response reason string response reason phrase resources array output field resources addresses array output field addresses ip string output field ip mac string output field mac assessedforpolicies boolean output field assessedforpolicies assessedforvulnerabilities boolean output field assessedforvulnerabilities history array output field history date string date value scanid number unique identifier type string type of the resource version number output field version hostname string name of the resource hostnames array name of the resource name string name of the resource source string output field source id number unique identifier ip string output field ip links array output field links href string output field href rel string output field rel mac string output field mac rawriskscore number score value riskscore number score value example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "fri, 06 jan 2023 18 19 53 gmt", "server" "security console" }, "reason" "ok", "json body" { "resources" \[], "page" {}, "links" \[] } } ] get asset retrieves detailed information for a specified asset using its unique asset id in rapid7 insight vm endpoint url /api/3/assets/{{asset id}} method get input argument name type required description asset id number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase addresses array output field addresses ip string output field ip mac string output field mac assessedforpolicies boolean output field assessedforpolicies assessedforvulnerabilities boolean output field assessedforvulnerabilities configurations array output field configurations name string name of the resource value string value for the parameter history array output field history date string date value scanid number unique identifier type string type of the resource version number output field version hostname string name of the resource hostnames array name of the resource name string name of the resource source string output field source id number unique identifier ids array unique identifier id string unique identifier source string output field source ip string output field ip links array output field links example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "tue, 23 may 2023 18 41 25 gmt", "server" "security console" }, "reason" "ok", "json body" { "addresses" \[], "assessedforpolicies" true, "assessedforvulnerabilities" true, "configurations" \[], "history" \[], "hostname" "ubuntu rapid7 swimlane us", "hostnames" \[], "id" 37, "ids" \[], "ip" "10 32 0 199", "links" \[], "mac" "00 50 56\ bd\ ef 5c", "os" "ubuntu linux 16 04", "oscertainty" "1 0", "osfingerprint" {} } } ] get asset vulnerability retrieve all vulnerabilities for a specified asset in rapid7 insight vm, including exceptions, by providing an asset id endpoint url api/3/assets/{{asset id}}/vulnerabilities method get input argument name type required description asset id number required unique identifier page number optional parameter for get asset vulnerability size number optional parameter for get asset vulnerability output parameter type description status code number http status code of the response reason string response reason phrase resources array output field resources id string unique identifier instances number output field instances links array output field links href string output field href rel string output field rel id string unique identifier results array result of the operation port number output field port proof string output field proof protocol string output field protocol since string output field since status string status value since string output field since status string status value page object output field page number number output field number size number output field size totalresources number output field totalresources totalpages number output field totalpages links array output field links href string output field href rel string output field rel example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 21 00 46 gmt", "server" "security console" }, "reason" "ok", "json body" { "resources" \[], "page" {}, "links" \[] } } ] get scan retrieves detailed information for a specific scan in rapid7 insight vm using the provided scan id endpoint url api/3/scans/{{id}} method get input argument name type required description id number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase assets number output field assets engineid number unique identifier engineids array unique identifier enginename string name of the resource id number unique identifier links array output field links href string output field href rel string output field rel id number unique identifier scanname string name of the resource scantype string type of the resource starttime string time value startedbyusername string name of the resource status string status value vulnerabilities object output field vulnerabilities critical number output field critical moderate number output field moderate severe number output field severe total number output field total example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 16 38 18 gmt", "server" "security console" }, "reason" "ok", "json body" { "assets" 0, "engineid" 3, "engineids" \[], "enginename" "local scan engine", "id" 2, "links" \[], "scanname" "test scan", "scantype" "manual", "starttime" "2023 01 09t16 36 31 283z", "startedbyusername" "swimlane", "status" "running", "vulnerabilities" {} } } ] get solution retrieve detailed information for a specific solution in rapid7 insight vm using the solution id endpoint url api/3/solutions/{{id}} method get input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase status number status value message string response message links array output field links href string output field href rel string output field rel example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "status" 123, "message" "string", "links" \[] } } ] get tag retrieves detailed information for a specified tag in rapid7 insight vm using the tag's unique identifier endpoint url api/3/tags/{{id}} method get input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase color string output field color created string output field created id number unique identifier links array output field links href string output field href rel string output field rel name string name of the resource riskmodifier string output field riskmodifier source string output field source type string type of the resource example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "fri, 06 jan 2023 20 16 31 gmt", "server" "security console" }, "reason" "ok", "json body" { "color" "default", "created" "2020 03 25t19 47 10 179z", "id" 1, "links" \[], "name" "very high", "riskmodifier" "2 0", "source" "built in", "type" "criticality" } } ] get tags retrieves a list of configured tags from rapid7 insight vm without requiring an id endpoint url api/3/tags method get input argument name type required description name string optional name of the resource type string optional type of the resource sort string optional parameter for get tags output parameter type description status code number http status code of the response reason string response reason phrase resources array output field resources color string output field color created string output field created id number unique identifier links array output field links href string output field href rel string output field rel name string name of the resource riskmodifier string output field riskmodifier source string output field source type string type of the resource page object output field page number number output field number size number output field size totalresources number output field totalresources totalpages number output field totalpages links array output field links href string output field href rel string output field rel example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "fri, 06 jan 2023 20 11 11 gmt", "server" "security console" }, "reason" "ok", "json body" { "resources" \[], "page" {}, "links" \[] } } ] get vulnerabilities retrieve a comprehensive list of vulnerabilities from rapid7 insight vm for analysis and action endpoint url api/3/vulnerabilities method get input argument name type required description sort string optional parameter for get vulnerabilities output parameter type description status code number http status code of the response reason string response reason phrase resources array output field resources added string output field added categories array output field categories cvss object output field cvss links array output field links href string output field href rel string output field rel v2 object output field v2 accesscomplexity string output field accesscomplexity accessvector string output field accessvector authentication string output field authentication availabilityimpact string output field availabilityimpact confidentialityimpact string unique identifier exploitscore number score value impactscore number score value integrityimpact string output field integrityimpact score number score value vector string output field vector denialofservice boolean output field denialofservice description object output field description html string output field html text string output field text exploits number output field exploits example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 14 20 00 gmt", "server" "security console" }, "reason" "ok", "json body" { "resources" \[], "page" {}, "links" \[] } } ] get vulnerabilities solutions retrieve potential solutions for remediation of a specified vulnerability in rapid7 insight vm, identified by its unique id endpoint url api/3/vulnerabilities/{{id}}/solutions method get input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links array output field links href string output field href rel string output field rel resources array output field resources example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 21 20 40 gmt", "server" "security console" }, "reason" "ok", "json body" { "links" \[], "resources" \[] } } ] get vulnerability retrieve detailed vulnerability findings for a specific asset in rapid7 insight vm using the provided 'id' endpoint url api/3/vulnerabilities/{{id}} method get input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase added string output field added categories array output field categories cvss object output field cvss links array output field links href string output field href rel string output field rel v2 object output field v2 accesscomplexity string output field accesscomplexity accessvector string output field accessvector authentication string output field authentication availabilityimpact string output field availabilityimpact confidentialityimpact string unique identifier exploitscore number score value impactscore number score value integrityimpact string output field integrityimpact score number score value vector string output field vector denialofservice boolean output field denialofservice description object output field description html string output field html text string output field text exploits number output field exploits id string unique identifier example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 15 07 55 gmt", "server" "security console" }, "reason" "ok", "json body" { "added" "2009 05 12", "categories" \[], "cvss" {}, "denialofservice" false, "description" {}, "exploits" 0, "id" "ssh default account admin password password", "links" \[], "malwarekits" 0, "modified" "2013 12 04", "pci" {}, "published" "1970 01 01", "riskscore" 999 99, "severity" "critical", "severityscore" 10 } } ] report download downloads a specified report from rapid7 insight vm using the provided report id and instance id endpoint url api/3/reports/{{report id}}/history/{{instance id}}/output method get input argument name type required description report id string required unique identifier instance id string required the identifier of the report instance accepts integer as string and value latest output parameter type description status code number http status code of the response reason string response reason phrase file object output field file file string output field file file name string name of the resource example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "set cookie" "nexposeccsessionid=acf13c7db78999431b71567100b920767eafddd8; path=/; secure; htt ", "cache control" "no store, must revalidate", "content type" "text/html;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 20 08 40 gmt", "connection" "close", "server" "security console" }, "reason" "ok" } ] report generation generates a configured report in rapid7 insight vm using the specified 'id' and returns the instance identifier endpoint url api/3/reports/{{id}}/generate method post input argument name type required description id number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links array output field links href string output field href rel string output field rel id number unique identifier example \[ { "status code" 200, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 20 28 34 gmt", "server" "security console" }, "reason" "ok", "json body" { "links" \[], "id" 9 } } ] start scan initiates a scan in rapid7 insight vm using specified engine, hosts, and template id, with 'id' as the required path parameter endpoint url api/3/sites/{{id}}/scans method post input argument name type required description id number required unique identifier engineid number required unique identifier hosts array required parameter for start scan name string required name of the resource templateid string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase links array output field links href string output field href rel string output field rel id number unique identifier example \[ { "status code" 201, "response headers" { "x frame options" "sameorigin", "x ua compatible" "ie=edge,chrome=1", "x content type options" "nosniff", "x xss protection" "1; mode=block", "cache control" "no store, must revalidate", "location" "https //10 32 0 199 3780/api/3/scans/3", "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "content encoding" "gzip", "vary" "accept encoding", "date" "mon, 09 jan 2023 19 10 31 gmt", "server" "security console" }, "reason" "created", "json body" { "links" \[], "id" 3 } } ] response headers header description example cache control directives for caching mechanisms no store, must revalidate connection http response header connection close content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated tue, 09 may 2023 17 19 56 gmt location the url to redirect a page to https //10 32 0 199 3780/api/3/scans/3 https //10 32 0 199 3780/api/3/scans/3 server information about the software used by the origin server security console set cookie http response header set cookie nexposeccsessionid=acf13c7db78999431b71567100b920767eafddd8; path=/; secure; httponly transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding x content type options http response header x content type options nosniff x frame options http response header x frame options sameorigin x ua compatible http response header x ua compatible ie=edge,chrome=1 x xss protection http response header x xss protection 1; mode=block notes you can find information on search criteria here https //help rapid7 com/insightvm/en us/api/index html#section/overview/responses