openapi: 3.2.0 info: description: Use the Vulnerability Scanning Service (VSS) API to manage scan recipes, targets, and reports. For more information, see [the Vulnerability Scanning documentation](/iaas/scanning/home.htm). title: Scanning Vulnerability Scanning API version: '20210215' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/dfcab9566c2b7a8c5656c725e400d20b105dfb00c2d7dc80250184ca17d7a4ad.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Scanning API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/dfcab9566c2b7a8c5656c725e400d20b105dfb00c2d7dc80250184ca17d7a4ad.yaml what: the harvested document for Scanning API servers: - url: http://127.0.0.1/20210215 - url: https://127.0.0.1/20210215 tags: - name: vulnerabilityScanning paths: /containerScanRecipes: get: description: 'Retrieves a list of ContainerScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned. ' operationId: ListContainerScanRecipes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of ContainerScanRecipeSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanRecipeSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all ContainerScanRecipes in a compartment tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanRecipe' post: description: 'Creates a new ContainerScanRecipe. A recipe determines the types of security issues that you want scanned. ' operationId: CreateContainerScanRecipe parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully created the ContainerScanRecipe, but it may not yet be in an active state. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ContainerScanRecipe tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateContainerScanRecipeDetails' description: Details for the new ContainerScanRecipe required: true /containerScanRecipes/{containerScanRecipeId}: delete: description: 'Deletes the ContainerScanRecipe identified by the recipe ID. ' operationId: DeleteContainerScanRecipe parameters: - $ref: '#/components/parameters/ContainerScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified ContainerScanRecipe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing ContainerScanRecipe tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanRecipe' get: description: 'Retrieves a ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned. ' operationId: GetContainerScanRecipe parameters: - $ref: '#/components/parameters/ContainerScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the ContainerScanRecipe with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a ContainerScanRecipe tags: - vulnerabilityScanning put: description: 'Updates the ContainerScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned. ' operationId: UpdateContainerScanRecipe parameters: - $ref: '#/components/parameters/ContainerScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to update the specified ContainerScanRecipe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the ContainerScanRecipe tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContainerScanRecipeDetails' description: The information to be updated. required: true /containerScanRecipes/{containerScanRecipeId}/actions/changeCompartment: post: description: 'Moves a ContainerScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeContainerScanRecipeCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContainerScanRecipeIdentifierPathParam' responses: 204: description: Successfully moved the ContainerScanRecipe to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a ContainerScanRecipe into a different compartment tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeContainerScanRecipeCompartmentDetails' description: The compartment information to update. required: true /containerScanResults: get: description: 'Retrieves a list of ContainerScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A container scan result includes a list of problems detected in a specific image in a Docker repository. ' operationId: ListContainerScanResults parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RepositoryQueryParam' - $ref: '#/components/parameters/ImageQueryParam' - $ref: '#/components/parameters/AreSubcompartmentsIncludedQueryParam' - $ref: '#/components/parameters/HighestProblemSeverityQueryParam' - $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ContainerScanResultSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsLatestOnlyQueryParam' responses: 200: description: Successfully retrieved a page of ContainerScanResultSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanResultSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists container scan results tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanResult' /containerScanResults/{containerScanResultId}: delete: description: 'Deletes the ContainerScanResult identified by the container scan ID. ' operationId: DeleteContainerScanResult parameters: - $ref: '#/components/parameters/ContainerScanResultIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified ContainerScanResult. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing container scan result tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanResult' get: description: 'Retrieves a ContainerScanResult identified by the container scan ID. The result includes a list of problems found in a specific image in a Docker repository. ' operationId: GetContainerScanResult parameters: - $ref: '#/components/parameters/ContainerScanResultIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the ContainerScanResult. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the results of a container scan tags: - vulnerabilityScanning /containerScanResults/{containerScanResultId}/actions/changeCompartment: post: description: 'Moves a ContainerScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeContainerScanResultCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContainerScanResultIdentifierPathParam' responses: 204: description: Successfully moved the ContainerScanResult to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a ContainerScanResult into a different compartment tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeContainerScanResultCompartmentDetails' description: The compartment information to update. required: true /containerScanTargets: get: description: 'Retrieves a list of ContainerScanTargetSummary objects in a compartment. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities. ' operationId: ListContainerScanTargets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of ContainerScanTargetSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanTargetSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all ContainerScanTargets in a compartment tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanTarget' post: description: 'Creates a new ContainerScanTarget. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities. ' operationId: CreateContainerScanTarget parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully created the ContainerScanTarget, but it may not yet be in an active state. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanTarget' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ContainerScanTarget tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateContainerScanTargetDetails' description: Details for the new ContainerScanTarget required: true /containerScanTargets/{containerScanTargetId}: delete: description: 'Deletes the ContainerScanTarget identified by the target ID. ' operationId: DeleteContainerScanTarget parameters: - $ref: '#/components/parameters/ContainerScanTargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified ContainerScanTarget. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a ContainerScanTarget tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanTarget' get: description: 'Gets a ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities. ' operationId: GetContainerScanTarget parameters: - $ref: '#/components/parameters/ContainerScanTargetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the ContainerScanTarget with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerScanTarget' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a ContainerScanTarget tags: - vulnerabilityScanning put: description: 'Updates the ContainerScanTarget identified by the target ID. A container scan target specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities. ' operationId: UpdateContainerScanTarget parameters: - $ref: '#/components/parameters/ContainerScanTargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to update the specified ContainerScanTarget. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a ContainerScanTarget tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContainerScanTargetDetails' description: The information to be updated. required: true /containerScanTargets/{containerScanTargetId}/actions/changeCompartment: post: description: 'Moves a ContainerScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeContainerScanTargetCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ContainerScanTargetIdentifierPathParam' responses: 204: description: Successfully moved the ContainerScanTarget to the new compartment headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a ContainerScanTarget into a different compartment tags: - vulnerabilityScanning x-related-resource: '#/definitions/ContainerScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeContainerScanTargetCompartmentDetails' description: The compartment information to update. required: true /hostAgentScanResults: get: description: 'Retrieves a list of HostAgentScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. An agent scan result includes a list of CVEs detected in a specific compute instance. ' operationId: ListHostAgentScanResults parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceIdQueryParam' - $ref: '#/components/parameters/HighestProblemSeverityQueryParam' - $ref: '#/components/parameters/OperatingSystemQueryParam' - $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostAgentScanResultSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsLatestOnlyQueryParam' responses: 200: description: Successfully retrieved a page of HostAgentScanResultSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostAgentScanResultSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists host agent scan results. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostAgentScanResult' /hostAgentScanResults/actions/exportCsv: post: description: 'Exports a list of HostAgentScanResultSummary objects within a compartment and during a specified time range in CSV format. You can filter the results by problem severity. ' operationId: ExportHostAgentScanResultCsv parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned a string in CSV format of all HostAgentScanResultSummaries for the compartment, time range, and filter criteria. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/csv: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the full list of HostAgentScanResultSummary objects as a CSV string. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostAgentScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportHostAgentScanResultCsvDetails' description: Information on which scan results to export to a CSV string. required: true /hostAgentScanResults/{hostAgentScanResultId}: delete: description: 'Deletes the HostAgentScanResult identified by the host agent scan ID. ' operationId: DeleteHostAgentScanResult parameters: - $ref: '#/components/parameters/HostAgentScanResultIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified HostAgentScanResult. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing host agent scan. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostAgentScanResult' get: description: 'Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a list of CVEs detected in a specific compute instance. ' operationId: GetHostAgentScanResult parameters: - $ref: '#/components/parameters/HostAgentScanResultIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostAgentScanResult. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostAgentScanResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the results of a host agent scan. tags: - vulnerabilityScanning /hostAgentScanResults/{hostAgentScanResultId}/actions/changeCompartment: post: description: 'Moves a HostAgentScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostAgentScanResultCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostAgentScanResultIdentifierPathParam' responses: 204: description: Successfully moved the HostAgentScanResult to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves a HostAgentScanResult into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostAgentScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostAgentScanResultCompartmentDetails' description: The compartment information to update. required: true /hostCisBenchmarkScanResults: get: description: 'Retrieves a list of HostCisBenchmarkScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A CIS (Center for Internet Security) benchmark scan result includes the number of failed benchmark tests on a specific compute instance. ' operationId: ListHostCisBenchmarkScanResults parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceIdQueryParam' - $ref: '#/components/parameters/HighestProblemSeverityQueryParam' - $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostCisBenchmarkScanResultSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsLatestOnlyQueryParam' responses: 200: description: Successfully retrieved a page of HostCisBenchmarkScanResultSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostCisBenchmarkScanResultSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the host CIS benchmark scan results. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostCisBenchmarkScanResult' /hostCisBenchmarkScanResults/{hostCisBenchmarkScanResultId}: delete: description: 'Deletes the HostCisBenchmarkScanResult identified by the benchmark scan result ID. ' operationId: DeleteHostCisBenchmarkScanResult parameters: - $ref: '#/components/parameters/HostCisBenchmarkScanResultIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified HostCisBenchmarkScanResult. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing host CIS benchmark scan. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostCisBenchmarkScanResult' get: description: 'Retrieves a HostCisBenchmarkScanResult identified by the benchmark scan result ID. A CIS (Center for Internet Security) benchmark scan result includes a list of benchmarks that were tested on a specific compute instance, and whether each test passed or failed. ' operationId: GetHostCisBenchmarkScanResult parameters: - $ref: '#/components/parameters/HostCisBenchmarkScanResultIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostCisBenchmarkScanResult. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostCisBenchmarkScanResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the results of a host CIS benchmark scan. tags: - vulnerabilityScanning /hostCisBenchmarkScanResults/{hostCisBenchmarkScanResultId}/actions/changeCompartment: post: description: 'Moves a HostCisBenchmarkScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostCisBenchmarkScanResultCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostCisBenchmarkScanResultIdentifierPathParam' responses: 204: description: Successfully moved the HostCisBenchmarkScanResult to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a HostCisBenchmarkScanResult into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostCisBenchmarkScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostCisBenchmarkScanResultCompartmentDetails' description: The compartment information to update. required: true /hostEndpointProtectionScanResults: get: description: 'Returns a collection of HostEndpointProtectionScanResultSummary objects. ' operationId: ListHostEndpointProtectionScanResults parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceIdQueryParam' - $ref: '#/components/parameters/HighestProblemSeverityQueryParam' - $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostEndpointProtectionScanResultSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsLatestOnlyQueryParam' responses: 200: description: Successfully retrieved a page of HostEndpointProtectionScanResultSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostEndpointProtectionScanResultSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists host Endpoint Protection scan results. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostEndpointProtectionScanResult' /hostEndpointProtectionScanResults/{hostEndpointProtectionScanResultId}: delete: description: 'Deletes the HostEndpointProtectionScanResult identified by the ID. ' operationId: DeleteHostEndpointProtectionScanResult parameters: - $ref: '#/components/parameters/HostEndpointProtectionScanResultIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The HostEndpointProtectionScanResult will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing host EndpointProtection scan. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostEndpointProtectionScanResult' get: description: 'Returns HostEndpointProtectionScanResults for the given host endpoint protection scan result ID. ' operationId: GetHostEndpointProtectionScanResult parameters: - $ref: '#/components/parameters/HostEndpointProtectionScanResultIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a HostEndpointProtectionScanResults object of the given host scan ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostEndpointProtectionScanResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the results of a host endpoint protection scan. tags: - vulnerabilityScanning /hostEndpointProtectionScanResults/{hostEndpointProtectionScanResultId}/actions/changeCompartment: post: description: 'Moves a HostEndpointProtectionScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostEndpointProtectionScanResultCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostEndpointProtectionScanResultIdentifierPathParam' responses: 204: description: The resource has been moved to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a HostEndpointProtectionScanResult into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostEndpointProtectionScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostEndpointProtectionScanResultCompartmentDetails' description: The compartment information to update. required: true /hostPortScanResults: get: description: 'Retrieves a list of HostPortScanResultSummary objects in a compartment. You can filter and sort the results by problem severity and time. A port scan result includes a list of open ports that were detected in a specific compute instance. ' operationId: ListHostPortScanResults parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceIdQueryParam' - $ref: '#/components/parameters/HighestProblemSeverityQueryParam' - $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostPortScanResultSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsLatestOnlyQueryParam' responses: 200: description: Successfully retrieved a page of HostPortScanResultSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostPortScanResultSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the host port scan results. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostPortScanResult' /hostPortScanResults/{hostPortScanResultId}: delete: description: 'Deletes the HostPortScanResult identified by the host port scan ID. ' operationId: DeleteHostPortScanResult parameters: - $ref: '#/components/parameters/HostPortScanResultIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified HostPortScanResult. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes an existing host port scan. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostPortScanResult' get: description: 'Retrieves a HostPortScanResult identified by the host port scan ID. The result includes a list of open ports that were detected in a specific compute instance. ' operationId: GetHostPortScanResult parameters: - $ref: '#/components/parameters/HostPortScanResultIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostPortScanResult object for the given host scan ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostPortScanResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the results of a host port scan. tags: - vulnerabilityScanning /hostPortScanResults/{hostPortScanResultId}/actions/changeCompartment: post: description: 'Moves a HostPortScanResult into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostPortScanResultCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostPortScanResultIdentifierPathParam' responses: 204: description: Successfully moved the HostPortScanResult to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a HostPortScanResult into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostPortScanResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostPortScanResultCompartmentDetails' description: The compartment information to update. required: true /hostScanRecipes: get: description: 'Retrieves a list of HostScanRecipeSummary objects in a compartment. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues. ' operationId: ListHostScanRecipes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of HostScanRecipeSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanRecipeSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all HostScanRecipes in a compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanRecipe' post: description: 'Creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues. ' operationId: CreateHostScanRecipe parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully created the HostScanRecipe, but it may not yet be active. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new HostScanRecipe. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostScanRecipeDetails' description: The details for the new HostScanRecipe. required: true /hostScanRecipes/{hostScanRecipeId}: delete: description: 'Deletes the HostScanRecipe identified by the recipe ID. ' operationId: DeleteHostScanRecipe parameters: - $ref: '#/components/parameters/HostScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified HostScanRecipe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the HostScanRecipe. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanRecipe' get: description: 'Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues. ' operationId: GetHostScanRecipe parameters: - $ref: '#/components/parameters/HostScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostScanRecipe. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanRecipe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a HostScanRecipe. tags: - vulnerabilityScanning put: description: 'Updates the HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan for those issues. ' operationId: UpdateHostScanRecipe parameters: - $ref: '#/components/parameters/HostScanRecipeIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to update the specified HostScanRecipe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the HostScanRecipe. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostScanRecipeDetails' description: The information to be updated. required: true /hostScanRecipes/{hostScanRecipeId}/actions/changeCompartment: post: description: 'Moves a HostScanRecipe into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostScanRecipeCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostScanRecipeIdentifierPathParam' responses: 204: description: Successfully moved the HostScanRecipe to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a HostScanRecipe into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanRecipe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostScanRecipeCompartmentDetails' description: The compartment information to update. required: true /hostScanTargets: get: description: 'Retrieves a list of HostScanTargetSummary objects in a compartment. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. ' operationId: ListHostScanTargets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of HostScanTargetSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanTargetSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all HostScanTargets in a compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanTarget' post: description: 'Creates a new HostScanTarget. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. ' operationId: CreateHostScanTarget parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully created the HostScanTarget, but it may not yet be active. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanTarget' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new HostScanTarget. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostScanTargetDetails' description: The details for the new HostScanTarget. required: true /hostScanTargets/{hostScanTargetId}: delete: description: 'Deletes the HostScanTarget identified by the target ID. ' operationId: DeleteHostScanTarget parameters: - $ref: '#/components/parameters/HostScanTargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to delete the specified HostScanTarget. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a HostScanTarget. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanTarget' get: description: 'Retrieves a HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. ' operationId: GetHostScanTarget parameters: - $ref: '#/components/parameters/HostScanTargetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostScanTarget with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanTarget' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a HostScanTarget. tags: - vulnerabilityScanning put: description: 'Updates the HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. ' operationId: UpdateHostScanTarget parameters: - $ref: '#/components/parameters/HostScanTargetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to update the specified HostScanTarget. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a HostScanTarget. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostScanTargetDetails' description: The information to be updated. required: true /hostScanTargets/{hostScanTargetId}/actions/changeCompartment: post: description: 'Moves a HostScanTarget into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeHostScanTargetCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/HostScanTargetIdentifierPathParam' responses: 204: description: Successfully moved the HostScanTarget to the new compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves a HostScanTarget into a different compartment. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostScanTarget' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostScanTargetCompartmentDetails' description: The compartment information to update. required: true /hostScanTargets/{hostScanTargetId}/errors: get: description: 'Retrieves a list of errors during scanning on instances associated with HostScanTarget identified by the target ID. A host scan target is a collection of compute instances that you want routinely scanned for security vulnerabilities. ' operationId: ListHostScanTargetErrors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/HostScanTargetIdentifierPathParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByTimeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a list of errors during scanning on instances associated with HostScanTarget identified by the target ID. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostScanTargetErrorSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists HostScanTarget errors. tags: - vulnerabilityScanning /hostVulnerabilities: get: description: 'Retrieves a list of HostVulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. ' operationId: ListHostVulnerabilities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProblemSeverityQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/CveReferenceQueryParam' - $ref: '#/components/parameters/VulnerabilityTypeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostVulnerabilitySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of HostVulnerabilitySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostVulnerabilitySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists host vulnerabilities. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostVulnerability' /hostVulnerabilities/actions/exportCsv: post: description: 'Exports a list of HostVulnerabilitySummary objects in a compartment in CSV format. ' operationId: ExportHostVulnerabilityCsv parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned a string in CSV format of all HostVulnerabilitySummary objects for the compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/csv: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the full list of HostVulnerabilitySummary objects as a CSV string. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostVulnerability' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportHostVulnerabilityCsvDetails' description: Information on which scan results to export to a CSV string. required: true /hostVulnerabilities/{hostVulnerabilityId}: get: description: 'Retrieves a HostVulnerability identified by the host vulnerability ID. A host vulnerability describes a security issue that was detected in scans of one or more compute instances. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories. ' operationId: GetHostVulnerability parameters: - $ref: '#/components/parameters/HostVulnerabilityIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the HostVulnerability object for the given vulnerability ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostVulnerability' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details on a host vulnerability. tags: - vulnerabilityScanning /hostVulnerabilities/{hostVulnerabilityId}/impactedHosts: get: description: 'Retrieves a list of HostVulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected. ' operationId: ListHostVulnerabilityImpactedHosts parameters: - $ref: '#/components/parameters/HostVulnerabilityIdentifierPathParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ImpactedHostSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of HostVulnerabilityImpactedHostSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostVulnerabilityImpactedHostSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the impacted hosts. tags: - vulnerabilityScanning x-related-resource: '#/definitions/HostVulnerability' /vulnerabilities: get: description: 'Retrieves a list of VulnerabilitySummary objects in a compartment. You can filter and sort the vulnerabilities by problem severity and time and type. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container images. ' operationId: ListVulnerabilities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProblemSeverityQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/VulnerabilityReferenceQueryParam' - $ref: '#/components/parameters/VulnerabilityTypeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'The field to sort by. Only one sort order may be provided. Default order for ''name'' is Ascending. Default order for other values is descending. If no value is specified name is default. ' in: query name: sortBy schema: type: string enum: - name - severity - firstDetected - lastDetected - impactedHosts - impactedContainers - impactedResources default: lastDetected - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of VulnerabilitySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VulnerabilitySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List vulnerabilities tags: - vulnerabilityScanning x-related-resource: '#/definitions/Vulnerability' /vulnerabilities/{vulnerabilityId}: get: description: 'Retrieves a Vulnerability identified by the vulnerability ID. A vulnerability describes a security issue that was detected in scans of one or more compute instances, container scan repositories. Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for operating systems and other software, including Critical Patch Updates and Security Alert advisories. ' operationId: GetVulnerability parameters: - $ref: '#/components/parameters/VulnerabilityIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the Vulnerability object for the given vulnerability ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vulnerability' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the details on a vulnerability tags: - vulnerabilityScanning /vulnerabilities/{vulnerabilityId}/impactedContainers: get: description: 'Retrieves a list of VulnerabilityImpactedContainerSummary objects for a specific vulnerability ID. An impacted container image summary identifies container images on which the specified vulnerability was detected. ' operationId: ListVulnerabilityImpactedContainers parameters: - $ref: '#/components/parameters/VulnerabilityIdentifierPathParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'The field to sort by. Only one sort order may be provided. Default order is Ascending. If no value is specified image name is default. ' in: query name: sortBy schema: type: string enum: - image - repository - registry default: image responses: 200: description: Successfully retrieved a page of VulnerabilityImpactedContainerSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VulnerabilityImpactedContainerSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List impacted container images tags: - vulnerabilityScanning x-related-resource: '#/definitions/Vulnerability' /vulnerabilities/{vulnerabilityId}/impactedHosts: get: description: 'Retrieves a list of VulnerabilityImpactedHostSummary objects for a specific host vulnerability ID. An impacted host summary identifies a compute instance on which the specified vulnerability was detected. ' operationId: ListVulnerabilityImpactedHosts parameters: - $ref: '#/components/parameters/VulnerabilityIdentifierPathParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ImpactedHostSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of VulnerabilityImpactedHostSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VulnerabilityImpactedHostSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List impacted hosts tags: - vulnerabilityScanning x-related-resource: '#/definitions/Vulnerability' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A page of WorkRequest objects headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - vulnerabilityScanning x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: 'Gets the status of the work request with the given ID. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Work Request Status tags: - vulnerabilityScanning x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A page of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - vulnerabilityScanning x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - vulnerabilityScanning x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 HighestProblemSeverityQueryParam: description: The parameter to filter by highestProblemSeverity for scan results. in: query name: highestProblemSeverity x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' schema: type: string enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL ProblemSeverityQueryParam: description: A filter to return only resources that have a severity that matches the given severity. in: query name: severity required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' schema: type: string enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL IfMatchHeader: description: '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. ' in: header name: if-match required: false schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC HostPortScanResultSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/HostPortScanResultSortBy' schema: type: string enum: - timeStarted - timeFinished - openPortCount - highestProblemSeverity - timeCompleted default: timeFinished AreSubcompartmentsIncludedQueryParam: description: When listing with one or more filters, whether to include subcompartments for the compartmentId being listed for. Does nothing if no filters are present in the query. in: query name: areSubcompartmentsIncluded required: false x-default-description: false schema: type: boolean VulnerabilityIdentifierPathParam: description: unique vulnerability identifier in: path name: vulnerabilityId required: true schema: type: string HostVulnerabilitySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for ''name'' is Ascending. Default order for other values is descending. If no value is specified name is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/HostVulnerabilitySortBy' schema: type: string enum: - name - severity - impactedHosts - firstDetected - lastDetected default: name RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED ContainerScanResultSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default. ' in: query name: sortBy required: false x-obmcs-top-level-enum: '#/definitions/ContainerScanResultSortBy' schema: type: string enum: - timeStarted - problemCount - highestProblemSeverity default: timeStarted RepositoryQueryParam: description: Repository name in: query name: repository required: false x-default-description: 'null' schema: type: string ContainerScanTargetIdentifierPathParam: description: unique ContainerScanTarget identifier in: path name: containerScanTargetId required: true schema: type: string ImageQueryParam: description: Image name in: query name: image required: false x-default-description: 'null' schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default sort order for timeCreated is descending. The default sort order for displayName is ascending. If no value is specified, timeCreated is the default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated IsLatestOnlyQueryParam: description: A flag to return only the latest scan result of an instance. in: query name: isLatestOnly required: false schema: type: boolean default: false HostEndpointProtectionScanResultIdentifierPathParam: description: unique host endpoint protection scan identifier in: path name: hostEndpointProtectionScanResultId required: true schema: type: string HostPortScanResultIdentifierPathParam: description: unique host port scan identifier in: path name: hostPortScanResultId required: true schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string HostAgentScanResultSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeStarted is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/HostAgentScanResultSortBy' schema: type: string enum: - timeStarted - timeFinished - problemCount - highestProblemSeverity - timeCompleted default: timeStarted SortByTimeQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default sort order for timeUpdated is descending. If no value is specified, timeUpdated is the default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortByTime' schema: type: string enum: - timeUpdated default: timeUpdated DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CveReferenceQueryParam: description: Parameter to filter by CVE reference number for vulnerabilities in: query name: cveReference x-default-description: 'null' schema: type: string HostVulnerabilityIdentifierPathParam: description: unique host scan vulnerability identifier in: path name: hostVulnerabilityId required: true schema: type: string PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 HostAgentScanResultIdentifierPathParam: description: unique host agent scan identifier in: path name: hostAgentScanResultId required: true schema: type: string ContainerScanResultIdentifierPathParam: description: unique container scan identifier in: path name: containerScanResultId required: true schema: type: string ContainerScanRecipeIdentifierPathParam: description: unique ContainerScanRecipe identifier in: path name: containerScanRecipeId required: true schema: type: string RetryTokenHeader: description: '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. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 HostEndpointProtectionScanResultSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/HostEndpointProtectionScanResultSortBy' schema: type: string enum: - timeStarted - timeFinished - problemSeverity default: timeFinished HostCisBenchmarkScanResultSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified timeFinished is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/HostCisBenchmarkScanResultSortBy' schema: type: string enum: - timeStarted - timeFinished - cisBenchmarkScanIssuesCount default: timeFinished HostScanRecipeIdentifierPathParam: description: unique HostScanRecipe identifier in: path name: hostScanRecipeId required: true schema: type: string ImpactedHostSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default sort order is ascending. If no value is specified, instanceId is the default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/ImpactedHostSortBy' schema: type: string enum: - instanceId default: instanceId InstanceIdQueryParam: description: The ID of a compute instance. in: query name: instanceId x-default-description: 'null' schema: type: string VulnerabilityReferenceQueryParam: description: Parameter to filter the vulnerability type's unique identifier. For CVE, this is the MITRE CVE ID in: query name: vulnerabilityReference x-default-description: 'null' schema: type: string OperatingSystemQueryParam: description: Parameter to filter by operating system for scan results in: query name: operatingSystem x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment which contains the resources to list. in: query name: compartmentId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 TimeStartedGreaterThanOrEqualToQueryParam: description: Date and time on or after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) in: query name: timeStartedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time TimeStartedLessThanOrEqualToQueryParam: description: Date and time on or before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) in: query name: timeStartedLessThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time VulnerabilityTypeQueryParam: description: 'The field to filter vulnerabilities based on its type. Only one value can be provided. ' in: query name: vulnerabilityType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/VulnerabilityType' schema: type: string enum: - CVE - PROBLEM HostScanTargetIdentifierPathParam: description: unique HostScanTarget identifier in: path name: hostScanTargetId required: true schema: type: string HostCisBenchmarkScanResultIdentifierPathParam: description: unique host Cis benchmark scan identifier in: path name: hostCisBenchmarkScanResultId required: true schema: type: string schemas: Error: description: The error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message HostEndpointProtectionScanResultSummaryCollection: description: A collection of a multiple Host EndpointProtection Scan Result Summary. properties: items: description: The HostEndpointProtectionScanResultSummary objects in the collection. items: $ref: '#/components/schemas/HostEndpointProtectionScanResultSummary' type: array required: - items type: object HostPortScanResultOpenPort: description: An open port found in a host port scan. properties: ipAddress: description: The IP Address on which the open port was found. type: string port: description: Open port. type: integer protocol: description: The protocol of the open port. type: string service: description: The service running on the port (if detected). type: string severity: description: The problem severity. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' vnicId: description: The ID of the attached VNIC that exposed the IP Address scanned. type: string required: - port - protocol - ipAddress - vnicId - severity type: object VulnerabilityImpactedContainerSummary: description: Information on a container image impacted by a vulnerability properties: containerScanTargetId: description: The scan target id of the repository scan result type: string image: description: The name of the container image. type: string lastContainerScanId: description: The ID of the last container image scan result Id type: string registry: description: The registry key of the container image. type: string repository: description: The repository id of the container image. type: string timeScanCompleted: description: Date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - containerScanTargetId - repository - image - registry - lastContainerScanId - timeScanCompleted type: object HostEndpointProtectionScanResultSummary: description: A result summary for the endpoint protections found in a host scan. properties: compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string endpointProtectionsCount: description: The total number of endpoint protections found in this scan. type: integer id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' problemSeverity: description: The problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - timeStarted - timeFinished - problemSeverity - endpointProtectionsCount type: object ContainerScanResultProblem: description: A problem found in a container scan properties: cveReference: description: Reference to problem MITRE CVE ID type: string description: description: Problem description type: string name: description: Name of the problem type: string severity: description: Problem severity enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: State of the vulnerability enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: Date of scan result that first reported the vulnerability format: date-time type: string timeLastDetected: description: Date of scan result that most recently reported the vulnerability format: date-time type: string vulnerablePackages: description: Packages in which the problem is detected items: $ref: '#/components/schemas/Package' maxItems: 10 minItems: 0 type: array uniqueItems: true required: - name - severity type: object HostVulnerabilityImpactedHostSummary: description: The information on a host impacted by a vulnerability. properties: compartmentId: description: The compartment ID of the impacted host. type: string instanceId: description: The compute instance ID of the impacted host. type: string lastAgentScanId: description: The ID of the last host agent scan result. type: string lifecycleState: description: The current state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' required: - instanceId - compartmentId - lastAgentScanId type: object ContainerScanTargetSummaryCollection: description: A collection of ContainerScanTargetSummary objects properties: items: description: The ContainerScanTargetSummary objects in the collection items: $ref: '#/components/schemas/ContainerScanTargetSummary' type: array required: - items type: object Package: description: The details of the vulnerable package found. properties: cveFixVersion: description: The package version in which the CVE was fixed. type: string locations: description: The disk locations where the package was found. items: type: string type: array name: description: The name of the package. type: string type: description: The package type. enum: - JAVA - APK - RPM - DEB - GO - NPM - PYTHON - RUST - PHP_COMPOSER - GEM - MSRC_KB type: string version: description: The package version. type: string required: - name - version - type type: object HostScanAgentSettings: description: The agent scan settings for a host scan. properties: agentConfiguration: $ref: '#/components/schemas/HostScanAgentConfiguration' scanLevel: description: The scan level. enum: - NONE - STANDARD type: string x-obmcs-top-level-enum: '#/definitions/HostAgentScanLevel' required: - scanLevel HostScanTargetErrorSummaryCollection: description: A collection of HostScanTargetError objects. properties: items: description: The HostScanTargetError objects in the collection. items: $ref: '#/components/schemas/HostScanTargetErrorSummary' type: array required: - items type: object ContainerScanTargetSummary: description: Summary of a container scan target (application of a container scan recipe to the registry or list of repos) properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan target's compartment type: string containerScanRecipeId: description: ID of the container scan recipe this target applies. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User friendly name of container scan target type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target. Immutable and generated on creation. type: string lifecycleState: description: The current state of the config. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetRegistry: $ref: '#/components/schemas/ContainerScanRegistry' timeCreated: description: Date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeUpdated: description: Date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - displayName - compartmentId - containerScanRecipeId - lifecycleState - timeCreated - timeUpdated type: object HostCisBenchmarkScanResultSummaryCollection: description: A collection of multiple Host CIS (Center for Internet Security) Benchmark Scan Result Summary. properties: items: description: The HostCisBenchmarkScanResultSummary objects in the collection. items: $ref: '#/components/schemas/HostCisBenchmarkScanResultSummary' type: array required: - items type: object UpdateContainerScanRegistryDetails: description: Registry information for a container scan target discriminator: propertyName: type properties: type: description: The scan level type: string x-obmcs-enumref: '#/definitions/ContainerScanRegistry/type' url: description: URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). If null, will not be updated. maxLength: 512 minLength: 1 type: string x-default-description: null required: - type type: object CreateHostScanRecipeDetails: description: The information for a new host scan recipe. properties: agentSettings: $ref: '#/components/schemas/HostScanAgentSettings' applicationSettings: $ref: '#/components/schemas/ApplicationScanSettings' compartmentId: description: The compartment ID of the scanning configuration. If no individual hosts are specified, all hosts in this compartment are scanned. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The recipe identifier, which can be renamed. If the identifier isn't present, it's auto-generated. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object portSettings: $ref: '#/components/schemas/HostScanPortSettings' schedule: $ref: '#/components/schemas/Schedule' required: - compartmentId - portSettings - agentSettings - schedule type: object ExportHostAgentScanResultCsvDetails: description: The details for a HostAgentScan list export to CSV. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to list scans in. maxLength: 255 minLength: 1 type: string highestProblemSeverity: description: The parameter to filter by the highestProblemSeverity for scan results. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' instanceId: description: The parameter to filter by a single compute instance ID for scan results. type: string x-default-description: 'null' operatingSystem: description: The parameter to filter by operating system for scan results. type: string x-default-description: 'null' timeStartedAfter: description: The date and time after which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStartedBefore: description: The date and time before which scans were started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - compartmentId - timeStartedAfter - timeStartedBefore type: object Schedule: description: A scanning schedule. properties: dayOfWeek: description: The day of the week the scheduled scan occurs (not applicable for DAILY type). enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' type: description: How often the scan occurs. enum: - DAILY - WEEKLY type: string x-obmcs-top-level-enum: '#/definitions/ScheduleType' required: - type type: object HostScanRecipe: description: A host scan recipe (collection of host scanning configuration settings). properties: agentSettings: $ref: '#/components/schemas/HostScanAgentSettings' applicationSettings: $ref: '#/components/schemas/ApplicationScanSettings' compartmentId: description: The compartment ID of the scan recipe. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The recipe identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique identifier of the configuration that is immutable on creation. type: string lifecycleState: description: The current state of the configuration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' portSettings: $ref: '#/components/schemas/HostScanPortSettings' schedule: $ref: '#/components/schemas/Schedule' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated - portSettings - agentSettings - schedule type: object HostEndpointProtectionScanResultEndpointProtection: description: An endpoint protection found in a host scan. properties: configurationFinding: description: The configuration information for the endpoint protection service at the time of the scan. example: Signatures are out dated type: string service: description: The name of the endpoint protection service. example: McAfee 8.94 type: string severity: description: The problem severity. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL example: CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' timeSignatureUpdated: description: The date and time endpoint protection signature was updated, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). example: 2021-01-02T15:04:05Z07:00 format: date-time type: string required: - service - configurationFinding - timeSignatureUpdated - severity type: object HostAgentScanResultProblem: description: A problem found in a host agent scan. properties: cveReference: description: The reference to the problem MITRE CVE ID. type: string description: description: The problem description. type: string issueId: description: The reference to the problem issue ID. type: integer name: description: The name of the problem. type: string severity: description: The problem severity. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: The state of the vulnerability. enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: The date of the scan result that first reported the vulnerability. format: date-time type: string timeLastDetected: description: The date of the scan result that most recently reported the vulnerability. format: date-time type: string vulnerablePackages: description: The packages in which the problem is detected. items: $ref: '#/components/schemas/Package' maxItems: 10 minItems: 0 type: array uniqueItems: true required: - name - severity type: object VulnerabilityImpactedContainerSummaryCollection: description: A collection of VulnerabilityImpactedContainer properties: items: description: The ImpactedContainerSummary objects in the collection items: $ref: '#/components/schemas/VulnerabilityImpactedContainerSummary' type: array required: - items type: object HostEndpointProtectionScanResult: description: A scan result for a host endpoint protection scan. properties: compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string endpointProtections: description: The list of endpoint protections found in this scan. items: $ref: '#/components/schemas/HostEndpointProtectionScanResultEndpointProtection' type: array endpointProtectionsCount: description: The total number of endpoint protections found in this scan. type: integer id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' problemSeverity: description: The problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - timeStarted - timeFinished - problemSeverity - endpointProtectionsCount - endpointProtections type: object HostScanTargetErrorSummary: description: A collection of errors during scanning on instances associated with a host scan target (application of a host scan recipe to a compartment or list of hosts). properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object errorCode: description: The error code of the task failure. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object instanceId: description: The OCID of the host instance where scan was performed. type: string lifecycleState: description: The current state of the configuration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' message: description: The error message detailing the task failure. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object task: description: The task that failed during the scan. type: string timeUpdated: description: The date and time the error was updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string vendor: description: The vendor used for the host scan agent. enum: - OCI - QUALYS type: string x-obmcs-top-level-enum: '#/definitions/VendorType' required: - vendor - message - instanceId - lifecycleState - timeUpdated type: object HostVulnerabilitySummaryCollection: description: A collection of the HostVulnerabilitySummary. properties: items: description: The HostVulnerabilitySummary objects in the collection. items: $ref: '#/components/schemas/HostVulnerabilitySummary' type: array required: - items type: object CreateContainerScanTargetDetails: description: The information for a new container scan target properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan target's compartment maxLength: 255 minLength: 1 type: string containerScanRecipeId: description: ID of the container scan recipe this target applies. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Target description. maxLength: 255 minLength: 0 type: string x-default-description: null displayName: description: User friendly name of container scan target. If not present, will be auto-generated. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format "containerScanTarget-" freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object targetRegistry: $ref: '#/components/schemas/CreateContainerScanRegistryDetails' required: - compartmentId - containerScanRecipeId - targetRegistry type: object HostCisBenchmarkScanResultScore: description: A single CIS (Center for Internet Security) benchmark executed in a host scan. properties: benchmarkIdentifier: description: The identifier for this CIS (Center for Internet Security) benchmark. example: 5.2.5 type: string description: description: The details of the CIS (Center for Internet Security) benchmark. example: Ensure SSH LogLevel is appropriate. type: string score: description: The result score of CIS (Center for Internet Security) benchmark execution (Pass/Fail). enum: - PASS - FAIL example: PASS type: string x-obmcs-top-level-enum: '#/definitions/ScanResultScore' required: - benchmarkIdentifier - description - score type: object HostScanAgentConfiguration: description: The agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on the selected agent vendor. discriminator: propertyName: vendor properties: vendor: description: The vendor to use for the host scan agent. enum: - OCI - QUALYS type: string x-obmcs-top-level-enum: '#/definitions/VendorType' vendorType: description: The vendor type to use for the host scan agent. enum: - OCI - QUALYS type: string x-obmcs-top-level-enum: '#/definitions/VendorType' required: - vendor type: object UpdateContainerScanTargetDetails: description: The information to update an existing container scan target properties: containerScanRecipeId: description: ID of the container scan recipe this target applies. maxLength: 255 minLength: 1 type: string x-default-description: null definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Target description. maxLength: 255 minLength: 0 type: string x-default-description: null displayName: description: User friendly name of container scan target maxLength: 255 minLength: 1 type: string x-default-description: null freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object targetRegistry: $ref: '#/components/schemas/UpdateContainerScanRegistryDetails' type: object ChangeContainerScanResultCompartmentDetails: description: Details for a ContainerScanResult compartment change properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the container scan should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object HostVulnerabilitySummary: description: The summary of a host scan vulnerability. properties: compartmentId: description: The compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments. type: string cveReference: description: The reference to the MITRE CVE ID. type: string hostCount: description: The number of scanned hosts in this compartment whose scan results currently report this vulnerability. type: integer id: description: The ID of the vulnerability. type: string lifecycleState: description: The current state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The vulnerability name. type: string severity: description: The severity of the vulnerability. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: The state of the vulnerability. enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: The date of the scan result that first reported the vulnerability. format: date-time type: string timeLastDetected: description: The date of the scan result that most recently reported the vulnerability. format: date-time type: string vulnerabilityType: description: Specifies the type of vulnerability. enum: - CVE - PROBLEM type: string x-obmcs-top-level-enum: '#/definitions/VulnerabilityType' required: - id - compartmentId - severity - name - timeLastDetected - timeFirstDetected - hostCount - vulnerabilityType type: object ContainerScanResultSummary: description: A summary of a result for a container scan properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target maximum: 255 minimum: 1 type: string containerScanTargetId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target. Immutable and generated on creation. type: string highestProblemSeverity: description: Highest problem severity in this report enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan result. Immutable and generated on creation. type: string image: description: Image name maximum: 255 minimum: 1 type: string problemCount: description: Total number of problems found in this scan type: integer repository: description: Repository in which the container image scanned is located maximum: 255 minimum: 1 type: string timeFinished: description: Date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeStarted: description: Date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - repository - image - compartmentId - highestProblemSeverity - timeStarted - timeFinished - problemCount type: object CreateContainerScanRecipeDetails: description: The information for a new container scan recipe properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan recipe's compartment maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User friendly name of container scan recipe. If not present, will be auto-generated. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format "containerScanRecipe-" freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object imageCount: description: This field is set equal to the number of images we want to scan in the first go when the recipe is created type: integer scanSettings: $ref: '#/components/schemas/ContainerScanSettings' required: - compartmentId - scanSettings type: object FolderToScan: description: The folder selected for scanning. properties: folder: description: The folder to be scanned in the corresponding operating system. type: string operatingsystem: description: The operating system type. enum: - LINUX - WINDOWS type: string x-obmcs-top-level-enum: '#/definitions/OperatingSystem' required: - operatingsystem - folder type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_HOST_SCAN_RECIPE - UPDATE_HOST_SCAN_RECIPE - DELETE_HOST_SCAN_RECIPE - CREATE_HOST_SCAN_TARGET - UPDATE_HOST_SCAN_TARGET - DELETE_HOST_SCAN_TARGET - CREATE_CONTAINER_SCAN_RECIPE - UPDATE_CONTAINER_SCAN_RECIPE - DELETE_CONTAINER_SCAN_RECIPE - CREATE_CONTAINER_SCAN_TARGET - UPDATE_CONTAINER_SCAN_TARGET - DELETE_CONTAINER_SCAN_TARGET - DELETE_HOST_AGENT_SCAN_RESULT - DELETE_HOST_PORT_SCAN_RESULT - DELETE_HOST_CIS_BENCHMARK_SCAN_RESULT - DELETE_CONTAINER_SCAN_RESULT type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CveDetails: description: The CVE details. properties: cveReference: description: The CVE ID. type: string cvss3: description: The CVSS v3 score. type: string description: description: The CVE description. type: string exploitable: description: Whether the vulnerability can be exploited. type: string impact: description: The impact on the resource if this vulnerability is exploited. type: string patchable: description: Whether the vulnerability can be patched. type: string referenceUrl: description: A link to more information about this vulnerability. example: https://lists.centos.org/pipermail/centos-announce/2017-May/022441.html type: string relatedCveReference: description: The ID of related CVE, if applicable. type: string solution: description: The recommended solution to fix this vulnerability. type: string threat: description: The threat that the item poses to the resource. type: string timePublished: description: The date and time the CVE was published. format: date-time type: string timeUpdated: description: The date and time the CVE was last modified. format: date-time type: string title: description: The vulnerability title. type: string required: - cveReference - title - cvss3 - timePublished - timeUpdated type: object HostScanRecipeSummary: description: The summary of a host scan recipe (a collection of host scanning configuration settings). properties: compartmentId: description: The compartment ID of the scan recipe. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The recipe identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique identifier of the configuration that is immutable on creation. type: string lifecycleState: description: The current state of the configuration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated type: object CreateContainerScanRegistryDetails: description: Registry information for a container scan target discriminator: propertyName: type properties: type: description: The scan level type: string x-obmcs-enumref: '#/definitions/ContainerScanRegistry/type' url: description: URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). maxLength: 512 minLength: 1 type: string x-default-description: null required: - type type: object Vulnerability: description: A vulnerability found from scans in a compartment properties: authentication: description: Mechanism used for scan authentication type: string compartmentId: description: Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments, based on scan target location type: string cveDescription: description: The description of CVE vulnerability type: string cveDetails: $ref: '#/components/schemas/CveDetails' id: description: ID of the vulnerability type: string impactedResourcesCount: $ref: '#/components/schemas/ImpactedResourcesCount' lifecycleState: description: The current state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: Vulnerability name type: string severity: description: Severity of the vulnerability enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: State of the vulnerability enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: Date of scan result that first reported the vulnerability format: date-time type: string timeLastDetected: description: Date of scan result that most recently reported the vulnerability format: date-time type: string vulnerabilityReference: description: Reference to the vulnerability type's unique identifier. For CVE, this is the MITRE CVE ID type: string vulnerabilityType: description: Specifies the type of Vulnerability enum: - CVE - PROBLEM type: string x-obmcs-top-level-enum: '#/definitions/VulnerabilityType' required: - id - compartmentId - severity - name - timeLastDetected - timeFirstDetected - impactedResourcesCount - vulnerabilityType type: object HostAgentScanResultSummary: description: A summary of a result for a host agent scan. properties: compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string highestProblemSeverity: description: The highest problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' operatingSystem: description: The operating system of the host. type: string problemCount: description: The total number of problems found in this scan. type: integer timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string vendor: description: The vendor that was used for this host scan agent. enum: - OCI - QUALYS type: string x-obmcs-top-level-enum: '#/definitions/VendorType' required: - id - instanceId - compartmentId - highestProblemSeverity - operatingSystem - timeStarted - timeFinished - problemCount type: object HostPortScanResultSummary: description: A result summary for a host agent scan. properties: compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string highestProblemSeverity: description: The highest problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' openPortCount: description: The total number of open ports across all attached VNICs found in this scan. type: integer timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - highestProblemSeverity - timeStarted - timeFinished - openPortCount type: object WorkRequestCollection: description: A collection of WorkRequest objects properties: items: description: The WorkRequest objects in the collection items: $ref: '#/components/schemas/WorkRequest' type: array required: - items type: object ImpactedResourcesCount: description: Number of resources impacted in this compartment whose scan results currently report this vulnerability properties: hostCount: description: Number of scanned hosts in this compartment whose scan results currently report this vulnerability type: integer imageCount: description: Number of scanned container images in this compartment whose scan results currently report this vulnerability type: integer required: - hostCount - imageCount type: object HostCisBenchmarkScanResultSummary: description: A results summary for all CIS (Center for Internet Security) benchmark executions for this host. properties: cisBenchmarkScanIssuesCount: description: Total number of CIS (Center for Internet Security) benchmark issues found in this scan. type: integer compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - timeStarted - timeFinished - cisBenchmarkScanIssuesCount type: object ContainerScanRecipe: description: A container scan recipe (collection of container scanning configuration settings) properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan recipe's compartment type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User friendly name of container scan recipe type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan recipe. Immutable and generated on creation. type: string imageCount: description: This field is set equal to the number of images we want to scan in the first go when the recipe is created type: integer lifecycleState: description: The current state of the config. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' scanSettings: $ref: '#/components/schemas/ContainerScanSettings' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeUpdated: description: Date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated - scanSettings type: object HostPortScanResult: description: A scan result for a host port scan. properties: compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string highestProblemSeverity: description: The highest problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' openPortCount: description: The total number of open ports across all attached VNICs found in this scan. type: integer openPorts: description: The list of open ports (including interface) found in this scan. items: $ref: '#/components/schemas/HostPortScanResultOpenPort' type: array timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - highestProblemSeverity - timeStarted - timeFinished - openPorts type: object VulnerabilityImpactedHostSummaryCollection: description: A collection of HostVulnerabilityImpactedHost properties: items: description: The ImpactedHostSummary objects in the collection items: $ref: '#/components/schemas/VulnerabilityImpactedHostSummary' type: array required: - items type: object ChangeHostCisBenchmarkScanResultCompartmentDetails: description: The details for a HostCisBenchmarkScanResult compartment change properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host port scan should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeContainerScanTargetCompartmentDetails: description: Details for a ContainerScanTarget compartment change properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the container scan target should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ContainerScanRegistry: description: Registry information for a container scan target discriminator: propertyName: type properties: type: description: The scan level enum: - OCIR type: string url: description: URL of the registry. type: string x-default-description: null required: - type - url type: object HostPortScanResultSummaryCollection: description: A collection of HostPortScanResultSummary. properties: items: description: The HostPortScanResultSummary objects in the collection. items: $ref: '#/components/schemas/HostPortScanResultSummary' type: array required: - items type: object ChangeHostScanRecipeCompartmentDetails: description: The details for a HostScanRecipe compartment change. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host scan recipe should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object VulnerabilityImpactedHostSummary: description: Information on a host impacted by a vulnerability properties: compartmentId: description: The compartment ID of the impacted host type: string instanceId: description: The compute instance ID of the impacted host type: string lastAgentScanId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host agent scan result. Immutable and generated on creation. type: string required: - instanceId - compartmentId - lastAgentScanId type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier UpdateHostScanRecipeDetails: description: The information to update an existing host scan recipe. properties: agentSettings: $ref: '#/components/schemas/HostScanAgentSettings' applicationSettings: $ref: '#/components/schemas/ApplicationScanSettings' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The recipe identifier, which can be renamed. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object portSettings: $ref: '#/components/schemas/HostScanPortSettings' schedule: $ref: '#/components/schemas/Schedule' type: object ChangeHostAgentScanResultCompartmentDetails: description: The details for a HostAgentScanResult compartment change. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host agent scan should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeContainerScanRecipeCompartmentDetails: description: Details for a ContainerScanRecipe compartment change properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the container scan recipe should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp ContainerScanRecipeSummaryCollection: description: A collection of ContainerScanRecipeSummary objects properties: items: description: The ContainerScanRecipeSummary objects in the collection items: $ref: '#/components/schemas/ContainerScanRecipeSummary' type: array required: - items type: object HostAgentScanResult: description: A scan result for a host agent scan. properties: compartmentId: description: The compartment ID of the resource. This is the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the resource. maximum: 255 minimum: 1 type: string highestProblemSeverity: description: The highest problem severity in this report. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string kernelVersion: description: The kernel version of the operating system. type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' operatingSystem: description: The operating system of the host. type: string problemCount: description: The total number of problems found in this scan. type: integer problems: description: The list of problems found in this scan. items: $ref: '#/components/schemas/HostAgentScanResultProblem' type: array timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string vendor: description: The vendor that was used for this host scan agent. enum: - OCI - QUALYS type: string x-obmcs-top-level-enum: '#/definitions/VendorType' required: - id - instanceId - compartmentId - highestProblemSeverity - operatingSystem - timeStarted - timeFinished - problems type: object UpdateHostScanTargetDetails: description: The information to update an existing host scan target. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The target description. maxLength: 255 type: string displayName: description: The target identifier, which can be renamed. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostScanRecipeId: description: The ID of the host scan recipe this target applies. maxLength: 255 minLength: 1 type: string instanceIds: description: (Optional) The list of compute instance IDs to target. If empty, targets the entire targetCompartmentId. items: type: string type: array targetCompartmentId: description: The compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. maxLength: 255 minLength: 1 type: string type: object ContainerScanResult: description: A scan result for a container scan properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan result's compartment. This is set to the same as the compartmentId of the container scan target maximum: 255 minimum: 1 type: string containerScanTargetId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target. type: string highestProblemSeverity: description: Highest problem severity in this report enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan result. Immutable and generated on creation. type: string image: description: Image name type: string problemCount: description: Total number of problems found in this scan type: integer problems: description: List of problems found in this scan items: $ref: '#/components/schemas/ContainerScanResultProblem' type: array registryUrl: description: The URL of the docker registry the repository is located in. type: string repository: description: Repository in which the container image scanned is located type: string targetCompartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to where scan was performed. maximum: 255 minimum: 1 type: string timeFinished: description: Date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeStarted: description: Date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - repository - image - compartmentId - highestProblemSeverity - timeStarted - timeFinished - problems type: object HostScanRecipeSummaryCollection: description: A collection of HostScanRecipeSummary objects. properties: items: description: The HostScanRecipeSummary objects in the collection. items: $ref: '#/components/schemas/HostScanRecipeSummary' type: array required: - items type: object VulnerabilitySummary: description: Summary of a scan vulnerability properties: compartmentId: description: Compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments. type: string cveDescription: description: The description of CVE vulnerability type: string id: description: ID of the vulnerability type: string impactedResourcesCount: $ref: '#/components/schemas/ImpactedResourcesCount' lifecycleState: description: The current state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: Vulnerability name type: string severity: description: Severity of the vulnerability enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: State of the vulnerability enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: Date of scan result that first reported the vulnerability format: date-time type: string timeLastDetected: description: Date of scan result that most recently reported the vulnerability format: date-time type: string vulnerabilityReference: description: Reference to the vulnerability type's unique identifier. For CVE, this is the MITRE CVE ID type: string vulnerabilityType: description: Specifies the type of Vulnerability enum: - CVE - PROBLEM type: string x-obmcs-top-level-enum: '#/definitions/VulnerabilityType' required: - id - compartmentId - severity - name - timeLastDetected - timeFirstDetected - impactedResourcesCount - vulnerabilityType type: object HostVulnerability: description: A vulnerability found in one or more host scans in a compartment. properties: authentication: description: The mechanism used for scan authentication. type: string compartmentId: description: The compartment ID of the vulnerability. Vulnerabilities with identical CVEs can exist in different compartments, based on the scan target location. type: string cveDetails: $ref: '#/components/schemas/CveDetails' cveReference: description: The reference to the MITRE CVE ID. type: string hostCount: description: The number of scanned hosts in this compartment whose scan results currently report this vulnerability. type: integer id: description: The ID of the vulnerability. type: string lifecycleState: description: The current state of the resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The vulnerability name. type: string severity: description: The severity of the vulnerability. enum: - NONE - LOW - MEDIUM - HIGH - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/ScanResultProblemSeverity' state: description: The state of the vulnerability. enum: - OPEN - FIXED - NOT_APPLICABLE type: string x-obmcs-top-level-enum: '#/definitions/ScanResultVulnerabilityState' timeFirstDetected: description: The date of the scan result that first reported the vulnerability. format: date-time type: string timeLastDetected: description: The date of the scan result that most recently reported the vulnerability. format: date-time type: string vulnerabilityType: description: Specifies the type of vulnerability. enum: - CVE - PROBLEM type: string x-obmcs-top-level-enum: '#/definitions/VulnerabilityType' required: - id - compartmentId - severity - name - timeLastDetected - timeFirstDetected - hostCount - vulnerabilityType type: object VulnerabilitySummaryCollection: description: A collection of VulnerabilitySummary properties: items: description: The VulnerabilitySummary objects in the collection items: $ref: '#/components/schemas/VulnerabilitySummary' type: array required: - items type: object ContainerScanRecipeSummary: description: Summary of a container scan recipe (collection of container scanning configuration settings) properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan recipe's compartment type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User friendly name of container scan recipe type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan recipe. Immutable and generated on creation. type: string lifecycleState: description: The current state of the config. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeUpdated: description: Date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated type: object HostVulnerabilityImpactedHostSummaryCollection: description: A collection of the HostVulnerabilityImpactedHost summary. properties: items: description: The ImpactedHostSummary objects in the collection. items: $ref: '#/components/schemas/HostVulnerabilityImpactedHostSummary' type: array required: - items type: object ChangeHostScanTargetCompartmentDetails: description: The details for a HostScanTarget compartment change. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host scan target should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeHostEndpointProtectionScanResultCompartmentDetails: description: The details for a HostEndpointProtectionScanResult compartment change. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host port scan should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ApplicationScanSettings: description: The agent scan settings for an application scan. properties: applicationScanRecurrence: description: "Scan recurrences in RFC-5545 section 3.3.10 format. \nOnly weekly, biweekly, and monthly frequencies are allowed:\n\nFREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. Sunday).\n\nFREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. Sunday).\n\nFREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. Sunday, starting from the next such weekday based on the time of setting creation).\n" format: x-obmcs-recurring-time type: string foldersToScan: description: The list of folders selected for scanning. items: $ref: '#/components/schemas/FolderToScan' type: array isEnabled: description: Enable or disable the application scan. type: boolean required: - applicationScanRecurrence - isEnabled - foldersToScan ContainerScanResultSummaryCollection: description: A collection of ContainerScanResultSummary properties: items: description: The ContainerScanResultSummary objects in the collection items: $ref: '#/components/schemas/ContainerScanResultSummary' type: array required: - items type: object ContainerScanSettings: description: A collection of container scan settings properties: scanLevel: description: The scan level enum: - NONE - STANDARD type: string required: - scanLevel type: object HostScanTarget: description: A host scan target (application of a host scan recipe to a compartment or list of hosts). properties: compartmentId: description: The compartment ID of the object (this). type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The target description. type: string displayName: description: The target identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostScanRecipeId: description: The ID of the host scan recipe this target applies. type: string id: description: The unique identifier of the configuration that is immutable on creation. type: string instanceIds: description: (Optional) The list of compute instance IDs to target. If empty, targets the entire targetCompartmentId. items: type: string type: array lifecycleState: description: The current state of the configuration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetCompartmentId: description: The compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. type: string timeCreated: description: The date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - targetCompartmentId - hostScanRecipeId - lifecycleState - timeCreated - timeUpdated type: object WorkRequestErrorCollection: description: A collection of WorkRequestError objects properties: items: description: The WorkRequestError objects in the collection items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object HostCisBenchmarkScanResult: description: A scan result of all CIS (Center for Internet Security) benchmark execution for this host. properties: cisBenchmarkScanIssuesCount: description: Total number of CIS (Center for Internet Security) benchmark issues found in this scan. type: integer cisBenchmarkScanResultScores: description: A single CIS (Center for Internet Security) benchmark scan executed on a host. items: $ref: '#/components/schemas/HostCisBenchmarkScanResultScore' type: array compartmentId: description: The compartment ID of the resource. This is set to the same as the compartment ID of the scan target. maximum: 255 minimum: 1 type: string displayName: description: The name of the result. maximum: 255 minimum: 1 type: string id: description: The unique identifier of the scan. type: string instanceId: description: The instance ID of the compute instance scanned. maximum: 255 minimum: 1 type: string lifecycleState: description: The current state of the result. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' timeFinished: description: The date and time the scan was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the scan was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - instanceId - compartmentId - timeStarted - timeFinished - cisBenchmarkScanIssuesCount - cisBenchmarkScanResultScores type: object UpdateContainerScanRecipeDetails: description: The information to update an existing container scan recipe properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User friendly name of container scan recipe maxLength: 255 minLength: 1 type: string x-default-description: null freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object imageCount: description: This field is set equal to the number of images we want to scan in the first go when the recipe is created type: integer scanSettings: $ref: '#/components/schemas/ContainerScanSettings' type: object HostScanTargetSummary: description: The summary of a host scan target (application of a host scan recipe to a compartment or list of hosts). properties: compartmentId: description: The compartment ID of the object (this). type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The target identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostScanRecipeId: description: The ID of the host scan recipe this target applies. type: string id: description: The unique identifier of the configuration that is immutable on creation. type: string instanceIds: description: (Optional) The list of compute instance IDs to target. If empty, targets the entire targetCompartmentId. items: type: string type: array lifecycleState: description: The current state of the configuration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetCompartmentId: description: The compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. type: string timeCreated: description: The date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - targetCompartmentId - hostScanRecipeId - lifecycleState - timeCreated - timeUpdated type: object ContainerScanTarget: description: A container scan target (application of a container scan recipe to the registry or list of repos) properties: compartmentId: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container scan target's compartment type: string containerScanRecipeId: description: ID of the container scan recipe this target applies. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Target description. type: string displayName: description: User friendly name of container scan target type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target. Immutable and generated on creation. type: string lifecycleState: description: The current state of the config. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetRegistry: $ref: '#/components/schemas/ContainerScanRegistry' timeCreated: description: Date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string timeUpdated: description: Date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string required: - id - displayName - compartmentId - containerScanRecipeId - lifecycleState - timeCreated - timeUpdated type: object ExportHostVulnerabilityCsvDetails: description: The details for a Host Vulnerability list export to CSV action. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to list vulnerabilities in. maxLength: 255 minLength: 1 type: string timeLastDetectedGreaterThanOrEqualTo: description: The date and time on or after which this vulnerability was last detected, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeLastDetectedLessThanOrEqualTo: description: The date and time on or before which this vulnerability was last detected, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - compartmentId - timeLastDetectedGreaterThanOrEqualTo - timeLastDetectedLessThanOrEqualTo type: object ChangeHostPortScanResultCompartmentDetails: description: The details for a HostPortScanResult compartment change. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the host port scan should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object HostScanPortSettings: description: The port scan settings for a host scan. properties: scanLevel: description: The scan level. enum: - NONE - LIGHT - STANDARD type: string x-obmcs-top-level-enum: '#/definitions/HostPortScanLevel' required: - scanLevel HostAgentScanResultSummaryCollection: description: A collection of HostAgentScanResultSummary. properties: items: description: The HostAgentScanResultSummary objects in the collection. items: $ref: '#/components/schemas/HostAgentScanResultSummary' type: array required: - items type: object HostScanTargetSummaryCollection: description: A collection of HostScanTargetSummary objects. properties: items: description: The HostScanTargetSummary objects in the collection. items: $ref: '#/components/schemas/HostScanTargetSummary' type: array required: - items type: object CreateHostScanTargetDetails: description: The information for a new host scan target. properties: compartmentId: description: The compartment ID of the object (this). maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The target description. maxLength: 255 type: string displayName: description: The target identifier, which can be renamed. If the identifier isn't present, it's auto-generated. Avoid entering confidential information. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostScanRecipeId: description: The ID of the host scan recipe this target applies. maxLength: 255 minLength: 1 type: string instanceIds: description: (Optional) The list of compute instance IDs to target. If empty, targets the entire targetCompartmentId. items: type: string type: array targetCompartmentId: description: The compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId - targetCompartmentId - hostScanRecipeId type: object WorkRequestLogEntryCollection: description: A collection of WorkRequestLogEntry objects properties: items: description: The WorkRequestLigEntry objects in the collection items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.vss.cp