Add Components

Updated on 15 Apr 2024
1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

How to: Add Components to a Software List

After you have created a software list, you can begin adding software components. To accomplish this, you can either import the SBOM or add a single component to the software list.

Import SBOM

The importSBOM endpoint allows you to import an SBOM into an organization from an SBOM file.

Endpoint
v1/project/importSBOM
Request Method
POST
Parameter	Description
sbom_id	The ID of the SBOM

Example Usage

curl --location 'https://api.ionchannel.io/v1/project/importSBOM?sbom_id={{sbom_id}}' \

--header 'Authorization: Bearer TOKEN \

--form 'file=@"~/path/to/file"'

Add Component

Add a single component to an existing software list.

Endpoint
v1/project/addComponent
Request Method
POST
Parameter	Description
name	Then name of the software component
version	(optional) The version of the software component
org	(optional) The supplier of the software component
product	(optional) The CPE of the component
purl	(optional) The Package URL of the component
repo_url	(optional) The URL of the component’s repository
sbom_id	The Software List ID

Example Usage

curl --location 'https://api.ionchannel.io/v1/project/addComponent' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer TOKEN' \

--data-raw '{

"name": "component_name",

"version": "1.0.0",

"org": "supplier name",

"product": "cpe:/a:org:name:1.0.0",

"purl": "pkg:type/name@1.0.0",

"repo_url": "https://github.com/org/name",

"software_list_id": "{{sbom_id}}"

Was this article helpful?

What's Next

Get SBOM