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 Administration API

Tenant administration - users, roles, IAM Safe entities, delivery integrations, and the Continuous Compliance Notification surface that routes findings to webhooks, SNS, Slack, Teams, ticketing systems and cloud security hubs. 77 operations across 50 paths.

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

Tagged areas include Administration, Notification, Integrations, Users, and Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 77 operations across 50 paths, organized into 14 resource areas, and defines 94 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/.

77 operations 50 paths 94 schemas 12 DELETE34 GET1 PATCH17 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
14

Authentication & Security 1

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

Paths & Operations 77

Across 50 paths, the API surfaces 77 operations — 12 DELETE, 34 GET, 1 PATCH, 17 POST, 13 PUT. They span 14 resource areas, including Account Trust, Audit, Billable Assets, Billable Assets Report, Cloud Infra User, Continuous Compliance Notification, Global Search, Role, and 6 more. Each is listed below with its method, path, parameters, and response codes.

Account Trust 5
GET
/v2/AccountTrust/assumable-roles
Get Assumable Roles
AccountTrust_GetAssumableRoles_get_/v2/AccountTrust/assumable-roles → 200
GET
/v2/AccountTrust
Get
AccountTrust_Get_get_/v2/AccountTrust 1 param → 200
POST
/v2/AccountTrust
Post
AccountTrust_Post_post_/v2/AccountTrust body → 200
PUT
/v2/AccountTrust/{id}
Put
AccountTrust_Put_put_/v2/AccountTrust/{id} 1 param body → 200
DELETE
/v2/AccountTrust/{id}
Delete
AccountTrust_Delete_delete_/v2/AccountTrust/{id} 1 param → 204
Audit 8

Audit logs

GET
/v2/audit/event-types
Get Event Types
Audit_GetEventTypes_get_/v2/audit/event-types → 200
GET
/v2/audit/awsgroup/{groupId}
Get Audit Events For Aws Sec Group
Audit_GetAuditEventsForAwsSecGroup_get_/v2/audit/awsgroup/{groupId} 3 params → 200
GET
/v2/audit/export
Get Export
Audit_GetExport_get_/v2/audit/export 4 params → 200
GET
/v2/audit/row-data-api
Get Row Data Api
Audit_GetRowDataApi_get_/v2/audit/row-data-api 3 params → 200
GET
/v2/audit/row-data-system
Get Row Data System
Audit_GetRowDataSystem_get_/v2/audit/row-data-system 3 params → 200
GET
/v2/audit/data-count
Get Row Data Count
Audit_GetRowDataCount_get_/v2/audit/data-count 4 params → 200
GET
/v2/Audit
Get
Audit_Get_get_/v2/Audit 7 params → 200
GET
/v2/Audit/{id}
Get Audit Event Metadata
Audit_GetAuditEventMetadata_get_/v2/Audit/{id} 1 param → 200
Billable Assets 1
GET
/v2/BillableAssets
Get
BillableAssets_Get_get_/v2/BillableAssets → 200
Billable Assets Report 2
GET
/v2/billableAssetsReport/dailyUsage
Get Daily Usage Billable Assets Report
BillableAssetsReport_GetDailyUsageBillableAssetsReport_get_/v2/billableAssetsReport/dailyUsage 2 params → 200
GET
/v2/BillableAssetsReport
Get Billable Assets Report
BillableAssetsReport_GetBillableAssetsReport_get_/v2/BillableAssetsReport 2 params → 200
Cloud Infra User 2
GET
/v2/CloudInfraUser
Get
CloudInfraUser_Get_get_/v2/CloudInfraUser → 200
POST
/v2/CloudInfraUser
Post
CloudInfraUser_Post_post_/v2/CloudInfraUser body → 200
Continuous Compliance Notification 11
GET
/v2/Compliance/ContinuousComplianceNotification/{id}
Get
ContinuousComplianceNotification_Get_get_/v2/Compliance/ContinuousComplianceNotification/{id} 1 param → 200
PUT
/v2/Compliance/ContinuousComplianceNotification/{id}
Put
ContinuousComplianceNotification_Put_put_/v2/Compliance/ContinuousComplianceNotification/{id} 1 param body → 200
DELETE
/v2/Compliance/ContinuousComplianceNotification/{id}
Delete
ContinuousComplianceNotification_Delete_delete_/v2/Compliance/ContinuousComplianceNotification/{id} 1 param → 204
GET
/v2/Compliance/ContinuousComplianceNotification
Get
ContinuousComplianceNotification_Get_get_/v2/Compliance/ContinuousComplianceNotification → 200
POST
/v2/Compliance/ContinuousComplianceNotification
Post
ContinuousComplianceNotification_Post_post_/v2/Compliance/ContinuousComplianceNotification body → 200
GET
/v2/Compliance/ContinuousComplianceNotification/get-by-name
Get By Name
ContinuousComplianceNotification_GetByName_get_/v2/Compliance/ContinuousComplianceNotification/get-by-name 1 param → 200
POST
/v2/Compliance/ContinuousComplianceNotification/PublishOpenedFindings/{id}
Publish Opened Findings By Policy Id
ContinuousComplianceNotification_PublishOpenedFindingsByPolicyIdAsync_post_/v2/Compliance/ContinuousComplianceNotification/PublishOpenedFindings/{id} 1 param body → 200
GET
/v2/Compliance/ContinuousComplianceNotification/webhookJiraTokens
Webhook Jira Tokens
ContinuousComplianceNotification_WebhookJiraTokens_get_/v2/Compliance/ContinuousComplianceNotification/webhookJiraTokens → 200
GET
/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker
Get All Circuit Breaker
ContinuousComplianceNotification_GetAllCircuitBreakerAsync_get_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker → 200
GET
/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}
Get Circuit Breaker
ContinuousComplianceNotification_GetCircuitBreakerAsync_get_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id} 1 param → 200
DELETE
/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}/{integrationType}
Delete Circuit Breaker
ContinuousComplianceNotification_DeleteCircuitBreakerAsync_delete_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}/{integrationType} 2 params → 204
Global Search 1
GET
/v2/GlobalSearch
Get
GlobalSearch_Get_get_/v2/GlobalSearch 1 param → 200
Role 6

