{ "opencollection": "1.0.0", "info": { "name": "Scanning Vulnerability Scanning API", "version": "20210215" }, "items": [ { "info": { "name": "vulnerabilityScanning", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all ContainerScanRecipes in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "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": "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, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order for timeCreated is descending. The default sort order for displayName is ascending. If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Retrieves a list of ContainerScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned.\n" }, { "info": { "name": "Creates a new ContainerScanRecipe", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/containerScanRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new ContainerScanRecipe. A recipe determines the types of security issues that you want scanned.\n" }, { "info": { "name": "Retrieves a ContainerScanRecipe", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanRecipes/:containerScanRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanRecipeId", "value": "", "type": "path", "description": "unique ContainerScanRecipe identifier" } ] }, "docs": "Retrieves a ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned.\n" }, { "info": { "name": "Updates the ContainerScanRecipe", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210215/containerScanRecipes/:containerScanRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanRecipeId", "value": "", "type": "path", "description": "unique ContainerScanRecipe identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned.\n" }, { "info": { "name": "Deletes an existing ContainerScanRecipe", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/containerScanRecipes/:containerScanRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanRecipeId", "value": "", "type": "path", "description": "unique ContainerScanRecipe identifier" } ] }, "docs": "Deletes the ContainerScanRecipe identified by the recipe ID.\n" }, { "info": { "name": "Moves a ContainerScanRecipe into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/containerScanRecipes/:containerScanRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "containerScanRecipeId", "value": "", "type": "path", "description": "unique ContainerScanRecipe identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a ContainerScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists container scan results", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "repository", "value": "", "type": "query", "description": "Repository name" }, { "name": "image", "value": "", "type": "query", "description": "Image name" }, { "name": "areSubcompartmentsIncluded", "value": "", "type": "query", "description": "When listing with one or more filters, whether to include subcompartments for the compartmentId being listed for. Does nothing if no filters are present in the query." }, { "name": "highestProblemSeverity", "value": "", "type": "query", "description": "The parameter to filter by highestProblemSeverity for scan results." }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default.\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": "isLatestOnly", "value": "", "type": "query", "description": "A flag to return only the latest scan result of an instance." } ] }, "docs": "Retrieves a list of ContainerScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A container scan result includes a list of problems detected in a specific image in a Docker repository.\n" }, { "info": { "name": "Gets the results of a container scan", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanResults/:containerScanResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanResultId", "value": "", "type": "path", "description": "unique container scan identifier" } ] }, "docs": "Retrieves a ContainerScanResult identified by the container scan ID. The result includes a list of problems found in a specific image in a Docker repository.\n" }, { "info": { "name": "Deletes an existing container scan result", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/containerScanResults/:containerScanResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanResultId", "value": "", "type": "path", "description": "unique container scan identifier" } ] }, "docs": "Deletes the ContainerScanResult identified by the container scan ID.\n" }, { "info": { "name": "Moves a ContainerScanResult into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/containerScanResults/:containerScanResultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "containerScanResultId", "value": "", "type": "path", "description": "unique container scan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a ContainerScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Gets a list of all ContainerScanTargets in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanTargets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "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": "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, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order for timeCreated is descending. The default sort order for displayName is ascending. If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Retrieves a list of ContainerScanTargetSummary objects in a compartment. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Creates a new ContainerScanTarget", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/containerScanTargets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new ContainerScanTarget. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Gets a ContainerScanTarget", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/containerScanTargets/:containerScanTargetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanTargetId", "value": "", "type": "path", "description": "unique ContainerScanTarget identifier" } ] }, "docs": "Gets a ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Updates a ContainerScanTarget", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210215/containerScanTargets/:containerScanTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanTargetId", "value": "", "type": "path", "description": "unique ContainerScanTarget identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Deletes a ContainerScanTarget", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/containerScanTargets/:containerScanTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerScanTargetId", "value": "", "type": "path", "description": "unique ContainerScanTarget identifier" } ] }, "docs": "Deletes the ContainerScanTarget identified by the target ID.\n" }, { "info": { "name": "Moves a ContainerScanTarget into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/containerScanTargets/:containerScanTargetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "containerScanTargetId", "value": "", "type": "path", "description": "unique ContainerScanTarget identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a ContainerScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists host agent scan results.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostAgentScanResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "instanceId", "value": "", "type": "query", "description": "The ID of a compute instance." }, { "name": "highestProblemSeverity", "value": "", "type": "query", "description": "The parameter to filter by highestProblemSeverity for scan results." }, { "name": "operatingSystem", "value": "", "type": "query", "description": "Parameter to filter by operating system for scan results" }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default.\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": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "isLatestOnly", "value": "", "type": "query", "description": "A flag to return only the latest scan result of an instance." } ] }, "docs": "Retrieves a list of HostAgentScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. An agent scan result includes a list of CVEs detected in a specific compute instance.\n" }, { "info": { "name": "Gets the full list of HostAgentScanResultSummary objects as a CSV string.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostAgentScanResults/actions/exportCsv", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports a list of HostAgentScanResultSummary objects within a compartment and during a specified time range in CSV format. You can filter the results by problem severity.\n" }, { "info": { "name": "Gets the results of a host agent scan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostAgentScanResults/:hostAgentScanResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostAgentScanResultId", "value": "", "type": "path", "description": "unique host agent scan identifier" } ] }, "docs": "Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a list of CVEs detected in a specific compute instance.\n" }, { "info": { "name": "Deletes an existing host agent scan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostAgentScanResults/:hostAgentScanResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostAgentScanResultId", "value": "", "type": "path", "description": "unique host agent scan identifier" } ] }, "docs": "Deletes the HostAgentScanResult identified by the host agent scan ID.\n" }, { "info": { "name": "Moves a HostAgentScanResult into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostAgentScanResults/:hostAgentScanResultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostAgentScanResultId", "value": "", "type": "path", "description": "unique host agent scan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostAgentScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists the host CIS benchmark scan results.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostCisBenchmarkScanResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "instanceId", "value": "", "type": "query", "description": "The ID of a compute instance." }, { "name": "highestProblemSeverity", "value": "", "type": "query", "description": "The parameter to filter by highestProblemSeverity for scan results." }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default.\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": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "isLatestOnly", "value": "", "type": "query", "description": "A flag to return only the latest scan result of an instance." } ] }, "docs": "Retrieves a list of HostCisBenchmarkScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A CIS (Center for Internet Security) benchmark scan result includes the number of failed benchmark tests on a specific compute instance.\n" }, { "info": { "name": "Gets the results of a host CIS benchmark scan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostCisBenchmarkScanResults/:hostCisBenchmarkScanResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostCisBenchmarkScanResultId", "value": "", "type": "path", "description": "unique host Cis benchmark scan identifier" } ] }, "docs": "Retrieves a HostCisBenchmarkScanResult identified by the benchmark scan result ID. A CIS (Center for Internet Security) benchmark scan result includes a list of benchmarks that were tested on a specific compute instance, and whether each test passed or failed.\n" }, { "info": { "name": "Deletes an existing host CIS benchmark scan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostCisBenchmarkScanResults/:hostCisBenchmarkScanResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostCisBenchmarkScanResultId", "value": "", "type": "path", "description": "unique host Cis benchmark scan identifier" } ] }, "docs": "Deletes the HostCisBenchmarkScanResult identified by the benchmark scan result ID.\n" }, { "info": { "name": "Moves a HostCisBenchmarkScanResult into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostCisBenchmarkScanResults/:hostCisBenchmarkScanResultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostCisBenchmarkScanResultId", "value": "", "type": "path", "description": "unique host Cis benchmark scan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostCisBenchmarkScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists host Endpoint Protection scan results.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostEndpointProtectionScanResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "instanceId", "value": "", "type": "query", "description": "The ID of a compute instance." }, { "name": "highestProblemSeverity", "value": "", "type": "query", "description": "The parameter to filter by highestProblemSeverity for scan results." }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default.\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": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "isLatestOnly", "value": "", "type": "query", "description": "A flag to return only the latest scan result of an instance." } ] }, "docs": "Returns a collection of HostEndpointProtectionScanResultSummary objects.\n" }, { "info": { "name": "Gets the results of a host endpoint protection scan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostEndpointProtectionScanResults/:hostEndpointProtectionScanResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostEndpointProtectionScanResultId", "value": "", "type": "path", "description": "unique host endpoint protection scan identifier" } ] }, "docs": "Returns HostEndpointProtectionScanResults for the given host endpoint protection scan result ID.\n" }, { "info": { "name": "Deletes an existing host EndpointProtection scan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostEndpointProtectionScanResults/:hostEndpointProtectionScanResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostEndpointProtectionScanResultId", "value": "", "type": "path", "description": "unique host endpoint protection scan identifier" } ] }, "docs": "Deletes the HostEndpointProtectionScanResult identified by the ID.\n" }, { "info": { "name": "Moves a HostEndpointProtectionScanResult into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostEndpointProtectionScanResults/:hostEndpointProtectionScanResultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostEndpointProtectionScanResultId", "value": "", "type": "path", "description": "unique host endpoint protection scan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostEndpointProtectionScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists the host port scan results.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostPortScanResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "instanceId", "value": "", "type": "query", "description": "The ID of a compute instance." }, { "name": "highestProblemSeverity", "value": "", "type": "query", "description": "The parameter to filter by highestProblemSeverity for scan results." }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "description": "Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default.\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": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "isLatestOnly", "value": "", "type": "query", "description": "A flag to return only the latest scan result of an instance." } ] }, "docs": "Retrieves a list of HostPortScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A port scan result includes a list of open ports that were detected in a specific compute instance.\n" }, { "info": { "name": "Gets the results of a host port scan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostPortScanResults/:hostPortScanResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostPortScanResultId", "value": "", "type": "path", "description": "unique host port scan identifier" } ] }, "docs": "Retrieves a HostPortScanResult identified by the host port scan ID. The result includes a list of open ports that were detected in a specific compute instance.\n" }, { "info": { "name": "Deletes an existing host port scan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostPortScanResults/:hostPortScanResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostPortScanResultId", "value": "", "type": "path", "description": "unique host port scan identifier" } ] }, "docs": "Deletes the HostPortScanResult identified by the host port scan ID.\n" }, { "info": { "name": "Moves a HostPortScanResult into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostPortScanResults/:hostPortScanResultId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostPortScanResultId", "value": "", "type": "path", "description": "unique host port scan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostPortScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Gets a list of all HostScanRecipes in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostScanRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "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": "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, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order for timeCreated is descending. The default sort order for displayName is ascending. If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Retrieves a list of HostScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues.\n" }, { "info": { "name": "Creates a new HostScanRecipe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostScanRecipes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues.\n" }, { "info": { "name": "Retrieves a HostScanRecipe.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostScanRecipes/:hostScanRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanRecipeId", "value": "", "type": "path", "description": "unique HostScanRecipe identifier" } ] }, "docs": "Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues.\n" }, { "info": { "name": "Updates the HostScanRecipe.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210215/hostScanRecipes/:hostScanRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanRecipeId", "value": "", "type": "path", "description": "unique HostScanRecipe identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues.\n" }, { "info": { "name": "Deletes the HostScanRecipe.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostScanRecipes/:hostScanRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanRecipeId", "value": "", "type": "path", "description": "unique HostScanRecipe identifier" } ] }, "docs": "Deletes the HostScanRecipe identified by the recipe ID.\n" }, { "info": { "name": "Moves a HostScanRecipe into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostScanRecipes/:hostScanRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostScanRecipeId", "value": "", "type": "path", "description": "unique HostScanRecipe identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Gets a list of all HostScanTargets in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostScanTargets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "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": "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, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order for timeCreated is descending. The default sort order for displayName is ascending. If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Retrieves a list of HostScanTargetSummary objects in a compartment. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Creates a new HostScanTarget.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostScanTargets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new HostScanTarget. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Gets a HostScanTarget.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostScanTargets/:hostScanTargetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanTargetId", "value": "", "type": "path", "description": "unique HostScanTarget identifier" } ] }, "docs": "Retrieves a HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Updates a HostScanTarget.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210215/hostScanTargets/:hostScanTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanTargetId", "value": "", "type": "path", "description": "unique HostScanTarget identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Deletes a HostScanTarget.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210215/hostScanTargets/:hostScanTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostScanTargetId", "value": "", "type": "path", "description": "unique HostScanTarget identifier" } ] }, "docs": "Deletes the HostScanTarget identified by the target ID.\n" }, { "info": { "name": "Moves a HostScanTarget into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostScanTargets/:hostScanTargetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostScanTargetId", "value": "", "type": "path", "description": "unique HostScanTarget identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Lists HostScanTarget errors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostScanTargets/:hostScanTargetId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "name": "hostScanTargetId", "value": "", "type": "path", "description": "unique HostScanTarget identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order for timeUpdated is descending. If no value is specified, timeUpdated is the default.\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": "Retrieves a list of errors during scanning on instances associated with HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.\n" }, { "info": { "name": "Lists host vulnerabilities.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostVulnerabilities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to 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": "severity", "value": "", "type": "query", "description": "A filter to return only resources that have a severity that matches the given severity." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "cveReference", "value": "", "type": "query", "description": "Parameter to filter by CVE reference number for vulnerabilities" }, { "name": "vulnerabilityType", "value": "", "type": "query", "description": "The field to filter vulnerabilities based on its type. Only one value can be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for 'name' is Ascending. Default order for other values is descending. If no value is specified name is default.\n" } ] }, "docs": "Retrieves a list of HostVulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time. A host vulnerability describes a security issue that was detected in scans of one or more compute instances.\n" }, { "info": { "name": "Gets the full list of HostVulnerabilitySummary objects as a CSV string.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210215/hostVulnerabilities/actions/exportCsv", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports a list of HostVulnerabilitySummary objects in a compartment in CSV format.\n" }, { "info": { "name": "Gets the details on a host vulnerability.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostVulnerabilities/:hostVulnerabilityId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostVulnerabilityId", "value": "", "type": "path", "description": "unique host scan vulnerability identifier" } ] }, "docs": "Retrieves a HostVulnerability identified by the host vulnerability ID. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories.\n" }, { "info": { "name": "Lists the impacted hosts.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/hostVulnerabilities/:hostVulnerabilityId/impactedHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostVulnerabilityId", "value": "", "type": "path", "description": "unique host scan vulnerability identifier" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order is ascending. If no value is specified, instanceId is the default.\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": "Retrieves a list of HostVulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected.\n" }, { "info": { "name": "List vulnerabilities", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/vulnerabilities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to 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": "severity", "value": "", "type": "query", "description": "A filter to return only resources that have a severity that matches the given severity." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "vulnerabilityReference", "value": "", "type": "query", "description": "Parameter to filter the vulnerability type's unique identifier. For CVE, this is the MITRE CVE ID" }, { "name": "vulnerabilityType", "value": "", "type": "query", "description": "The field to filter vulnerabilities based on its type. Only one value can be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for 'name' is Ascending. Default order for other values is descending. If no value is specified name is default.\n" } ] }, "docs": "Retrieves a list of VulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time and type. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container images.\n" }, { "info": { "name": "Get the details on a vulnerability", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/vulnerabilities/:vulnerabilityId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityId", "value": "", "type": "path", "description": "unique vulnerability identifier" } ] }, "docs": "Retrieves a Vulnerability identified by the vulnerability ID. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container scan repositories. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories.\n" }, { "info": { "name": "List impacted container images", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/vulnerabilities/:vulnerabilityId/impactedContainers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityId", "value": "", "type": "path", "description": "unique vulnerability identifier" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "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": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order is Ascending. If no value is specified image name is default.\n" } ] }, "docs": "Retrieves a list of VulnerabilityImpactedContainerSummary objects for a specific vulnerability ID. An impacted container image summary identifies container images on which the specified vulnerability was detected.\n" }, { "info": { "name": "List impacted hosts", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/vulnerabilities/:vulnerabilityId/impactedHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityId", "value": "", "type": "path", "description": "unique vulnerability identifier" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default sort order is ascending. If no value is specified, instanceId is the default.\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": "Retrieves a list of VulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment which contains the resources to list." }, { "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." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID.\n" }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/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." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210215/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." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }