Skip to content

VulnerabilitiesApi.md

Latest commit

 

History

History
268 lines (200 loc) · 9.42 KB

VulnerabilitiesApi.md

File metadata and controls

268 lines (200 loc) · 9.42 KB

cloudsmith_api.VulnerabilitiesApi

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

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}/{identifier}/ Get a scan result.
vulnerabilities_repo_list GET /vulnerabilities/{owner}/{repo}/ Lists scan results for a specific repository.

vulnerabilities_namespace_list

list[VulnerabilityScanResultsList] vulnerabilities_namespace_list(owner, page=page, page_size=page_size)

Lists scan results for a specific namespace.

Lists scan results for a specific namespace.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.VulnerabilitiesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)

try:
    # Lists scan results for a specific namespace.
    api_response = api_instance.vulnerabilities_namespace_list(owner, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilitiesApi->vulnerabilities_namespace_list: %s\n" % e)

Parameters

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

Return type

list[VulnerabilityScanResultsList]

Authorization

apikey, basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vulnerabilities_package_list

list[VulnerabilityScanResultsList] vulnerabilities_package_list(owner, repo, package, page=page, page_size=page_size)

Lists scan results for a specific package.

Lists scan results for a specific package.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.VulnerabilitiesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
package = 'package_example' # str | 
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)

try:
    # Lists scan results for a specific package.
    api_response = api_instance.vulnerabilities_package_list(owner, repo, package, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilitiesApi->vulnerabilities_package_list: %s\n" % e)

Parameters

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

Return type

list[VulnerabilityScanResultsList]

Authorization

apikey, basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vulnerabilities_read

VulnerabilityScanResults vulnerabilities_read(owner, repo, package, identifier)

Get a scan result.

Get a scan result.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.VulnerabilitiesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
package = 'package_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Get a scan result.
    api_response = api_instance.vulnerabilities_read(owner, repo, package, identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilitiesApi->vulnerabilities_read: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
package str
identifier str

Return type

VulnerabilityScanResults

Authorization

apikey, basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vulnerabilities_repo_list

list[VulnerabilityScanResultsList] vulnerabilities_repo_list(owner, repo, page=page, page_size=page_size)

Lists scan results for a specific repository.

Lists scan results for a specific repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.VulnerabilitiesApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)

try:
    # Lists scan results for a specific repository.
    api_response = api_instance.vulnerabilities_repo_list(owner, repo, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilitiesApi->vulnerabilities_repo_list: %s\n" % e)

Parameters

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

Return type

list[VulnerabilityScanResultsList]

Authorization

apikey, basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]