CloudGuard Roles

PUT
/{id}/external
Put Role By External Account Id
Role_PutRoleByExternalAccountId_put_/{id}/external 1 param body → 200
GET
/v2/Role
Get
Role_Get_get_/v2/Role → 200
POST
/v2/Role
Post
Role_Post_post_/v2/Role body → 200
GET
/v2/Role/{id}
Get
Role_Get_get_/v2/Role/{id} 1 param → 200
PUT
/v2/Role/{id}
Put
Role_Put_put_/v2/Role/{id} 1 param body → 200
DELETE
/v2/Role/{id}
Delete
Role_Delete_delete_/v2/Role/{id} 1 param → 204
Service Account 7
POST
/v2/service-account/update
Update Service Account
ServiceAccount_UpdateServiceAccount_post_/v2/service-account/update body → 200
GET
/v2/service-account/{id}
Get
ServiceAccount_Get_get_/v2/service-account/{id} 1 param → 200
DELETE
/v2/service-account/{serviceAccountId}
Delete Service Account
ServiceAccount_DeleteServiceAccount_delete_/v2/service-account/{serviceAccountId} 1 param → 204
POST
/v2/service-account/generate-key
Generate Secret For Service Account
ServiceAccount_GenerateSecretForServiceAccount_post_/v2/service-account/generate-key body → 200
GET
/v2/service-account
Get Service Accounts
ServiceAccount_GetServiceAccounts_get_/v2/service-account → 200
POST
/v2/service-account
Post Service Account
ServiceAccount_PostServiceAccount_post_/v2/service-account body → 200
DELETE
/v2/service-account
Delete All Service Accounts For User
ServiceAccount_DeleteAllServiceAccountsForUser_delete_/v2/service-account → 204
Settings 10

Account Settings

