Asset Groups

APIs for managing asset groups

Get all or filtered asset groups

post

By grouping assets based on shared attributes, you can address them collectively. Asset groups enable more efficient bulk actions and simplifies both filtering and scoping within the inventory and across the platform.

Get all or filtered asset groups.

Required license: Cortex XDR.

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

Responses

200

Ok

application/json

403

Unauthorized

application/json

500

Internal Server Error, Invalid Input

application/json

post/public_api/v1/asset-groups

POST /public_api/v1/asset-groups HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "request_data": {
    "filters": {
      "AND": [
        {
          "SEARCH_FIELD": "XDM.ASSET_GROUP.TYPE",
          "SEARCH_TYPE": "EQ",
          "SEARCH_VALUE": "Dynamic"
        }
      ]
    },
    "sort": [
      {
        "FIELD": "XDM.ASSET_GROUP.LAST_UPDATE_TIME",
        "ORDER": "DESC"
      }
    ],
    "search_from": 1,
    "search_to": 1000
  }
}

[
  {
    "reply": {
      "data": [
        {}
      ],
      "metadata": {
        "filter_count": 1,
        "total_count": 1000
      }
    }
  }
]

Create an Asset Group

post

Create a dynamic Asset Group by specifying the filters, or a static group to manually include individual assets.

Required license: Cortex XDR.

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

Responses

200

Ok

application/json

403

Unauthorized

application/json

500

Internal Server Error, Invalid Input

application/json

post/public_api/v1/asset-groups/create

POST /public_api/v1/asset-groups/create HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "request_data": {
    "asset_group": {
      "group_name": "text",
      "group_type": "Dynamic",
      "group_description": "text",
      "membership_predicate": {
        "AND": [
          {
            "SEARCH_FIELD": "xdm.asset.type.class",
            "SEARCH_TYPE": "NEQ",
            "SEARCH_VALUE": "Other"
          }
        ]
      }
    }
  }
}

[
  {
    "reply": {
      "data": {
        "success": true,
        "asset_group_id": 1
      }
    }
  }
]

Update an Asset Group

post

Update the Asset Group specified by Asset Group ID.

Required license: Cortex XDR.

Path parameters

group_idstringRequired

Asset Group ID

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

Responses

200

Ok

application/json

403

Unauthorized

application/json

500

Internal Server Error, Invalid Input

application/json

post/public_api/v1/asset-groups/update/{group_id}

POST /public_api/v1/asset-groups/update/{group_id} HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "request_data": {
    "asset_group": {
      "group_name": "text",
      "group_type": "Dynamic",
      "group_description": "text",
      "membership_predicate": {
        "AND": [
          {
            "SEARCH_FIELD": "xdm.asset.type.class",
            "SEARCH_TYPE": "NEQ",
            "SEARCH_VALUE": "Other"
          }
        ]
      }
    }
  }
}

[
  {
    "reply": {
      "data": {
        "success": true
      }
    }
  }
]

Delete an Asset Group

post

Delete the Asset Group specified by Asset Group ID.

Required license: Cortex XDR.

Path parameters

group_idstringRequired

Asset Group ID

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Responses

200

Ok

application/json

403

Unauthorized

application/json

500

Internal Server Error, Invalid Input

application/json

post/public_api/v1/asset-groups/delete/{group_id}

POST /public_api/v1/asset-groups/delete/{group_id} HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Accept: */*

[
  {
    "reply": {
      "data": {
        "success": true
      }
    }
  }
]