artifact-keeper-client 1.2.1

# \SecurityApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**acknowledge_finding**](SecurityApi.md#acknowledge_finding) | **POST** /api/v1/security/findings/{id}/acknowledge | 
[**create_policy**](SecurityApi.md#create_policy) | **POST** /api/v1/security/policies | 
[**delete_policy**](SecurityApi.md#delete_policy) | **DELETE** /api/v1/security/policies/{id} | 
[**dt_status**](SecurityApi.md#dt_status) | **GET** /api/v1/dependency-track/status | Get Dependency-Track integration status
[**get_all_scores**](SecurityApi.md#get_all_scores) | **GET** /api/v1/security/scores | 
[**get_dashboard**](SecurityApi.md#get_dashboard) | **GET** /api/v1/security/dashboard | 
[**get_policy**](SecurityApi.md#get_policy) | **GET** /api/v1/security/policies/{id} | 
[**get_portfolio_metrics**](SecurityApi.md#get_portfolio_metrics) | **GET** /api/v1/dependency-track/metrics/portfolio | Get portfolio-level metrics
[**get_project**](SecurityApi.md#get_project) | **GET** /api/v1/dependency-track/projects/{project_uuid} | Get project findings by project UUID
[**get_project_components**](SecurityApi.md#get_project_components) | **GET** /api/v1/dependency-track/projects/{project_uuid}/components | Get components for a project
[**get_project_findings**](SecurityApi.md#get_project_findings) | **GET** /api/v1/dependency-track/projects/{project_uuid}/findings | Get vulnerability findings for a project
[**get_project_metrics**](SecurityApi.md#get_project_metrics) | **GET** /api/v1/dependency-track/projects/{project_uuid}/metrics | Get metrics for a project
[**get_project_metrics_history**](SecurityApi.md#get_project_metrics_history) | **GET** /api/v1/dependency-track/projects/{project_uuid}/metrics/history | Get metrics history for a project
[**get_project_violations**](SecurityApi.md#get_project_violations) | **GET** /api/v1/dependency-track/projects/{project_uuid}/violations | Get policy violations for a project
[**get_repo_security**](SecurityApi.md#get_repo_security) | **GET** /api/v1/repositories/{key}/security | 
[**get_scan**](SecurityApi.md#get_scan) | **GET** /api/v1/security/scans/{id} | 
[**list_artifact_scans**](SecurityApi.md#list_artifact_scans) | **GET** /api/v1/security/artifacts/{artifact_id}/scans | 
[**list_dependency_track_policies**](SecurityApi.md#list_dependency_track_policies) | **GET** /api/v1/dependency-track/policies | List all policies
[**list_findings**](SecurityApi.md#list_findings) | **GET** /api/v1/security/scans/{id}/findings | 
[**list_policies**](SecurityApi.md#list_policies) | **GET** /api/v1/security/policies | 
[**list_projects**](SecurityApi.md#list_projects) | **GET** /api/v1/dependency-track/projects | List all Dependency-Track projects
[**list_repo_scans**](SecurityApi.md#list_repo_scans) | **GET** /api/v1/repositories/{key}/security/scans | 
[**list_scan_configs**](SecurityApi.md#list_scan_configs) | **GET** /api/v1/security/configs | 
[**list_scans**](SecurityApi.md#list_scans) | **GET** /api/v1/security/scans | 
[**revoke_acknowledgment**](SecurityApi.md#revoke_acknowledgment) | **DELETE** /api/v1/security/findings/{id}/acknowledge | 
[**trigger_scan**](SecurityApi.md#trigger_scan) | **POST** /api/v1/security/scan | 
[**update_analysis**](SecurityApi.md#update_analysis) | **PUT** /api/v1/dependency-track/analysis | Update analysis (triage) for a finding
[**update_policy**](SecurityApi.md#update_policy) | **PUT** /api/v1/security/policies/{id} | 
[**update_repo_security**](SecurityApi.md#update_repo_security) | **PUT** /api/v1/repositories/{key}/security | 



## acknowledge_finding

> models::FindingResponse acknowledge_finding(id, acknowledge_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Finding ID | [required] |
**acknowledge_request** | [**AcknowledgeRequest**](AcknowledgeRequest.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## create_policy

> models::PolicyResponse create_policy(create_policy_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_policy_request** | [**CreatePolicyRequest**](CreatePolicyRequest.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_policy

> serde_json::Value delete_policy(id)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Policy ID | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## dt_status

> models::DtStatusResponse dt_status()
Get Dependency-Track integration status

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_all_scores

> Vec<models::ScoreResponse> get_all_scores()


### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ScoreResponse>**](ScoreResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_dashboard

> models::DashboardResponse get_dashboard()


### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_policy

> models::PolicyResponse get_policy(id)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Policy ID | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_portfolio_metrics

> models::DtPortfolioMetrics get_portfolio_metrics()
Get portfolio-level metrics

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project

> Vec<models::DtFinding> get_project(project_uuid)
Get project findings by project UUID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |

### Return type

[**Vec<models::DtFinding>**](DtFinding.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project_components

> Vec<models::DtComponentFull> get_project_components(project_uuid)
Get components for a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |

### Return type

[**Vec<models::DtComponentFull>**](DtComponentFull.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project_findings

> Vec<models::DtFinding> get_project_findings(project_uuid)
Get vulnerability findings for a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |

### Return type

[**Vec<models::DtFinding>**](DtFinding.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project_metrics

> models::DtProjectMetrics get_project_metrics(project_uuid)
Get metrics for a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project_metrics_history

> Vec<models::DtProjectMetrics> get_project_metrics_history(project_uuid, days)
Get metrics history for a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |
**days** | Option<**i32**> |  |  |

### Return type

[**Vec<models::DtProjectMetrics>**](DtProjectMetrics.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_project_violations

> Vec<models::DtPolicyViolation> get_project_violations(project_uuid)
Get policy violations for a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_uuid** | **String** | Project UUID | [required] |

### Return type

[**Vec<models::DtPolicyViolation>**](DtPolicyViolation.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_repo_security

> models::RepoSecurityResponse get_repo_security(key)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_scan

> models::ScanResponse get_scan(id)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Scan result ID | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_artifact_scans

> models::ScanListResponse list_artifact_scans(artifact_id, status, page, per_page)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | **uuid::Uuid** | Artifact ID | [required] |
**status** | Option<**String**> | Filter by scan status |  |
**page** | Option<**i64**> | Page number (default: 1) |  |
**per_page** | Option<**i64**> | Items per page (default: 20, max: 100) |  |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_dependency_track_policies

> Vec<models::DtPolicyFull> list_dependency_track_policies()
List all policies

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::DtPolicyFull>**](DtPolicyFull.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_findings

> models::FindingListResponse list_findings(id, page, per_page)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Scan result ID | [required] |
**page** | Option<**i64**> |  |  |
**per_page** | Option<**i64**> |  |  |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_policies

> Vec<models::PolicyResponse> list_policies()


### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::PolicyResponse>**](PolicyResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_projects

> Vec<models::DtProject> list_projects()
List all Dependency-Track projects

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::DtProject>**](DtProject.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_repo_scans

> models::ScanListResponse list_repo_scans(key, repository_id, artifact_id, status, page, per_page)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |
**repository_id** | Option<**uuid::Uuid**> |  |  |
**artifact_id** | Option<**uuid::Uuid**> |  |  |
**status** | Option<**String**> |  |  |
**page** | Option<**i64**> |  |  |
**per_page** | Option<**i64**> |  |  |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_scan_configs

> Vec<models::ScanConfigResponse> list_scan_configs()


### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ScanConfigResponse>**](ScanConfigResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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_scans

> models::ScanListResponse list_scans(repository_id, artifact_id, status, page, per_page)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**repository_id** | Option<**uuid::Uuid**> |  |  |
**artifact_id** | Option<**uuid::Uuid**> |  |  |
**status** | Option<**String**> |  |  |
**page** | Option<**i64**> |  |  |
**per_page** | Option<**i64**> |  |  |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## revoke_acknowledgment

> models::FindingResponse revoke_acknowledgment(id)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Finding ID | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## trigger_scan

> models::TriggerScanResponse trigger_scan(trigger_scan_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trigger_scan_request** | [**TriggerScanRequest**](TriggerScanRequest.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## update_analysis

> models::DtAnalysisResponse update_analysis(update_analysis_body)
Update analysis (triage) for a finding

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_analysis_body** | [**UpdateAnalysisBody**](UpdateAnalysisBody.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## update_policy

> models::PolicyResponse update_policy(id, update_policy_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Policy ID | [required] |
**update_policy_request** | [**UpdatePolicyRequest**](UpdatePolicyRequest.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## update_repo_security

> models::ScanConfigResponse update_repo_security(key, upsert_scan_config_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** | Repository key | [required] |
**upsert_scan_config_request** | [**UpsertScanConfigRequest**](UpsertScanConfigRequest.md) |  | [required] |

### Return type

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

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)