Oracle Cloud Guard API
The cloudGuard API from Oracle — 101 operation(s) for cloudguard.
Oracle Cloud Guard API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 142 operations across 101 paths, and defines 239 schemas. It is described by OpenAPI 3.2.0, at version 20200131.
Requests are made against 2 base URLs: http://127.0.0.1/20200131, https://127.0.0.1/20200131.
142 operations
101 paths
239 schemas
15 DELETE73 GET37 POST17 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 142
Across 101 paths, the API surfaces 142 operations — 15 DELETE, 73 GET, 37 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.
cloudGuard 142
POST
/actions/validateCredentials
Validates service user credentials for an SaaS applications such as Fusion Apps. Returns detailed credential validation information (CredentialsValidationDetails resource) for credential information…
GET
/conditionMetadataTypes
Returns a list of ConditionMetadataType resources.
GET
/conditionMetadataTypes/{conditionMetadataTypeId}
Returns a ConditionMetatDataType resource with its details.
GET
/configuration
Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
PUT
/configuration
Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.
GET
/dataMaskRules
Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.
POST
/dataMaskRules
Creates a new DataMaskRule resource definition.
DELETE
/dataMaskRules/{dataMaskRuleId}
Deletes a DataMaskRule resource, identified by dataMaskRuleId.
GET
/dataMaskRules/{dataMaskRuleId}
Returns a resource object, identified by dataMaskRuleId.
PUT
/dataMaskRules/{dataMaskRuleId}
Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.
GET
/dataSources
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.
POST
/dataSources
Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.
DELETE
/dataSources/{dataSourceId}
Deletes a data source (DataSource resource) identified by dataSourceId.
GET
/dataSources/{dataSourceId}
Returns a data source (DataSource resource) identified by dataSourceId.
PUT
/dataSources/{dataSourceId}
Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.
POST
/dataSources/{dataSourceId}/actions/changeCompartment
Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.
GET
/dataSources/{dataSourceId}/events
Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.
GET
/detectorRecipes
Returns a list of all detector recipes (DetectorRecipe objects) in a compartment, identified by compartmentId.
POST
/detectorRecipes
Creates a new DetectorRecipe resource.
DELETE
/detectorRecipes/{detectorRecipeId}
Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
GET
/detectorRecipes/{detectorRecipeId}
Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
PUT
/detectorRecipes/{detectorRecipeId}
Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
POST
/detectorRecipes/{detectorRecipeId}/actions/changeCompartment
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…
GET
/detectorRecipes/{detectorRecipeId}/detectorRules
Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.
POST
/detectorRecipes/{detectorRecipeId}/detectorRules
Creates a detector rule.
DELETE
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}
Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.
GET
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
PUT
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}
Updates a detector rule (DetectorRule resource) identified by detectorRuleId.
DELETE
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/dataSources/{dataSourceId}
Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.
GET
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes
Returns a list of all SightingTypes identified by detectorRuleId.
POST
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes
Adds a sighting type to a detector rule associated with a detector recipe.
DELETE
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes/{sightingTypeId}
Deletes a SightingType associated with a detector rule
PUT
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes/{sightingTypeId}
Updates a sighting type attached to a detector rule associated with a detector recipe.
DELETE
/detectorRecipes/{detectorRecipeId}/detectorRules/{detectorRuleId}/sightingTypes/{sightingTypeId}/dataSources/{dataSourceId}
Detach the DetectorRecipeDetectorRuleSightingTypeDataSource resource identified by ID.
GET
/detectors
Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.
GET
/detectors/{detectorId}
Returns a Detector resource, identified by detectorId.
GET
/detectors/{detectorId}/detectorRules
Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.
GET
/detectors/{detectorId}/detectorRules/{detectorRuleId}
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
GET
/managedListTypes
Returns all managed list types (listType parameter) that Cloud Guard supports.
GET
/managedLists
Returns a list of all ManagedList resources in a compartment, identified by compartmentId.
POST
/managedLists
Creates a new ManagedList resource.
DELETE
/managedLists/{managedListId}
Deletes a managed list identified by managedListId.
GET
/managedLists/{managedListId}
Returns a managed list identified by managedListId.
PUT
/managedLists/{managedListId}
Updates a ManagedList resource, identified by managedList.
POST
/managedLists/{managedListId}/actions/changeCompartment
Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.
GET
/mitreTactics
Returns a list of Cloud Guard supported MITRE ATT@CK framework tactics.
GET
/mitreTactics/{mitreTacticId}/mitreTechniques
Returns a list of MITRE ATT@CK framework techniques associated with a tactic.
GET
/monitoringResources
Returns the list of monitoring resources.
GET
/policies
Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.
GET
/problems
Returns a list of all problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.
POST
/problems/actions/bulkUpdateStatus
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 UpdateBulkProblemStatusDet…
POST
/problems/actions/summarize
Returns the number of problems matching the key-value pairs in dimensionMap.
POST
/problems/actions/summarizeActivityProblems
Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.
POST
/problems/actions/summarizeTrend
Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of P…
GET
/problems/{problemId}
Returns the Problem resource identified by problemId.
POST
/problems/{problemId}/actions/triggerResponder
Sends the problem identified by problemId to the responder engine, to be processed by rule that’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.
POST
/problems/{problemId}/actions/updateStatus
Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.
GET
/problems/{problemId}/endpoints
Returns a list of endpoints associated with a problem, identified by problemId.
GET
/problems/{problemId}/entities
Returns a list of entities for a problem.
GET
/problems/{problemId}/histories
Returns a list of actions taken on a problem.
GET
/problems/{problemId}/impactedResources
Returns a list of impacted resources for a problem identified by problemId.
GET
/problems/{problemId}/responderActivities
Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.
GET
/recommendations
Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.
POST
/resourceProfileRiskScores/actions/summarizeTopTrends
Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources)…
GET
/resourceProfiles
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 sp…
GET
/resourceProfiles/{resourceProfileId}
Returns details for a resource profile, identified by resourceProfileId.
GET
/resourceProfiles/{resourceProfileId}/endpoints
Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.
GET
/resourceProfiles/{resourceProfileId}/impactedResources
Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resource…
POST
/resourceRiskScores/actions/summarizeTrend
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 Reques…
GET
/resourceTypes
Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.
GET
/responderExecutions
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.
POST
/responderExecutions/actions/bulkSkip
Skips the execution for a bulk of responder executions.
POST
/responderExecutions/actions/summarize
Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources.
POST
/responderExecutions/actions/summarizeTrend
Returns the number of remediations performed by Responders, for a given time period.
GET
/responderExecutions/{responderExecutionId}
Returns a responder execution identified by responderExecutionId.
POST
/responderExecutions/{responderExecutionId}/actions/execute
Executes the responder execution. When provided, if-match is checked against etag values of the resource.
POST
/responderExecutions/{responderExecutionId}/actions/skip
Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource.
GET
/responderRecipes
Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources) of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentI…
POST
/responderRecipes
Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.
DELETE
/responderRecipes/{responderRecipeId}
Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
GET
/responderRecipes/{responderRecipeId}
Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
PUT
/responderRecipes/{responderRecipeId}
Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.
POST
/responderRecipes/{responderRecipeId}/actions/changeCompartment
Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When…
GET
/responderRecipes/{responderRecipeId}/responderRules
Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe…
GET
/responderRecipes/{responderRecipeId}/responderRules/{responderRuleId}
Returns a responder rule (ResponderRule resource) identified by responderRuleId.
PUT
/responderRecipes/{responderRecipeId}/responderRules/{responderRuleId}
Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.
GET
/responderRules
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.
GET
/responderRules/{responderRuleId}
Returns a responder rule (ResponderRule resource) identified by resonderRuleId.
POST
/riskScores
Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.
GET
/securityPolicies
Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.
GET
/securityPolicies/{securityPolicyId}
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 vio…
GET
/securityRecipes
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
POST
/securityRecipes
Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.
DELETE
/securityRecipes/{securityRecipeId}
Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone.
GET
/securityRecipes/{securityRecipeId}
Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
PUT
/securityRecipes/{securityRecipeId}
Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.
POST
/securityRecipes/{securityRecipeId}/actions/changeCompartment
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…
POST
/securityScores
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.
POST
/securityScores/actions/summarizeTrend
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.
GET
/securityZones
Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.
POST
/securityZones
Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.
DELETE
/securityZones/{securityZoneId}
Deletes a security zone, identified by securityZoneId.
GET
/securityZones/{securityZoneId}
Returns a security zone (SecurityZone resource) identified by securityZoneId.
PUT
/securityZones/{securityZoneId}
Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.
POST
/securityZones/{securityZoneId}/actions/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…
POST
/securityZones/{securityZoneId}/actions/changeCompartment
Moves a security zone, identified by securityZoneId, to a different compartment. Pass parameters through a ChangeSecurityZoneCompartmentDetails resource. When provided, if-match is checked against et…
POST
/securityZones/{securityZoneId}/actions/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 rem…
GET
/sightings
For the parameters passed, returns a list of sightings (SightingCollection resource) with a page of SightingSummary resources.
GET
/sightings/{sightingId}
Returns a single sighting (Sighting resource) identified by sightingId.
PUT
/sightings/{sightingId}
Updates a sighting.
GET
/sightings/{sightingId}/additionalEntities
Returns a list of associated additional entities for a Cloud Guard sighting
GET
/sightings/{sightingId}/endpoints
Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.
GET
/sightings/{sightingId}/impactedResources
Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.
GET
/tactics
Returns a list of TacticSummary resources for a compartment, identified by compartmentId.
GET
/targets
Returns a list of targets (TargetCollection resources with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is…
POST
/targets
Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.
DELETE
/targets/{targetId}
Deletes a target (Target resource) identified by targetId.
GET
/targets/{targetId}
Returns a target (Target resource) identified by targetId.
PUT
/targets/{targetId}
Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.
GET
/targets/{targetId}/monitoringSignals
Returns a list of target monitoring signals for a compartment identified by compartmentId and a target identified by targetId. Some values are passed in a ListTargetMonitoringSignalsList resource. Li…
GET
/targets/{targetId}/targetDetectorRecipes
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 TargetDetectorRecipeColle…
POST
/targets/{targetId}/targetDetectorRecipes
Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.
DELETE
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}
Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.
GET
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}
Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.
PUT
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}
Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.
GET
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules
Returns a list of DetectorRule associated with DetectorRecipe within a Target.
GET
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules/{detectorRuleId}
Returns DetectorRule resource by identified by targetDetectorRecipeId.
PUT
/targets/{targetId}/targetDetectorRecipes/{targetDetectorRecipeId}/detectorRules/{detectorRuleId}
Updates the DetectorRule resource identified by targetDetectorRecipeId
GET
/targets/{targetId}/targetResponderRecipes
Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by ta…
POST
/targets/{targetId}/targetResponderRecipes
Attaches a responder recipe to a target.
DELETE
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}
Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.
GET
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}
Returns a target responder recipe (TargetResponderRecipe resource), identified by targetResponderRecipeId, for a target (Target resource) identified by targetId.
PUT
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}
Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an Upda…
GET
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules
Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRul…
GET
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules/{responderRuleId}
Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a t…
PUT
/targets/{targetId}/targetResponderRecipes/{targetResponderRecipeId}/responderRules/{responderRuleId}
Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Ta…
GET
/techniques
Returns a list of techniques associated with detector rules.
GET
/workRequests
Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.
DELETE
/workRequests/{workRequestId}
Cancels a work request identified by workRequestId.
GET
/workRequests/{workRequestId}
Returns details for a work request (WorkRequest resource) identified by workRequestId.
GET
/workRequests/{workRequestId}/errors
Returns a list of errors for a work request identified by workRequestId.
GET
/workRequests/{workRequestId}/logs
Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.
Schemas 239
The contract defines 239 schemas that model the data the API accepts and returns. The most detailed are Problem (29 properties), Sighting (22 properties), SightingSummary (20 properties), DetectorRecipeDetectorRule (20 properties). Each schema is shown below with its type and property counts.
UpdateTargetDetectorRecipe
object
Parameters to update a detector recipe attached to a target.
2 properties
1 required
CreateSecurityRecipeDetails
object
Parameters to be used to create a security recipe.
6 properties
3 required
SecurityPolicySummary
object
Summary information for a Security Zones policy. A security policy defines a security requirement for resources in a security zone.
15 properties
3 required
UpdateTargetDetectorRecipeDetectorRuleDetails
object
Parameters to use to update a detector rule in a detector recipe attached to a target.
1 property
1 required
ResponderRecipe
object
A ResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat). A ResponderRe…
15 properties
2 required
ActivityProblemAggregationCollection
object
A collection of ProblemAggregation resources for problem analytics.
1 property
1 required
UpdateDataSourceDetails
object
Parameters to update a data source.
6 properties
DetectorRecipeCollection
object
The collection of summary information for detector recipes.
2 properties
1 required
ValidateCredentialsDetails
object
Collection of credential details to be validated.
2 properties
1 required
ActivityProblemAggregation
object
Provides the parameters and their corresponding count.
4 properties
4 required
CreateDetectorRecipeDetectorRuleDetails
object
Parameters to use to create details in a detector rule in a detector recipe.
1 property
ResponderExecutionAggregationCollection
object
Collection of ResponderExecutionAggregation resources.
1 property
1 required
TargetDetails
object
Details specific to the target type.
1 property
1 required
EntityDetails
object
Detailed information for the entities mapped to a data source.
3 properties
Condition
object
The base condition resource.
1 property
1 required
TechniqueCollection
object
Collection of technique summaries.
2 properties
1 required
ImpactedResourceSummary
object
Summary of information on a resource that’s been impacted by a detected problem.
10 properties
8 required
OperatorSummary
object
Summary information on available operators.
7 properties
6 required
SecurityScoreAggregation
object
Provides the dimensions and their corresponding count value.
3 properties
3 required
TargetDetectorRecipeDetectorRuleSummary
object
Summary information for a detector rule in a detector recipe.
19 properties
2 required
UpdateSecurityZoneDetails
object
Parameters to be used to update a security zone.
6 properties
1 required
SightingEndpointSummary
object
A summary of sighting endpoints.
16 properties
5 required
ResponderRecipeResponderRuleCollection
object
The collection of responder rule summaries for a responder recipe.
1 property
1 required
UpdateManagedListDetails
object
Parameters to use to update details for a managed list.
6 properties
TargetSummary
object
Summary information for a target.
16 properties
5 required
ResponderRecipeSummary
object
Summary information for a responder recipe.
14 properties
2 required
DetectorRecipeDetectorRule
object
A DetectorRecipeDetectorRule resource defines a single recipe rule in the collection for a DetectorRecipe resource.
20 properties
4 required
ResponderExecutionSummary
object
A summary of detailed information on responder execution.
17 properties
14 required
TacticSummary
object
Summary information for a tactic.
2 properties
2 required
SightingAdditionalEntityCollection
object
The collection of sighting additional entities' details.
2 properties
1 required
SecurityZoneCollection
object
A collection of security zones. Results of a security zone search.
2 properties
1 required
TargetResponderRecipeResponderRule
object
A TargetResponderRecipeResponderRule resource contains a specific instance of a single responder rule. A TargetResponderRecipeRule resource: Is effectively a c…
12 properties
2 required
ProblemAggregation
object
Provides aggregated information on counts of problems by specified parameters.
2 properties
2 required
TargetResponderRecipeResponderRuleCollection
object
Collection of summary information for target responder recipe responder rules.
1 property
1 required
GeographicalLocation
object
The geographical location of a problem in terms of latitude and longitude.
2 properties
2 required
CandidateResponderRule
object
Information for a responder rule that can be used to remediate a problem triggered by specific detector rule.
3 properties
TargetMonitoringSignalCollection
object
Collection of target monitoring signals.
1 property
1 required
ResourceProfileEndpointSummary
object
Summary information for resource profile endpoints.
18 properties
7 required
LoggingQueryDetails
object
Details for a logging query for a data source.
1 property
1 required
CredentialsValidationDetailsItem
object
Credentials validation response.
4 properties
1 required
PropertyTuple
object
key and value pair for configuration values
2 properties
2 required
TargetDetectorRecipe
object
A TargetDetectorRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which…
15 properties
6 required
CreateResponderRecipeDetails
object
Parameters for creating a responder recipe.
7 properties
3 required
ProblemEndpointCollection
object
Collection of problem endpoint summaries.
2 properties
1 required
ChangeSecurityZoneCompartmentDetails
object
Parameters to be used to move a security zone to a different compartment.
1 property
1 required
UpdateDetectorRecipeDetectorRule
object
Parameters to use to update a detector rule.
2 properties
2 required
ResourceTypeSummary
object
A summary of detailed information on a resource type.
4 properties
2 required
DataMaskRuleCollection
object
Collection of data mask rules.
2 properties
1 required
DataSourceEventSummary
object
Summary information about a data source event.
7 properties
5 required
MitreTacticSummary
object
Summary information for a MITRE ATT@CK framework tactic.
2 properties
2 required
ChangeManagedListCompartmentDetails
object
Parameters to use to move a managed list to a different compartment.
1 property
1 required
ManagedListTypeCollection
object
Collection of managed list type summaries.
2 properties
1 required
SecurityPolicyCollection
object
Results of a security policy search.
5 properties
1 required
ResourceProfileRiskScoreAggregationSummary
object
Summary of resource profile risk score aggregations.
4 properties
3 required
ResponderRecipeResponderRuleSummary
object
Summary information for a responder rule
12 properties
2 required
DetectorConfiguration
object
Configuration details for a detector.
8 properties
2 required
ConfigValue
object
Details for a configuration value for a managed list.
3 properties
3 required
DataSource
object
Detailed information for a data source (DataSource resource).
17 properties
4 required
DetectorCollection
object
The collection of detector summaries.
1 property
1 required
Configuration
object
Specifies several key settings for a Cloud Guard tenancy, identified by tenancy root compartment OCID.
3 properties
1 required
ResourceRiskScoreAggregation
object
Risk score of a resource.
4 properties
4 required
ResourceProfileRiskScoreAggregationSummaryCollection
object
Collection of resource profile risk score aggregation summaries.
1 property
1 required
MonitoringResourceSummary
object
Summary of monitoring resource information.
3 properties
ProblemCollection
object
Collection of summary information for problems.
2 properties
1 required
UpdateBulkProblemStatusDetails
object
List of problem IDs to be passed in to update problem status.
3 properties
2 required
TechniqueSummary
object
Summary information for a technique.
2 properties
2 required
CreateTargetDetectorRecipeDetails
object
Parameters to use to create a target detector recipe.
2 properties
1 required
WorkRequestSummary
object
Summary information about a work request.
9 properties
7 required
ResourceProfileSummary
object
Summary information for a resource profile.
12 properties
8 required
TargetDetectorRecipeDetectorRuleCollection
object
Collection of summary information for target detector recipe detector rules.
2 properties
1 required
UpdateDetectorRecipeDetectorRuleDetails
object
Parameters to use to update details in a detector rule.
1 property
ManagedList
object
A managed list is a reusable list of parameters that makes it easier to set the scope for detector and responder rules. A ManagedList resource contains the reu…
18 properties
4 required
TargetDetectorRecipeDetectorRule
object
A TargetDetectorRecipeDetectorRule resource contains a specific instance of a single detector rule in one of the supported detector types (for example, activit…
19 properties
4 required
DataMaskRuleSummary
object
Summary information for a data mask rule.
16 properties
4 required
UpdateResponderRuleDetails
object
Parameters to be updated for a responder rule within a responder recipe.
1 property
1 required
UpdateConfigurationDetails
object
Parameters to update Cloud Guard configuration details for a tenancy.
3 properties
2 required
DetectorRecipeDetectorRuleCollection
object
Collection of summary information for detector rules in a detector recipe.
2 properties
1 required
RequestSummarizedTrendResourceRiskScoresDetails
object
Details for requesting summarized trend risk scores.
2 properties
2 required
DetectorRecipeDetectorRuleSightingTypeSummary
object
Summary of detector sighting type.
10 properties
4 required
DataSourceEventCollection
object
The collection of events related to a data source.
2 properties
1 required
ResponderActivitySummary
object
Responder activity summary definition.
9 properties
9 required
ResponderExecutionTrendAggregation
object
Provides the timestamps and their corresponding number of remediations.
4 properties
4 required
RecommendationSummaryCollection
object
Collection of RecommendationSummary resources.
2 properties
1 required
ResourceProfileImpactedResourceSummary
object
Summary information on impacted resource in resource profile.
15 properties
10 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties
2 required
WorkRequest
object
Detailed information about a work request (WorkRequest resource).
10 properties
7 required
SightingAdditionalEntitySummary
object
Additional information about sighting additional entities' details.
7 properties
5 required
DetectorRecipeDetectorRuleSightingType
object
The sighting type associated with a Threat Detector rule.
13 properties
4 required
RegionStatusDetail
object
Status of replication of a data source query in a region
2 properties
2 required
ResourceProfileEndpointCollection
object
Collection of resource profile endpoint summaries.
1 property
1 required
ImpactedResourceCollection
object
Collection of impacted resource summaries.
2 properties
1 required
UpdateTargetResponderRuleDetails
object
Parameters to update details for a responder rule for a target responder recipe. TargetResponderRuleDetails contains all configurations associated with the Res…
3 properties
SecurityZoneSummary
object
Summary information for a security zone. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe.
13 properties
3 required
ResponderRule
object
A ResponderRule resource contains the default settings for a single responder rule that Cloud Guard provides. A ResponderRule resource: Is used as the original…
12 properties
4 required
SightingImpactedResourceSummary
object
Summary of resources impacted by a sighting.
13 properties
8 required
ConditionMetadataTypeSummary
object
Additional information on supported condition types.
4 properties
2 required
AttachTargetDetectorRecipeDetails
object
Identifier for an existing detector recipe to use to create a new detector recipe (TargetDetectorRecipe resource) to be attached to a target.
1 property
1 required
DetectorRule
object
Information for a detector rule (DetectorRule object).
15 properties
4 required
WorkRequestResource
object
Parameters of a work request resource, which is created or operated on by a work request.
5 properties
3 required
ChangeDataSourceCompartmentDetails
object
The compartmentId for the compartment into which the data source is to be moved.
1 property
1 required
ProblemTrendAggregation
object
Provides aggregated information on trends for counts of problems by specified parameters.
4 properties
4 required
ResponderRuleCollection
object
Collection of responder rule summaries.
2 properties
1 required
WorkRequestError
object
Summary information for an error (WorkRequestError resource) encountered while executing a work request
3 properties
3 required
ResourceProfileImpactedResourceCollection
object
Collection of resource profile impacted resource summaries
2 properties
1 required
ConditionMetadataType
object
The metadata definition of the requested condition type.
3 properties
2 required
RecommendationSummary
object
Recommendation definition.
14 properties
9 required
ServiceTypeSummary
object
Summary information for a service type.
2 properties
2 required
TargetResponderRecipe
object
A TargetResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which…
11 properties
6 required
ResourceRiskScoreAggregationCollection
object
Collection of risk score aggregations.
4 properties
3 required
DataMaskRule
object
A data mask rule specifies the conditions in which the value for a sensitive data field in the UI is to be hidden or displayed when viewed by specified groups…
17 properties
4 required
ProblemEntityCollection
object
The collection of problem entities detail related to a data source.
2 properties
1 required
RuleSummary
object
Summary information for a rule.
3 properties
3 required
Detector
object
Information for a single detector category. For example, IAASACTIVITYDETECTOR or IAASCONFIGURATIONDETECTOR.
3 properties
2 required
ResponderExecutionTrendAggregationCollection
object
Collection of ResponderExecutionTrendAggregation resources.
1 property
1 required
DetectorRuleSummary
object
Summary information for a detector rule.
17 properties
2 required
UpdateTargetRecipeDetectorRuleDetails
object
Parameters to be used to update a detector rule in a target detector recipe.
2 properties
2 required
CreateDataMaskRuleDetails
object
Parameters to us to create a new data mask rule.
10 properties
5 required
ManagedListCollection
object
Collection of managed list summaries.
2 properties
1 required
TargetResponderRecipeCollection
object
Collection of target responder recipe summaries.
2 properties
1 required
Error
object
Error information.
2 properties
2 required
UpdateSightingDetails
object
The classification status of a sighting.
1 property
1 required
RemoveCompartmentDetails
object
Detailed information on a compartment to be removed from a security zone.
1 property
1 required
ChangeResponderRecipeCompartmentDetails
object
Parameters to use to move a responder recipe to a different compartment.
1 property
1 required
DataSourceEventInfo
object
This resource can have multiple subtypes, depending on the dataSourceFeedProvider value. For example, if dataSourceFeedProvider is LOGGINGQUERY, this resource…
1 property
1 required
ResponderRuleDetails
object
Detailed information for a responder rule
4 properties
1 required
WorkRequestSummaryCollection
object
Collection of work request summaries.
2 properties
1 required
SecurityRecipe
object
A security zone recipe (SecurityRecipe resource) is a collection of security zone policies (SecurityPolicy resources). Oracle Cloud Infrastructure enforces the…
13 properties
4 required
AdditionalConfigPropertyDefinition
object
Detector rule additional property field
3 properties
UpdateDataMaskRuleDetails
object
The information to be updated for a data mask rule.
8 properties
ExecuteResponderExecutionDetails
object
The configuration details for a responder rule execution.
1 property
UpdateTargetDetectorRecipeDetails
object
Parameters to be used to update a target detector recipe.
3 properties
SkipBulkResponderExecutionDetails
object
Details of responders to skip execution.
1 property
1 required
ProblemEndpointSummary
object
Summary information for endpoints associated with a problem (Problem object).
15 properties
8 required
DetectorRecipeSummary
object
Summary information for a detector recipe.
16 properties
5 required
UpdateTargetDetectorRuleDetails
object
Parameters to update detector rule configuration details in a detector recipe attached to a target.
1 property
UpdateProblemStatusDetails
object
The additional details to be updated for the problem.
3 properties
1 required
PolicySummary
object
A policy summary (PolicySummary object) contains a list of all current global policy statements (policy attributes).
1 property
1 required
DetectorSummary
object
Summary information for a detector.
4 properties
1 required
UpdateTargetDetails
object
The target information to be updated.
7 properties
TacticCollection
object
Collection of tactic summaries.
2 properties
1 required
RiskScoreAggregationCollection
object
Collection of RiskScoreAggregation resources.
1 property
1 required
SecurityScoreTrendAggregation
object
Provides the dimensions and their corresponding time and security score.
5 properties
5 required
ResourceTypeCollection
object
Collection of supported resource types.
2 properties
1 required
RiskScoreAggregation
object
Provides the dimensions and their corresponding risk score.
2 properties
2 required
ChangeSecurityRecipeCompartmentDetails
object
Parameters to be used to move a security recipe to a different compartment.
1 property
1 required
SightingEndpointCollection
object
Collection of sighting endpoint summaries.
1 property
1 required
MitreTechnique
object
MITRE ATT@CK framework technique
2 properties
ResponderExecutionCollection
object
Collection of aggregated responder execution information, including their corresponding count values.
2 properties
1 required
CreateDetectorRecipeDetectorRuleSightingTypeDetails
object
Details for creating new sighting type.
6 properties
4 required
SightingImpactedResourceCollection
object
Collection of sighting impacted resource summaries.
2 properties
1 required
UpdateTargetResponderRecipeResponderRuleDetails
object
Parameters to update a responder rule for a responder recipe attached to a target.
1 property
1 required
ResourceProfileCollection
object
Collection of resource profile summaries.
2 properties
1 required
DetectorRecipeDetectorRuleSummary
object
Summary information for a DetectorRecipeDetectorRule resoource.
19 properties
2 required
ResponderExecutionAggregation
object
Provides the dimensions and their corresponding count value.
2 properties
2 required
CreateDataSourceDetails
object
Parameters for creating a data source (DataSource resource).
8 properties
4 required
SightingType
object
Information for a sighting type
12 properties
MonitoringResourceCollection
object
The collection of MonitoringResourceSummary resources.
2 properties
1 required
CreateTargetResponderRecipeDetails
object
Parameters to be used to create a new target responder recipe (TargetDetectorRecipe resource).
2 properties
1 required
UpdateTargetResponderRecipe
object
Parameters to update a responder recipe attached to a target
2 properties
1 required
ResponderConfiguration
object
Details for a configuration to be applied to a responder.
3 properties
3 required
SecurityRecipeCollection
object
Collection of Security Zones recipes (SecurityRecipeSummary resources), resulting from a security zone recipe search.
5 properties
1 required
ChangeDetectorRecipeCompartmentDetails
object
Parameters to use to move a detector recipe to a different compartment.
1 property
1 required
CreateDetectorRecipeDetails
object
Parameters to use to create details for a detector recipe.
8 properties
2 required
ResourceLock
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
4 properties
1 required
Problem
object
Problems are at the core of Cloud Guard’s functionality. A Problem resource is created whenever an action or a configuration on a resource triggers a rule in a…
29 properties
2 required
TargetResponderRecipeResponderRuleSummary
object
Summary information for a target responder recipe responder rule.
12 properties
2 required
UpdateTargetRecipeResponderRuleDetails
object
Parameters to update the configuration details of a target detector recipe.
2 properties
2 required
ResponderRecipeResponderRule
object
A ResponderRecipeRule resource contains a specific instance of a single responder rule. A ResponderRecipeRule resource: Is effectively a copy of a ResponderRul…
13 properties
2 required
ResponderExecution
object
Attributes for a responder execution (ResponderExecution resource).
17 properties
13 required
SightingSummary
object
Sighting summary definition.
20 properties
14 required
ResponderRecipeCollection
object
Collection of responder recipe summary information.
2 properties
1 required
DetectorRecipe
object
A detector recipe is a collection of rules that can be configured to trigger problems that appear on the Cloud Guard Problems page. A DetectorRecipe resource c…
18 properties
6 required
ProblemEntitySummary
object
Summary information about problem entities for a data source for a problem.
6 properties
4 required
ProblemAggregationCollection
object
A collection of problem aggregation data for problem analytics.
1 property
1 required
DetectorDetails
object
Detailed information for a detector.
13 properties
1 required
MitreTechniqueSummary
object
Summary information for a MITRE ATT@CK framework technique.
3 properties
3 required
TargetCollection
object
Collection of summary information for targets.
2 properties
1 required
UpdateDetectorRuleDetails
object
Parameters to be updated for a detector rule within a detector recipe.
11 properties
1 required
ProblemSummary
object
Summary information for a problem.
18 properties
2 required
TriggerResponderDetails
object
The responder triggering details to be pushed to responder rules.
2 properties
1 required
RuleType
object
The detector rule types.
2 properties
2 required
ResponderRuleExecutionDetails
object
Details of responder rule execution for a problem.
2 properties
WorkRequestLogEntryCollection
object
The collection of work request log entries. These result from a workRequestLog search. Contains both workRequestLog items and other information, such as metada…
2 properties
1 required
ManagedListSummary
object
Summary information for a managed list.
18 properties
6 required
ManagedListTypeSummary
object
A managed list type summary (ManagedListTypeSummary object) contains summary information for a managed list type (ManagedListType object).
5 properties
1 required
SecurityScoreAggregationCollection
object
Collection of security score aggregation information.
1 property
1 required
DataSourceMappingInfo
object
Details of the detector recipe and detector rule mapped to the data source.
3 properties
2 required
ProblemTrendAggregationCollection
object
Collection of problem trend aggregations
1 property
1 required
SecurityPolicy
object
A security policy (SecurityPolicy resource) defines security requirements for resources in a security zone. If a security zone enables a security policy throug…
16 properties
3 required
CredentialsValidationDetails
object
A collection of CredentialValidationDetailsItem resources. This resource contains details about the result of the credential validation call. For example, it c…
2 properties
1 required
DataSourceCollection
object
The collection of data source summaries (DataSourceSummary resources).
2 properties
1 required
MitreDetails
object
MITRE ATT@CK framework details for the sighting type.
2 properties
UpdateTargetResponderRecipeDetails
object
Parameters to update a responder recipe attached to a target. UpdateTargetResponderRecipe contains the responder rules to be updated that are associated with a…
1 property
1 required
ProblemHistoryCollection
object
Collection of problem history summary information.
2 properties
1 required
CreateDetectorRuleDetails
object
Details of a detector rule to be created in a detector recipe.
13 properties
1 required
DataSourceSummaryDetails
object
Summary information for a data source of a specified data source type.
1 property
1 required
ConditionGroup
object
Details for a condition configured on a target.
2 properties
2 required
UpdateResponderRecipeResponderRuleDetails
object
Parameters to use to update a responder rule within a responder recipe.
1 property
1 required
SecurityRecipeSummary
object
Summary information for a Security Zones recipe.
13 properties
4 required
UpdateResponderRecipeResponderRule
object
Parameters to use to update a responder recipe responder rule.
2 properties
2 required
CreateManagedListDetails
object
Parameters to use to create details for a new managed list.
9 properties
2 required
EntitiesMapping
object
Parameters for entities mapping to data source.
3 properties
1 required
AddCompartmentDetails
object
Parameter for an existing compartment to be added to a security zone.
1 property
1 required
ResponderRuleSummary
object
Summary information for a responder rule.
11 properties
4 required
ConditionOperator
object
Conditions related to the parameter data type.
2 properties
2 required
Target
object
A target defines the scope of resources that Cloud Guard monitors and the rules to be enforced in that monitoring. A Target resource contains the settings for…
20 properties
5 required
TargetSummaryAdditionalDetails
object
A summary of additional details of a target.
1 property
1 required
ResourceProfile
object
Resource profile details.
18 properties
9 required
ProblemHistorySummary
object
Problem history definition.
11 properties
8 required
MitreTechniqueCollection
object
Collection of summaries for MITRE ATT@CK framework techniques supported by Cloud Guard.
2 properties
1 required
MitreTactic
object
MITRE ATT@CK framework tactic
2 properties
DataSourceSummary
object
Summary information for a specific data source.
15 properties
4 required
ResponderActivityCollection
object
Provides a summary of responder activities and their corresponding count values.
1 property
1 required
DetectorRuleCollection
object
Summary information for the collection of detector rules.
1 property
1 required
UpdateDetectorRecipeDetectorRuleSightingTypeDetails
object
Details for updating a sighting type.
6 properties
TargetDetectorRecipeSummary
object
Summary information for a target detector recipe
14 properties
6 required
SightingCollection
object
Collection of sighting summaries.
2 properties
1 required
UpdateResponderRecipeDetails
object
Parameters to use to update a responder recipe.
5 properties
1 required
DataSourceDetails
object
Details specific to the data source type.
1 property
1 required
ConditionMetadataTypeCollection
object
The collection of available condition types.
2 properties
1 required
CreateTargetDetails
object
Parameters used to create a new target.
11 properties
4 required
TargetDetectorRecipeCollection
object
Collection of target detector recipe summaries.
2 properties
1 required
UpdateDetectorRecipeDetails
object
Parameters to use to update details for a detector recipe.
5 properties
CredentialsDetailsItem
object
Details for the credentials to be validated.
4 properties
1 required
SecurityScoreTrendAggregationCollection
object
Collection of security trend aggregation information.
1 property
1 required
DetectorRecipeDetectorRuleSightingTypeCollection
object
Collection of sighting type summaries for detector rules.
2 properties
1 required
TargetMonitoringSignalSummary
object
Summary information for a target monitoring signal (TargetMonitoringSignal resource).
8 properties
UpdateSecurityRecipeDetails
object
Parameters to be used to update a Security Zones security recipe.
5 properties
1 required
PoliticalLocation
object
The geographical location of a problem in terms of political units.
3 properties
3 required
TargetResponderRecipeSummary
object
Summary information for a target responder recipe.
11 properties
6 required
CreateSecurityZoneDetails
object
Parameters to be used to create a new security zone.
7 properties
3 required
SecurityZone
object
A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone's compartment (and any…
15 properties
3 required
WorkRequestErrorCollection
object
The collection of work request error resources. These result from a workRequestError search. Contains WorkRequestError items and other information, such as met…
1 property
1 required
TargetSelected
object
Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
1 property
1 required
TargetDetectorDetails
object
Overriden settings of a detector rule in recipe attached to target.
9 properties
1 required
AttachTargetResponderRecipeDetails
object
Identifier for an existing detector recipe to use to create a new detector recipe (TargetDetectorRecipe resource) to be attached to a target.
1 property
1 required
Sighting
object
Sighting details.
22 properties
14 required
MitreTacticCollection
object
Collection of summary information for MITRE ATT@CK framework tactics supported by Cloud Guard.
1 property
1 required
PolicyCollection
object
Collection of policy statements required by Cloud Guard.
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from
This is an independent, third-party profile of Oracle Cloud Guard API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.