CloudsmithApi::VulnerabilitiesApi

All URIs are relative to https://api.cloudsmith.io/v1

Method	HTTP request	Description
vulnerabilities_namespace_list	GET /vulnerabilities/owner/	Lists scan results for a specific namespace.
vulnerabilities_package_list	GET /vulnerabilities/owner/repo/package/	Lists scan results for a specific package.
vulnerabilities_read	GET /vulnerabilities/owner/repo/package/scan_id/	Returns a Scan Result.
vulnerabilities_repo_list	GET /vulnerabilities/owner/repo/	Lists scan results for a specific repository.

vulnerabilities_namespace_list

Array<VulnerabilityScanResultsList> vulnerabilities_namespace_list(owner, opts)

Lists scan results for a specific namespace.

Example

# load the gem
require 'cloudsmith-api'
# setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
end

api_instance = CloudsmithApi::VulnerabilitiesApi.new

owner = 'owner_example' # String | 

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #Lists scan results for a specific namespace.
  result = api_instance.vulnerabilities_namespace_list(owner, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_namespace_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

Array<VulnerabilityScanResultsList>

Authorization

apikey

HTTP request headers

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

vulnerabilities_package_list

Array<VulnerabilityScanResultsList> vulnerabilities_package_list(owner, repo, package, opts)

Lists scan results for a specific package.

Example

# load the gem
require 'cloudsmith-api'
# setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
end

api_instance = CloudsmithApi::VulnerabilitiesApi.new

owner = 'owner_example' # String | 

repo = 'repo_example' # String | 

package = 'package_example' # String | 

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #Lists scan results for a specific package.
  result = api_instance.vulnerabilities_package_list(owner, repo, package, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_package_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
repo	String
package	String
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

Array<VulnerabilityScanResultsList>

Authorization

apikey

HTTP request headers

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

vulnerabilities_read

VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)

Returns a Scan Result.

Example

# load the gem
require 'cloudsmith-api'
# setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
end

api_instance = CloudsmithApi::VulnerabilitiesApi.new

owner = 'owner_example' # String | 

repo = 'repo_example' # String | 

package = 'package_example' # String | 

scan_id = 'scan_id_example' # String | 


begin
  #Returns a Scan Result.
  result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
repo	String
package	String
scan_id	String

Return type

VulnerabilityScanResults

Authorization

apikey

HTTP request headers

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

vulnerabilities_repo_list

Array<VulnerabilityScanResultsList> vulnerabilities_repo_list(owner, repo, opts)

Lists scan results for a specific repository.

Example

# load the gem
require 'cloudsmith-api'
# setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
end

api_instance = CloudsmithApi::VulnerabilitiesApi.new

owner = 'owner_example' # String | 

repo = 'repo_example' # String | 

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #Lists scan results for a specific repository.
  result = api_instance.vulnerabilities_repo_list(owner, repo, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_repo_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
repo	String
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

Array<VulnerabilityScanResultsList>

Authorization

apikey

HTTP request headers

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