{ "opencollection": "1.0.0", "info": { "name": "Application Dependency Management API", "version": "20220421" }, "items": [ { "info": { "name": "applicationDependencyManagement", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Knowledge Bases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/knowledgeBases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the specified identifier.\nRequired only if the compartmentId query parameter is not specified.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort Knowledge Bases. Only one sort order is allowed.\nDefault order for _displayName_ is **ascending alphabetical order**.\nDefault order for _lifecyleState_ is the following sequence: **CREATING, ACTIVE, UPDATING, FAILED, DELETING, and DELETED**.Default order for _timeCreated_ is **descending**.\nDefault order for _timeUpdated_ is **descending**.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Knowledge Bases that match the specified lifecycleState." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the specified compartment identifier.\nRequired only if the id query param is not specified.\n" } ] }, "docs": "Returns a list of KnowledgeBases based on the specified query parameters.\nAt least id or compartmentId query parameter must be provided.\n" }, { "info": { "name": "Creates a new Knowledge Base.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/knowledgeBases", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Knowledge Base." }, { "info": { "name": "Returns the Knowledge Base.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Knowledge Base, as a URL path parameter." } ] }, "docs": "Returns the details of the specified Knowledge Base." }, { "info": { "name": "Updates the specified Knowledge Base.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220421/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Knowledge Base, as a URL path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Knowledge Base." }, { "info": { "name": "Deletes the specified Knowledge Base.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220421/knowledgeBases/:knowledgeBaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Knowledge Base, as a URL path parameter." } ] }, "docs": "Deletes the specified Knowledge Base." }, { "info": { "name": "Moves a Knowledge Base to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/knowledgeBases/:knowledgeBaseId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Knowledge Base, as a URL path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Knowledge Base from one compartment to another." }, { "info": { "name": "Returns a list of Remediation Recipes.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRecipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the specified identifier.\nRequired only if the compartmentId query parameter is not specified.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort Remediation Recipes. Only one sort order is allowed.\nDefault order for _displayName_ is **ascending alphabetical order**.\nDefault order for _lifecyleState_ is the following sequence: **CREATING, ACTIVE, UPDATING, INACTIVE, FAILED, DELETING, and DELETED**.\nDefault order for _timeCreated_ is **descending**.\nDefault order for _timeUpdated_ is **descending**. \nDefault order for _type_ is the following sequence: **ADM**.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Remediation Recipes that match the specified lifecycleState." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the specified compartment identifier.\nRequired only if the id query param is not specified.\n" } ] }, "docs": "Returns a list of Remediation Recipes based on the specified query parameters.\nThe query parameters `compartmentId` or `id` must be provided.\n" }, { "info": { "name": "Creates a new Remediation Recipe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRecipes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Remediation Recipe." }, { "info": { "name": "Returns the RemediationRecipe.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ] }, "docs": "Returns the details of the specified RemediationRecipe." }, { "info": { "name": "Updates the specified Remediation Recipe.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Remediation Recipe." }, { "info": { "name": "Deletes the specified Remediation Recipe.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ] }, "docs": "Deletes the specified Remediation Recipe." }, { "info": { "name": "Activates the specified Remediation Recipe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId/actions/activate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ] }, "docs": "Activates the specified Remediation Recipe." }, { "info": { "name": "Moves a Remediation Recipe into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Remediation Recipe from one compartment to another." }, { "info": { "name": "Deactivates the specified Remediation Recipe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRecipes/:remediationRecipeId/actions/deactivate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRecipeId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of a Remediation Recipe, as a URL path parameter." } ] }, "docs": "Deactivates the specified Remediation Recipe." }, { "info": { "name": "Returns a list of remediation runs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRuns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the specified identifier.\nRequired only if the compartmentId query parameter is not specified.\n" }, { "name": "remediationRecipeId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified Remediation Recipe identifier." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Remediation Runs that match the specified lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort Remediation Runs. Only one sort order is allowed.\nDefault order for _timeCreated_ is **descending**.\nDefault order for _timeFinished_ is **descending**.\nDefault order for _timeStarted_ is **descending**.\nDefault order for _displayName_ is **ascending alphabetical order**.\nDefault order for _lifecycleState_ is the following sequence: **CREATING, ACTIVE, UPDATING, DELETING, DELETED, and FAILED**.\nDefault order for currentStageType is the following sequence: **DETECT, RECOMMEND, VERIFY, and APPLY**.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the specified compartment identifier.\nRequired only if the id query param is not specified.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns a list of remediation runs contained by a compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new remediation run.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRuns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new remediation run." }, { "info": { "name": "Returns the specified remediation run.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." } ] }, "docs": "Returns the details of the specified remediation run." }, { "info": { "name": "Updates the specified remediation run.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates by identifier one or more attributes of the specified remediation run." }, { "info": { "name": "Deletes the specified remediation run.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." } ] }, "docs": "Deletes the specified remediation run." }, { "info": { "name": "Cancels the specified remediation run.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." } ] }, "docs": "Cancels the specified remediation run." }, { "info": { "name": "Moves a remediation run into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a remediation run from one compartment to another." }, { "info": { "name": "Lists application dependencies with their associated recommendations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId/applicationDependencyRecommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "gav", "value": "", "type": "query", "description": "A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given." }, { "name": "purl", "value": "", "type": "query", "description": "A filter to return only resources that match the entire purl given." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nIf 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.\nIf 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.\nDefault order for gav is ascending where ascending corresponds to alphanumerical order.\nDefault order for purl is ascending where ascending corresponds to alphabetical order\nDefault order for nodeId is ascending where ascending corresponds to alphanumerical order.\nSorting by DFS or BFS cannot be used in conjunction with the following query parameters: \"gav\", \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\" and \"vulnerabilityId\".\n" } ] }, "docs": "Returns a list of application dependency with their associated recommendations." }, { "info": { "name": "Returns a list of Remediation Run Stages.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId/stages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only Stages that match the specified type." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only Stages that match the specified status." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort Stages. Only one sort order is allowed.\nDefault order for status is the following sequence: **CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELING, and CANCELED**.\nDefault order for _timeCreated_ is **descending**.\nDefault order for _timeFinished_ is **descending**.\nDefault order for _timeStarted_ is **descending**.\nDefault order for _type_ is the following sequence: **DETECT, RECOMMEND, VERIFY, and APPLY**.\n" } ] }, "docs": "Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier." }, { "info": { "name": "Returns the details of the specified Remediation Run Stage.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/remediationRuns/:remediationRunId/stages/:stageType", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "remediationRunId", "value": "", "type": "path", "description": "Unique Remediation Run identifier path parameter." }, { "name": "stageType", "value": "", "type": "path", "description": "The type of Remediation Run Stage, as a URL path parameter." } ] }, "docs": "Returns the details of the specified Remediation Run Stage." }, { "info": { "name": "Returns a list of Vulnerability Audits.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/vulnerabilityAudits", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the specified identifier.\nRequired only if the compartmentId query parameter is not specified.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the specified compartment identifier.\nRequired only if the id query param is not specified.\n" }, { "name": "knowledgeBaseId", "value": "", "type": "query", "description": "A filter to return only Audits that were created against the specified knowledge base." }, { "name": "isSuccess", "value": "", "type": "query", "description": "A filter to return only successful or failed Vulnerability Audits." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Vulnerability Audits that match the specified lifecycleState." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort Vulnerability Audits. Only one sort order is allowed.\nDefault order for _maxObservedCvssV2Score_ is **ascending**.\nDefault order for _maxObservedCvssV3Score_ is **ascending**.\nDefault order for _maxObservedCvssV2ScoreWithIgnored_ is **ascending**.\nDefault order for _maxObservedCvssV3ScoreWithIgnored_ is **ascending**.\nDefault order for _timeCreated_ is **descending**.\nDefault order for _vulnerableArtifactsCount_ is **ascending**.\nDefault order for _vulnerableArtifactsCountWithIgnored_ is **ascending**.\nDefault order for _maxObservedSeverity_ is **ascending**.\nDefault order for _maxObservedSeverityWithIgnored_ is **ascending**.\nDefault order for _displayName_ is **ascending**.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only Vulnerability Audits with timeCreated greater or equal to the specified value." }, { "name": "timeCreatedLessThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only Vulnerability Audits with timeCreated less or equal to the specified value." }, { "name": "maxObservedSeverityGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that returns only Vulnerability Audits that have a maximum observed Severity greater than or equal to the specified value.\n" } ] }, "docs": "Returns a list of Vulnerability Audits based on the specified query parameters.\nAt least one of id, compartmentId query parameter must be provided.\n" }, { "info": { "name": "Creates a new Vulnerability Audit.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/vulnerabilityAudits", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Vulnerability Audit by providing a tree of Application Dependencies." }, { "info": { "name": "Returns the details of the specified Vulnerability Audit.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." } ] }, "docs": "Returns the details of the specified Vulnerability Audit." }, { "info": { "name": "Updates the specified Vulnerability Audit.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Vulnerability Audit." }, { "info": { "name": "Deletes the specified Vulnerability Audit.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." } ] }, "docs": "Deletes the specified Vulnerability Audit." }, { "info": { "name": "Moves a Vulnerability Audit into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Vulnerability Audit from one compartment to another." }, { "info": { "name": "Lists Application Dependencies with their associated vulnerabilities.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId/applicationDependencyVulnerabilities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." }, { "name": "vulnerabilityId", "value": "", "type": "query", "description": "A filter to return only Vulnerability Audits that match the specified id." }, { "name": "cvssV3GreaterThanOrEqual", "value": "", "type": "query", "description": "A filter that returns only Vulnerabilities that have a Common Vulnerability Scoring System Version 3 (CVSS V3) greater than or equal to the specified value.\n" }, { "name": "cvssV2GreaterThanOrEqual", "value": "", "type": "query", "description": "A filter that returns only Vulnerabilities that have a Common Vulnerability Scoring System Version 2 (CVSS V2) greater than or equal to the specified value.\n" }, { "name": "severityGreaterThanOrEqual", "value": "", "type": "query", "description": "A filter that returns only Vulnerabilities that have a severity greater than or equal to the specified value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nIf 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.\nIf 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.\nDefault order for gav is ascending where ascending corresponds to alphanumerical order.\nDefault order for purl is ascending where ascending corresponds to alphabetical order\nDefault order for nodeId is ascending where ascending corresponds to alphanumerical order.\nSorting by DFS or BFS cannot be used in conjunction with the following query parameters: \"gav\", \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\" and \"vulnerabilityId\".\n" }, { "name": "rootNodeId", "value": "", "type": "query", "description": "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.\nQuery parameters \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\", \"gav\" and \"vulnerabilityId\" cannot be used in conjunction with this parameter.\n" }, { "name": "depth", "value": "", "type": "query", "description": "A filter to limit depth of the application dependencies tree traversal.\nAdditionally query parameters such as \"cvssV2GreaterThanOrEqual\", \"cvssV3GreaterThanOrEqual\", \"gav\" and \"vulnerabilityId\" can't be used in conjunction with this latter.\n" }, { "name": "gav", "value": "", "type": "query", "description": "A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given." }, { "name": "purl", "value": "", "type": "query", "description": "A filter to return only resources that match the entire purl given." } ] }, "docs": "Returns a list of Application Dependencies with their associated vulnerabilities." }, { "info": { "name": "Lists vulnerability details associated with an audit.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/vulnerabilityAudits/:vulnerabilityAuditId/vulnerabilities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vulnerabilityAuditId", "value": "", "type": "path", "description": "Unique Vulnerability Audit identifier path parameter." }, { "name": "isDirectVulnerability", "value": "", "type": "query", "description": "A filter when set returns only vulnerabilities that are immediately(directly) affecting any artifact, when unset all vulnerabilities are returned." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns a list of vulnerability details for an audit." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the specified compartment identifier.\nRequired only if the id query param is not specified.\n" }, { "name": "workRequestId", "value": "", "type": "query", "description": "The identifier of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources that match the specified OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is **descending**.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Cancel the work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220421/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of the asynchronous request." } ] }, "docs": "Cancel work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is **descending**.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220421/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)) of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort WorkRequests. Only one sort order is allowed. Default order for _timeAccepted_ is **descending**.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }