Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudGuardClient

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

  • CloudGuardClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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 = "CloudGuard"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://cloudguard-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

addCompartment

  • Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone's policies.

    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 AddCompartment API.

    Parameters

    Returns Promise<AddCompartmentResponse>

    AddCompartmentResponse

cancelWorkRequest

changeDataSourceCompartment

  • Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.

    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 ChangeDataSourceCompartment API.

    Parameters

    Returns Promise<ChangeDataSourceCompartmentResponse>

    ChangeDataSourceCompartmentResponse

changeDetectorRecipeCompartment

  • Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource.

    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 ChangeDetectorRecipeCompartment API.

    Parameters

    Returns Promise<ChangeDetectorRecipeCompartmentResponse>

    ChangeDetectorRecipeCompartmentResponse

changeManagedListCompartment

  • Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment. 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 ChangeManagedListCompartment API.

    Parameters

    Returns Promise<ChangeManagedListCompartmentResponse>

    ChangeManagedListCompartmentResponse

changeResponderRecipeCompartment

  • Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource.

    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 ChangeResponderRecipeCompartment API.

    Parameters

    Returns Promise<ChangeResponderRecipeCompartmentResponse>

    ChangeResponderRecipeCompartmentResponse

changeSavedQueryCompartment

  • Moves the SavedQuery resource into a different compartment. When provided, If-Match is checked against etag values of the resource. 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 ChangeSavedQueryCompartment API.

    Parameters

    Returns Promise<ChangeSavedQueryCompartmentResponse>

    ChangeSavedQueryCompartmentResponse

changeSecurityRecipeCompartment

  • Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource.

    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 ChangeSecurityRecipeCompartment API.

    Parameters

    Returns Promise<ChangeSecurityRecipeCompartmentResponse>

    ChangeSecurityRecipeCompartmentResponse

changeSecurityZoneCompartment

  • Moves a security zone, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, if-match is checked against etag values of the resource.

    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 ChangeSecurityZoneCompartment API.

    Parameters

    Returns Promise<ChangeSecurityZoneCompartmentResponse>

    ChangeSecurityZoneCompartmentResponse

close

  • close(): void

createAdhocQuery

createDataMaskRule

createDataSource

  • Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.

    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 CreateDataSource API.

    Parameters

    Returns Promise<CreateDataSourceResponse>

    CreateDataSourceResponse

createDetectorRecipe

createDetectorRecipeDetectorRule

createManagedList

createResponderRecipe

  • Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.

    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 CreateResponderRecipe API.

    Parameters

    Returns Promise<CreateResponderRecipeResponse>

    CreateResponderRecipeResponse

createSavedQuery

createSecurityRecipe

  • Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.

    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 CreateSecurityRecipe API.

    Parameters

    Returns Promise<CreateSecurityRecipeResponse>

    CreateSecurityRecipeResponse

createSecurityZone

  • Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.

    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 CreateSecurityZone API.

    Parameters

    Returns Promise<CreateSecurityZoneResponse>

    CreateSecurityZoneResponse

createTarget

  • Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.

    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 CreateTarget API.

    Parameters

    Returns Promise<CreateTargetResponse>

    CreateTargetResponse

createTargetDetectorRecipe

  • Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target

    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 CreateTargetDetectorRecipe API.

    Parameters

    Returns Promise<CreateTargetDetectorRecipeResponse>

    CreateTargetDetectorRecipeResponse

createTargetResponderRecipe

createWaiters

  • Creates a new CloudGuardWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns CloudGuardWaiter

    The service waiters.

createWlpAgent

  • Creates and registers a WLP agent for an on-premise resource.

    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 CreateWlpAgent API.

    Parameters

    Returns Promise<CreateWlpAgentResponse>

    CreateWlpAgentResponse

deleteAdhocQuery

deleteDataMaskRule

deleteDataSource

  • Deletes a data source (DataSource resource) identified by dataSourceId. 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 DeleteDataSource API.

    Parameters

    Returns Promise<DeleteDataSourceResponse>

    DeleteDataSourceResponse

