How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

CloudGuard Events API is one of 25 APIs that CloudGuard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Findings, Events, Alerts, and Triage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 44 operations across 42 paths, organized into 4 resource areas, and defines 52 schemas. It is described by OpenAPI 3.0.0, at version v2.

Requests are made against 2 base URLs: https://api.dome9.com/, https://api.{region}.dome9.com/.

44 operations 42 paths 52 schemas 4 DELETE6 GET21 POST13 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v2
Base URL
https://api.dome9.com
Authentication
HTTP Basic
Resource Areas
4

Authentication & Security 1

CloudGuard Events API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic). By default, every request must be authenticated.

Paths & Operations 44

Across 42 paths, the API surfaces 44 operations — 4 DELETE, 6 GET, 21 POST, 13 PUT. They span 4 resource areas: External Findings, Finding, Findings Report, Protected Assets Report. Each is listed below with its method, path, parameters, and response codes.

External Findings 6
POST
/v2/ExternalFindings/{id}/Archive
Archive External Finding
ExternalFindings_ArchiveExternalFinding_post_/v2/ExternalFindings/{id}/Archive 1 param → 204
POST
/v2/ExternalFindings/Archive
Archive External Findings
ExternalFindings_ArchiveExternalFindings_post_/v2/ExternalFindings/Archive body → 204
POST
/v2/ExternalFindings/search
Search
ExternalFindings_Search_post_/v2/ExternalFindings/search body → 200
POST
/v2/ExternalFindings
Post
ExternalFindings_Post_post_/v2/ExternalFindings body → 200
DELETE
/v2/ExternalFindings
Delete External Findings
ExternalFindings_DeleteExternalFindings_delete_/v2/ExternalFindings body → 204
DELETE
/v2/ExternalFindings/{id}
Delete External Finding
ExternalFindings_DeleteExternalFinding_delete_/v2/ExternalFindings/{id} 1 param → 204
Finding 32

Compliance Findings

