Vulnerability Scanning Functions
Package: DBMS_CLOUD_OCI_VS_VULNERABILITY_SCANNING
CHANGE_CONTAINER_SCAN_RECIPE_COMPARTMENT Function
Moves a ContainerScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_container_scan_recipe_compartment (
container_scan_recipe_id varchar2,
change_container_scan_recipe_compartment_details dbms_cloud_oci_vulnerability_scanning_change_container_scan_recipe_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_container_scan_recipe_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanRecipe identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CONTAINER_SCAN_RESULT_COMPARTMENT Function
Moves a ContainerScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_container_scan_result_compartment (
container_scan_result_id varchar2,
change_container_scan_result_compartment_details dbms_cloud_oci_vulnerability_scanning_change_container_scan_result_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_container_scan_result_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique container scan identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CONTAINER_SCAN_TARGET_COMPARTMENT Function
Moves a ContainerScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_container_scan_target_compartment (
container_scan_target_id varchar2,
change_container_scan_target_compartment_details dbms_cloud_oci_vulnerability_scanning_change_container_scan_target_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_container_scan_target_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanTarget identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_AGENT_SCAN_RESULT_COMPARTMENT Function
Moves a HostAgentScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_agent_scan_result_compartment (
host_agent_scan_result_id varchar2,
change_host_agent_scan_result_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_agent_scan_result_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_agent_scan_result_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host agent scan identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_CIS_BENCHMARK_SCAN_RESULT_COMPARTMENT Function
Moves a HostCisBenchmarkScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_cis_benchmark_scan_result_compartment (
host_cis_benchmark_scan_result_id varchar2,
change_host_cis_benchmark_scan_result_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_cis_benchmark_scan_result_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_cis_benchmark_scan_result_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host Cis benchmark scan identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_ENDPOINT_PROTECTION_SCAN_RESULT_COMPARTMENT Function
Moves a HostEndpointProtectionScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_endpoint_protection_scan_result_compartment (
host_endpoint_protection_scan_result_id varchar2,
change_host_endpoint_protection_scan_result_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_endpoint_protection_scan_result_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_endpoint_protection_scan_result_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host endpoint protection scan identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_PORT_SCAN_RESULT_COMPARTMENT Function
Moves a HostPortScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_port_scan_result_compartment (
host_port_scan_result_id varchar2,
change_host_port_scan_result_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_port_scan_result_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_port_scan_result_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host port scan identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_SCAN_RECIPE_COMPARTMENT Function
Moves a HostScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_scan_recipe_compartment (
host_scan_recipe_id varchar2,
change_host_scan_recipe_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_scan_recipe_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_scan_recipe_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanRecipe identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_HOST_SCAN_TARGET_COMPARTMENT Function
Moves a HostScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_host_scan_target_compartment (
host_scan_target_id varchar2,
change_host_scan_target_compartment_details dbms_cloud_oci_vulnerability_scanning_change_host_scan_target_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_change_host_scan_target_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanTarget identifier |
|
(required) The compartment information to update. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CONTAINER_SCAN_RECIPE Function
Creates a new ContainerScanRecipe. A recipe determines the types of security issues that you want scanned.
Syntax
FUNCTION create_container_scan_recipe (
create_container_scan_recipe_details dbms_cloud_oci_vulnerability_scanning_create_container_scan_recipe_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_create_container_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new ContainerScanRecipe |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CONTAINER_SCAN_TARGET Function
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.
Syntax
FUNCTION create_container_scan_target (
create_container_scan_target_details dbms_cloud_oci_vulnerability_scanning_create_container_scan_target_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_create_container_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new ContainerScanTarget |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_HOST_SCAN_RECIPE Function
Creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan.
Syntax
FUNCTION create_host_scan_recipe (
create_host_scan_recipe_details dbms_cloud_oci_vulnerability_scanning_create_host_scan_recipe_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_create_host_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new HostScanRecipe |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_HOST_SCAN_TARGET Function
Creates a new HostScanTarget. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.
Syntax
FUNCTION create_host_scan_target (
create_host_scan_target_details dbms_cloud_oci_vulnerability_scanning_create_host_scan_target_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_create_host_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new HostScanTarget |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CONTAINER_SCAN_RECIPE Function
Deletes the ContainerScanRecipe identified by the recipe ID.
Syntax
FUNCTION delete_container_scan_recipe (
container_scan_recipe_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_container_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanRecipe identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CONTAINER_SCAN_RESULT Function
Deletes the ContainerScanResult identified by the container scan ID.
Syntax
FUNCTION delete_container_scan_result (
container_scan_result_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_container_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique container scan identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CONTAINER_SCAN_TARGET Function
Deletes the ContainerScanTarget identified by the target ID.
Syntax
FUNCTION delete_container_scan_target (
container_scan_target_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_container_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanTarget identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_AGENT_SCAN_RESULT Function
Deletes the HostAgentScanResult identified by the host agent scan ID.
Syntax
FUNCTION delete_host_agent_scan_result (
host_agent_scan_result_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_agent_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host agent scan identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_CIS_BENCHMARK_SCAN_RESULT Function
Deletes the HostCisBenchmarkScanResult identified by the benchmark scan result ID.
Syntax
FUNCTION delete_host_cis_benchmark_scan_result (
host_cis_benchmark_scan_result_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_cis_benchmark_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host Cis benchmark scan identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_ENDPOINT_PROTECTION_SCAN_RESULT Function
Deletes the HostEndpointProtectionScanResult identified by the id
Syntax
FUNCTION delete_host_endpoint_protection_scan_result (
host_endpoint_protection_scan_result_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_endpoint_protection_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host endpoint protection scan identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_PORT_SCAN_RESULT Function
Deletes the HostPortScanResult identified by the host port scan ID.
Syntax
FUNCTION delete_host_port_scan_result (
host_port_scan_result_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_port_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host port scan identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_SCAN_RECIPE Function
Deletes the HostScanRecipe identified by the recipe ID.
Syntax
FUNCTION delete_host_scan_recipe (
host_scan_recipe_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanRecipe identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_HOST_SCAN_TARGET Function
Deletes the HostScanTarget identified by the target ID.
Syntax
FUNCTION delete_host_scan_target (
host_scan_target_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_delete_host_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanTarget identifier |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
EXPORT_HOST_AGENT_SCAN_RESULT_CSV Function
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.
Syntax
FUNCTION export_host_agent_scan_result_csv (
export_host_agent_scan_result_csv_details dbms_cloud_oci_vulnerability_scanning_export_host_agent_scan_result_csv_details_t,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_export_host_agent_scan_result_csv_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Information on which scan results to export to CSV |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
EXPORT_HOST_VULNERABILITY_CSV Function
Exports a list of HostVulnerabilitySummary objects in a compartment in CSV format.
Syntax
FUNCTION export_host_vulnerability_csv (
export_host_vulnerability_csv_details dbms_cloud_oci_vulnerability_scanning_export_host_vulnerability_csv_details_t,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_export_host_vulnerability_csv_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Information on which scan results to export to CSV |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONTAINER_SCAN_RECIPE Function
Retrieves a ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned.
Syntax
FUNCTION get_container_scan_recipe (
container_scan_recipe_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_container_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanRecipe identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONTAINER_SCAN_RESULT Function
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.
Syntax
FUNCTION get_container_scan_result (
container_scan_result_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_container_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique container scan identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONTAINER_SCAN_TARGET Function
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.
Syntax
FUNCTION get_container_scan_target (
container_scan_target_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_container_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanTarget identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_AGENT_SCAN_RESULT Function
Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a list of CVEs detected in a specific compute instance.
Syntax
FUNCTION get_host_agent_scan_result (
host_agent_scan_result_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_agent_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host agent scan identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_CIS_BENCHMARK_SCAN_RESULT Function
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.
Syntax
FUNCTION get_host_cis_benchmark_scan_result (
host_cis_benchmark_scan_result_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_cis_benchmark_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host Cis benchmark scan identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_ENDPOINT_PROTECTION_SCAN_RESULT Function
Returns HostEndpointProtectionScanResults for the given host endpoint protection scan result ID.
Syntax
FUNCTION get_host_endpoint_protection_scan_result (
host_endpoint_protection_scan_result_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_endpoint_protection_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host endpoint protection scan identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_PORT_SCAN_RESULT Function
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.
Syntax
FUNCTION get_host_port_scan_result (
host_port_scan_result_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_port_scan_result_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host port scan identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_SCAN_RECIPE Function
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.
Syntax
FUNCTION get_host_scan_recipe (
host_scan_recipe_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanRecipe identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_SCAN_TARGET Function
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.
Syntax
FUNCTION get_host_scan_target (
host_scan_target_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanTarget identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_HOST_VULNERABILITY Function
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.
Syntax
FUNCTION get_host_vulnerability (
host_vulnerability_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_host_vulnerability_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host scan vulnerability identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VULNERABILITY Function
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.
Syntax
FUNCTION get_vulnerability (
vulnerability_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_vulnerability_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique vulnerability identifier |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_WORK_REQUEST Function
Gets the status of the work request with the given ID.
Syntax
FUNCTION get_work_request (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_get_work_request_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CONTAINER_SCAN_RECIPES Function
Retrieves a list of ContainerScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned.
Syntax
FUNCTION list_container_scan_recipes (
compartment_id varchar2,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_container_scan_recipes_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CONTAINER_SCAN_RESULTS Function
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.
Syntax
FUNCTION list_container_scan_results (
compartment_id varchar2,
repository varchar2 DEFAULT NULL,
image varchar2 DEFAULT NULL,
are_subcompartments_included number DEFAULT NULL,
highest_problem_severity varchar2 DEFAULT NULL,
time_started_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
time_started_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
is_latest_only number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_container_scan_results_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) Repository name |
|
(optional) Image name |
|
(optional) 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. |
|
(optional) Parameter to filter by highestProblemSeverity for scan results Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) Date and time on or after which scans were started, as described in RFC 3339 |
|
(optional) Date and time on or before which scans were started, as described in RFC 3339 |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default. Allowed values are: 'timeStarted', 'problemCount', 'highestProblemSeverity' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) A flag to return only the latest scan result of an instance. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CONTAINER_SCAN_TARGETS Function
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.
Syntax
FUNCTION list_container_scan_targets (
compartment_id varchar2,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_container_scan_targets_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_AGENT_SCAN_RESULTS Function
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.
Syntax
FUNCTION list_host_agent_scan_results (
compartment_id varchar2,
instance_id varchar2 DEFAULT NULL,
highest_problem_severity varchar2 DEFAULT NULL,
operating_system varchar2 DEFAULT NULL,
time_started_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
time_started_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
is_latest_only number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_agent_scan_results_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of a compute instance |
|
(optional) Parameter to filter by highestProblemSeverity for scan results Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) Parameter to filter by operating system for scan results |
|
(optional) Date and time on or after which scans were started, as described in RFC 3339 |
|
(optional) Date and time on or before which scans were started, as described in RFC 3339 |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default. Allowed values are: 'timeStarted', 'timeFinished', 'problemCount', 'highestProblemSeverity', 'timeCompleted' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) A flag to return only the latest scan result of an instance. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_CIS_BENCHMARK_SCAN_RESULTS Function
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.
Syntax
FUNCTION list_host_cis_benchmark_scan_results (
compartment_id varchar2,
instance_id varchar2 DEFAULT NULL,
highest_problem_severity varchar2 DEFAULT NULL,
time_started_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
time_started_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
is_latest_only number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_cis_benchmark_scan_results_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of a compute instance |
|
(optional) Parameter to filter by highestProblemSeverity for scan results Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) Date and time on or after which scans were started, as described in RFC 3339 |
|
(optional) Date and time on or before which scans were started, as described in RFC 3339 |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. Allowed values are: 'timeStarted', 'timeFinished', 'cisBenchmarkScanIssuesCount' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) A flag to return only the latest scan result of an instance. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_ENDPOINT_PROTECTION_SCAN_RESULTS Function
Returns a collection of HostEndpointProtectionScanResultSummary objects
Syntax
FUNCTION list_host_endpoint_protection_scan_results (
compartment_id varchar2,
instance_id varchar2 DEFAULT NULL,
highest_problem_severity varchar2 DEFAULT NULL,
time_started_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
time_started_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
is_latest_only number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_endpoint_protection_scan_results_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of a compute instance |
|
(optional) Parameter to filter by highestProblemSeverity for scan results Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) Date and time on or after which scans were started, as described in RFC 3339 |
|
(optional) Date and time on or before which scans were started, as described in RFC 3339 |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. Allowed values are: 'timeStarted', 'timeFinished', 'problemSeverity' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) A flag to return only the latest scan result of an instance. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_PORT_SCAN_RESULTS Function
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.
Syntax
FUNCTION list_host_port_scan_results (
compartment_id varchar2,
instance_id varchar2 DEFAULT NULL,
highest_problem_severity varchar2 DEFAULT NULL,
time_started_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
time_started_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
is_latest_only number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_port_scan_results_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of a compute instance |
|
(optional) Parameter to filter by highestProblemSeverity for scan results Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) Date and time on or after which scans were started, as described in RFC 3339 |
|
(optional) Date and time on or before which scans were started, as described in RFC 3339 |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. Allowed values are: 'timeStarted', 'timeFinished', 'openPortCount', 'highestProblemSeverity', 'timeCompleted' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) A flag to return only the latest scan result of an instance. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_SCAN_RECIPES Function
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.
Syntax
FUNCTION list_host_scan_recipes (
compartment_id varchar2,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_scan_recipes_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_SCAN_TARGET_ERRORS Function
Retrieves list of errors during scanning on instances associated with HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities.
Syntax
FUNCTION list_host_scan_target_errors (
compartment_id varchar2,
host_scan_target_id varchar2,
lifecycle_state varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_scan_target_errors_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(required) unique HostScanTarget identifier |
|
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. If no value is specified timeUpdated is default. Allowed values are: 'timeUpdated' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_SCAN_TARGETS Function
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.
Syntax
FUNCTION list_host_scan_targets (
compartment_id varchar2,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_scan_targets_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A filter to return only resources that match the entire display name given. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_VULNERABILITIES Function
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.
Syntax
FUNCTION list_host_vulnerabilities (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
severity varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
cve_reference varchar2 DEFAULT NULL,
vulnerability_type varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_vulnerabilities_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) A filter to return only resources that have a severity that matches the given severity Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) Parameter to filter by CVE reference number for vulnerabilities |
|
(optional) The field to filter vulnerabilities based on its type. Only one value can be provided. Allowed values are: 'CVE', 'PROBLEM' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'name', 'severity', 'impactedHosts', 'firstDetected', 'lastDetected' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_HOST_VULNERABILITY_IMPACTED_HOSTS Function
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.
Syntax
FUNCTION list_host_vulnerability_impacted_hosts (
host_vulnerability_id varchar2,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_host_vulnerability_impacted_hosts_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique host scan vulnerability identifier |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is Ascending. If no value is specified instanceId is default. Allowed values are: 'instanceId' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VULNERABILITIES Function
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.
Syntax
FUNCTION list_vulnerabilities (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
severity varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
vulnerability_reference varchar2 DEFAULT NULL,
vulnerability_type varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_vulnerabilities_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) A filter to return only resources that have a severity that matches the given severity Allowed values are: 'NONE', 'LOW', 'MEDIUM', 'HIGH', 'CRITICAL' |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) Parameter to filter the vulnerability type's unique identifier. For CVE, this is the MITRE CVE ID |
|
(optional) The field to filter vulnerabilities based on its type. Only one value can be provided. Allowed values are: 'CVE', 'PROBLEM' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) 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. Allowed values are: 'name', 'severity', 'firstDetected', 'lastDetected', 'impactedHosts', 'impactedContainers', 'impactedResources' |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VULNERABILITY_IMPACTED_CONTAINERS Function
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.
Syntax
FUNCTION list_vulnerability_impacted_containers (
vulnerability_id varchar2,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_vulnerability_impacted_containers_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique vulnerability identifier |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) 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. Allowed values are: 'image', 'repository', 'registry' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VULNERABILITY_IMPACTED_HOSTS Function
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.
Syntax
FUNCTION list_vulnerability_impacted_hosts (
vulnerability_id varchar2,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_vulnerability_impacted_hosts_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique vulnerability identifier |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order is Ascending. If no value is specified instanceId is default. Allowed values are: 'instanceId' |
|
(optional) The maximum number of items to return. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_ERRORS Function
Return a (paginated) list of errors for a given work request.
Syntax
FUNCTION list_work_request_errors (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_work_request_errors_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_LOGS Function
Return a (paginated) list of logs for a given work request.
Syntax
FUNCTION list_work_request_logs (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_work_request_logs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUESTS Function
Lists the work requests in a compartment.
Syntax
FUNCTION list_work_requests (
compartment_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_list_work_requests_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The client request ID for tracing. |
|
(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CONTAINER_SCAN_RECIPE Function
Updates the ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned.
Syntax
FUNCTION update_container_scan_recipe (
container_scan_recipe_id varchar2,
update_container_scan_recipe_details dbms_cloud_oci_vulnerability_scanning_update_container_scan_recipe_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_update_container_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanRecipe identifier |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CONTAINER_SCAN_TARGET Function
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.
Syntax
FUNCTION update_container_scan_target (
container_scan_target_id varchar2,
update_container_scan_target_details dbms_cloud_oci_vulnerability_scanning_update_container_scan_target_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_update_container_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique ContainerScanTarget identifier |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_HOST_SCAN_RECIPE Function
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.
Syntax
FUNCTION update_host_scan_recipe (
host_scan_recipe_id varchar2,
update_host_scan_recipe_details dbms_cloud_oci_vulnerability_scanning_update_host_scan_recipe_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_update_host_scan_recipe_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanRecipe identifier |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_HOST_SCAN_TARGET Function
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.
Syntax
FUNCTION update_host_scan_target (
host_scan_target_id varchar2,
update_host_scan_target_details dbms_cloud_oci_vulnerability_scanning_update_host_scan_target_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vs_vulnerability_scanning_update_host_scan_target_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) unique HostScanTarget identifier |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://vss-cp-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |