Get schema of asset inventory

get /public_api/v1/assets/schema

Get the schema of the asset inventory, including the field names, pretty field names, and field type for every entry in the data model.

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

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'https://api-yourfqdn/public_api/v1/assets/schema'

import http.client

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

conn.request("GET", "/public_api/v1/assets/schema")

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/assets/schema")

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

request = Net::HTTP::Get.new(url)

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

const data = null;

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

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

xhr.open("GET", "https://api-yourfqdn/public_api/v1/assets/schema");

xhr.send(data);

HttpResponse<String> response = Unirest.get("https://api-yourfqdn/public_api/v1/assets/schema")
  .asString();

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-yourfqdn/public_api/v1/assets/schema")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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/assets/schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-yourfqdn/public_api/v1/assets/schema");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-yourfqdn/public_api/v1/assets/schema");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Responses

Body

application/json

[

replyobject

dataarray

[

field_namestring

Data model field name

Example:"xdm.asset.id"

field_pretty_namestring

Data model pretty field name

Example:"Asset ID"

data_typestring (Enum)

Data type

Allowed values:"TEXT""ENUM""INT""JSON""BOOLEAN""TIMESTAMP""FLOAT"

]

RESPONSE

{
  "reply": {
    "DATA": [
      {
        "field_name": "xdm.asset.id",
        "field_pretty_name": "Asset ID",
        "data_type": "TEXT"
      },
      {
        "field_name": "xdm.asset.name",
        "field_pretty_name": "Name",
        "data_type": "TEXT"
      },
      {
        "field_name": "xdm.asset.provider",
        "field_pretty_name": "Provider",
        "data_type": "ENUM"
      },
      {
        "field_name": "xdm.asset.type.class",
        "field_pretty_name": "Class",
        "data_type": "ENUM"
      }
    ]
  }
}

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

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"
  }
]