GET
/v2/Compliance/Finding/stats/aggregatedbyproperty
Get Stats By Property
Finding_GetStatsByProperty_get_/v2/Compliance/Finding/stats/aggregatedbyproperty 4 params → 200
GET
/v2/Compliance/Finding/bundle/{bundleId}/stats
Get Bundle Stats
Finding_GetBundleStats_get_/v2/Compliance/Finding/bundle/{bundleId}/stats 1 param → 200
GET
/v2/Compliance/Finding/bundle/{bundleId}
Get Findings
Finding_GetFindings_get_/v2/Compliance/Finding/bundle/{bundleId} 4 params → 200
GET
/v2/Compliance/Finding/{id}
Get Finding
Finding_GetFinding_get_/v2/Compliance/Finding/{id} 1 param → 200
DELETE
/v2/Compliance/Finding/{id}
Delete
Finding_DeleteAsync_delete_/v2/Compliance/Finding/{id} 1 param → 200
POST
/v2/Compliance/Finding/getByKey
Get Finding By Key
Finding_GetFindingByKey_post_/v2/Compliance/Finding/getByKey body → 200
DELETE
/v2/Compliance/Finding/archive/{id}
Delete
Finding_DeleteAsync_delete_/v2/Compliance/Finding/archive/{id} 1 param → 200
POST
/v2/Compliance/Finding/bulk/close
Bulk Delete
Finding_BulkDeleteAsync_post_/v2/Compliance/Finding/bulk/close body → 200
POST
/v2/Compliance/Finding/bulk/archive/close
Bulk Delete
Finding_BulkDeleteAsync_post_/v2/Compliance/Finding/bulk/archive/close body → 200
POST
/v2/Compliance/Finding/selectAll/close
Select All Close
Finding_SelectAllClose_post_/v2/Compliance/Finding/selectAll/close body → 200
POST
/v2/Compliance/Finding/selectAll/archive/close
Select All Close
Finding_SelectAllClose_post_/v2/Compliance/Finding/selectAll/archive/close body → 200
POST
/v2/Compliance/Finding/search
Search
Finding_Search_post_/v2/Compliance/Finding/search body → 200
POST
/v2/Compliance/Finding/searchAggregate
Search Aggregate
Finding_SearchAggregate_post_/v2/Compliance/Finding/searchAggregate body → 200
GET
/v2/Compliance/Finding/Sources
Get Supported Sources
Finding_GetSupportedSources_get_/v2/Compliance/Finding/Sources → 200
PUT
/v2/Compliance/Finding/{id}/acknowledge
Acknowledge
Finding_Acknowledge_put_/v2/Compliance/Finding/{id}/acknowledge 1 param body → 200
PUT
/v2/Compliance/Finding/bulk/acknowledge
Bulk Acknowledge
Finding_BulkAcknowledge_put_/v2/Compliance/Finding/bulk/acknowledge body → 200
PUT
/v2/Compliance/Finding/selectAll/acknowledge
Select All Acknowledge
Finding_SelectAllAcknowledge_put_/v2/Compliance/Finding/selectAll/acknowledge body → 200
PUT
/v2/Compliance/Finding/{id}/severity
Change Severity
Finding_ChangeSeverity_put_/v2/Compliance/Finding/{id}/severity 1 param body → 200
PUT
/v2/Compliance/Finding/bulk/severity
Bulk Severity
Finding_BulkSeverity_put_/v2/Compliance/Finding/bulk/severity body → 200
PUT
/v2/Compliance/Finding/selectAll/severity
Select All Severity
Finding_SelectAllSeverity_put_/v2/Compliance/Finding/selectAll/severity body → 200
PUT
/v2/Compliance/Finding/{id}/assign
Assign
Finding_Assign_put_/v2/Compliance/Finding/{id}/assign 1 param body → 200
PUT
/v2/Compliance/Finding/bulk/assign
Bulk Assign
Finding_BulkAssign_put_/v2/Compliance/Finding/bulk/assign body → 200
PUT
/v2/Compliance/Finding/selectAll/assign
Select All Assign
Finding_SelectAllAssign_put_/v2/Compliance/Finding/selectAll/assign body → 200
POST
/v2/Compliance/Finding/{id}/comment
Add Comment
Finding_AddComment_post_/v2/Compliance/Finding/{id}/comment 1 param body → 200
PUT
/v2/Compliance/Finding/bulk/comment
Bulk Comment
Finding_BulkComment_put_/v2/Compliance/Finding/bulk/comment body → 200
PUT
/v2/Compliance/Finding/selectAll/comment
Select All Comment
Finding_SelectAllComment_put_/v2/Compliance/Finding/selectAll/comment body → 200
POST
/v2/Compliance/Finding/{id}/archive
Archive
Finding_Archive_post_/v2/Compliance/Finding/{id}/archive 1 param → 200
POST
/v2/Compliance/Finding/{id}/unarchive
Archive
Finding_Archive_post_/v2/Compliance/Finding/{id}/unarchive 1 param → 200
PUT
/v2/Compliance/Finding/bulk/archive
Bulk Archive
Finding_BulkArchive_put_/v2/Compliance/Finding/bulk/archive body → 200
PUT
/v2/Compliance/Finding/bulk/unarchive
Bulk Archive
Finding_BulkArchive_put_/v2/Compliance/Finding/bulk/unarchive body → 200
POST
/v2/Compliance/Finding/comment
Add Comment By Finding Key
Finding_AddCommentByFindingKey_post_/v2/Compliance/Finding/comment body → 200
GET
/v2/Compliance/Finding/origins
Get Origins
Finding_GetOrigins_get_/v2/Compliance/Finding/origins → 200
Findings Report 3
POST
/v2/findingsReport/exportToCsv
Export To Csv
FindingsReport_ExportToCsv_post_/v2/findingsReport/exportToCsv body → 200
POST
/v2/findingsReport/exportToCsv/downloadLink
Export To Csv Download Link
FindingsReport_ExportToCsvDownloadLink_post_/v2/findingsReport/exportToCsv/downloadLink body → 200
POST
/v2/findingsReport/exportToCsv/downloadCSV
Export To Csv DownloadCSV
FindingsReport_ExportToCsvDownloadCSV_post_/v2/findingsReport/exportToCsv/downloadCSV body → 200
Protected Assets Report 3
POST
/v2/ProtectedAssetsReport/exportToCsv
Export To Csv
ProtectedAssetsReport_ExportToCsv_post_/v2/ProtectedAssetsReport/exportToCsv body → 200
POST
/v2/ProtectedAssetsReport/exportToCsv/downloadLink
Export To Csv Download Link
ProtectedAssetsReport_ExportToCsvDownloadLink_post_/v2/ProtectedAssetsReport/exportToCsv/downloadLink body → 200
POST
/v2/ProtectedAssetsReport/exportToCsv/downloadCSV
Export To Csv DownloadCSV
ProtectedAssetsReport_ExportToCsvDownloadCSV_post_/v2/ProtectedAssetsReport/exportToCsv/downloadCSV body → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Dome9.Web.Api.Compliance.Finding.FindingViewModel (46 properties), Dome9.Web.Api.Compliance.Finding.BaseFindingViewModel (45 properties), Falconetix.Model.ExternalFindings.ExternalFindingUpsertRequestViewModel (23 properties), Dome9.Web.Api.ProtectedAsset.SearchRequestViewModel (10 properties). Each schema is shown below with its type and property counts.

