--- sourceDocument: Australia Security Management sourceDocumentLink: https://www.servicenow.com/docs/r/australia/security-management Release : - australia ft:locale : - en-US ft:publication_title : - Australia Security Management ft:clusterId : - security bundleId : - security workflow : - Technology --- # Uploading Software Bill of Materials files using a REST API # Uploading Software Bill of Materials files using a REST API {#ariaid-title1} Release version: Australia Updated June 25, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Uploading Software Bill of Materials files using a REST API This documentation explains how ServiceNow customers can upload Software Bill of Materials (SBOM) files using a REST API in the Australia release (updated June 25, 2026). It covers the necessary roles, supported file formats, API endpoints, request parameters, response formats, and key enhancements in SBOM Core version 4.0. Show full answer Show less ## Key Features * **Role Required:** To upload SBOM files, the user must have the `snsbomcore.sbomingest` role. * **Supported SBOM Formats:** * CycloneDX versions 1.5 - 1.6 (XML and JSON) * SPDX versions 2.2 - 2.3 (JSON) * **Upload API Details:** * HTTP POST method to `/api/sbom/core/upload` on your ServiceNow instance. * Content-Type header is mandatory and must be set to `text/xml`, `application/json`, or `application/xml` depending on the SBOM file format. * Files larger than 32 MB may not upload properly. * Request body contains the SBOM file content; additional optional parameters allow mapping to product models or business applications, specify the SBOM source, and provide metadata such as `requestedBy`. * **DevOps Integration:** When `requestedBy` is set to "devops," the parameters `buildId` and `lifecycleStage` (production or preproduction) become mandatory, and options to fetch vulnerability and package intelligence info (`fetchVulenrabilityInfo` and `fetchPackageInfo`) are included. * **Status API:** A GET method at `/api/sbom/core/upload/status` retrieves the processing status and summary of an uploaded SBOM using the `bomRecordId`. * **Response Details:** Successful uploads return a status, message, and `bomRecordId`. Status API responses include component counts and, if requested, vulnerability or package intelligence breakdowns. * **SBOM Data View:** After processing, SBOM records are accessible in the SBOM Workspace under either the BOM Queue module (for SBOM Response users) or SBOM Core \> BOM Ingestion Status for others. ## Enhancements in SBOM Core Version 4.0 * Expanded support for CycloneDX versions 1.5 - 1.6 and SPDX 2.2-2.3 with XML and JSON formats. * Introduction of the `snsbomcore.collectproperties` property (disabled by default) to import additional metadata not generally supported, stored in the SBOM Component Property table. * Extended parsing for CycloneDX component types including Platform, Data, Device driver, Machine Learning model (v1.5), and Cryptographic (v1.6). * Support for viewing declared and concluded licenses in SBOM files version 1.4 and later. ## Practical Application for ServiceNow Customers By using the REST API with proper roles and request formatting, customers can automate the ingestion of SBOM files into their ServiceNow instances for software supply chain visibility. The API enables integration with DevOps pipelines by requiring build and lifecycle information and allows fetching vulnerability and package intelligence data to enhance security insights. Processed SBOM data is accessible within ServiceNow's SBOM workspace for further analysis and reporting. Understanding the supported SBOM formats, request headers, and parameters ensures successful uploads and efficient management of software component data. Review the following information prior to uploading Software Bill of Materials files using an API. ## Using the REST API {#vr-sbom-preparing-upload__section_u41_c3p_xzb} To upload an SBOM file with an API, the sn_sbom_core.sbom_ingest role is required. Upload API. This API is used for uploading and ingesting an SBOM file (CycloneDX/SPDX) into your instance. Version 4.0 of SBOM Core supports: * XML and JSON in CycloneDx (versions 1.5 - 1.6). * JSON in SPDX (versions 2.2-2.3) * Note: Files over 32 MB might not load properly. {#vr-sbom-preparing-upload__ul_rys_3wh_2cc} HTTP method: (POST) API URL: \/api/sbom/core/upload Note: \ is your ServiceNow instance name. Request headers. The Content-Type header is required when calling the Upload API. Set the Content-Type value to match the SBOM file content submitted in the request body. Supported values include: * Content-Type: text/xml * Content-Type: application/json * Content-Type: application/xml {#vr-sbom-preparing-upload__ul_l25_jvn_rjc}If the Content-Type header is missing, the API rejects the request with a HTTP 400 error and returns the following code: { "status": "failure", "message": "Content-Type header is missing" } If the Content-Type header is unsupported, the API rejects the request with an HTTP 400 error and returns the following code: { "status": "error", "message": "Unsupported Content-Type. BOM data must be in JSON or XML." } All the following request parameters are optional; the request body is the SBOM file content. If you're using DevOps as part of your development process, the value of 'requestedBy' should be 'devops'. See [Uploading Software Bill of Materials for DevOps SBOM files](https://www.servicenow.com/docs/4~lS694nGLL0WEQvORukog "Generate and upload Software Bill of Materials SBOM files for software throughout its continuous integration and continuous deployment development cycles.") for more general information about DevOps. If the value for 'requestedby' is "devops" (devlopment operations), these parameters are mandatory: * buildId * lifecycleStage {#vr-sbom-preparing-upload__ul_p3t_z3h_2cc} In addition, if 'requestedBy' is 'devops', data for fetchVulenrabilityInfo, and fetchPackageInfo is included. * buildId- string you send * lifecycleStage- two values, production or pre_production * fetchVulenrabilityInfo- t/f * fetchPackageInfo-t/f {#vr-sbom-preparing-upload__ul_j2m_ybh_2cc} {#vr-sbom-preparing-upload__table_fsh_lgh_2cc__entry__3} | Request parameters | Possible values | Description | |-|-|-| | productModelId | Sys id | Sys id of product model to map with the root application of given SBOM. | | businessApplicationId | Sys id | Sys id of business application to map with the root application of given SBOM. | | businessApplicationName (deprecated) | Your business application name | Name of business application to map with the root application of given SBOM. | | sbomSource | A product such as Veracode, for example | The source for your SBOM file. | | requestedBy | A tool, or name of a methodology, Jenkins. If you use "devops", buildId and lifecycleStage are mandatory. | Upload requested by | | buildId | A string requester sends. | Build ID of the SBOM build. | | lifecycleStage | production or pre_production | Life cycle stage of the entity. | | fetchVulenrabilityInfo | t/f | If true, triggers vulnerability intelligence integration. | | fetchPackage Info | t/f | If true, triggers package intelligence integration. | [ ] {#vr-sbom-preparing-upload__table_fsh_lgh_2cc} Upload API Response: included 'status' success/fail, 'message' (string), 'bomRecordId' (this is the sys id of the SBOM that is returned through the upload API for a successful SBOM upload). { "result": { "status": "success", "message": "Queued for processing.", "bomRecordId": "f207059b4393c290629aa597cbb8f247" } } ## Status API {#vr-sbom-preparing-upload__section_jzy_rjh_2cc} This API gets the status and summary of an SBOM that Is queued for ingestion. * API URL: /api/sbom/core/upload/status * HTTP method (GET) {#vr-sbom-preparing-upload__ul_pvm_3ch_2cc} {#vr-sbom-preparing-upload__table_rw2_fkh_2cc__entry__3} | Request parameters | Possible values | Description | |-|-|-| | bomRecordId | Sys id | SBOM record ID that is returned the through the upload API for a successful SBOM upload. | [ ] {#vr-sbom-preparing-upload__table_rw2_fkh_2cc} Status API default response example. { "result": { "bomRecordId": "0407c0fea3e70a505df340f5251e617e", "uploadStatus": "processed", "additionalInfoStatus": "not_requested", "uploadSummary": { "components": { "added": 0, "removed": 0, "total": 70 } } } } Status API response with additional parameters example. If you requested fetchVulenrabilityInfo for that SBOM, you get the vulnerability breakdown as part of the response. { "result": { "bomRecordId": "93af349b4393c290629aa597cbb8f258", "uploadStatus": "processed", "additionalInfoStatus": "complete", "uploadSummary": { "components": { "added": 0, "removed": 0, "total": 3 }, "vulnerabilityInfo": { "critical": 0, "high": 0, "medium": 0, "low": 0, "none": 0 } }, "buildId": "1" } } If you requested fetchPackageInfo for that SBOM, you get stale and abandoned counts as part of the response. After an SBOM is successfully processed, where you view the uploaded records depends on the applications you're using. * If you're using SBOM Response, the BOM Entity record is displayed on the SBOM Ingestion Status list in the BOM Queue module in the SBOM Workspace. * If you're using SBOM Core, navigate to SBOM CoreBOM Ingestion Status. {#vr-sbom-preparing-upload__ul_dtp_21v_xzb} ## Enhancements to supported SBOM standards and general usage information {#vr-sbom-preparing-upload__section_em2_wbp_xzb} Version 4.0 of SBOM Core supports: * XML and JSON in CycloneDx (versions 1.5 - 1.6). * JSON in SPDX (versions 2.2-2.3) * Note: Files over 32 MB might not load properly. {#vr-sbom-preparing-upload__ul_hj5_vbb_2cc} Starting with v4.0 of SBOM Core, the following enhancements were made to support CycloneDx standards for versions 1.5 - 1.6: * Import additional information in CycloneDX SBOM files with the (sn_sbom_core.collect_properties) property. This property is deactivated by default. Activate the property to import information that is generally not supported. Any information imported from these properties is uploaded to the SBOM Component Property \[sn_sbom_comp_property\] table for the following: * Uploaded SBOM files * Metadata * Individual vulnerabilities * Components {#vr-sbom-preparing-upload__ul_v5n_gbb_2cc} * View imported component data for declared and concluded licenses for SBOM files in versions 1.4 and later of CycloneDX in two new license fields: * Declared * Concluded {#vr-sbom-preparing-upload__ul_dv2_1bb_2cc} * SBOM parsing support is extended for the following CycloneDX component types: * Version 1.5: Platform, Data, Device driver, Machine Learning model * Version 1.6: Cryptographic {#vr-sbom-preparing-upload__ul_ayz_mbb_2cc} {#vr-sbom-preparing-upload__ul_xp2_y1b_2cc} Version 3.0 of SBOM Core supports: * XML and JSON in CycloneDx (version 1.5 and later). * JSON in SPDX (up to and including v2.3). {#vr-sbom-preparing-upload__ul_h1l_1yh_2cc} If the calling user is successfully authenticated and has the sn_sbom_core.sbom_ingest role in your ServiceNow instance, you can access the API from outside of your instance to upload the SBOM data. After data is uploaded, it is parsed. Before data is parsed, the following requirements are verified: * Incoming data is checked that it is valid JSON or XML. * The BOM format is supported. Starting with v2.1 of SBOM Core, CycloneDX (JSON and XML) and SPDX (XML) formats are supported. * The minimum fields are available so that data can be parsed. {#vr-sbom-preparing-upload__ul_rrd_fcp_xzb} After these checks are verified, an entry is made into the Bill of Materials \[sn_sbom_doc\] table with incoming SBOM data as an attachment. The Process BOM file business rule is triggered automatically as a result of the record insertion and data parsing. Note: This business rule is activated during installation of SBOM Core by default. All the components listed in an SBOM have a defined type. * Components for which SBOM files were uploaded are considered BOM Entities. * Components listed as type=library are considered third-party components. {#vr-sbom-preparing-upload__ul_srd_fcp_xzb} **Related concepts** * [Viewing reports and dashboards in the Software Bill of Materials workspace](https://www.servicenow.com/docs/y_jtoeqbUC6WVIUzom44GQ "Vulnerability analysts view uploaded software bill of materials files in records, data visualizations, as well as enhanced vulnerability intelligence in the Software Bill of Materials (SBOM) Workspace.") **Related tasks** * [View upload status for Software Bill of Materials files](https://www.servicenow.com/docs/q6KZMmj4XHgo3~rsrCeFhA "Check the upload status for the Software Bill of Materials (SBOM) files that you upload in the BOM Queue module in the Software Bill of Materials (SBOM) Workspace. Track the files that you upload successfully, your upload history, and errors.") *[\>]: and then