SBOM

APIs for managing SBOMs

Get the SBOM of the specified asset

get

Get an SBOM (Software Bill of Materials) report for the specified asset. You can specify the format and version of the SBOM, as well as which attribute you would like included.

Required license: Cortex Cloud Runtime Security. In Cortex Cloud Posture Management, requires the Cortex Cloud Runtime Security add-on.

Path parameters

assetIDstringRequired

ID of the asset of which you want to export the SBOM

Query parameters

formatstring · enumOptional

The format in which the SBOM is to be exported.

Possible values:

output_formatstring · enumOptional

The version of the SBOM format to be used.

Possible values:

attributesstring · enumOptional

The list of attributes to be included in the SBOM. If not specified, all fields are included except Type and Name, which are always included.

Possible values:

Header parameters

AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

OK. The request was successful, and the SBOM data is returned in the specified format.

application/xml

string · binaryOptional

400

Bad Request. The request was malformed, missing the required parameters, or the Asset ID provided does not support SBOM Export.

application/json

401

The API key provided is invalid or missing.

application/json

403

Forbidden. The API key does not have the necessary permissions to access the requested resource.

application/json

404

The specified asset was not found.

application/json

500

An error occurred on the server while processing the request.

application/json

get/public_api/v1/assets/{assetID}/sbom

GET /public_api/v1/assets/{assetID}/sbom HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Accept: */*

<?xml version="1.0"?>
<object>binary</object>