CloudGuard Events API
Search, acknowledge, assign, comment on, re-prioritise, archive and close compliance findings, and push third-party findings in through the External Findings surface. 44 operations across 42 paths.
Search, acknowledge, assign, comment on, re-prioritise, archive and close compliance findings, and push third-party findings in through the External Findings surface. 44 operations across 42 paths.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cloudguard-findings-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
info:
title: Events
version: v2
openapi: 3.0.0
servers:
- url: https://api.dome9.com/
description: US region
- url: https://api.{region}.dome9.com/
description: Other regions
variables:
region:
enum:
- eu1
- ap1
- ap2
- ap3
- cace1
default: eu1
paths:
/v2/ExternalFindings/{id}/Archive:
post:
tags:
- External Findings
summary: Archive External Finding
operationId: ExternalFindings_ArchiveExternalFinding_post_/v2/ExternalFindings/{id}/Archive
parameters:
- name: id
in: path
description: the id of the alert (in Dome9)
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
description: Archive a specific external finding. The finding in Dome9 will be marked as 'archived', but not deleted.
It will be searchable.
/v2/ExternalFindings/Archive:
post:
tags:
- External Findings
summary: Archive External Findings
operationId: ExternalFindings_ArchiveExternalFindings_post_/v2/ExternalFindings/Archive
responses:
'204':
description: No Content
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingsOperationRequestViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingsOperationRequestViewModel'
description: filter block, selecting external system, resource, cloud account id, and finding id
required: true
description: Archive selected external findings according filter settings. The findings will be marked as 'archived',
but not deleted. They will be searchable.
/v2/ExternalFindings/search:
post:
tags:
- External Findings
operationId: ExternalFindings_Search_post_/v2/ExternalFindings/search
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.ExternalFindings.ExternalFindingPaginationViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SearchRequestViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SearchRequestViewModel'
required: true
description: ''
summary: Search
/v2/ExternalFindings:
post:
tags:
- External Findings
summary: Post
operationId: ExternalFindings_Post_post_/v2/ExternalFindings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingsResponseViewModel'
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingUpsertRequestViewModel'
application/x-www-form-urlencoded:
schema:
type: array
items:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingUpsertRequestViewModel'
description: list of findings
required: true
description: "Add a list of findings to Dome9, from an external source. The findings will be labelled as external,\
\ but will be searchable as any other finding.\r\nFindings much have a unique findingId (per source)."
delete:
tags:
- External Findings
summary: Delete External Findings
operationId: ExternalFindings_DeleteExternalFindings_delete_/v2/ExternalFindings
responses:
'204':
description: No Content
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingsOperationRequestViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Falconetix.Model.ExternalFindings.ExternalFindingsOperationRequestViewModel'
description: '>filter block, selecting external system, resource, cloud account id, and finding id'
required: true
description: Delete selected external findings in Dome9. The findings will be permanently removed from Dome9 and will
not be searchable.
/v2/ExternalFindings/{id}:
delete:
tags:
- External Findings
summary: Delete External Finding
operationId: ExternalFindings_DeleteExternalFinding_delete_/v2/ExternalFindings/{id}
parameters:
- name: id
in: path
description: the id of the alert (in Dome9)
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
description: Delete a specific finding in Dome9. The finding will be permanently deleted, and will not be searchable.
/v2/Compliance/Finding/stats/aggregatedbyproperty:
get:
tags:
- Finding
summary: Get Stats By Property
operationId: Finding_GetStatsByProperty_get_/v2/Compliance/Finding/stats/aggregatedbyproperty
parameters:
- name: fromDateTime
in: query
required: true
schema:
type: string
format: date-time
- name: toDateTime
in: query
required: true
schema:
type: string
format: date-time
- name: origin
in: query
required: true
schema:
type: string
enum:
- ComplianceEngine
- Magellan
- MagellanAwsGuardDuty
- Serverless
- Agentless
- AwsInspector
- ServerlessSecurityAnalyzer
- ExternalFindingSource
- Qualys
- Tenable
- AwsGuardDuty
- KubernetesImageScanning
- KubernetesRuntimeAssurance
- ContainersRuntimeProtection
- WorkloadChangeMonitoring
- ImageAssurance
- SourceCodeAssurance
- InfrastructureAsCode
- CIEM
- Incident
- name: aggProperty
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingsStatsBySeverityViewModel'
description: Get aggregation per property
/v2/Compliance/Finding/bundle/{bundleId}/stats:
get:
tags:
- Finding
summary: Get Bundle Stats
operationId: Finding_GetBundleStats_get_/v2/Compliance/Finding/bundle/{bundleId}/stats
parameters:
- name: bundleId
in: path
description: ''
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingsStatsViewModel'
description: Get statistics for each rule in a bundle (number failures)
/v2/Compliance/Finding/bundle/{bundleId}:
get:
tags:
- Finding
summary: Get Findings
operationId: Finding_GetFindings_get_/v2/Compliance/Finding/bundle/{bundleId}
parameters:
- name: bundleId
in: path
description: the bundle id
required: true
schema:
type: integer
format: int64
- name: ruleLogicHash
in: query
description: MD5 hash of the rule GSL string
required: true
schema:
type: string
- name: pageNumber
in: query
description: the findings page (findings are returned in pages, with pageSize findings in each page)
required: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: the number of findings in a page
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BaseFindingViewModel'
description: Get the findings for a specific rule in a bundle, for all of the user's accounts. Results are paged, so
each request returns findings for a specific page.
/v2/Compliance/Finding/{id}:
get:
tags:
- Finding
summary: Get Finding
operationId: Finding_GetFinding_get_/v2/Compliance/Finding/{id}
parameters:
- name: id
in: path
description: the finding id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
description: Get details for a specific finding, identified by its id.
delete:
tags:
- Finding
summary: Delete
operationId: Finding_DeleteAsync_delete_/v2/Compliance/Finding/{id}
parameters:
- name: id
in: path
description: Finding ID (Guid)
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: Delete finding originated in Magellan by id (Guid)
/v2/Compliance/Finding/getByKey:
post:
tags:
- Finding
summary: Get Finding By Key
operationId: Finding_GetFindingByKey_post_/v2/Compliance/Finding/getByKey
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.GetFindingByKeyViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.GetFindingByKeyViewModel'
description: finding key
required: true
description: Get details for a specific finding, identified by finding key.
/v2/Compliance/Finding/archive/{id}:
delete:
tags:
- Finding
summary: Delete
operationId: Finding_DeleteAsync_delete_/v2/Compliance/Finding/archive/{id}
parameters:
- name: id
in: path
description: Finding ID (Guid)
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: Delete finding originated in Magellan by id (Guid)
/v2/Compliance/Finding/bulk/close:
post:
tags:
- Finding
summary: Bulk Delete
operationId: Finding_BulkDeleteAsync_post_/v2/Compliance/Finding/bulk/close
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
$ref: '#/components/requestBodies/Finding_BulkDeleteAsyncIds'
description: Delete findings originated in Magellan by ids (Guid)
/v2/Compliance/Finding/bulk/archive/close:
post:
tags:
- Finding
summary: Bulk Delete
operationId: Finding_BulkDeleteAsync_post_/v2/Compliance/Finding/bulk/archive/close
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
$ref: '#/components/requestBodies/Finding_BulkDeleteAsyncIds'
description: Delete findings originated in Magellan by ids (Guid)
/v2/Compliance/Finding/selectAll/close:
post:
tags:
- Finding
summary: Select All Close
operationId: Finding_SelectAllClose_post_/v2/Compliance/Finding/selectAll/close
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Compliance.Models.ActionType_'
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action that selected\
\ - Delete findings originated in Magellan by ids (Guid)."
/v2/Compliance/Finding/selectAll/archive/close:
post:
tags:
- Finding
summary: Select All Close
operationId: Finding_SelectAllClose_post_/v2/Compliance/Finding/selectAll/archive/close
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Compliance.Models.ActionType_'
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action that selected\
\ - Delete findings originated in Magellan by ids (Guid)."
/v2/Compliance/Finding/search:
post:
tags:
- Finding
summary: Search
operationId: Finding_Search_post_/v2/Compliance/Finding/search
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingPaganationViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.SearchRequestViewModel'
description: Filter findings by account, region, VPC, IP, or instance name
/v2/Compliance/Finding/searchAggregate:
post:
tags:
- Finding
summary: Search Aggregate
operationId: Finding_SearchAggregate_post_/v2/Compliance/Finding/searchAggregate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingPaganationViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.SearchRequestViewModel'
description: Filter findings by account, region, VPC, IP, or instance name , returns only aggregations appear in the
searchRequest's filter
/v2/Compliance/Finding/Sources:
get:
tags:
- Finding
summary: Get Supported Sources
operationId: Finding_GetSupportedSources_get_/v2/Compliance/Finding/Sources
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingController.FindingSourceViewModel'
description: returns all the supported sources and their metadata
/v2/Compliance/Finding/{id}/acknowledge:
put:
tags:
- Finding
summary: Acknowledge
operationId: Finding_Acknowledge_put_/v2/Compliance/Finding/{id}/acknowledge
parameters:
- name: id
in: path
description: the finding id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel'
description: updated information about the finding, including the acknowledgement
required: true
description: Acknowledge a finding. Acknowledging a finding indicates it was viewed (or retrieved), but does not indicate
it was resolved.
/v2/Compliance/Finding/bulk/acknowledge:
put:
tags:
- Finding
operationId: Finding_BulkAcknowledge_put_/v2/Compliance/Finding/bulk/acknowledge
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_'
required: true
description: ''
summary: Bulk Acknowledge
/v2/Compliance/Finding/selectAll/acknowledge:
put:
tags:
- Finding
summary: Select All Acknowledge
operationId: Finding_SelectAllAcknowledge_put_/v2/Compliance/Finding/selectAll/acknowledge
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_'
description: the filter selections and updated information about the findings, including the acknowledgement
required: true
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action that selected\
\ - Acknowledge a finding. Acknowledging a finding indicates it was viewed (or retrieved), but does not indicate it\
\ was resolved.."
/v2/Compliance/Finding/{id}/severity:
put:
tags:
- Finding
summary: Change Severity
operationId: Finding_ChangeSeverity_put_/v2/Compliance/Finding/{id}/severity
parameters:
- name: id
in: path
description: the finding id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel'
description: updated information about the finding, including the new severity
required: true
description: Change the severity of a specific finding
/v2/Compliance/Finding/bulk/severity:
put:
tags:
- Finding
operationId: Finding_BulkSeverity_put_/v2/Compliance/Finding/bulk/severity
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_'
required: true
description: ''
summary: Bulk Severity
/v2/Compliance/Finding/selectAll/severity:
put:
tags:
- Finding
summary: Select All Severity
operationId: Finding_SelectAllSeverity_put_/v2/Compliance/Finding/selectAll/severity
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_'
description: the filter selections and updated information about the findings, including the new severity
required: true
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action that selected\
\ - Change the severity of all specific findings."
/v2/Compliance/Finding/{id}/assign:
put:
tags:
- Finding
summary: Assign
operationId: Finding_Assign_put_/v2/Compliance/Finding/{id}/assign
parameters:
- name: id
in: path
description: the finding id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel'
description: updated information about the finding, including the assigned user
required: true
description: Assign a finding to a user.
/v2/Compliance/Finding/bulk/assign:
put:
tags:
- Finding
operationId: Finding_BulkAssign_put_/v2/Compliance/Finding/bulk/assign
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_'
required: true
description: ''
summary: Bulk Assign
/v2/Compliance/Finding/selectAll/assign:
put:
tags:
- Finding
summary: Select All Assign
operationId: Finding_SelectAllAssign_put_/v2/Compliance/Finding/selectAll/assign
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_'
description: the filter selections and updated information about the findings, including the assigned user
required: true
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action - Assign a finding\
\ to a user."
/v2/Compliance/Finding/{id}/comment:
post:
tags:
- Finding
summary: Add Comment
operationId: Finding_AddComment_post_/v2/Compliance/Finding/{id}/comment
parameters:
- name: id
in: path
description: the finding id (or key)
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PostCommentViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PostCommentViewModel'
description: updated information about the finding, including the comment
required: true
description: Add a comment for a finding
/v2/Compliance/Finding/bulk/comment:
put:
tags:
- Finding
operationId: Finding_BulkComment_put_/v2/Compliance/Finding/bulk/comment
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_'
required: true
description: ''
summary: Bulk Comment
/v2/Compliance/Finding/selectAll/comment:
put:
tags:
- Finding
summary: Select All Comment
operationId: Finding_SelectAllComment_put_/v2/Compliance/Finding/selectAll/comment
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_'
description: the filter selections and updated the findings comment
required: true
description: "Filter findings by account, region, VPC, IP, instance name..\r\nThen perform the action that selected\
\ - Add a comment for the findings."
/v2/Compliance/Finding/{id}/archive:
post:
tags:
- Finding
summary: Archive
operationId: Finding_Archive_post_/v2/Compliance/Finding/{id}/archive
parameters:
- name: id
in: path
description: ''
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
description: Archive/unarchive a specific finding
/v2/Compliance/Finding/{id}/unarchive:
post:
tags:
- Finding
summary: Archive
operationId: Finding_Archive_post_/v2/Compliance/Finding/{id}/unarchive
parameters:
- name: id
in: path
description: ''
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
description: Archive/unarchive a specific finding
/v2/Compliance/Finding/bulk/archive:
put:
tags:
- Finding
summary: Bulk Archive
operationId: Finding_BulkArchive_put_/v2/Compliance/Finding/bulk/archive
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.ArchiveFindingModel_'
description: Bulk archive/unarchive findings
/v2/Compliance/Finding/bulk/unarchive:
put:
tags:
- Finding
summary: Bulk Archive
operationId: Finding_BulkArchive_put_/v2/Compliance/Finding/bulk/unarchive
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel'
requestBody:
$ref: '#/components/requestBodies/Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.ArchiveFindingModel_'
description: Bulk archive/unarchive findings
/v2/Compliance/Finding/comment:
post:
tags:
- Finding
summary: Add Comment By Finding Key
operationId: Finding_AddCommentByFindingKey_post_/v2/Compliance/Finding/comment
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.FindingViewModel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PostCommentByFindingKeyViewModel'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Dome9.Web.Api.Compliance.Finding.PostCommentByFindingKeyViewModel'
description: updated information about the finding, including the comment and the finding key
required: true
description: Add a comment for a finding
/v2/Compliance/Finding/origins:
get:
tags:
- Finding
operationId: Finding_GetOrigins_get_/v2/Compliance/Finding/origins
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudguard/refs/heads/main/openapi/cloudguard-events-openapi.yml