# \SecurityApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**acknowledge_finding**](SecurityApi.md#acknowledge_finding) | **POST** /api/v1/security/findings/{id}/acknowledge | Acknowledge finding
[**create_security_policy**](SecurityApi.md#create_security_policy) | **POST** /api/v1/security/policies | Create security policy
[**delete_security_policy**](SecurityApi.md#delete_security_policy) | **DELETE** /api/v1/security/policies/{id} | Delete security policy
[**get_scan**](SecurityApi.md#get_scan) | **GET** /api/v1/security/scans/{id} | Get scan details
[**get_security_dashboard**](SecurityApi.md#get_security_dashboard) | **GET** /api/v1/security/dashboard | Get security dashboard
[**get_security_policy**](SecurityApi.md#get_security_policy) | **GET** /api/v1/security/policies/{id} | Get security policy
[**get_security_score**](SecurityApi.md#get_security_score) | **GET** /api/v1/security/scores/{repository_key} | Get repository security score
[**get_security_summary**](SecurityApi.md#get_security_summary) | **GET** /api/v1/security/summary | Security summary
[**list_artifact_scans**](SecurityApi.md#list_artifact_scans) | **GET** /api/v1/security/artifacts/{artifact_id}/scans | List scans for an artifact
[**list_scan_findings**](SecurityApi.md#list_scan_findings) | **GET** /api/v1/security/scans/{id}/findings | List scan findings
[**list_scans**](SecurityApi.md#list_scans) | **GET** /api/v1/security/scans | List security scans
[**list_security_policies**](SecurityApi.md#list_security_policies) | **GET** /api/v1/security/policies | List security policies
[**list_security_scores**](SecurityApi.md#list_security_scores) | **GET** /api/v1/security/scores | List security scores
[**trigger_scan**](SecurityApi.md#trigger_scan) | **POST** /api/v1/security/scans | Trigger security scan
[**trigger_security_scan**](SecurityApi.md#trigger_security_scan) | **POST** /api/v1/security/scan | Trigger a security scan
[**unacknowledge_finding**](SecurityApi.md#unacknowledge_finding) | **DELETE** /api/v1/security/findings/{id}/acknowledge | Remove finding acknowledgement
[**update_security_policy**](SecurityApi.md#update_security_policy) | **PUT** /api/v1/security/policies/{id} | Update a security policy



## acknowledge_finding

> models::Finding acknowledge_finding(id, acknowledge_finding_request)
Acknowledge finding

Marks a vulnerability finding as acknowledged with an explanatory reason.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Finding UUID | [required] |
**acknowledge_finding_request** | [**AcknowledgeFindingRequest**](AcknowledgeFindingRequest.md) |  | [required] |

### Return type

[**models::Finding**](Finding.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)


## create_security_policy

> models::SecurityPolicy create_security_policy(create_security_policy_request)
Create security policy

Creates a new security policy with rules for vulnerability handling.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_security_policy_request** | [**CreateSecurityPolicyRequest**](CreateSecurityPolicyRequest.md) |  | [required] |

### Return type

[**models::SecurityPolicy**](SecurityPolicy.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_security_policy

> delete_security_policy(id)
Delete security policy

Permanently deletes a security policy.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Security policy UUID | [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)


## get_scan

> models::Scan get_scan(id)
Get scan details

Returns detailed information about a single security scan.

### Parameters


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

### Return type

[**models::Scan**](Scan.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_security_dashboard

> models::GetSecurityDashboard200Response get_security_dashboard()
Get security dashboard

Returns an overview of security scan statistics and overall health score.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetSecurityDashboard200Response**](getSecurityDashboard_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_security_policy

> models::SecurityPolicy get_security_policy(id)
Get security policy

Returns a single security policy by its unique identifier.

### Parameters


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

### Return type

[**models::SecurityPolicy**](SecurityPolicy.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_security_score

> models::SecurityScore get_security_score(repository_key)
Get repository security score

Returns the security score and vulnerability counts for a specific repository.

### Parameters


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

### Return type

[**models::SecurityScore**](SecurityScore.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_security_summary

> models::GetSecuritySummary200Response get_security_summary()
Security summary

Returns an aggregate security summary with total vulnerability counts across all repositories.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetSecuritySummary200Response**](getSecuritySummary_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_artifact_scans

> Vec<models::Scan> list_artifact_scans(artifact_id)
List scans for an artifact

Returns all security scans that have been performed on a specific artifact.

### Parameters


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

### Return type

[**Vec<models::Scan>**](Scan.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_scan_findings

> models::ListScanFindings200Response list_scan_findings(id, severity, page, per_page)
List scan findings

Returns a paginated list of vulnerability findings for a specific scan with optional severity filtering.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Scan UUID | [required] |
**severity** | Option<**String**> | Filter by vulnerability severity. |  |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**per_page** | Option<**i32**> | Number of items per page |  |[default to 20]

### Return type

[**models::ListScanFindings200Response**](listScanFindings_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_scans

> models::ListScans200Response list_scans(status, repository_id, page, per_page)
List security scans

Returns a paginated list of security scans with optional filtering by status and repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**status** | Option<**String**> | Filter by scan status. |  |
**repository_id** | Option<**uuid::Uuid**> | Filter by repository UUID. |  |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**per_page** | Option<**i32**> | Number of items per page |  |[default to 20]

### Return type

[**models::ListScans200Response**](listScans_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_security_policies

> Vec<models::SecurityPolicy> list_security_policies()
List security policies

Returns all configured security policies.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::SecurityPolicy>**](SecurityPolicy.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_security_scores

> Vec<models::SecurityScore> list_security_scores()
List security scores

Returns security scores for all repositories.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::SecurityScore>**](SecurityScore.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)


## trigger_scan

> models::Scan trigger_scan(trigger_scan_request)
Trigger security scan

Triggers a new security scan for the specified artifact or repository.

### Parameters


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

### Return type

[**models::Scan**](Scan.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)


## trigger_security_scan

> models::TriggerSecurityScan202Response trigger_security_scan(trigger_security_scan_request)
Trigger a security scan

Initiates an asynchronous security scan for a specific artifact, repository, or using a named scanner.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trigger_security_scan_request** | [**TriggerSecurityScanRequest**](TriggerSecurityScanRequest.md) |  | [required] |

### Return type

[**models::TriggerSecurityScan202Response**](triggerSecurityScan_202_response.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)


## unacknowledge_finding

> models::Finding unacknowledge_finding(id)
Remove finding acknowledgement

Removes the acknowledgement from a previously acknowledged finding.

### Parameters


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

### Return type

[**models::Finding**](Finding.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_security_policy

> models::SecurityPolicy update_security_policy(id, security_policy)
Update a security policy

Replaces a security policy with the provided definition.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Security policy UUID | [required] |
**security_policy** | [**SecurityPolicy**](SecurityPolicy.md) |  | [required] |

### Return type

[**models::SecurityPolicy**](SecurityPolicy.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)

