Create an Asset Group

post /public_api/v1/asset-groups/create

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

Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM NG SIEM or Cortex XSIAM Enterprise Plus.

Request headers

Authorization String required

{api_key}

Example: authorization_example

x-xdr-auth-id String required

{api_key_id}

Example: xXdrAuthId_example

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: application/json'
      
        -H
        'Content-Type: application/json'
      
          -H
          'Authorization: authorization_example'
          -H
          'x-xdr-auth-id: xXdrAuthId_example'
      
      'https://api-yourfqdn/public_api/v1/asset-groups/create'
    
      -d
      ''

import http.client

conn = http.client.HTTPSConnection("api-yourfqdn")

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

headers = {
    'Authorization': "SOME_STRING_VALUE",
    'x-xdr-auth-id': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/public_api/v1/asset-groups/create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api-yourfqdn/public_api/v1/asset-groups/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'SOME_STRING_VALUE'
request["x-xdr-auth-id"] = 'SOME_STRING_VALUE'
request["content-type"] = 'application/json'
request.body = "{\"request_data\":{\"asset_group\":{\"group_name\":\"string\",\"group_type\":\"Dynamic\",\"group_description\":\"string\",\"membership_predicate\":{\"AND\":[{\"SEARCH_FIELD\":\"xdm.asset.type.class\",\"SEARCH_TYPE\":\"NEQ\",\"SEARCH_VALUE\":\"Other\"}]}}}}"

response = http.request(request)
puts response.read_body

const data = JSON.stringify({
  "request_data": {
    "asset_group": {
      "group_name": "string",
      "group_type": "Dynamic",
      "group_description": "string",
      "membership_predicate": {
        "AND": [
          {
            "SEARCH_FIELD": "xdm.asset.type.class",
            "SEARCH_TYPE": "NEQ",
            "SEARCH_VALUE": "Other"
          }
        ]
      }
    }
  }
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api-yourfqdn/public_api/v1/asset-groups/create");
xhr.setRequestHeader("Authorization", "SOME_STRING_VALUE");
xhr.setRequestHeader("x-xdr-auth-id", "SOME_STRING_VALUE");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://api-yourfqdn/public_api/v1/asset-groups/create")
  .header("Authorization", "SOME_STRING_VALUE")
  .header("x-xdr-auth-id", "SOME_STRING_VALUE")
  .header("content-type", "application/json")
  .body("{\"request_data\":{\"asset_group\":{\"group_name\":\"string\",\"group_type\":\"Dynamic\",\"group_description\":\"string\",\"membership_predicate\":{\"AND\":[{\"SEARCH_FIELD\":\"xdm.asset.type.class\",\"SEARCH_TYPE\":\"NEQ\",\"SEARCH_VALUE\":\"Other\"}]}}}}")
  .asString();

import Foundation

let headers = [
  "Authorization": "SOME_STRING_VALUE",
  "x-xdr-auth-id": "SOME_STRING_VALUE",
  "content-type": "application/json"
]
let parameters = ["request_data": ["asset_group": [
      "group_name": "string",
      "group_type": "Dynamic",
      "group_description": "string",
      "membership_predicate": ["AND": [
          [
            "SEARCH_FIELD": "xdm.asset.type.class",
            "SEARCH_TYPE": "NEQ",
            "SEARCH_VALUE": "Other"
          ]
        ]]
    ]]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-yourfqdn/public_api/v1/asset-groups/create")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-yourfqdn/public_api/v1/asset-groups/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"request_data\":{\"asset_group\":{\"group_name\":\"string\",\"group_type\":\"Dynamic\",\"group_description\":\"string\",\"membership_predicate\":{\"AND\":[{\"SEARCH_FIELD\":\"xdm.asset.type.class\",\"SEARCH_TYPE\":\"NEQ\",\"SEARCH_VALUE\":\"Other\"}]}}}}",
  CURLOPT_HTTPHEADER => [
    "Authorization: SOME_STRING_VALUE",
    "content-type: application/json",
    "x-xdr-auth-id: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-yourfqdn/public_api/v1/asset-groups/create");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: SOME_STRING_VALUE");
headers = curl_slist_append(headers, "x-xdr-auth-id: SOME_STRING_VALUE");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"request_data\":{\"asset_group\":{\"group_name\":\"string\",\"group_type\":\"Dynamic\",\"group_description\":\"string\",\"membership_predicate\":{\"AND\":[{\"SEARCH_FIELD\":\"xdm.asset.type.class\",\"SEARCH_TYPE\":\"NEQ\",\"SEARCH_VALUE\":\"Other\"}]}}}}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-yourfqdn/public_api/v1/asset-groups/create");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "SOME_STRING_VALUE");
request.AddHeader("x-xdr-auth-id", "SOME_STRING_VALUE");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"request_data\":{\"asset_group\":{\"group_name\":\"string\",\"group_type\":\"Dynamic\",\"group_description\":\"string\",\"membership_predicate\":{\"AND\":[{\"SEARCH_FIELD\":\"xdm.asset.type.class\",\"SEARCH_TYPE\":\"NEQ\",\"SEARCH_VALUE\":\"Other\"}]}}}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

application/json

request_dataobject

asset_groupobject

group_namestring

Asset Group name

group_typestring (Enum)

The type of Asset Group. Valid values include:

Dynamic: Assets grouped using filters. Any asset that meets the defined criteria is included.
Static: Manually add individual assets to be included in a group.

Allowed values:"Dynamic""Static"

group_descriptionstring

Add an optional description to clarify the purpose of the Asset Group.

membership_predicateobject

Define the filter conditions for selecting which assets to be included in a dynamic Asset Group.

Any of

ANDarrayrequired

[

SEARCH_FIELDstring

The field you want to filter.

Example:"xdm.asset.type.class"

SEARCH_TYPEstring (Enum)

The operator to apply to the SEARCH_FIELD. It defines how the SEARCH_VALUE will be used to evaluate the SEARCH_FIELD.

Example:"NEQ"

Allowed values:"EQ""NEQ""GT""LT""GTE""LTE""IN""NIN""RLIKE""NRLIKE""WILDCARD""WILDCARD_NOT""CONTAINS""NCONTAINS""IP_MATCH""NIP_MATCH""ARRAY_CONTAINS""ARRAY_NOT_CONTAINS""IS_EMPTY""NIS_EMPTY""REGEX""REGEX_NOT""REGEX_MATCH""REGEX_NOT_MATCH""IPLIST_MATCH""NLISTIP_MATCH""INCIDR""NINCIDR""INCIDR6""NINCIDR6""RANGE""RELATIVE_TIMESTAMP""JSON_OVERLAPS""JSON_ARRAY_CONTAINED_IN""JSON_IS_NOT_EMPTY"

SEARCH_VALUEobject

The value that the SEARCH_FIELD will be compared to, based on the SEARCH_TYPE operator. Valid values include: EQ, IN, NIN, NEQ, IS, IS_NOT, LIKE_ANY, NOT_LIKE_ANY, WILDCARD, WILDCARD_NOT, REGEX, REGEX_NOT, GT, LT, GTE, LTE, RELATIVE_TIMESTAMP, RANGE, CONTAINS, JSON_SEARCH, JSON_OVERLAPS, JSON_OVERLAPS_NOT, NCONTAINS, CONTAINS_IN_LIST, NOT_CONTAINS_IN_LIST, ARRAY_LEN_EQ, ARRAY_LEN_NEQ, ARRAY_CONTAINS, ARRAY_CONTAINS_NUMBERS, ARRAY_NOT_CONTAINS, JSON_EQ, JSON_NEQ, JSON_WILDCARD_NOT, JSON_WILDCARD, JSON_GTE, JSON_LTE, JSON_GT, JSON_LT, JSON_CONTAINS_NOT, JSON_CONTAINS, JSON_ARRAY_CONTAINED_IN, JSON_ARRAY_NOT_CONTAINED_IN, JSON_ARRAY_CONTAINS, JSON_ARRAY_CONTAINS_NOT, JSON_IS_EMPTY, JSON_IS_NOT_EMPTY`

Example:"Other"

One of

string

Example:"Other"

boolean

Example:"Other"

integer

Example:"Other"

]

ORarrayrequired

[

SEARCH_FIELDstring

The field you want to filter.

Example:"xdm.asset.type.class"

SEARCH_TYPEstring (Enum)

The operator to apply to the SEARCH_FIELD. It defines how the SEARCH_VALUE will be used to evaluate the SEARCH_FIELD.

Example:"NEQ"

SEARCH_VALUEobject

Example:"Other"

One of

string

Example:"Other"

boolean

Example:"Other"

integer

Example:"Other"

]

REQUEST

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

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

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

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

Responses

Body

application/json

[

replyobject

dataobject

successboolean

Whether the Asset Group creation was successful

asset_group_idinteger

ID of the new Asset Group

Example:1

]

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

Unauthorized

Body

application/json

[

err_codeinteger

Example:403

err_msgstring

Example:"Forbidden. Access was denied to this resource."

err_extrastring

]

RESPONSE
[
  {
    "err_code": 403,
    "err_msg": "Forbidden. Access was denied to this resource.",
    "err_extra": "example"
  }
]

Internal Server Error, Invalid Input

Body

application/json

[

err_codeinteger

Example:500

err_msgstring

Example:"An unexpected behavior occurred by Cortex Pubic API"

err_extrastring

]

RESPONSE
[
  {
    "err_code": 500,
    "err_msg": "An unexpected behavior occurred by Cortex Pubic API",
    "err_extra": "example"
  }
]