deleteDetectorRecipe

deleteDetectorRecipeDetectorRule

deleteDetectorRecipeDetectorRuleDataSource

deleteManagedList

deleteResponderRecipe

deleteSavedQuery

deleteSecurityRecipe

  • Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone. 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 DeleteSecurityRecipe API.

    Parameters

    Returns Promise<DeleteSecurityRecipeResponse>

    DeleteSecurityRecipeResponse

deleteSecurityZone

deleteTarget

  • Deletes a target (Target resource) identified by targetId. 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 DeleteTarget API.

    Parameters

    Returns Promise<DeleteTargetResponse>

    DeleteTargetResponse

deleteTargetDetectorRecipe

  • Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.

    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 DeleteTargetDetectorRecipe API.

    Parameters

    Returns Promise<DeleteTargetDetectorRecipeResponse>

    DeleteTargetDetectorRecipeResponse

deleteTargetResponderRecipe

  • Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.

    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 DeleteTargetResponderRecipe API.

    Parameters

    Returns Promise<DeleteTargetResponderRecipeResponse>

    DeleteTargetResponderRecipeResponse

deleteWlpAgent

  • Deletes and unregisters the WLP agent for an on-premise resource. x-obmcs-splat: routing: strategy: route-to-any-ad serviceList: [ 'cloudguard-cp-SPLAT_ENV' ] resources: wlpAgent: serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404('cloudguard-cp-SPLAT_ENV', 'GetWlpAgent', request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ "WLP_AGENT_DELETE" ] authorization: mode: automated check: resources['wlpAgent'].grantedPermissions.contains('WLP_AGENT_DELETE') allowCrossTenancy: true tagStore: mode: automated maximumAttemptCount: 3 throttling: perUserLimit: rpsLimit: 15 perTenantLimit: rpsLimit: 30 quotas: mode: automated search: mode: backfilling operationResourceName: wlpAgent lock: mode: test operationResourceName: wlpAgent

    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 DeleteWlpAgent API.

    Parameters

    Returns Promise<DeleteWlpAgentResponse>

    DeleteWlpAgentResponse

executeResponderExecution

getAdhocQuery

getAdhocQueryResultContent

getConditionMetadataType

getConfiguration

  • Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.

    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 GetConfiguration API.

    Parameters

    Returns Promise<GetConfigurationResponse>

    GetConfigurationResponse

getDataMaskRule

getDataSource

  • Returns a data source (DataSource resource) identified by dataSourceId. 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 GetDataSource API.

    Parameters

    Returns Promise<GetDataSourceResponse>

    GetDataSourceResponse

getDetector

  • Returns a Detector resource, identified by detectorId.

    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 GetDetector API.

    Parameters

    Returns Promise<GetDetectorResponse>

    GetDetectorResponse

getDetectorRecipe

  • Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId. 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 GetDetectorRecipe API.

    Parameters

    Returns Promise<GetDetectorRecipeResponse>

    GetDetectorRecipeResponse

getDetectorRecipeDetectorRule

getDetectorRule

  • Returns a detector rule (DetectorRule resource) identified by detectorRuleId.

    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 GetDetectorRule API.

    Parameters

    Returns Promise<GetDetectorRuleResponse>

    GetDetectorRuleResponse

getManagedList

getProblem

  • Returns the Problem resource identified by problemId. 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 GetProblem API.

    Parameters

    Returns Promise<GetProblemResponse>

    GetProblemResponse

getResource

  • Returns a resource identified by resourceId 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 GetResource API.

    Parameters

    Returns Promise<GetResourceResponse>

    GetResourceResponse

getResourceProfile

getResourceVulnerability

getResponderExecution

getResponderRecipe

  • Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId. 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 GetResponderRecipe API.

    Parameters

    Returns Promise<GetResponderRecipeResponse>

    GetResponderRecipeResponse

getResponderRecipeResponderRule