Falconetix.Model.RuleEngine.Entities.TagRuleEntity
object
2 properties
Falconetix.Model.ExternalFindings.ExternalFindingsOperationRequestViewModel
object
4 properties 2 required
Dome9.Web.Api.Compliance.Finding.SearchRequestViewModel
object
8 properties
Dome9.Web.Api.Compliance.Finding.SortingViewModel
object
2 properties
Dome9.Web.Api.Compliance.Finding.SearchFilterViewModel
object
7 properties
CGN.OpenSearch.Model.CommonViewModels.FieldFilterViewModel
object
2 properties
Dome9.Web.Api.Shared.SharedViewModels.DateRangeViewModel
object
2 properties
Dome9.Web.Api.ExternalFindings.ExternalFindingPaginationViewModel
object
5 properties
Dome9.Web.Api.Compliance.Finding.FindingViewModel
object
46 properties
Dome9.Web.Api.Compliance.Finding.FieldAggregationViewModel
object
2 properties
Dome9.Web.Api.Compliance.Finding.FindingCommentViewModel
object
comments for a finding (listed by user)
3 properties
Falconetix.Model.RuleEngine.Entities.Compliance.AssessmentFinding.MagellanData
object
2 properties
Falconetix.Model.ElasticSearch.WebhookResponse.WebhookResponseMessage
object
2 properties
Falconetix.Model.RuleEngine.Entities.FindingAdditionalFieldViewModel
object
2 properties
Falconetix.Model.ExternalFindings.ExternalFindingUpsertRequestViewModel
object
23 properties 9 required
Falconetix.Model.ExternalFindings.ExternalFindingsRulesPackageViewModel
object
4 properties
Falconetix.Model.ExternalFindings.ExternalFindingsFieldViewModel
object
3 properties
Falconetix.Model.ExternalFindings.ExternalFindingsResponseViewModel
object
3 properties
Falconetix.Model.ExternalFindings.FailedExternalFindingsResponse
object
2 properties
Dome9.Web.Api.Compliance.Finding.FindingsStatsBySeverityViewModel
object
Statistics (passes/fails) per severity
2 properties
Dome9.ElasticSearch.Std.Base.AggKeyStatistics
object
2 properties
Dome9.Web.Api.Compliance.Finding.FindingsStatsViewModel
object
Statistics (passes/fails) for a bundle
1 property
Dome9.ElasticSearch.Std.Finding.RuleStatistics
object
2 properties
Dome9.Web.Api.Compliance.Finding.BaseFindingViewModel
object
45 properties
Dome9.Web.Api.Compliance.Finding.GetFindingByKeyViewModel
object
1 property 1 required
Dome9.Web.Api.Compliance.Finding.SelectAllResponseViewModel
object
8 properties
Dome9.Web.Api.Compliance.Finding.FindingPaganationViewModel
object
5 properties
Dome9.Web.Api.Compliance.Finding.FindingController.FindingSourceViewModel
object
4 properties
Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel
object
2 properties
Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel
object
2 properties 1 required
Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel
object
1 property
Dome9.Web.Api.Compliance.Finding.PostCommentViewModel
object
1 property 1 required
Dome9.Web.Api.Compliance.Finding.ArchiveFindingModel
object
Dome9.Web.Api.Compliance.Finding.PostCommentByFindingKeyViewModel
object
2 properties 2 required
Dome9.Web.Api.Compliance.Finding.FindingController.AssessmentFindingOriginProperties
object
3 properties
Dome9.Web.Api.Compliance.Report.FindingsReportViewModel
object
4 properties
Dome9.Web.Api.ProtectedAsset.SearchRequestViewModel
object
Search or filter parameters. This object is passed via url so the field names are short because quary params are limited (about 2000 chars)
10 properties
CGN.OpenSearch.Model.CommonViewModels.SortingViewModel
object
2 properties
CGN.OpenSearch.Model.CommonViewModels.SearchFilterViewModel
object
7 properties
CGN.OpenSearch.Model.CommonViewModels.AdditionalFieldsRequestViewModel
object
3 properties
CGN.OpenSearch.Model.CommonViewModels.TagViewModel
object
2 properties
Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Compliance.Models.ActionType_
object
3 properties
Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_
object
2 properties
Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAcknowledgedViewModel_
object
3 properties
Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_
object
2 properties
Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutSeverityViewModel_
object
3 properties
Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_
object
2 properties
Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PutAssigneeViewModel_
object
3 properties
Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_
object
2 properties
Dome9.Web.Api.Compliance.Finding.SelectAllRequestViewModel_Dome9.Web.Api.Compliance.Finding.PostCommentViewModel_
object
3 properties
Dome9.Web.Api.Compliance.Finding.BulkViewModel.BulkRequestViewModel_Dome9.Web.Api.Compliance.Finding.ArchiveFindingModel_
object
2 properties
Falconetix.Model.ProtectedAssetsReport.ProtectedAssetsReportViewModel_Dome9.Web.Api.ProtectedAsset.SearchRequestViewModel_
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudguard-events-openapi.yml Raw ↑

Other APIs CloudGuard publishes across the network.

CloudGuard Onboarding API
CloudGuard Posture Management API
CloudGuard Administration API
CloudGuard Risk Management API
CloudGuard Workload Protection (CWPP) API
CloudGuard Network Security API
CloudGuard Identity API
CloudGuard Intelligence API
CloudGuard Inventory API
CloudGuard Inventory - AWS Global API
CloudGuard Inventory - AWS IAM API
CloudGuard Inventory - AWS Compute and Containers API
Where this information came from

This is an independent, third-party profile of CloudGuard Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.