PUT
/v2/settings/lease-time
Update Lease Time
Settings_UpdateLeaseTime_put_/v2/settings/lease-time body → 204
PUT
/v2/settings/email-notifications
Update Email Notifications
Settings_UpdateEmailNotifications_put_/v2/settings/email-notifications body → 204
PUT
/v2/settings/Sns
Update Sns Integration
Settings_UpdateSnsIntegration_put_/v2/settings/Sns body → 204
POST
/v2/settings/Sns
Add Sns Integration
Settings_AddSnsIntegration_post_/v2/settings/Sns body → 204
DELETE
/v2/settings/Sns
Delete Sns Integration
Settings_DeleteSnsIntegration_delete_/v2/settings/Sns → 204
GET
/v2/settings/email-notification-filters/cloudAccounts
Get Email Notification Filters
Settings_GetEmailNotificationFilters_get_/v2/settings/email-notification-filters/cloudAccounts → 200
PUT
/v2/settings/email-notification-filters/cloudAccounts
Update Email Notification Filters
Settings_UpdateEmailNotificationFilters_put_/v2/settings/email-notification-filters/cloudAccounts body → 200
DELETE
/v2/settings/email-notification-filters/cloudAccounts
Delete Email Notification Filters
Settings_DeleteEmailNotificationFilters_delete_/v2/settings/email-notification-filters/cloudAccounts → 204
GET
/v2/Settings
Get
Settings_Get_get_/v2/Settings → 200
PATCH
/v2/Settings
Update Settings
Settings_UpdateSettings_patch_/v2/Settings body → 204
Tenable Account 5
POST
/v2/TenableAccount/{id}/Validate
Validate Permissions
TenableAccount_ValidatePermissions_post_/v2/TenableAccount/{id}/Validate 1 param → 204
POST
/v2/TenableAccount/Sync
Sync Vulnerabilities
TenableAccount_SyncVulnerabilities_post_/v2/TenableAccount/Sync body → 200
GET
/v2/TenableAccount
Get
TenableAccount_Get_get_/v2/TenableAccount → 200
POST
/v2/TenableAccount
Post
TenableAccount_Post_post_/v2/TenableAccount body → 200
DELETE
/v2/TenableAccount
Delete
TenableAccount_Delete_delete_/v2/TenableAccount → 204
User 9

CloudGuard account users

GET
/v2/user/{id}
Get
User_Get_get_/v2/user/{id} 1 param → 200
PUT
/v2/user/{id}
Put
User_Put_put_/v2/user/{id} 1 param body → 200
DELETE
/v2/user/{id}
Delete
User_Delete_delete_/v2/user/{id} 1 param → 204
PUT
/v2/user/{id}/unlock
Unlock User
User_UnlockUser_put_/v2/user/{id}/unlock 1 param → 204
PUT
/v2/user/{id}/iam-safe/accounts/{accountId}/iamEntities
Put Iam Safe Account Iam Entities
User_PutIamSafeAccountIamEntities_put_/v2/user/{id}/iam-safe/accounts/{accountId}/iamEntities 2 params body → 200
POST
/v2/user/{id}/iam-safe/accounts/{cloudAccountId}/iamEntities
Post Iam Safe Account Iam Entities
User_PostIamSafeAccountIamEntitiesAsync_post_/v2/user/{id}/iam-safe/accounts/{cloudAccountId}/iamEntities 2 params body → 200
POST
/v2/user/{id}/iam-safe/accounts/{accountId}/deleteIamEntities
Delete Iam Safe Entities For User
User_DeleteIamSafeEntitiesForUser_post_/v2/user/{id}/iam-safe/accounts/{accountId}/deleteIamEntities 2 params body → 200
GET
/v2/user
Get
User_Get_get_/v2/user → 200
POST
/v2/user
Post
User_Post_post_/v2/user body → 200
Integration 5

Integration

POST
/v2/integration
Create Integration
Integration_CreateIntegration_post_/v2/integration body → 201
GET
/v2/integration
Get All Integrations
Integration_GetAllIntegrations_get_/v2/integration 1 param → 200
PUT
/v2/integration
Update Integration
Integration_UpdateIntegration_put_/v2/integration body → 200
GET
/v2/integration/{id}
Get Integration By Id
Integration_GetIntegrationById_get_/v2/integration/{id} 1 param → 200
DELETE
/v2/integration/{id}
Delete Integration
Integration_DeleteIntegration_delete_/v2/integration/{id} 1 param → 200
Notification 5

Notification