getResponderRule

  • Returns a responder rule (ResponderRule resource) identified by resonderRuleId. 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 GetResponderRule API.

    Parameters

    Returns Promise<GetResponderRuleResponse>

    GetResponderRuleResponse

getSavedQuery

  • Returns a SavedQuery resource identified by savedQueryId. 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 GetSavedQuery API.

    Parameters

    Returns Promise<GetSavedQueryResponse>

    GetSavedQueryResponse

getSecurityPolicy

  • Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.

    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 GetSecurityPolicy API.

    Parameters

    Returns Promise<GetSecurityPolicyResponse>

    GetSecurityPolicyResponse

getSecurityRecipe

  • Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId. 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 GetSecurityRecipe API.

    Parameters

    Returns Promise<GetSecurityRecipeResponse>

    GetSecurityRecipeResponse

getSecurityZone

  • Returns a security zone (SecurityZone resource) identified by securityZoneId. 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 GetSecurityZone API.

    Parameters

    Returns Promise<GetSecurityZoneResponse>

    GetSecurityZoneResponse

getSighting

  • Returns a single sighting (Sighting resource) identified by sightingId. 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 GetSighting API.

    Parameters

    Returns Promise<GetSightingResponse>

    GetSightingResponse

getTarget

  • Returns a target (Target resource) identified by targetId. 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 GetTarget API.

    Parameters

    Returns Promise<GetTargetResponse>

    GetTargetResponse

getTargetDetectorRecipe

getTargetDetectorRecipeDetectorRule

getTargetResponderRecipe

  • Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.

    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 GetTargetResponderRecipe API.

    Parameters

    Returns Promise<GetTargetResponderRecipeResponse>

    GetTargetResponderRecipeResponse

getTargetResponderRecipeResponderRule

  • Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.

    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 GetTargetResponderRecipeResponderRule API.

    Parameters

    Returns Promise<GetTargetResponderRecipeResponderRuleResponse>

    GetTargetResponderRecipeResponderRuleResponse

getWaiters

getWlpAgent

  • Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId. 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 GetWlpAgent API.

    Parameters

    Returns Promise<GetWlpAgentResponse>

    GetWlpAgentResponse

getWorkRequest

  • Returns details for a work request (WorkRequest resource) identified by workRequestId. 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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAdhocQueries

  • Returns a list of all adhoc queries (AdhocQuery resources) for a compartment identified by compartmentId. List is returned in a AdhocQueryCollection resource with page of AdhocQuerySummary resources.

    The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListAdhocQueries API.

    Parameters

    Returns Promise<ListAdhocQueriesResponse>

    ListAdhocQueriesResponse

listAdhocQueryResults

listConditionMetadataTypes

listDataMaskRules

  • Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.

    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 ListDataMaskRules API.

    Parameters

    Returns Promise<ListDataMaskRulesResponse>

    ListDataMaskRulesResponse

listDataSourceEvents

  • Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.

    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 ListDataSourceEvents API.

    Parameters

    Returns Promise<ListDataSourceEventsResponse>

    ListDataSourceEventsResponse

listDataSources

  • Returns a list of all data sources (DataSource resources) for a compartment identified by compartmentId. List is returned in a DataSourceCollection resource with page of DataSourceSummary resources.

    The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListAdhocQueries on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListDataSources API.

    Parameters

    Returns Promise<ListDataSourcesResponse>

    ListDataSourcesResponse

listDetectorRecipeDetectorRules

listDetectorRecipes

  • Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.

    The ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListDetectorRecipes on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListDetectorRecipes API.

    Parameters

    Returns Promise<ListDetectorRecipesResponse>

    ListDetectorRecipesResponse

listDetectorRules

  • Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.

    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 ListDetectorRules API.

    Parameters

    Returns Promise<ListDetectorRulesResponse>

    ListDetectorRulesResponse

listDetectors

  • Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.

    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 ListDetectors API.

    Parameters

    Returns Promise<ListDetectorsResponse>

    ListDetectorsResponse

