ADM Functions

Package: DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_MANAGEMENT

ACTIVATE_REMEDIATION_RECIPE Function

Activates the specified Remediation Recipe.

Syntax

FUNCTION activate_remediation_recipe (
  remediation_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_adm_application_dependency_management_activate_remediation_recipe_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_REMEDIATION_RUN Function

Cancels the specified remediation run.

Syntax

FUNCTION cancel_remediation_run (
  remediation_run_id varchar2,
  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_adm_application_dependency_management_cancel_remediation_run_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_WORK_REQUEST Function

Cancel work request with the given ID.

Syntax

FUNCTION cancel_work_request (
  work_request_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_adm_application_dependency_management_cancel_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The Oracle Cloud Identifier (OCID) of the asynchronous request.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_KNOWLEDGE_BASE_COMPARTMENT Function

Moves a Knowledge Base from one compartment to another.

Syntax

FUNCTION change_knowledge_base_compartment (
  knowledge_base_id varchar2,
  change_knowledge_base_compartment_details dbms_cloud_oci_adm_change_knowledge_base_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_adm_application_dependency_management_change_knowledge_base_compartment_response_t;

Parameters

Parameter	Description
`knowledge_base_id`	(required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter.
`change_knowledge_base_compartment_details`	(required) The information to be updated.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REMEDIATION_RECIPE_COMPARTMENT Function

Moves a Remediation Recipe from one compartment to another.

Syntax

FUNCTION change_remediation_recipe_compartment (
  remediation_recipe_id varchar2,
  change_remediation_recipe_compartment_details dbms_cloud_oci_adm_change_remediation_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_adm_application_dependency_management_change_remediation_recipe_compartment_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`change_remediation_recipe_compartment_details`	(required) The information to be updated.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REMEDIATION_RUN_COMPARTMENT Function

Moves a remediation run from one compartment to another.

Syntax

FUNCTION change_remediation_run_compartment (
  remediation_run_id varchar2,
  change_remediation_run_compartment_details dbms_cloud_oci_adm_change_remediation_run_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_adm_application_dependency_management_change_remediation_run_compartment_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`change_remediation_run_compartment_details`	(required) The information to be updated.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VULNERABILITY_AUDIT_COMPARTMENT Function

Moves a Vulnerability Audit from one compartment to another.

Syntax

FUNCTION change_vulnerability_audit_compartment (
  vulnerability_audit_id varchar2,
  change_vulnerability_audit_compartment_details dbms_cloud_oci_adm_change_vulnerability_audit_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_adm_application_dependency_management_change_vulnerability_audit_compartment_response_t;

Parameters

Parameter	Description
`vulnerability_audit_id`	(required) Unique Vulnerability Audit identifier path parameter.
`change_vulnerability_audit_compartment_details`	(required) The information to be updated.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_KNOWLEDGE_BASE Function

Creates a new Knowledge Base.

Syntax

FUNCTION create_knowledge_base (
  create_knowledge_base_details dbms_cloud_oci_adm_create_knowledge_base_details_t,
  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_adm_application_dependency_management_create_knowledge_base_response_t;

Parameters

Parameter	Description
`create_knowledge_base_details`	(required) The details to create a new Knowledge Base.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REMEDIATION_RECIPE Function

Creates a new Remediation Recipe.

Syntax

FUNCTION create_remediation_recipe (
  create_remediation_recipe_details dbms_cloud_oci_adm_create_remediation_recipe_details_t,
  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_adm_application_dependency_management_create_remediation_recipe_response_t;

Parameters

Parameter	Description
`create_remediation_recipe_details`	(required) The details to create a new Remediation Recipe.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REMEDIATION_RUN Function

Creates a new remediation run.

Syntax

FUNCTION create_remediation_run (
  create_remediation_run_details dbms_cloud_oci_adm_create_remediation_run_details_t,
  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_adm_application_dependency_management_create_remediation_run_response_t;

Parameters

Parameter	Description
`create_remediation_run_details`	(required) The details used to create a new remediation run.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VULNERABILITY_AUDIT Function

Creates a new Vulnerability Audit by providing a tree of Application Dependencies.

Syntax

FUNCTION create_vulnerability_audit (
  create_vulnerability_audit_details dbms_cloud_oci_adm_create_vulnerability_audit_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_adm_application_dependency_management_create_vulnerability_audit_response_t;

Parameters

Parameter	Description
`create_vulnerability_audit_details`	(required) The details to create a new Vulnerability Audit.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEACTIVATE_REMEDIATION_RECIPE Function

Deactivates the specified Remediation Recipe.

Syntax

FUNCTION deactivate_remediation_recipe (
  remediation_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_adm_application_dependency_management_deactivate_remediation_recipe_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_KNOWLEDGE_BASE Function

Deletes the specified Knowledge Base.

Syntax

FUNCTION delete_knowledge_base (
  knowledge_base_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_adm_application_dependency_management_delete_knowledge_base_response_t;

Parameters

Parameter	Description
`knowledge_base_id`	(required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REMEDIATION_RECIPE Function

Deletes the specified Remediation Recipe.

Syntax

FUNCTION delete_remediation_recipe (
  remediation_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_adm_application_dependency_management_delete_remediation_recipe_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REMEDIATION_RUN Function

Deletes the specified remediation run.

Syntax

FUNCTION delete_remediation_run (
  remediation_run_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_adm_application_dependency_management_delete_remediation_run_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VULNERABILITY_AUDIT Function

Deletes the specified Vulnerability Audit.

Syntax

FUNCTION delete_vulnerability_audit (
  vulnerability_audit_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_adm_application_dependency_management_delete_vulnerability_audit_response_t;

Parameters

Parameter	Description
`vulnerability_audit_id`	(required) Unique Vulnerability Audit identifier path parameter.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_KNOWLEDGE_BASE Function

Returns the details of the specified Knowledge Base.

Syntax

FUNCTION get_knowledge_base (
  knowledge_base_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_adm_application_dependency_management_get_knowledge_base_response_t;

Parameters

Parameter	Description
`knowledge_base_id`	(required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REMEDIATION_RECIPE Function

Returns the details of the specified RemediationRecipe.

Syntax

FUNCTION get_remediation_recipe (
  remediation_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_adm_application_dependency_management_get_remediation_recipe_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REMEDIATION_RUN Function

Returns the details of the specified remediation run.

Syntax

FUNCTION get_remediation_run (
  remediation_run_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_adm_application_dependency_management_get_remediation_run_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STAGE Function

Returns the details of the specified Remediation Run Stage.

Syntax

FUNCTION get_stage (
  remediation_run_id varchar2,
  stage_type varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_adm_application_dependency_management_get_stage_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`stage_type`	(required) The type of Remediation Run Stage, as a URL path parameter. Allowed values are: 'DETECT', 'RECOMMEND', 'VERIFY', 'APPLY'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VULNERABILITY_AUDIT Function

Returns the details of the specified Vulnerability Audit.

Syntax

FUNCTION get_vulnerability_audit (
  vulnerability_audit_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_adm_application_dependency_management_get_vulnerability_audit_response_t;

Parameters

Parameter	Description
`vulnerability_audit_id`	(required) Unique Vulnerability Audit identifier path parameter.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(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_adm_application_dependency_management_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The Oracle Cloud Identifier (OCID) of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_APPLICATION_DEPENDENCY_RECOMMENDATIONS Function

Returns a list of application dependency with their associated recommendations.

Syntax

FUNCTION list_application_dependency_recommendations (
  remediation_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  gav 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_adm_application_dependency_management_list_application_dependency_recommendations_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`gav`	(optional) A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. If sort order is dfs, the nodes are returned by going through the application dependency tree in a depth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. If sort order is bfs, the nodes are returned by going through the application dependency tree in a breadth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. Default order for gav is ascending where ascending corresponds to alphanumerical order. Default order for nodeId is ascending where ascending corresponds to alphanumerical order. Sorting by DFS or BFS cannot be used in conjunction with the following query parameters: \"gav\", \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\" and \"vulnerabilityId\". Allowed values are: 'gav', 'nodeId', 'dfs', 'bfs'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_APPLICATION_DEPENDENCY_VULNERABILITIES Function

Returns a list of Application Dependencies with their associated vulnerabilities.

Syntax

FUNCTION list_application_dependency_vulnerabilities (
  vulnerability_audit_id varchar2,
  vulnerability_id varchar2 DEFAULT NULL,
  cvss_v3_greater_than_or_equal number DEFAULT NULL,
  cvss_v2_greater_than_or_equal number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  root_node_id varchar2 DEFAULT NULL,
  depth number DEFAULT NULL,
  gav 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_adm_application_dependency_management_list_application_dependency_vulnerabilities_response_t;

Parameters

Parameter	Description
`vulnerability_audit_id`	(required) Unique Vulnerability Audit identifier path parameter.
`vulnerability_id`	(optional) A filter to return only Vulnerability Audits that match the specified id.
`cvss_v3_greater_than_or_equal`	(optional) A filter that returns only Vulnerability Audits that have a Common Vulnerability Scoring System Version 3 (CVSS V3) greater or equal than the specified value.
`cvss_v2_greater_than_or_equal`	(optional) A filter that returns only Vulnerability Audits that have a Common Vulnerability Scoring System Version 2 (CVSS V2) greater or equal than the specified value.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. If sort order is dfs, the nodes are returned by going through the application dependency tree in a depth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. If sort order is bfs, the nodes are returned by going through the application dependency tree in a breadth-first manner. Children are sorted based on their GAV property alphabetically (either ascending or descending, depending on the order parameter). Default order is ascending. Default order for gav is ascending where ascending corresponds to alphanumerical order. Default order for nodeId is ascending where ascending corresponds to alphanumerical order. Sorting by DFS or BFS cannot be used in conjunction with the following query parameters: \"gav\", \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\" and \"vulnerabilityId\". Allowed values are: 'gav', 'nodeId', 'dfs', 'bfs'
`root_node_id`	(optional) A filter to override the top level root identifier with the new given value. The application dependency tree will only be traversed from the given node. Query parameters \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\", \"gav\" and \"vulnerabilityId\" cannot be used in conjunction with this parameter.
`depth`	(optional) A filter to limit depth of the application dependencies tree traversal. Additionally query parameters such as \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\", \"gav\" and \"vulnerabilityId\" can't be used in conjunction with this latter.
`gav`	(optional) A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_KNOWLEDGE_BASES Function

Returns a list of KnowledgeBases based on the specified query parameters. At least id or compartmentId query parameter must be provided.

Syntax

FUNCTION list_knowledge_bases (
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id 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_adm_application_dependency_management_list_knowledge_bases_response_t;

Parameters

Parameter	Description
`id`	(optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
`sort_by`	(optional) The field used to sort Knowledge Bases. Only one sort order is allowed. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecyleState_ is the following sequence: CREATING, ACTIVE, UPDATING, FAILED, DELETING, and DELETED.Default order for _timeCreated_ is descending. Default order for _timeUpdated_ is descending. Allowed values are: 'DISPLAY_NAME', 'LIFECYCLE_STATE', 'TIME_CREATED', 'TIME_UPDATED'
`lifecycle_state`	(optional) A filter to return only Knowledge Bases that match the specified lifecycleState.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`compartment_id`	(optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REMEDIATION_RECIPES Function

Returns a list of Remediation Recipes based on the specified query parameters. The query parameters `compartmentId` or `id` must be provided.

Syntax

FUNCTION list_remediation_recipes (
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id 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_adm_application_dependency_management_list_remediation_recipes_response_t;

Parameters

Parameter	Description
`id`	(optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
`sort_by`	(optional) The field used to sort Remediation Recipes. Only one sort order is allowed. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecyleState_ is the following sequence: CREATING, ACTIVE, UPDATING, INACTIVE, FAILED, DELETING, and DELETED. Default order for _timeCreated_ is descending. Default order for _timeUpdated_ is descending. Default order for _type_ is the following sequence: ADM. Allowed values are: 'DISPLAY_NAME', 'LIFECYCLE_STATE', 'TIME_CREATED', 'TIME_UPDATED', 'TYPE'
`lifecycle_state`	(optional) A filter to return only Remediation Recipes that match the specified lifecycleState.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`compartment_id`	(optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REMEDIATION_RUNS Function

Returns a list of remediation runs contained by a compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified.

Syntax

FUNCTION list_remediation_runs (
  id varchar2 DEFAULT NULL,
  remediation_recipe_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  compartment_id 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_adm_application_dependency_management_list_remediation_runs_response_t;

Parameters

Parameter	Description
`id`	(optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
`remediation_recipe_id`	(optional) A filter to return only resources that match the specified Remediation Recipe identifier.
`lifecycle_state`	(optional) A filter to return only Remediation Runs that match the specified lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used to sort Remediation Runs. Only one sort order is allowed. Default order for _timeCreated_ is descending. Default order for _timeFinished_ is descending. Default order for _timeStarted_ is descending. Default order for _displayName_ is ascending alphabetical order. Default order for _lifecycleState_ is the following sequence: CREATING, ACTIVE, UPDATING, DELETING, DELETED, and FAILED. Default order for currentStageType is the following sequence: DETECT, RECOMMEND, VERIFY, and APPLY. Allowed values are: 'timeCreated', 'timeFinished', 'timeStarted', 'displayName', 'lifecycleState', 'currentStageType'
`compartment_id`	(optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STAGES Function

Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier.

Syntax

FUNCTION list_stages (
  remediation_run_id varchar2,
  l_type varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  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_adm_application_dependency_management_list_stages_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`l_type`	(optional) A filter to return only Stages that match the specified type. Allowed values are: 'DETECT', 'RECOMMEND', 'VERIFY', 'APPLY'
`status`	(optional) A filter to return only Stages that match the specified status.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`opc_request_id`	(optional) The client request ID for tracing.
`sort_by`	(optional) The field used to sort Stages. Only one sort order is allowed. Default order for status is the following sequence: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELING, and CANCELED. Default order for _timeCreated_ is descending. Default order for _timeFinished_ is descending. Default order for _timeStarted_ is descending. Default order for _type_ is the following sequence: DETECT, RECOMMEND, VERIFY, and APPLY. Allowed values are: 'status', 'timeCreated', 'timeFinished', 'timeStarted', 'type'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VULNERABILITY_AUDITS Function

Returns a list of Vulnerability Audits based on the specified query parameters. At least one of id, compartmentId query parameter must be provided.

Syntax

FUNCTION list_vulnerability_audits (
  id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  knowledge_base_id varchar2 DEFAULT NULL,
  is_success number DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_adm_application_dependency_management_list_vulnerability_audits_response_t;

Parameters

Parameter	Description
`id`	(optional) A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
`compartment_id`	(optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
`knowledge_base_id`	(optional) A filter to return only Vulnerability Audits that were created against the specified knowledge base.
`is_success`	(optional) A filter to return only successful or failed Vulnerability Audits.
`lifecycle_state`	(optional) A filter to return only Vulnerability Audits that match the specified lifecycleState.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`opc_request_id`	(optional) The client request ID for tracing.
`sort_by`	(optional) The field used to sort Vulnerability Audits. Only one sort order is allowed. Default order for _maxObservedCvssV2Score_ is ascending. Default order for _maxObservedCvssV3Score_ is ascending. Default order for _maxObservedCvssV2ScoreWithIgnored_ is ascending. Default order for _maxObservedCvssV3ScoreWithIgnored_ is ascending. Default order for _timeCreated_ is descending. Default order for _vulnerableArtifactsCount_ is ascending. Default order for _vulnerableArtifactsCountWithIgnored_ is ascending. Allowed values are: 'maxObservedCvssV2Score', 'maxObservedCvssV3Score', 'timeCreated', 'vulnerableArtifactsCount', 'maxObservedCvssV2ScoreWithIgnored', 'maxObservedCvssV3ScoreWithIgnored', 'vulnerableArtifactsCountWithIgnored'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(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,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_adm_application_dependency_management_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The Oracle Cloud Identifier (OCID) of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(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,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_adm_application_dependency_management_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The Oracle Cloud Identifier (OCID) of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(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 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order 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_adm_application_dependency_management_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
`work_request_id`	(optional) The identifier of the asynchronous work request.
`status`	(optional) A filter to return only resources that match the specified OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`resource_id`	(optional) The Oracle Cloud Identifier (OCID) of the resource affected by the work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is descending. Allowed values are: 'timeAccepted'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_KNOWLEDGE_BASE Function

Updates one or more attributes of the specified Knowledge Base.

Syntax

FUNCTION update_knowledge_base (
  knowledge_base_id varchar2,
  update_knowledge_base_details dbms_cloud_oci_adm_update_knowledge_base_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_adm_application_dependency_management_update_knowledge_base_response_t;

Parameters

Parameter	Description
`knowledge_base_id`	(required) The Oracle Cloud Identifier (OCID) of a Knowledge Base, as a URL path parameter.
`update_knowledge_base_details`	(required) The details to update a Knowledge Base.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REMEDIATION_RECIPE Function

Updates one or more attributes of the specified Remediation Recipe.

Syntax

FUNCTION update_remediation_recipe (
  remediation_recipe_id varchar2,
  update_remediation_recipe_details dbms_cloud_oci_adm_update_remediation_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_adm_application_dependency_management_update_remediation_recipe_response_t;

Parameters

Parameter	Description
`remediation_recipe_id`	(required) The Oracle Cloud Identifier (OCID) of a Remediation Recipe, as a URL path parameter.
`update_remediation_recipe_details`	(required) The details to update a Remediation Recipe.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REMEDIATION_RUN Function

Updates by identifier one or more attributes of the specified remediation run.

Syntax

FUNCTION update_remediation_run (
  remediation_run_id varchar2,
  update_remediation_run_details dbms_cloud_oci_adm_update_remediation_run_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_adm_application_dependency_management_update_remediation_run_response_t;

Parameters

Parameter	Description
`remediation_run_id`	(required) Unique Remediation Run identifier path parameter.
`update_remediation_run_details`	(required) The details used to update a remediation run.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VULNERABILITY_AUDIT Function

Updates one or more attributes of the specified Vulnerability Audit.

Syntax

FUNCTION update_vulnerability_audit (
  vulnerability_audit_id varchar2,
  update_vulnerability_audit_details dbms_cloud_oci_adm_update_vulnerability_audit_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_adm_application_dependency_management_update_vulnerability_audit_response_t;

Parameters

Parameter	Description
`vulnerability_audit_id`	(required) Unique Vulnerability Audit identifier path parameter.
`update_vulnerability_audit_details`	(required) The details to update a Vulnerability Audit.
`if_match`	(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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://adm.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ACTIVATE_REMEDIATION_RECIPE Function 🔗

CANCEL_REMEDIATION_RUN Function 🔗

CANCEL_WORK_REQUEST Function 🔗

CHANGE_KNOWLEDGE_BASE_COMPARTMENT Function 🔗

CHANGE_REMEDIATION_RECIPE_COMPARTMENT Function 🔗

CHANGE_REMEDIATION_RUN_COMPARTMENT Function 🔗

CHANGE_VULNERABILITY_AUDIT_COMPARTMENT Function 🔗

CREATE_KNOWLEDGE_BASE Function 🔗

CREATE_REMEDIATION_RECIPE Function 🔗

CREATE_REMEDIATION_RUN Function 🔗

CREATE_VULNERABILITY_AUDIT Function 🔗

DEACTIVATE_REMEDIATION_RECIPE Function 🔗

DELETE_KNOWLEDGE_BASE Function 🔗

DELETE_REMEDIATION_RECIPE Function 🔗

DELETE_REMEDIATION_RUN Function 🔗

DELETE_VULNERABILITY_AUDIT Function 🔗

GET_KNOWLEDGE_BASE Function 🔗

GET_REMEDIATION_RECIPE Function 🔗

GET_REMEDIATION_RUN Function 🔗

GET_STAGE Function 🔗

GET_VULNERABILITY_AUDIT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_APPLICATION_DEPENDENCY_RECOMMENDATIONS Function 🔗

LIST_APPLICATION_DEPENDENCY_VULNERABILITIES Function 🔗

LIST_KNOWLEDGE_BASES Function 🔗

LIST_REMEDIATION_RECIPES Function 🔗

LIST_REMEDIATION_RUNS Function 🔗

LIST_STAGES Function 🔗

LIST_VULNERABILITY_AUDITS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_KNOWLEDGE_BASE Function 🔗

UPDATE_REMEDIATION_RECIPE Function 🔗

UPDATE_REMEDIATION_RUN Function 🔗

UPDATE_VULNERABILITY_AUDIT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ACTIVATE_REMEDIATION_RECIPE Function

CANCEL_REMEDIATION_RUN Function

CANCEL_WORK_REQUEST Function

CHANGE_KNOWLEDGE_BASE_COMPARTMENT Function

CHANGE_REMEDIATION_RECIPE_COMPARTMENT Function

CHANGE_REMEDIATION_RUN_COMPARTMENT Function

CHANGE_VULNERABILITY_AUDIT_COMPARTMENT Function

CREATE_KNOWLEDGE_BASE Function

CREATE_REMEDIATION_RECIPE Function

CREATE_REMEDIATION_RUN Function

CREATE_VULNERABILITY_AUDIT Function

DEACTIVATE_REMEDIATION_RECIPE Function

DELETE_KNOWLEDGE_BASE Function

DELETE_REMEDIATION_RECIPE Function

DELETE_REMEDIATION_RUN Function

DELETE_VULNERABILITY_AUDIT Function

GET_KNOWLEDGE_BASE Function

GET_REMEDIATION_RECIPE Function

GET_REMEDIATION_RUN Function

GET_STAGE Function

GET_VULNERABILITY_AUDIT Function

GET_WORK_REQUEST Function

LIST_APPLICATION_DEPENDENCY_RECOMMENDATIONS Function

LIST_APPLICATION_DEPENDENCY_VULNERABILITIES Function

LIST_KNOWLEDGE_BASES Function

LIST_REMEDIATION_RECIPES Function

LIST_REMEDIATION_RUNS Function

LIST_STAGES Function

LIST_VULNERABILITY_AUDITS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_KNOWLEDGE_BASE Function

UPDATE_REMEDIATION_RECIPE Function

UPDATE_REMEDIATION_RUN Function

UPDATE_VULNERABILITY_AUDIT Function