# \SbomApi

All URIs are relative to *https://registry.example.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_license_compliance**](SbomApi.md#check_license_compliance) | **POST** /api/v1/sbom/check-compliance | Check license compliance
[**convert_sbom**](SbomApi.md#convert_sbom) | **POST** /api/v1/sbom/{sbom_id}/convert | Convert SBOM format
[**delete_license_policy**](SbomApi.md#delete_license_policy) | **DELETE** /api/v1/license-policies/{id} | Delete license policy
[**generate_sbom**](SbomApi.md#generate_sbom) | **POST** /api/v1/sbom | Generate SBOM for artifact
[**get_cve_history**](SbomApi.md#get_cve_history) | **GET** /api/v1/sbom/cve/history/{artifact_id} | Get CVE history for artifact
[**get_cve_trends**](SbomApi.md#get_cve_trends) | **GET** /api/v1/sbom/cve/trends | Get CVE trends
[**get_license_policy**](SbomApi.md#get_license_policy) | **GET** /api/v1/license-policies/{id} | Get license policy
[**get_sbom**](SbomApi.md#get_sbom) | **GET** /api/v1/sbom/{sbom_id} | Get SBOM with content
[**get_sbom_components**](SbomApi.md#get_sbom_components) | **GET** /api/v1/sbom/{sbom_id}/components | List SBOM components
[**list_license_policies**](SbomApi.md#list_license_policies) | **GET** /api/v1/license-policies | List license policies
[**list_sboms**](SbomApi.md#list_sboms) | **GET** /api/v1/sbom | List SBOMs
[**update_cve_status**](SbomApi.md#update_cve_status) | **POST** /api/v1/sbom/cve/status/{id} | Update CVE status
[**upsert_license_policy**](SbomApi.md#upsert_license_policy) | **POST** /api/v1/license-policies | Create or update license policy



## check_license_compliance

> models::LicenseCheckResult check_license_compliance(check_license_compliance_request)
Check license compliance

Evaluates a set of SPDX license identifiers against all active license policies (or those scoped to a specific repository) and returns the compliance result.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**check_license_compliance_request** | [**CheckLicenseComplianceRequest**](CheckLicenseComplianceRequest.md) |  | [required] |

### Return type

[**models::LicenseCheckResult**](LicenseCheckResult.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## convert_sbom

> models::SbomResponse convert_sbom(sbom_id, convert_sbom_request)
Convert SBOM format

Converts an existing SBOM to a different format (e.g. CycloneDX to SPDX or vice versa) and stores the result as a new SBOM record.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sbom_id** | **uuid::Uuid** | SBOM identifier | [required] |
**convert_sbom_request** | [**ConvertSbomRequest**](ConvertSbomRequest.md) |  | [required] |

### Return type

[**models::SbomResponse**](SbomResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_license_policy

> delete_license_policy(id)
Delete license policy

Permanently removes a license compliance policy. This action cannot be undone.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | License policy identifier | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## generate_sbom

> models::SbomResponse generate_sbom(generate_sbom_request)
Generate SBOM for artifact

Generates a Software Bill of Materials for the specified artifact in the requested format. If an SBOM already exists, returns the cached version unless force_regenerate is set.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**generate_sbom_request** | [**GenerateSbomRequest**](GenerateSbomRequest.md) |  | [required] |

### Return type

[**models::SbomResponse**](SbomResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_cve_history

> models::GetCveHistory200Response get_cve_history(artifact_id)
Get CVE history for artifact

Returns the chronological list of CVEs detected across all SBOM scans for the given artifact, including current status and acknowledgement details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | **uuid::Uuid** | Artifact identifier | [required] |

### Return type

[**models::GetCveHistory200Response**](getCveHistory_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_cve_trends

> models::GetCveTrends200Response get_cve_trends(repository_id, days)
Get CVE trends

Returns aggregated CVE trend data over a configurable time window, broken down by severity. Useful for dashboards and reporting.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**repository_id** | Option<**uuid::Uuid**> | Limit trends to a specific repository. |  |
**days** | Option<**i32**> | Number of days to look back for trend data. |  |[default to 30]

### Return type

[**models::GetCveTrends200Response**](getCveTrends_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_license_policy

> models::LicensePolicyResponse get_license_policy(id)
Get license policy

Returns full details of a single license compliance policy.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | License policy identifier | [required] |

### Return type

[**models::LicensePolicyResponse**](LicensePolicyResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_sbom

> models::SbomContentResponse get_sbom(sbom_id)
Get SBOM with content

Returns full SBOM details including the raw SBOM document content as a JSON object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sbom_id** | **uuid::Uuid** | SBOM identifier | [required] |

### Return type

[**models::SbomContentResponse**](SbomContentResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_sbom_components

> models::GetSbomComponents200Response get_sbom_components(sbom_id)
List SBOM components

Returns the list of software components declared in the specified SBOM, including package URLs, licenses, and checksums.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sbom_id** | **uuid::Uuid** | SBOM identifier | [required] |

### Return type

[**models::GetSbomComponents200Response**](getSbomComponents_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_license_policies

> models::ListLicensePolicies200Response list_license_policies()
List license policies

Returns all configured license compliance policies, optionally filtered by repository.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListLicensePolicies200Response**](listLicensePolicies_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_sboms

> models::ListSboms200Response list_sboms(artifact_id, repository_id, format)
List SBOMs

Returns a list of generated SBOMs with optional filtering by artifact, repository, or format.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | Option<**uuid::Uuid**> | Filter by artifact ID. |  |
**repository_id** | Option<**uuid::Uuid**> | Filter by repository ID. |  |
**format** | Option<**String**> | Filter by SBOM format (e.g. cyclonedx, spdx). |  |

### Return type

[**models::ListSboms200Response**](listSboms_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_cve_status

> models::CveHistoryEntry update_cve_status(id, update_cve_status_request)
Update CVE status

Updates the triage status of a CVE history entry, optionally recording a reason for the status change.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | CVE history entry identifier | [required] |
**update_cve_status_request** | [**UpdateCveStatusRequest**](UpdateCveStatusRequest.md) |  | [required] |

### Return type

[**models::CveHistoryEntry**](CveHistoryEntry.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## upsert_license_policy

> models::LicensePolicyResponse upsert_license_policy(upsert_license_policy_request)
Create or update license policy

Creates a new license compliance policy or updates an existing one. Policies define which licenses are allowed or denied for artifacts in a repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**upsert_license_policy_request** | [**UpsertLicensePolicyRequest**](UpsertLicensePolicyRequest.md) |  | [required] |

### Return type

[**models::LicensePolicyResponse**](LicensePolicyResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

