Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VulnerabilityScanningClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • VulnerabilityScanningClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new VulnerabilityScanningClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): VulnerabilityScanningClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "VulnerabilityScanning"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://vss-cp-api.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeContainerScanRecipeCompartment

changeContainerScanResultCompartment

changeContainerScanTargetCompartment

changeHostAgentScanResultCompartment

changeHostCisBenchmarkScanResultCompartment

changeHostEndpointProtectionScanResultCompartment

changeHostPortScanResultCompartment

changeHostScanRecipeCompartment

changeHostScanTargetCompartment

close

  • close(): void

createContainerScanRecipe

createContainerScanTarget

  • Creates a new ContainerScanTarget. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateContainerScanTarget API.

    Parameters

    Returns Promise<CreateContainerScanTargetResponse>

    CreateContainerScanTargetResponse

createHostScanRecipe

createHostScanTarget

  • Creates a new HostScanTarget. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateHostScanTarget API.

    Parameters

    Returns Promise<CreateHostScanTargetResponse>

    CreateHostScanTargetResponse

createWaiters

deleteContainerScanRecipe

deleteContainerScanResult

deleteContainerScanTarget

deleteHostAgentScanResult

deleteHostCisBenchmarkScanResult

deleteHostEndpointProtectionScanResult

deleteHostPortScanResult

deleteHostScanRecipe

deleteHostScanTarget

exportHostAgentScanResultCsv

exportHostVulnerabilityCsv

getContainerScanRecipe

getContainerScanResult

  • Retrieves a ContainerScanResult identified by the container scan ID. The result includes a list of problems found in a specific image in a Docker repository.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetContainerScanResult API.

    Parameters

    Returns Promise<GetContainerScanResultResponse>

    GetContainerScanResultResponse

getContainerScanTarget

  • Gets a ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetContainerScanTarget API.

    Parameters

    Returns Promise<GetContainerScanTargetResponse>

    GetContainerScanTargetResponse

getHostAgentScanResult

  • Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a list of CVEs detected in a specific compute instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostAgentScanResult API.

    Parameters

    Returns Promise<GetHostAgentScanResultResponse>

    GetHostAgentScanResultResponse

getHostCisBenchmarkScanResult

  • Retrieves a HostCisBenchmarkScanResult identified by the benchmark scan result ID. A CIS (Center for Internet Security) benchmark scan result includes a list of benchmarks that were tested on a specific compute instance, and whether each test passed or failed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostCisBenchmarkScanResult API.

    Parameters

    Returns Promise<GetHostCisBenchmarkScanResultResponse>

    GetHostCisBenchmarkScanResultResponse

getHostEndpointProtectionScanResult

getHostPortScanResult

  • Retrieves a HostPortScanResult identified by the host port scan ID. The result includes a list of open ports that were detected in a specific compute instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostPortScanResult API.

    Parameters

    Returns Promise<GetHostPortScanResultResponse>

    GetHostPortScanResultResponse

getHostScanRecipe

  • Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostScanRecipe API.

    Parameters

    Returns Promise<GetHostScanRecipeResponse>

    GetHostScanRecipeResponse

getHostScanTarget

  • Retrieves a HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostScanTarget API.

    Parameters

    Returns Promise<GetHostScanTargetResponse>

    GetHostScanTargetResponse

getHostVulnerability

  • Retrieves a HostVulnerability identified by the host vulnerability ID. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostVulnerability API.

    Parameters

    Returns Promise<GetHostVulnerabilityResponse>

    GetHostVulnerabilityResponse

getVulnerability

  • Retrieves a Vulnerability identified by the vulnerability ID. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container scan repositories. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVulnerability API.

    Parameters

    Returns Promise<GetVulnerabilityResponse>

    GetVulnerabilityResponse

getWaiters

getWorkRequest

listContainerScanRecipes

listContainerScanResults

  • Retrieves a list of ContainerScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A container scan result includes a list of problems detected in a specific image in a Docker repository.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListContainerScanResults API.

    Parameters

    Returns Promise<ListContainerScanResultsResponse>

    ListContainerScanResultsResponse