GET
/v2/notification/{id}
Get
Notification_Get_get_/v2/notification/{id} 1 param → 200
DELETE
/v2/notification/{id}
Delete
Notification_Delete_delete_/v2/notification/{id} 1 param → 200
GET
/v2/notification
Get All
Notification_GetAll_get_/v2/notification 1 param → 200
POST
/v2/notification
Create
Notification_Create_post_/v2/notification body → 201
PUT
/v2/notification
Update
Notification_Update_put_/v2/notification body → 200

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are Falconetix.Model.EmailNotificationsDescriptor (29 properties), Dome9.Web.Api.User.UserViewModel (23 properties), Dome9.Web.Api.Compliance.ContinuousCompliance.ChangeDetectionNotificationViewModel (20 properties), Dome9.Web.Api.Tenable.Account.TenableAccountStatusViewModel (10 properties). Each schema is shown below with its type and property counts.

Dome9.Web.Api.Account.AccountTrustAssumableRolesViewModel
object
3 properties
Dome9.Web.Api.Account.AccountTrustViewModel
object
6 properties 2 required
Dome9.Web.Api.Account.AccountTrustRestrictionsViewModel
object
1 property
Dome9.Web.Api.Account.AccountTrustPostViewModel
object
3 properties 2 required
Dome9.Web.Api.Account.AccountTrustPutViewModel
object
2 properties 1 required
Falconetix.Model.RuleEngine.Entities.TagRuleEntity
object
2 properties
Dome9.Web.Api.Models.AuditEntryViewModel
object
3 properties
Falconetix.Model.Audit.ApiAuditResult
object
9 properties
Falconetix.Model.Audit.SystemAuditResult
object
4 properties
Falconetix.Model.Audit.CountAuditResult
object
1 property
Dome9.Web.Api.Models.AuditViewModel
object
4 properties
Dome9.Web.Api.BillableAssets.AccountBillableAssetsViewModel
object
6 properties
Dome9.Web.Api.BillableAssets.CloudAccountBillableAssetsViewModel
object
3 properties
Falconetix.Model.BillableAssets.AccountAssetsTotalData
object
6 properties
Falconetix.Model.BillableAssets.GrandTotalData
object
4 properties
Dome9.Web.Api.BillableAssets.AssetsViewModel
object
4 properties
Falconetix.Model.CloudInfra.CloudInfraUserViewModel
object
8 properties
Dome9.Web.Api.UserAndRole.CreateDome9CloudInfraUserRequestViewModel
object
2 properties
Dome9.Web.Api.UserAndRole.CreateDome9CloudInfraUserResponseViewModel
object
3 properties
Dome9.Web.Api.UserAndRole.CloudInfraUserCreationFailureResult
object
2 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationGetViewModel
object
9 properties 1 required
Dome9.Web.Api.Compliance.ContinuousCompliance.ScheduledReportNotificationViewModel
object
2 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.ChangeDetectionNotificationViewModel
object
20 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.GcpSecurityCommandCenterIntegrationViewModel
object
3 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationFilterViewModel
object
5 properties
Falconetix.Model.RuleEngine.Entities.ContinuousComplianceNotificationEntity.ReportScheduleData
object
4 properties 2 required
Falconetix.Model.RuleEngine.Entities.ContinuousComplianceNotificationEntity.EmailNotificationData
object
1 property 1 required
Falconetix.Model.RuleEngine.Entities.ContinuousComplianceNotificationEntity.EmailPerFindingNotificationData
object
2 properties 1 required
Dome9.Web.Api.Compliance.ContinuousCompliance.SnsDataNotificationViewModel
object
2 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.TicketingSystemNotificationDataViewModel
object
7 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.AwsSecurityHubIntegrationNotificationViewModel
object
2 properties 2 required
Dome9.Web.Api.Compliance.ContinuousCompliance.AzureSecurityCenterIntegrationNotificationViewModel
object
1 property 1 required
Dome9.Web.Api.Compliance.ContinuousCompliance.WebhookNotificationDataViewModel
object
9 properties 4 required
Dome9.Web.Api.Compliance.ContinuousCompliance.SlackNotificationDataViewModel
object
1 property
Dome9.Web.Api.Compliance.ContinuousCompliance.TeamsNotificationDataViewModel
object
1 property
Dome9.Web.Api.Compliance.ContinuousCompliance.EventarcNotificationDataViewModel
object
1 property
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPutViewModel
object
8 properties 1 required
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPostViewModel
object
8 properties 1 required
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationSyncViewModel
object
2 properties
Dome9.BL.Std.Services.ContinuousAssessment.ContinuousComplianceNotificationService.PublishResult
object
2 properties
Dome9.BL.Std.Services.ContinuousAssessment.ContinuousComplianceNotificationService.PublishResultItem
object
2 properties
Dome9.BL.Std.Services.ContinuousAssessment.ContinuousComplianceNotificationService.PolicyHistoryMetadata
object
2 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceCircuitBreakerGetAllViewModel
object
3 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.CircuitBreakerIntgrationViewModel
object
6 properties
Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceCircuitBreakerGetViewModel
object
8 properties
Dome9.Web.Api.Role.EditRoleViewModel
object
3 properties 2 required
Dome9.Web.Api.User.PermissionsViewModel
object
10 properties
Dome9.Web.Api.Role.RoleGetViewModel
object
6 properties 2 required
Dome9.Web.Api.Role.RoleGetUserViewModel
object
2 properties
Dome9.Web.Api.Role.RoleGetServiceAccountViewModel
object
2 properties
Dome9.Web.Api.Role.RoleViewModel
object
4 properties 2 required
Dome9.Web.Api.ServiceAccountViewModel
object
3 properties
Dome9.Web.Api.ServiceAccountGetViewModel
object
6 properties
Falconetix.Model.EmailNotificationsDescriptor
object
29 properties
Falconetix.Model.IamSafeEmailNotificationsDescriptor
object
6 properties
Falconetix.Model.ComplianceEmailNotificationsDescriptor
object
5 properties
Falconetix.Model.KubernetesEmailNotificationsDescriptor
object
1 property
Dome9.Web.Api.Models.SnsSettingsViewModel
object
1 property
Dome9.Web.Api.Models.EmailNotificationFiltersViewModel
object
1 property
Dome9.Web.Api.Models.SettingsViewModel
object
6 properties
Dome9.Web.Api.Tenable.Account.TenableVulnerabilitySyncViewModel
object
2 properties 1 required
Dome9.Web.Api.Tenable.Account.TenableVulnerabilitySyncResultViewModel
object
1 property
Dome9.Web.Api.Tenable.Account.TenableAccountStatusViewModel
object
10 properties
Dome9.Web.Api.Tenable.Account.TenableAccountViewModel
object
3 properties 3 required
Dome9.Web.Api.User.UserViewModel
object
23 properties 1 required
Dome9.Web.Api.UserAndRole.IamSafe.UserIamSafeConfigViewModel
object
1 property
Dome9.Web.Api.UserAndRole.MfaUserEnforcementViewModel
object
3 properties
Dome9.Web.Api.UserAndRole.IamSafe.UserApiKeyViewModel
object
4 properties 1 required
Dome9.Web.Api.UserAndRole.IamSafe.UserIamSafeAccountViewModel
object
9 properties
Dome9.Web.Api.UserAndRole.IamSafe.IamEntityLastLeaseTimeViewModel
object
2 properties
Dome9.Web.Api.UserAndRole.IamSafe.UserIamSafeAccountPutViewModel
object
1 property 1 required
Dome9.Web.Api.User.UserPostViewModel
object
4 properties 3 required
RuleSeverity
string
CloudRegion
string
TagRuleEntity
object
2 properties 2 required
ComplianceNotificationFilter
object
6 properties 6 required
IntegrationViewModel
object
5 properties 5 required
IntegrationType
string
MethodType
string
AuthType
string
BaseConfiguration
object
NotificationOrigin
string
NotificationOutputType
string
IntegrationPostRequestModel
object
3 properties 3 required
IntegrationUpdateRequestModel
object
4 properties 4 required
ResponseNotificationViewModel
BaseNotificationViewModel
object
6 properties 6 required
NotificationIntegrationSettingsViewModel
object
3 properties 3 required
ReportNotificationIntegrationSettingsViewModel
BaseNotificationIntegrationSettingsViewModel
object
3 properties 3 required
SingleNotificationIntegrationSettingsViewModel
ScheduledNotificationIntegrationSettingsViewModel
PostNotificationViewModel
PutNotificationViewModel

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudguard-administration-openapi.yml Raw ↑

Other APIs CloudGuard publishes across the network.

CloudGuard Onboarding API
CloudGuard Posture Management API
CloudGuard Events 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 Administration 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.