{ "opencollection": "1.0.0", "info": { "name": "Security Zones Cloud Guard API", "version": "20200131" }, "items": [ { "info": { "name": "cloudGuard", "type": "folder" }, "items": [ { "info": { "name": "Validates service user credentials for an SaaS applications such as Fusion Apps.\nReturns detailed credential validation information (CredentialsValidationDetails\nresource) for credential information passed in a ValidateCredentialsDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/actions/validateCredentials", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates service user credentials for an SaaS applications such as Fusion Apps.\nReturns detailed credential validation information (CredentialsValidationDetails\nresource) for credential information passed in a ValidateCredentialsDetails resource.\n" }, { "info": { "name": "Returns a list of ConditionMetadataType resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/conditionMetadataTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of ConditionMetadataType resources.\n" }, { "info": { "name": "Returns a ConditionMetatDataType resource with its details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/conditionMetadataTypes/:conditionMetadataTypeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "conditionMetadataTypeId", "value": "", "type": "path", "description": "The type of the condition metadata." }, { "name": "serviceType", "value": "", "type": "query", "description": "Service type filter for the condition metadata." }, { "name": "resourceType", "value": "", "type": "query", "description": "Resource filter for the condition metadata." } ] }, "docs": "Returns a ConditionMetatDataType resource with its details.\n" }, { "info": { "name": "Returns the configuration details for a Cloud Guard tenancy,\nidentified by root compartment OCID.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/configuration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ] }, "docs": "Returns the configuration details for a Cloud Guard tenancy,\nidentified by root compartment OCID.\n" }, { "info": { "name": "Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID.\nThe reporting region cannot be updated once created.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/configuration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID.\nThe reporting region cannot be updated once created.\n" }, { "info": { "name": "Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/dataMaskRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "dataMaskRuleStatus", "value": "", "type": "query", "description": "The status of the data mask rule" }, { "name": "targetId", "value": "", "type": "query", "description": "OCID of the target" }, { "name": "iamGroupId", "value": "", "type": "query", "description": "OCID of the IAM group" }, { "name": "targetType", "value": "", "type": "query", "description": "Type of target" } ] }, "docs": "Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.\n" }, { "info": { "name": "Creates a new DataMaskRule resource definition.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/dataMaskRules", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DataMaskRule resource definition.\n" }, { "info": { "name": "Returns a resource object, identified by dataMaskRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/dataMaskRules/:dataMaskRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataMaskRuleId", "value": "", "type": "path", "description": "OCID of the data mask rule" } ] }, "docs": "Returns a DataMaskRule resource, identified by dataMaskRuleId." }, { "info": { "name": "Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/dataMaskRules/:dataMaskRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataMaskRuleId", "value": "", "type": "path", "description": "OCID of the data mask rule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId." }, { "info": { "name": "Deletes a DataMaskRule resource, identified by dataMaskRuleId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/dataMaskRules/:dataMaskRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataMaskRuleId", "value": "", "type": "path", "description": "OCID of the data mask rule" } ] }, "docs": "Deletes a DataMaskRule resource, identified by dataMaskRuleId." }, { "info": { "name": "Returns a list of all data sources (DataSource resources) for a compartment\nidentified by compartmentId. List is returned in a DataSourceCollection resource\nwith page of DataSourceSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/dataSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "dataSourceFeedProvider", "value": "", "type": "query", "description": "A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "loggingQueryType", "value": "", "type": "query", "description": "A filter to return only resources where their query type matches the given LoggingQueryType." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of all data sources (DataSource resources) for a compartment\nidentified by compartmentId. List is returned in a DataSourceCollection resource\nwith page of DataSourceSummary resources.\n\nThe ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at l" }, { "info": { "name": "Creates a data source (DataSource resource), using parameters passed\nthrough a CreateDataSourceDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/dataSources", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a data source (DataSource resource), using parameters passed\nthrough a CreateDataSourceDetails resource.\n" }, { "info": { "name": "Returns a data source (DataSource resource) identified by dataSourceId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/dataSources/:dataSourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ] }, "docs": "Returns a data source (DataSource resource) identified by dataSourceId." }, { "info": { "name": "Updates a data source (DataSource resource) identified by dataSourceId,\nusing values passed in an UpdateDataSourceDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a data source (DataSource resource) identified by dataSourceId,\nusing values passed in an UpdateDataSourceDetails resource.\n" }, { "info": { "name": "Deletes a data source (DataSource resource) identified by dataSourceId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ] }, "docs": "Deletes a data source (DataSource resource) identified by dataSourceId." }, { "info": { "name": "Moves a data source (DataSource resource), identified by parameters\npassed in a ChangeDataSourceCompartmentDetails resource, from the current\ncompartment to another.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/dataSources/:dataSourceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a data source (DataSource resource), identified by parameters\npassed in a ChangeDataSourceCompartmentDetails resource, from the current\ncompartment to another.\n" }, { "info": { "name": "Returns a list of data source events\n(DataSourceEventCollection resource) from the data source\n(DataSource resource) identified by dataSourceId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/dataSources/:dataSourceId/events", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." }, { "name": "region", "value": "", "type": "query", "description": "A filter to return only resource where their region matches the given region." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of data source events\n(DataSourceEventCollection resource) from the data source\n(DataSource resource) identified by dataSourceId.\n" }, { "info": { "name": "Returns a list of all detector recipes (DetectorRecipe objects) in a compartment, identified by compartmentId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectorRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "resourceMetadataOnly", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the list of all Oracle-managed resources\nmetadata supported by Cloud Guard is returned.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.\n\nThe ListDetectorRecipes operation returns only the detector recipes in `compartmentId` passed.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a " }, { "info": { "name": "Creates a new DetectorRecipe resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/detectorRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DetectorRecipe resource.\n" }, { "info": { "name": "Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" } ] }, "docs": "Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId." }, { "info": { "name": "Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId." }, { "info": { "name": "Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" } ] }, "docs": "Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId." }, { "info": { "name": "Moves the detector recipe (DetectorRecipe resource),\nidentified by detectorRecipeId, from the current compartment to\nanother compartment. When provided, If-Match is checked against\netag values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the detector recipe (DetectorRecipe resource),\nidentified by detectorRecipeId, from the current compartment to\nanother compartment. When provided, If-Match is checked against\netag values of the resource.\n" }, { "info": { "name": "Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.\n" }, { "info": { "name": "Creates a detector rule.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a detector rule." }, { "info": { "name": "Returns a detector rule (DetectorRule resource) identified by detectorRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." } ] }, "docs": "Returns a detector rule (DetectorRule resource) identified by detectorRuleId." }, { "info": { "name": "Updates a detector rule (DetectorRule resource) identified by detectorRuleId.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a detector rule (DetectorRule resource) identified by detectorRuleId." }, { "info": { "name": "Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." } ] }, "docs": "Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId." }, { "info": { "name": "Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." }, { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ] }, "docs": "Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier." }, { "info": { "name": "Returns a list of all SightingTypes identified by detectorRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/sightingTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of all SightingTypes identified by detectorRuleId.\nThe ListSightingTypes operation returns only sightingTypes that match the passed filters.\n" }, { "info": { "name": "Adds a sighting type to a detector rule associated with a detector recipe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/sightingTypes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a sighting type to a detector rule associated with a detector recipe." }, { "info": { "name": "Updates a sighting type attached to a detector rule associated with a detector recipe.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/sightingTypes/:sightingTypeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." }, { "name": "sightingTypeId", "value": "", "type": "path", "description": "Unique ID of the sighting type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a sighting type attached to a detector rule associated with a detector recipe." }, { "info": { "name": "Deletes a SightingType associated with a detector rule", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/sightingTypes/:sightingTypeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." }, { "name": "sightingTypeId", "value": "", "type": "path", "description": "Unique ID of the sighting type." } ] }, "docs": "Deletes a SightingType associated with a detector rule" }, { "info": { "name": "Detach the DetectorRecipeDetectorRuleSightingTypeDataSource resource identified by ID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/detectorRecipes/:detectorRecipeId/detectorRules/:detectorRuleId/sightingTypes/:sightingTypeId/dataSources/:dataSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorRecipeId", "value": "", "type": "path", "description": "Detector recipe OCID" }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." }, { "name": "sightingTypeId", "value": "", "type": "path", "description": "Unique ID of the sighting type." }, { "name": "dataSourceId", "value": "", "type": "path", "description": "Data source OCID." } ] }, "docs": "Detach the DetectorRecipeDetectorRuleSightingTypeDataSource resource identified by ID." }, { "info": { "name": "Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.\n" }, { "info": { "name": "Returns a Detector resource, identified by detectorId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectors/:detectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorId", "value": "", "type": "path", "description": "Detector name." } ] }, "docs": "Returns a Detector resource, identified by detectorId.\n" }, { "info": { "name": "Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectors/:detectorId/detectorRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorId", "value": "", "type": "path", "description": "Detector name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "detectorRuleId", "value": "", "type": "query", "description": "The unique identifier of a detector rule." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "ruleCategory", "value": "", "type": "query", "description": "The field rule category. Only one category can be provided. Default value for category is rule. If no value is specified category is rule." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.\n" }, { "info": { "name": "Returns a detector rule (DetectorRule resource) identified by detectorRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/detectors/:detectorId/detectorRules/:detectorRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "detectorId", "value": "", "type": "path", "description": "Detector name." }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of a detector rule." } ] }, "docs": "Returns a detector rule (DetectorRule resource) identified by detectorRuleId.\n" }, { "info": { "name": "Returns all managed list types (listType parameter) that Cloud Guard supports.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/managedListTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns all managed list types (listType parameter) that Cloud Guard supports." }, { "info": { "name": "Returns a list of all ManagedList resources in a compartment, identified by compartmentId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/managedLists", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "resourceMetadataOnly", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the list of all Oracle-managed resources\nmetadata supported by Cloud Guard is returned.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "listType", "value": "", "type": "query", "description": "The type of managed list." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of all ManagedList resources in a compartment, identified by compartmentId.\nThe ListManagedLists operation returns only the managed lists in `compartmentId` passed.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return ManagedLists in only\nthose compartments for which the requestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartmen" }, { "info": { "name": "Creates a new ManagedList resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/managedLists", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new ManagedList resource.\n" }, { "info": { "name": "Returns a managed list identified by managedListId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/managedLists/:managedListId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedListId", "value": "", "type": "path", "description": "The managed list OCID to be passed in the request." } ] }, "docs": "Returns a managed list identified by managedListId." }, { "info": { "name": "Updates a ManagedList resource, identified by managedList.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/managedLists/:managedListId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedListId", "value": "", "type": "path", "description": "The managed list OCID to be passed in the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a ManagedList resource, identified by managedList." }, { "info": { "name": "Deletes a managed list identified by managedListId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/managedLists/:managedListId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedListId", "value": "", "type": "path", "description": "The managed list OCID to be passed in the request." } ] }, "docs": "Deletes a managed list identified by managedListId." }, { "info": { "name": "Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/managedLists/:managedListId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedListId", "value": "", "type": "path", "description": "The managed list OCID to be passed in the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment." }, { "info": { "name": "Returns a list of Cloud Guard supported MITRE ATT@CK framework tactics.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/mitreTactics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" } ] }, "docs": "Returns a list of Cloud Guard supported MITRE ATT@CK framework tactics.\n" }, { "info": { "name": "Returns a list of MITRE ATT@CK framework techniques associated with a tactic.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/mitreTactics/:mitreTacticId/mitreTechniques", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mitreTacticId", "value": "", "type": "path", "description": "Unique identifier of the MITRE ATT@CK framework tactic." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" } ] }, "docs": "Returns a list of MITRE ATT@CK framework techniques associated with a tactic.\n" }, { "info": { "name": "Returns the list of monitoring resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/monitoringResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetResourceType", "value": "", "type": "query", "description": "Target resource type" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns the list of monitoring resources." }, { "info": { "name": "Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/policies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.\n" }, { "info": { "name": "Returns a list of all problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "timeLastDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeLastDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." }, { "name": "timeFirstDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeFirstDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." }, { "name": "lifecycleDetail", "value": "", "type": "query", "description": "The field life cycle state. Only one state can be provided. Default value for state is active." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "region", "value": "", "type": "query", "description": "OCI monitoring region." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "riskLevel", "value": "", "type": "query", "description": "Risk level of the problem." }, { "name": "resourceType", "value": "", "type": "query", "description": "Resource type associated with the resource." }, { "name": "city", "value": "", "type": "query", "description": "City of the problem." }, { "name": "state", "value": "", "type": "query", "description": "State or province of the problem." }, { "name": "country", "value": "", "type": "query", "description": "Country of the problem." }, { "name": "label", "value": "", "type": "query", "description": "User-defined label associated with the problem." }, { "name": "detectorRuleIdList", "value": "", "type": "query", "description": "Comma seperated list of detector rule IDs to be passed in to match against Problems." }, { "name": "detectorType", "value": "", "type": "query", "description": "The field to list the problems by detector type.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "The ID of the target in which to list resources." }, { "name": "problemCategory", "value": "", "type": "query", "description": "Setting this to `SECURITY_ZONE` returns only security zone-related violations.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource associated with the problem." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default.\n" } ] }, "docs": "Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.\n\nThe ListProblems operation returns only the problems in `compartmentId` passed.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a su" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/actions/bulkUpdateStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n" }, { "info": { "name": "Returns the number of problems matching the key-value pairs in dimensionMap.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/actions/summarize", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listDimensions", "value": "", "type": "query", "description": "The possible attributes based on which the problems can be distinguished." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns the number of problems matching the key-value pairs in dimensionMap.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid only when\n`compartmentIdInSubtree` is set to `true`.\n\nThe parameter `compartm" }, { "info": { "name": "Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/actions/summarizeActivityProblems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "includeUnknownLocations", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the summary of activity problems that has unknown values for\ncity, state or country will be included.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid only when\n`compartmentIdInSubtree` is set to" }, { "info": { "name": "Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/actions/summarizeTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "timeFirstDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeFirstDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrin" }, { "info": { "name": "Returns the Problem resource identified by problemId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." } ] }, "docs": "Returns the Problem resource identified by problemId." }, { "info": { "name": "Sends the problem identified by problemId to the responder engine, to be processed by rule\nthat’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/:problemId/actions/triggerResponder", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends the problem identified by problemId to the responder engine, to be processed by rule\nthat’s identified by responderRuleId, in the TriggerResponderDetails resource that’s passed.\n" }, { "info": { "name": "Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/problems/:problemId/actions/updateStatus", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.\n" }, { "info": { "name": "Returns a list of endpoints associated with a problem, identified by problemId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId/endpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of endpoints associated with a problem, identified by problemId.\n" }, { "info": { "name": "Returns a list of entities for a problem.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId/entities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of entities for a problem.\n" }, { "info": { "name": "Returns a list of actions taken on a problem.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId/histories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of actions taken on a problem.\n" }, { "info": { "name": "Returns a list of impacted resources for a problem identified by problemId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId/impactedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of impacted resources for a problem identified by problemId.\n" }, { "info": { "name": "Returns a list of responder activities for a problem, identified by problemId, in a\nResponderActivityCollection resource, with a page of ResponderActivitySummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/problems/:problemId/responderActivities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "path", "description": "OCID of the problem." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of responder activities for a problem, identified by problemId, in a\nResponderActivityCollection resource, with a page of ResponderActivitySummary resources.\n" }, { "info": { "name": "Returns a list of recommendations (RecommendationSummaryCollection resource with a page of\nRecommendationSummary resources) for a specified compartment OCID.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/recommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for riskLevel and timeCreated is descending. If no value is specified riskLevel is default.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "The ID of the target in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "lifecycleDetail", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of recommendations (RecommendationSummaryCollection resource with a page of\nRecommendationSummary resources) for a specified compartment OCID.\n" }, { "info": { "name": "Returns a list of resource profile risk score aggregation summaries\n(ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of\nResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/resourceProfileRiskScores/actions/summarizeTopTrends", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "timeScoreComputedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days." }, { "name": "timeScoreComputedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to today's current time." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort trendlines for resource profiles. Only one sort order may be provided. If no value is specified riskScore is default.\n" }, { "name": "count", "value": "", "type": "query", "description": "Number of resource profile risk score trend-lines to be displayed. Default value is 10.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of resource profile risk score aggregation summaries\n(ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of\nResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.\n" }, { "info": { "name": "Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of\nResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/resourceProfiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "timeLastDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeLastDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." }, { "name": "timeFirstDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeFirstDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "resourceTypes", "value": "", "type": "query", "description": "A filter to return only resources that match the list of resource types given." }, { "name": "riskScoreGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Risk score filter." }, { "name": "riskScoreLessThanOrEqualTo", "value": "", "type": "query", "description": "Risk score filter," }, { "name": "techniques", "value": "", "type": "query", "description": "A filter to return only resources that match the list of techniques given." }, { "name": "tactics", "value": "", "type": "query", "description": "A filter to return only resources that match the list of tactics given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort resource profiles. Only one sort order may be provided. Default order for timeLastDetected is descending. If no value is specified timeLastDetected is default.\n" } ] }, "docs": "Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of\nResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.\n\nThe ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed.\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the " }, { "info": { "name": "Returns details for a resource profile, identified by resourceProfileId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/resourceProfiles/:resourceProfileId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceProfileId", "value": "", "type": "path", "description": "OCID of the resource profile." } ] }, "docs": "Returns details for a resource profile, identified by resourceProfileId." }, { "info": { "name": "Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of\nResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/resourceProfiles/:resourceProfileId/endpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceProfileId", "value": "", "type": "path", "description": "OCID of the resource profile." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of\nResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.\n" }, { "info": { "name": "Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource\nwith a page of ResourceProfileImpactedResourceSummary resources) for a resource profile\nidentified by resourceProfileId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/resourceProfiles/:resourceProfileId/impactedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceProfileId", "value": "", "type": "path", "description": "OCID of the resource profile." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource\nwith a page of ResourceProfileImpactedResourceSummary resources) for a resource profile\nidentified by resourceProfileId.\n" }, { "info": { "name": "Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource,\nwith a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify\nin a RequestSummarizedTrendResourceRiskScoresDetailsresource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/resourceRiskScores/actions/summarizeTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "timeScoreComputedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days." }, { "name": "timeScoreComputedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to today's current time." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource,\nwith a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify\nin a RequestSummarizedTrendResourceRiskScoresDetailsresource.\n" }, { "info": { "name": "Returns a single ResourceTypeCollection resource, containing a list of resource types,\nidentified by parameters specified.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/resourceTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "detectorId", "value": "", "type": "query", "description": "Detector type." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a single ResourceTypeCollection resource, containing a list of resource types,\nidentified by parameters specified.\n" }, { "info": { "name": "Returns a list of responder executions. A responder execution is an entity that tracks\nthe collective execution of multiple responder rule executions for a given problem.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderExecutions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "responderRuleIds", "value": "", "type": "query", "description": "Responder rule unique identifier filter for the responder executions." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Creation start time for filtering" }, { "name": "timeCreatedLessThanOrEqualTo", "value": "", "type": "query", "description": "Creation end time for filtering." }, { "name": "timeCompletedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Completion end time." }, { "name": "timeCompletedLessThanOrEqualTo", "value": "", "type": "query", "description": "Completion start time." }, { "name": "targetId", "value": "", "type": "query", "description": "The ID of the target in which to list resources." }, { "name": "resourceType", "value": "", "type": "query", "description": "Resource type associated with the resource." }, { "name": "responderType", "value": "", "type": "query", "description": "The field to list the responder executions by responder type. Valid values are REMEDIATION and NOTIFICATION.\n" }, { "name": "responderExecutionStatus", "value": "", "type": "query", "description": "The status of the responder execution in which to list responders." }, { "name": "responderExecutionMode", "value": "", "type": "query", "description": "The mode of the responder execution in which to list responders." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of responder executions. A responder execution is an entity that tracks\nthe collective execution of multiple responder rule executions for a given problem.\n" }, { "info": { "name": "Skips the execution for a bulk of responder executions.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderExecutions/actions/bulkSkip", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Skips the execution for a bulk of responder executions." }, { "info": { "name": "Returns the number of responder executions, identified by parameters specified, in a page of\nResponderExecutionAggregation resources.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderExecutions/actions/summarize", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderExecutionsDimensions", "value": "", "type": "query", "description": "The possible attributes based on which the responder executions can be distinguished." }, { "name": "responderTypeFilter", "value": "", "type": "query", "description": "The possible filters for responder type dimension to distinguish responder executions.\nIf no values are passed, the metric for responder executions of all responder types are returned.\n" }, { "name": "responderExecutionStatusFilter", "value": "", "type": "query", "description": "The possible filters for responder type dimension to distinguish responder executions.\nIf no values are passed, the metric for responder executions of all status are returned.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns the number of responder executions, identified by parameters specified, in a page of\nResponderExecutionAggregation resources.\n\nSetting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions,\ndirectly or indirectly (permissions can be on a resource in a subcompartment). “Not Authorized” is returned\nif user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED,\npermissions are checked and no partia" }, { "info": { "name": "Returns the number of remediations performed by Responders, for a given time period.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderExecutions/actions/summarizeTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "timeCompletedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Completion end time." }, { "name": "timeCompletedLessThanOrEqualTo", "value": "", "type": "query", "description": "Completion start time." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns the number of remediations performed by Responders, for a given time period.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid only when\n`compartmentIdInSubtree` is set to `true`.\n\nThe parameter `" }, { "info": { "name": "Returns a responder execution identified by responderExecutionId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderExecutions/:responderExecutionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderExecutionId", "value": "", "type": "path", "description": "The unique identifier of the responder execution." } ] }, "docs": "Returns a responder execution identified by responderExecutionId.\n" }, { "info": { "name": "Executes the responder execution. When provided, if-match is checked\nagainst etag values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderExecutions/:responderExecutionId/actions/execute", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "responderExecutionId", "value": "", "type": "path", "description": "The unique identifier of the responder execution." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Executes the responder execution. When provided, if-match is checked\nagainst etag values of the resource.\n" }, { "info": { "name": "Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderExecutions/:responderExecutionId/actions/skip", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "responderExecutionId", "value": "", "type": "path", "description": "The unique identifier of the responder execution." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ] }, "docs": "Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource." }, { "info": { "name": "Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources)\nof all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "resourceMetadataOnly", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the list of all Oracle-managed resources\nmetadata supported by Cloud Guard is returned.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources)\nof all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.\nThe ListResponderRecipe operation returns only the targets in `compartmentId` passed.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at le" }, { "info": { "name": "Creates a responder recipe (ResponderRecipe resource), from values passed in a\nCreateResponderRecipeDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a responder recipe (ResponderRecipe resource), from values passed in a\nCreateResponderRecipeDetails resource.\n" }, { "info": { "name": "Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." } ] }, "docs": "Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId." }, { "info": { "name": "Updates a responder recipe (ResponderRecipe resource) identified by\nresponderRecipeId, passed in an UpdateResponderRecipeDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a responder recipe (ResponderRecipe resource) identified by\nresponderRecipeId, passed in an UpdateResponderRecipeDetails resource.\n" }, { "info": { "name": "Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." } ] }, "docs": "Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId." }, { "info": { "name": "Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId\nin a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.\nWhen provided, if-match is checked against etag values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId\nin a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment.\nWhen provided, if-match is checked against etag values of the resource.\n" }, { "info": { "name": "Returns a list of responder rules (ResponderRule resources in a\nresponderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources),\nfor a responder recipe (ResponderRecipe resource), identified by responderRecipeId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId/responderRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of responder rules (ResponderRule resources in a\nresponderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources),\nfor a responder recipe (ResponderRecipe resource), identified by responderRecipeId.\n" }, { "info": { "name": "Returns a responder rule (ResponderRule resource) identified by responderRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId/responderRules/:responderRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." }, { "name": "responderRuleId", "value": "", "type": "path", "description": "Unique identifier of the responder rule." } ] }, "docs": "Returns a responder rule (ResponderRule resource) identified by responderRuleId." }, { "info": { "name": "Updates a responder rule (ResponderRule resource) identified by responderRuleId,\npassed in a UpdateResponderRecipeResponderRuleDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/responderRecipes/:responderRecipeId/responderRules/:responderRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRecipeId", "value": "", "type": "path", "description": "OCID of the responder recipe." }, { "name": "responderRuleId", "value": "", "type": "path", "description": "Unique identifier of the responder rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a responder rule (ResponderRule resource) identified by responderRuleId,\npassed in a UpdateResponderRecipeResponderRuleDetails resource.\n" }, { "info": { "name": "Returns a list of responder rules for the ResponderRecipe resource\nidentified by responderId. The list is contained in a ResponderRuleCollection\nresource with a page of ResponderRuleSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of responder rules for the ResponderRecipe resource\nidentified by responderId. The list is contained in a ResponderRuleCollection\nresource with a page of ResponderRuleSummary resources.\n" }, { "info": { "name": "Returns a responder rule (ResponderRule resource) identified by resonderRuleId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/responderRules/:responderRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "responderRuleId", "value": "", "type": "path", "description": "Unique identifier of the responder rule." } ] }, "docs": "Returns a responder rule (ResponderRule resource) identified by resonderRuleId." }, { "info": { "name": "Returns a page of RiskScoreAggregation resources for a compartment,\nidentified by compartmentId.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/riskScores", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a page of RiskScoreAggregation resources for a compartment,\nidentified by compartmentId.\n" }, { "info": { "name": "Returns a list of security zone policies (SecurityPolicySummary resources),\nidentified by compartmentId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "The unique identifier of the security zone policy. (`SecurityPolicy`)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of security zone policies (SecurityPolicySummary resources),\nidentified by compartmentId.\n" }, { "info": { "name": "Returns a security zone policy (SecurityPolicy resource), identified by its unique ID\n(securityPolicyId). When a policy is enabled in a security zone, then any action in\nthe zone that attempts to violate that policy is blocked.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityPolicies/:securityPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "path", "description": "The unique identifier of the security zone policy. (`SecurityPolicy`)" } ] }, "docs": "Returns a security zone policy (SecurityPolicy resource), identified by its unique ID\n(securityPolicyId). When a policy is enabled in a security zone, then any action in\nthe zone that attempts to violate that policy is blocked.\n" }, { "info": { "name": "Returns a list of security zone recipes (SecurityRecipeSummary resources) in a\ncompartment, identified by compartmentId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of security zone recipes (SecurityRecipeSummary resources) in a\ncompartment, identified by compartmentId.\n" }, { "info": { "name": "Creates a security zone recipe (SecurityRecipe resource), using parameters\npassed in a CreateSecurityRecipeDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a security zone recipe (SecurityRecipe resource), using parameters\npassed in a CreateSecurityRecipeDetails resource.\n" }, { "info": { "name": "Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityRecipes/:securityRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityRecipeId", "value": "", "type": "path", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)" } ] }, "docs": "Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId." }, { "info": { "name": "Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId,\nusing parameters passed in an UpdateSecurityRecipeDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/securityRecipes/:securityRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityRecipeId", "value": "", "type": "path", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId,\nusing parameters passed in an UpdateSecurityRecipeDetails resource.\n" }, { "info": { "name": "Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/securityRecipes/:securityRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityRecipeId", "value": "", "type": "path", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)" } ] }, "docs": "Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone." }, { "info": { "name": "Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId,\nfrom the current compartment to another compartment. When provided, `if-match` is checked\nagainst `etag` values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityRecipes/:securityRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityRecipeId", "value": "", "type": "path", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId,\nfrom the current compartment to another compartment. When provided, `if-match` is checked\nagainst `etag` values of the resource.\n" }, { "info": { "name": "Returns a page of SecurityScoreAggregation resources. These measure the number\nof resources examined across all regions and compare it with the number of problems detected.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityScores", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a page of SecurityScoreAggregation resources. These measure the number\nof resources examined across all regions and compare it with the number of problems detected.\n" }, { "info": { "name": "Returns a page of SecurityScoreTrendAggregation resources. These measure the number\nof resources examined across all regions and compare it with the number of problems detected.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityScores/actions/summarizeTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "timeScoreComputedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days." }, { "name": "timeScoreComputedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to today's current time." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a page of SecurityScoreTrendAggregation resources. These measure the number\nof resources examined across all regions and compare it with the number of problems detected.\n" }, { "info": { "name": "Returns a list of security zones (SecurityZone resources) in a compartment identified by\ncompartmentId. List is contained in a page of SecurityZoneSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityZones", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "The unique identifier of the security zone (`SecurityZone` resource)." }, { "name": "securityRecipeId", "value": "", "type": "query", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe` resource)." }, { "name": "isRequiredSecurityZonesInSubtree", "value": "", "type": "query", "description": "Is security zones in the subtree?" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of security zones (SecurityZone resources) in a compartment identified by\ncompartmentId. List is contained in a page of SecurityZoneSummary resources.\n" }, { "info": { "name": "Creates a security zone (SecurityZone resource) for a compartment. Pass parameters\nthrough a CreateSecurityZoneDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityZones", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a security zone (SecurityZone resource) for a compartment. Pass parameters\nthrough a CreateSecurityZoneDetails resource.\n" }, { "info": { "name": "Returns a security zone (SecurityZone resource) identified by securityZoneId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ] }, "docs": "Returns a security zone (SecurityZone resource) identified by securityZoneId." }, { "info": { "name": "Updates a security zone (SecurityZone resource) identified by securityZoneId.\nPass parameters through an UpdateSecurityZoneDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a security zone (SecurityZone resource) identified by securityZoneId.\nPass parameters through an UpdateSecurityZoneDetails resource.\n" }, { "info": { "name": "Deletes a security zone, identified by securityZoneId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ] }, "docs": "Deletes a security zone, identified by securityZoneId." }, { "info": { "name": "Adds a compartment to an existing security zone (SecurityZone resource), identified by\nsecurityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass.\nIf you previously removed a subcompartment from a security zone, you can add it back to the\nsame security zone. The security zone ensures that resources in the subcompartment comply with\nthe security zone's policies.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId/actions/addCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a compartment to an existing security zone (SecurityZone resource), identified by\nsecurityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass.\nIf you previously removed a subcompartment from a security zone, you can add it back to the\nsame security zone. The security zone ensures that resources in the subcompartment comply with\nthe security zone's policies.\n" }, { "info": { "name": "Moves a security zone, identified by securityZoneId, to a different compartment.\nPass parameters through a ChangeSecurityZoneCompartmentDetails resource.\nWhen provided, `if-match` is checked against `etag` values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a security zone, identified by securityZoneId, to a different compartment.\nPass parameters through a ChangeSecurityZoneCompartmentDetails resource.\nWhen provided, `if-match` is checked against `etag` values of the resource.\n" }, { "info": { "name": "Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.\nPass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a\nsubcompartment from a security zone, it no longer enforces security zone policies on the resources in the\nsubcompartment. You can't remove the primary compartment that was used to create the security zone.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/securityZones/:securityZoneId/actions/removeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityZoneId", "value": "", "type": "path", "description": "The unique identifier of the security zone (`SecurityZone` resource)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId.\nPass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a\nsubcompartment from a security zone, it no longer enforces security zone policies on the resources in the\nsubcompartment. You can't remove the primary compartment that was used to create the security zone.\n" }, { "info": { "name": "For the parameters passed, returns a list of sightings\n(SightingCollection resource) with a page of SightingSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/sightings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "problemId", "value": "", "type": "query", "description": "OCID of the problem." }, { "name": "resourceProfileId", "value": "", "type": "query", "description": "OCID of the resource profile." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" }, { "name": "timeLastDetectedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Start time for a filter. If start time is not specified, start time will be set to current time - 30 days." }, { "name": "timeLastDetectedLessThanOrEqualTo", "value": "", "type": "query", "description": "End time for a filter. If end time is not specified, end time will be set to current time." } ] }, "docs": "For the parameters passed, returns a list of sightings\n(SightingCollection resource) with a page of SightingSummary resources.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid only when\n`compartmentIdInS" }, { "info": { "name": "Returns a single sighting (Sighting resource) identified by sightingId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/sightings/:sightingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sightingId", "value": "", "type": "path", "description": "OCID of the sighting." } ] }, "docs": "Returns a single sighting (Sighting resource) identified by sightingId." }, { "info": { "name": "Updates a sighting.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/sightings/:sightingId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sightingId", "value": "", "type": "path", "description": "OCID of the sighting." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a sighting." }, { "info": { "name": "Returns a list of associated additional entities for a Cloud Guard sighting", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/sightings/:sightingId/additionalEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sightingId", "value": "", "type": "path", "description": "OCID of the sighting." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of associated additional entities for a Cloud Guard sighting" }, { "info": { "name": "Returns sighting endpoints details in a\nSightingEndpointsCollection resource\nwith a page of SightingEndpointSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/sightings/:sightingId/endpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sightingId", "value": "", "type": "path", "description": "OCID of the sighting." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns sighting endpoints details in a\nSightingEndpointsCollection resource\nwith a page of SightingEndpointSummary resources.\n" }, { "info": { "name": "Returns a list of impacted resources for a sighting, identified by sightingId, in a\nSightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/sightings/:sightingId/impactedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sightingId", "value": "", "type": "path", "description": "OCID of the sighting." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of impacted resources for a sighting, identified by sightingId, in a\nSightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.\n" }, { "info": { "name": "Returns a list of TacticSummary resources for a compartment, identified by compartmentId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/tactics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of TacticSummary resources for a compartment, identified by compartmentId." }, { "info": { "name": "Returns a list of targets (TargetCollection resources with page of TargetSummary\nresources) for the target identified by compartmentId. By default, only the target\nassociated with the compartment is returned. Setting compartmentIdInSubtree to true\nreturns the entire hierarchy of targets in subcompartments.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "isNonSecurityZoneTargetsOnlyQuery", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, only the targets that would be deleted as part of\nsecurity zone creation will be returned.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the setting of `accessLevel`.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\nWhen set to `RESTRICTED` permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of targets (TargetCollection resource with page of TargetSummary\nresources) for the target identified by compartmentId. By default, only the target\nassociated with the compartment is returned. Setting compartmentIdInSubtree to true\nreturns the entire hierarchy of targets in subcompartments.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (th" }, { "info": { "name": "Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/targets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.\n" }, { "info": { "name": "Returns a target (Target resource) identified by targetId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" } ] }, "docs": "Returns a target (Target resource) identified by targetId." }, { "info": { "name": "Updates a target (Target resource) identified by targetId, using parameters\npassed in an UpdateTargetDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/targets/:targetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a target (Target resource) identified by targetId, using parameters\npassed in an UpdateTargetDetails resource.\n" }, { "info": { "name": "Deletes a target (Target resource) identified by targetId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/targets/:targetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" } ] }, "docs": "Deletes a target (Target resource) identified by targetId." }, { "info": { "name": "Returns a list of target monitoring signals for a compartment\nidentified by compartmentId and a target identified by targetId.\nSome values are passed in a ListTargetMonitoringSignalsList resource.\nList is returned in a TargetMonitoringSignal resource.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/monitoringSignals", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "scanStatus", "value": "", "type": "query", "description": "The field scan status. Only one status can be provided. Default value for scan status is failed. If no value is specified scan status is failed." }, { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of target monitoring signals for a compartment\nidentified by compartmentId and a target identified by targetId.\nSome values are passed in a ListTargetMonitoringSignalsList resource.\n" }, { "info": { "name": "Returns a list of all target detector recipes (TargetDetectorRecipe resources)\nassociated with a target (Target resource), identified by targetId. The list is contained\nin a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of all target detector recipes (TargetDetectorRecipe resources)\nassociated with a target (Target resource), identified by targetId. The list is contained\nin a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.\n" }, { "info": { "name": "Attaches a DetectorRecipe to a target (Target resource) identified by targetId,\nusing parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches a DetectorRecipe to a target (Target resource) identified by targetId,\nusing parameters passed in a TargetAttachTargetDetectorRecipeDetails resource.\nAttach a DetectorRecipe with the Target\n" }, { "info": { "name": "Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." } ] }, "docs": "Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId." }, { "info": { "name": "Updates a target detector recipe (TargtetDetectorRecipe resource) identified by\ntargetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a target detector recipe (TargtetDetectorRecipe resource) identified by\ntargetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.\n" }, { "info": { "name": "Deletes the target detector recipe (TargetDetectorRecipe resource) identified by\ntargetDetectorRecipeId, from a target (Target resource) identified by targetId.\n", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." } ] }, "docs": "Deletes the target detector recipe (TargetDetectorRecipe resource) identified by\ntargetDetectorRecipeId, from a target (Target resource) identified by targetId.\n" }, { "info": { "name": "Returns a list of DetectorRule associated with DetectorRecipe within a Target.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId/detectorRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of DetectorRule associated with DetectorRecipe within a Target.\n" }, { "info": { "name": "Returns DetectorRule resource by identified by targetDetectorRecipeId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId/detectorRules/:detectorRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of the detector rule." } ] }, "docs": "Returns DetectorRule resource by identified by targetDetectorRecipeId." }, { "info": { "name": "Updates the DetectorRule resource identified by targetDetectorRecipeId", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/targets/:targetId/targetDetectorRecipes/:targetDetectorRecipeId/detectorRules/:detectorRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetDetectorRecipeId", "value": "", "type": "path", "description": "OCID of the target detector recipe." }, { "name": "detectorRuleId", "value": "", "type": "path", "description": "The unique identifier of the detector rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the DetectorRule resource identified by targetDetectorRecipeId" }, { "info": { "name": "Returns a list of summary information for all responder recipes\n(TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources)\nattached to a target identified by targetId, located in a compartment identified by compartmentId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of summary information for all responder recipes\n(TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources)\nattached to a target identified by targetId, located in a compartment identified by compartmentId.\n" }, { "info": { "name": "Attaches a responder recipe to a target.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches a responder recipe to a target.\n" }, { "info": { "name": "Returns a target responder recipe (TargetResponderRecipe resource), identified by\ntargetResponderRecipeId, for a target (Target resource) identified by targetId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." } ] }, "docs": "Returns a target responder recipe (TargetResponderRecipe) identified by\ntargetResponderRecipeId for a target (Target resource) identified by targetId.\n" }, { "info": { "name": "Updates the target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, attached to a target identified\nby targetId. Pass parameters for the update through an\nUpdateTargetResponderRecipeDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, attached to a target identified\nby targetId. Pass parameters for the update through an\nUpdateTargetResponderRecipeDetails resource.\n" }, { "info": { "name": "Detaches a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, from a target (Target resource)\nidentified by targetId.\n", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." } ] }, "docs": "Detaches a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, from a target (Target resource)\nidentified by targetId.\n" }, { "info": { "name": "Returns a list of responder rules (ResponderRule resources) associated with a\nresponder recipe (ResponderRecipe resource) attached to a Target.\nList is returned in a TargetResponderRecipeResponderRuleCollection resource\nwith page of TargetResponderRecipeResponderRuleSummary resources.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId/responderRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of responder rules (ResponderRule resources) associated with a\nresponder recipe (ResponderRecipe resource) attached to a Target.\nList is returned in a TargetResponderRecipeResponderRuleCollection resource\nwith page of TargetResponderRecipeResponderRuleSummary resources.\n" }, { "info": { "name": "Returns a responder rule (ResponderRule resource) identified by\nresponderRuleId, from a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, attached to a target (Target resource)\nidentified by targetId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId/responderRules/:responderRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." }, { "name": "responderRuleId", "value": "", "type": "path", "description": "Unique identifier of the responder rule." } ] }, "docs": "Returns a responder rule (ResponderRule resource) identified by\nresponderRuleId, from a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, attached to a target (Target resource)\nidentified by targetId.\n" }, { "info": { "name": "Updates a responder rule (ResponderRule resource) identified by\nresponderRuleId, for a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, for a target (Target resource)\nidentified by targetId. Parameters for the update are passed through an\nUpdateTargetResponderRecipeResponderRuleDetails resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200131/targets/:targetId/targetResponderRecipes/:targetResponderRecipeId/responderRules/:responderRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetId", "value": "", "type": "path", "description": "OCID of the target" }, { "name": "targetResponderRecipeId", "value": "", "type": "path", "description": "OCID of the target responder recipe." }, { "name": "responderRuleId", "value": "", "type": "path", "description": "Unique identifier of the responder rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a responder rule (ResponderRule resource) identified by\nresponderRuleId, for a target responder recipe (TargetResponderRecipe resource)\nidentified by targetResponderRecipeId, for a target (Target resource)\nidentified by targetId. Parameters for the update are passed through an\nUpdateTargetResponderRecipeResponderRuleDetails resource.\n" }, { "info": { "name": "Returns a list of techniques associated with detector rules.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/techniques", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "tactics", "value": "", "type": "query", "description": "A filter to return only resources that match the list of tactics given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Returns a list of techniques associated with detector rules.\n" }, { "info": { "name": "Returns a list of work requests (WorkRequestSummaryCollection resource),\nin a compartment identified by compartmentId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given operation status (OperationStatus resource)." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending." } ] }, "docs": "Returns a list of work requests (WorkRequestSummaryCollection resource),\nin a compartment identified by compartmentId.\n" }, { "info": { "name": "Returns details for a work request (WorkRequest resource) identified by workRequestId.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Returns details for a work request (WorkRequest resource) identified by workRequestId." }, { "info": { "name": "Cancels a work request identified by workRequestId.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200131/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancels a work request identified by workRequestId." }, { "info": { "name": "Returns a list of errors for a work request \nidentified by workRequestId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" } ] }, "docs": "Returns a list of errors for a work request \nidentified by workRequestId.\n" }, { "info": { "name": "Returns a paginated list (WorkRequestLogEntryCollection resource)\nof log entries for a request, identified by workRequestId.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200131/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use" } ] }, "docs": "Returns a paginated list (WorkRequestLogEntryCollection resource)\nof log entries for a request, identified by workRequestId.\n" } ] } ], "bundled": true }