listImpactedResources

listManagedListTypes

listManagedLists

  • Returns a list of all ManagedList resources in a compartment, identified by compartmentId. The ListManagedLists operation returns only the managed lists in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListManagedLists on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListManagedLists API.

    Parameters

    Returns Promise<ListManagedListsResponse>

    ListManagedListsResponse

listPolicies

  • Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.

    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 ListPolicies API.

    Parameters

    Returns Promise<ListPoliciesResponse>

    ListPoliciesResponse

listProblemEndpoints

listProblemEntities

listProblemHistories

listProblems

  • Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.

    The ListProblems operation returns only the problems in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListProblems API.

    Parameters

    Returns Promise<ListProblemsResponse>

    ListProblemsResponse

listRecommendations

  • Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.

    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 ListRecommendations API.

    Parameters

    Returns Promise<ListRecommendationsResponse>

    ListRecommendationsResponse

listResourcePorts

  • Returns the list of open ports associated with the resourceId where resource is an 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 ListResourcePorts API.

    Parameters

    Returns Promise<ListResourcePortsResponse>

    ListResourcePortsResponse

listResourceProfileEndpoints

  • Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.

    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 ListResourceProfileEndpoints API.

    Parameters

    Returns Promise<ListResourceProfileEndpointsResponse>

    ListResourceProfileEndpointsResponse

listResourceProfileImpactedResources

  • Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.

    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 ListResourceProfileImpactedResources API.

    Parameters

    Returns Promise<ListResourceProfileImpactedResourcesResponse>

    ListResourceProfileImpactedResourcesResponse

listResourceProfiles

  • Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.

    The ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListResourceProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListResourceProfiles API.

    Parameters

    Returns Promise<ListResourceProfilesResponse>

    ListResourceProfilesResponse

listResourceTypes

  • Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.

    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 ListResourceTypes API.

    Parameters

    Returns Promise<ListResourceTypesResponse>

    ListResourceTypesResponse

listResourceVulnerabilities

listResources

  • Returns a list of all resources in a compartment

    The ListResources operation returns only the resources in `compartmentId` passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListResources on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListResources API.

    Parameters

    Returns Promise<ListResourcesResponse>

    ListResourcesResponse

listResponderActivities

  • Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.

    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 ListResponderActivities API.

    Parameters

    Returns Promise<ListResponderActivitiesResponse>

    ListResponderActivitiesResponse

listResponderExecutions

  • Returns a list of responder executions. A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem.

    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 ListResponderExecutions API.

    Parameters

    Returns Promise<ListResponderExecutionsResponse>

    ListResponderExecutionsResponse

listResponderRecipeResponderRules

  • Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.

    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 ListResponderRecipeResponderRules API.

    Parameters

    Returns Promise<ListResponderRecipeResponderRulesResponse>

    ListResponderRecipeResponderRulesResponse

listResponderRecipes

  • Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId. The ListResponderRecipe operation returns only the targets in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListResponderRecipes API.

    Parameters

    Returns Promise<ListResponderRecipesResponse>

    ListResponderRecipesResponse

listResponderRules

  • Returns a list of responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.

    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 ListResponderRules API.

    Parameters

    Returns Promise<ListResponderRulesResponse>

    ListResponderRulesResponse

listSavedQueries

listSecurityPolicies

  • Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.

    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 ListSecurityPolicies API.

    Parameters

    Returns Promise<ListSecurityPoliciesResponse>

    ListSecurityPoliciesResponse

listSecurityRecipes

  • Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.

    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 ListSecurityRecipes API.

    Parameters

    Returns Promise<ListSecurityRecipesResponse>

    ListSecurityRecipesResponse

listSecurityZones

  • Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.

    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 ListSecurityZones API.

    Parameters

    Returns Promise<ListSecurityZonesResponse>

    ListSecurityZonesResponse

listSightingEndpoints

  • Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.

    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 ListSightingEndpoints API.

    Parameters

    Returns Promise<ListSightingEndpointsResponse>

    ListSightingEndpointsResponse

