# SwaggerClient::VulnerabilityCheckApi

All URIs are relative to *https://localhost:3780/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_vulnerability_check_types**](VulnerabilityCheckApi.md#get_vulnerability_check_types) | **GET** /api/3/vulnerability_checks_types | Check Types
[**get_vulnerability_checks**](VulnerabilityCheckApi.md#get_vulnerability_checks) | **GET** /api/3/vulnerability_checks | Checks
[**get_vulnerability_checks_for_vulnerability**](VulnerabilityCheckApi.md#get_vulnerability_checks_for_vulnerability) | **GET** /api/3/vulnerabilities/{id}/checks | Vulnerability Checks
[**vulnerability_check**](VulnerabilityCheckApi.md#vulnerability_check) | **GET** /api/3/vulnerability_checks/{id} | Check

# **get_vulnerability_check_types**
> ReferencesWithVulnerabilityCheckTypeIDLink get_vulnerability_check_types

Check Types

Returns the vulnerability check types. The type groups related vulnerability checks by their purpose, property, or related characteristic.

### Example
```ruby
# load the gem
require 'swagger_client'

api_instance = SwaggerClient::VulnerabilityCheckApi.new

begin
  #Check Types
  result = api_instance.get_vulnerability_check_types
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling VulnerabilityCheckApi->get_vulnerability_check_types: #{e}"
end
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ReferencesWithVulnerabilityCheckTypeIDLink**](ReferencesWithVulnerabilityCheckTypeIDLink.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=UTF-8



# **get_vulnerability_checks**
> PageOfVulnerabilityCheck get_vulnerability_checks(opts)

Checks

Returns vulnerability checks. Optional search and filtering parameters may be supplied to refine the results. Searching allows full text search of the vulnerability details a check is related to.

### Example
```ruby
# load the gem
require 'swagger_client'

api_instance = SwaggerClient::VulnerabilityCheckApi.new
opts = { 
  search: 'search_example', # String | Vulnerability search term to find vulnerability checks for. e.g. `\"ssh\"`.
  safe: true, # BOOLEAN | Whether to return vulnerability checks that are considered \"safe\" to run. Defaults to return safe and unsafe checks.
  potential: true, # BOOLEAN | Whether to only return checks that result in potentially vulnerable results. Defaults to return all checks.
  requires_credentials: true, # BOOLEAN | Whether to only return checks that require credentials in order to successfully execute. Defaults to return all checks.
  unique: true, # BOOLEAN | Whether to only return checks that guarantee to be executed once-and-only once on a host resulting in a unique result. False returns checks that can result in multiple occurrences of the same vulnerability on a host.
  type: 'type_example', # String | The type of vulnerability checks to return. See <a href=\"#operation/vulnerabilityCheckTypesUsingGET\">Check Types</a> for all available types.
  page: 0, # Integer | The index of the page (zero-based) to retrieve.
  size: 10, # Integer | The number of records per page to retrieve.
  sort: ['sort_example'] # Array<String> | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
}

begin
  #Checks
  result = api_instance.get_vulnerability_checks(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling VulnerabilityCheckApi->get_vulnerability_checks: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **search** | **String**| Vulnerability search term to find vulnerability checks for. e.g. &#x60;\&quot;ssh\&quot;&#x60;. | [optional] 
 **safe** | **BOOLEAN**| Whether to return vulnerability checks that are considered \&quot;safe\&quot; to run. Defaults to return safe and unsafe checks. | [optional] 
 **potential** | **BOOLEAN**| Whether to only return checks that result in potentially vulnerable results. Defaults to return all checks. | [optional] 
 **requires_credentials** | **BOOLEAN**| Whether to only return checks that require credentials in order to successfully execute. Defaults to return all checks. | [optional] 
 **unique** | **BOOLEAN**| Whether to only return checks that guarantee to be executed once-and-only once on a host resulting in a unique result. False returns checks that can result in multiple occurrences of the same vulnerability on a host. | [optional] 
 **type** | **String**| The type of vulnerability checks to return. See &lt;a href&#x3D;\&quot;#operation/vulnerabilityCheckTypesUsingGET\&quot;&gt;Check Types&lt;/a&gt; for all available types. | [optional] 
 **page** | **Integer**| The index of the page (zero-based) to retrieve. | [optional] [default to 0]
 **size** | **Integer**| The number of records per page to retrieve. | [optional] [default to 10]
 **sort** | [**Array&lt;String&gt;**](String.md)| The criteria to sort the records by, in the format: &#x60;property[,ASC|DESC]&#x60;. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. | [optional] 

### Return type

[**PageOfVulnerabilityCheck**](PageOfVulnerabilityCheck.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=UTF-8



# **get_vulnerability_checks_for_vulnerability**
> ReferencesWithVulnerabilityCheckIDLink get_vulnerability_checks_for_vulnerability(id)

Vulnerability Checks

Returns the vulnerability checks that assess for a specific vulnerability during a scan.

### Example
```ruby
# load the gem
require 'swagger_client'

api_instance = SwaggerClient::VulnerabilityCheckApi.new
id = 'id_example' # String | The identifier of the vulnerability.


begin
  #Vulnerability Checks
  result = api_instance.get_vulnerability_checks_for_vulnerability(id)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling VulnerabilityCheckApi->get_vulnerability_checks_for_vulnerability: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| The identifier of the vulnerability. | 

### Return type

[**ReferencesWithVulnerabilityCheckIDLink**](ReferencesWithVulnerabilityCheckIDLink.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=UTF-8



# **vulnerability_check**
> VulnerabilityCheck vulnerability_check(id)

Check

Returns the vulnerability check.

### Example
```ruby
# load the gem
require 'swagger_client'

api_instance = SwaggerClient::VulnerabilityCheckApi.new
id = 'id_example' # String | The identifier of the vulnerability check.


begin
  #Check
  result = api_instance.vulnerability_check(id)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling VulnerabilityCheckApi->vulnerability_check: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| The identifier of the vulnerability check. | 

### Return type

[**VulnerabilityCheck**](VulnerabilityCheck.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=UTF-8