RArapid7
Asset Group

Asset Group

Changed on

Updates the details of an asset group. See the search criteria endpoint (/search_criteria) for more information about building the search criteria and examples.

put/api/3/asset_groups/{id}

Request

Path parameters

idinteger required

The identifier of the asset group.

Example:61

Request body

assetsinteger

The number of assets that belong to the asset group.

descriptionstring

The description of the asset group.

idobject

The identifier of the asset group.

namestring required

The name of the asset group.

riskScorenumber double

The total risk score of all assets that belong to the asset group.

type'static' | 'dynamic' required

The type of the asset group.

Example request

{
  "assets": 768,
  "description": "Assets with unacceptable high risk required immediate remediation.",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "name": "High Risk Assets",
  "riskScore": 4457823.78,
  "searchCriteria": {
    "match": "all"
  },
  "type": "dynamic",
  "vulnerabilities": {
    "critical": 16,
    "moderate": 3,
    "severe": 76,
    "total": 95
  }
}

Response

OK

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

  • 3a8197c22d71Revision 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

    • info

      added the media type application/json;charset=UTF-8 for the response with the status