listSightingImpactedResources

  • Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.

    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 ListSightingImpactedResources API.

    Parameters

    Returns Promise<ListSightingImpactedResourcesResponse>

    ListSightingImpactedResourcesResponse

listSightings

  • For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSightings on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListSightings API.

    Parameters

    Returns Promise<ListSightingsResponse>

    ListSightingsResponse

listTactics

  • Returns a list of TacticSummary resources for a compartment, identified by compartmentId. 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 ListTactics API.

    Parameters

    Returns Promise<ListTacticsResponse>

    ListTacticsResponse

listTargetDetectorRecipeDetectorRules

listTargetDetectorRecipes

  • Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.

    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 ListTargetDetectorRecipes API.

    Parameters

    Returns Promise<ListTargetDetectorRecipesResponse>

    ListTargetDetectorRecipesResponse

listTargetResponderRecipeResponderRules

  • Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources.

    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 ListTargetResponderRecipeResponderRules API.

    Parameters

    Returns Promise<ListTargetResponderRecipeResponderRulesResponse>

    ListTargetResponderRecipeResponderRulesResponse

listTargetResponderRecipes

  • Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.

    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 ListTargetResponderRecipes API.

    Parameters

    Returns Promise<ListTargetResponderRecipesResponse>

    ListTargetResponderRecipesResponse

listTargets

  • Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListTargets on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all targets in compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 ListTargets API.

    Parameters

    Returns Promise<ListTargetsResponse>

    ListTargetsResponse

listTechniques

  • Returns a list of techniques associated with detector rules.

    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 ListTechniques API.

    Parameters

    Returns Promise<ListTechniquesResponse>

    ListTechniquesResponse

listWlpAgents

listWorkRequestErrors

listWorkRequestLogs

  • Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.

    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 ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.

    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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

removeCompartment

  • Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can't remove the primary compartment that was used to create the security zone.

    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 RemoveCompartment API.

    Parameters

    Returns Promise<RemoveCompartmentResponse>

    RemoveCompartmentResponse

requestRiskScores

  • Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.

    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 RequestRiskScores API.

    Parameters

    Returns Promise<RequestRiskScoresResponse>

    RequestRiskScoresResponse

requestSecurityScoreSummarizedTrend

  • Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems 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 RequestSecurityScoreSummarizedTrend API.

    Parameters

    Returns Promise<RequestSecurityScoreSummarizedTrendResponse>

    RequestSecurityScoreSummarizedTrendResponse

requestSecurityScores

  • Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems 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 RequestSecurityScores API.

    Parameters

    Returns Promise<RequestSecurityScoresResponse>

    RequestSecurityScoresResponse

requestSummarizedActivityProblems

  • Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    The compartmentId to be passed with `accessLevel` and `compartmentIdInSubtree` params has to be the root compartment id (tenant-id) only.

    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 RequestSummarizedActivityProblems API.

    Parameters

    Returns Promise<RequestSummarizedActivityProblemsResponse>

    RequestSummarizedActivityProblemsResponse

requestSummarizedProblems

  • Returns the number of problems matching the key-value pairs in dimensionMap.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 RequestSummarizedProblems API.

    Parameters

    Returns Promise<RequestSummarizedProblemsResponse>

    RequestSummarizedProblemsResponse

requestSummarizedResponderExecutions

  • Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.

    Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201CNot Authorized\u201D is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

    Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201CNot Authorized\u201D is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.

    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 RequestSummarizedResponderExecutions API.

    Parameters

    Returns Promise<RequestSummarizedResponderExecutionsResponse>

    RequestSummarizedResponderExecutionsResponse

requestSummarizedRiskScores

requestSummarizedSecurityScores

requestSummarizedTopTrendResourceProfileRiskScores

requestSummarizedTrendProblems

  • Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 RequestSummarizedTrendProblems API.

    Parameters

    Returns Promise<RequestSummarizedTrendProblemsResponse>

    RequestSummarizedTrendProblemsResponse