listContainerScanTargets

  • Retrieves a list of ContainerScanTargetSummary objects in a compartment. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListContainerScanTargets API.

    Parameters

    Returns Promise<ListContainerScanTargetsResponse>

    ListContainerScanTargetsResponse

listHostAgentScanResults

  • Retrieves a list of HostAgentScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. An agent scan result includes a list of CVEs detected in a specific compute instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostAgentScanResults API.

    Parameters

    Returns Promise<ListHostAgentScanResultsResponse>

    ListHostAgentScanResultsResponse

listHostCisBenchmarkScanResults

  • Retrieves a list of HostCisBenchmarkScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A CIS (Center for Internet Security) benchmark scan result includes the number of failed benchmark tests on a specific compute instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostCisBenchmarkScanResults API.

    Parameters

    Returns Promise<ListHostCisBenchmarkScanResultsResponse>

    ListHostCisBenchmarkScanResultsResponse

listHostEndpointProtectionScanResults

listHostPortScanResults

  • Retrieves a list of HostPortScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A port scan result includes a list of open ports that were detected in a specific compute instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostPortScanResults API.

    Parameters

    Returns Promise<ListHostPortScanResultsResponse>

    ListHostPortScanResultsResponse

listHostScanRecipes

  • Retrieves a list of HostScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned, and how often to scan.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostScanRecipes API.

    Parameters

    Returns Promise<ListHostScanRecipesResponse>

    ListHostScanRecipesResponse

listHostScanTargetErrors

  • Retrieves list of errors during scanning on instances associated with HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostScanTargetErrors API.

    Parameters

    Returns Promise<ListHostScanTargetErrorsResponse>

    ListHostScanTargetErrorsResponse

listHostScanTargets

  • Retrieves a list of HostScanTargetSummary objects in a compartment. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostScanTargets API.

    Parameters

    Returns Promise<ListHostScanTargetsResponse>

    ListHostScanTargetsResponse

listHostVulnerabilities

  • Retrieves a list of HostVulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time. A host vulnerability describes a security issue that was detected in scans of one or more compute instances.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostVulnerabilities API.

    Parameters

    Returns Promise<ListHostVulnerabilitiesResponse>

    ListHostVulnerabilitiesResponse

listHostVulnerabilityImpactedHosts

  • Retrieves a list of HostVulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostVulnerabilityImpactedHosts API.

    Parameters

    Returns Promise<ListHostVulnerabilityImpactedHostsResponse>

    ListHostVulnerabilityImpactedHostsResponse

listVulnerabilities

  • Retrieves a list of VulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time and type. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container images.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVulnerabilities API.

    Parameters

    Returns Promise<ListVulnerabilitiesResponse>

    ListVulnerabilitiesResponse

listVulnerabilityImpactedContainers

  • Retrieves a list of VulnerabilityImpactedContainerSummary objects for a specific vulnerability ID. An impacted container image summary identifies container images on which the specified vulnerability was detected.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVulnerabilityImpactedContainers API.

    Parameters

    Returns Promise<ListVulnerabilityImpactedContainersResponse>

    ListVulnerabilityImpactedContainersResponse

listVulnerabilityImpactedHosts

  • Retrieves a list of VulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVulnerabilityImpactedHosts API.

    Parameters

    Returns Promise<ListVulnerabilityImpactedHostsResponse>

    ListVulnerabilityImpactedHostsResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateContainerScanRecipe

updateContainerScanTarget

  • Updates the ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateContainerScanTarget API.

    Parameters

    Returns Promise<UpdateContainerScanTargetResponse>

    UpdateContainerScanTargetResponse

updateHostScanRecipe

  • Updates the HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateHostScanRecipe API.

    Parameters

    Returns Promise<UpdateHostScanRecipeResponse>

    UpdateHostScanRecipeResponse

updateHostScanTarget

  • Updates the HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateHostScanTarget API.

    Parameters

    Returns Promise<UpdateHostScanTargetResponse>

    UpdateHostScanTargetResponse