requestSummarizedTrendResourceRiskScores

  • Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.

    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 RequestSummarizedTrendResourceRiskScores API.

    Parameters

    Returns Promise<RequestSummarizedTrendResourceRiskScoresResponse>

    RequestSummarizedTrendResourceRiskScoresResponse

requestSummarizedTrendResponderExecutions

  • Returns the number of remediations performed by Responders, for a given time period.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform summarize API on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    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 RequestSummarizedTrendResponderExecutions API.

    Parameters

    Returns Promise<RequestSummarizedTrendResponderExecutionsResponse>

    RequestSummarizedTrendResponderExecutionsResponse

requestSummarizedTrendSecurityScores

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

skipBulkResponderExecution

skipResponderExecution

  • Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource. 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 SkipResponderExecution API.

    Parameters

    Returns Promise<SkipResponderExecutionResponse>

    SkipResponderExecutionResponse

triggerResponder

  • Sends the problem identified by problemId to the responder engine, to be processed by rule that\u2019s identified by responderRuleId, in the TriggerResponderDetails resource that\u2019s passed.

    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 TriggerResponder API.

    Parameters

    Returns Promise<TriggerResponderResponse>

    TriggerResponderResponse

updateBulkProblemStatus

  • Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.

    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 UpdateBulkProblemStatus API.

    Parameters

    Returns Promise<UpdateBulkProblemStatusResponse>

    UpdateBulkProblemStatusResponse

updateConfiguration

  • Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.

    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 UpdateConfiguration API.

    Parameters

    Returns Promise<UpdateConfigurationResponse>

    UpdateConfigurationResponse

updateDataMaskRule

updateDataSource

  • Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.

    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 UpdateDataSource API.

    Parameters

    Returns Promise<UpdateDataSourceResponse>

    UpdateDataSourceResponse

updateDetectorRecipe

updateDetectorRecipeDetectorRule

updateManagedList

updateProblemStatus

  • Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.

    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 UpdateProblemStatus API.

    Parameters

    Returns Promise<UpdateProblemStatusResponse>

    UpdateProblemStatusResponse

updateResponderRecipe

  • Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.

    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 UpdateResponderRecipe API.

    Parameters

    Returns Promise<UpdateResponderRecipeResponse>

    UpdateResponderRecipeResponse

updateResponderRecipeResponderRule

updateSavedQuery

updateSecurityRecipe

  • Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.

    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 UpdateSecurityRecipe API.

    Parameters

    Returns Promise<UpdateSecurityRecipeResponse>

    UpdateSecurityRecipeResponse

updateSecurityZone

  • Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.

    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 UpdateSecurityZone API.

    Parameters

    Returns Promise<UpdateSecurityZoneResponse>

    UpdateSecurityZoneResponse

updateTarget

  • Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.

    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 UpdateTarget API.

    Parameters

    Returns Promise<UpdateTargetResponse>

    UpdateTargetResponse

updateTargetDetectorRecipe

  • Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.

    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 UpdateTargetDetectorRecipe API.

    Parameters

    Returns Promise<UpdateTargetDetectorRecipeResponse>

    UpdateTargetDetectorRecipeResponse

updateTargetDetectorRecipeDetectorRule

updateTargetResponderRecipe

  • Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.

    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 UpdateTargetResponderRecipe API.

    Parameters

    Returns Promise<UpdateTargetResponderRecipeResponse>

    UpdateTargetResponderRecipeResponse

updateTargetResponderRecipeResponderRule

  • Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.

    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 UpdateTargetResponderRecipeResponderRule API.

    Parameters

    Returns Promise<UpdateTargetResponderRecipeResponderRuleResponse>

    UpdateTargetResponderRecipeResponderRuleResponse

updateWlpAgent

  • Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId. 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 UpdateWlpAgent API.

    Parameters

    Returns Promise<UpdateWlpAgentResponse>

    UpdateWlpAgentResponse