Dome9 API
The CloudGuard (Dome9) v2 REST API — 601 paths and 722 operations covering cloud-account onboarding for AWS, Azure, Google, Alibaba, Kubernetes and container registries, compliance rulesets and assessments, posture findings and alerts, security groups and firewall policy, access leases, users, roles and service accounts. HTTP Basic auth with a V2 API key id and secret. The API is region-pinned across six deployments.
Operations 722
Showing the first 250 of 722. The full set is in the contract, and via get_provider_operations.
GET
/v2/account/managing
gets the MSP account who manages this one. returns error (404) if no managing account (regular Dome9 account)
#
GET
/v2/AccountTrust/assumable-roles
Get a list of objects that represent a trusted account and its assumebale roles
#
GET
/v2/AccountTrust
Get a list of accounts which are trusted by or trust this account according to the given "trustDirection"
#
POST
/v2/AccountTrust
Create a new account trust where this account is the target based on the given "SourceAccountId", i.e. this account trusts the source account
#
POST
/v2/workload/agentless/aws/accounts/{id}/enableCentralizedAccount
Add AWP AWS Centralized account
#
POST
/v2/workload/agentless/azure/accounts/{id}/enableCentralizedAccount
Add AWP Azure Centralized account
#
PATCH
/v2/workload/agentless/{cloudProvider}/accounts/{id}/settings
Modify a single AWP account scanner settings (supported for inAccount and Saas scan mode)
#
PATCH
/v2/workload/agentless/{cloudProvider}/accounts/{id}/centralizedAccountSettings
Modify a single AWP centralized account scanner settings
#
POST
/v2/workload/agentless/aws/accounts/{id}/generate-onboarding-data
Generate Aws onboarding data
#
POST
/v2/workload/agentless/azure/accounts/{id}/generate-onboarding-data
Generate Azure onboarding data
#
GET
/v2/workload/agentless/{cloudProvider}/accounts/{id}/onboarding/checkForUpdate
Check if the AWP account needs to be updated
#
GET
/v2/workload/agentless/azure/accounts/{id}/centralizedAccounts
Get Azure centralized accounts data
#
GET
/v2/Alert
Get multiple alerts. By default it will also return acknowledged alerts and FIM alerts. To reduce the returned set - use a filter.
#
DELETE
/v2/AlibabaCloudAccount/{id}/DeleteForce
Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba) and linked entities
#
GET
/v2/AlibabaCloudAccount/{cloudAccountId}/account-stats
Gets Cloud Account network statistics on cloud account page
#
GET
/v2/AlibabaCloudAccount/MissingPermissions
Get a list of missing permissions (needed by Dome9 to manage the accounts) for all Alibaba accounts in Dome9
#
GET
/v2/AlibabaCloudAccount/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts.
#
PUT
/v2/AlibabaCloudAccount/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts.
#
GET
/v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType
Get missing permissions for a specific entity type for a specific Alibaba Cloud account
#
PUT
/v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset
Reset (re-validate) a Alibaba Cloud account credentials in Dome9. Will cause all entities to retry fetching from the Alibaba cloud account.
#
PUT
/v2/AlibabaCloudAccount/{id}/AccountName
Update a Alibaba Cloud account name (as it appears in Dome9)
#
PUT
/v2/AlibabaCloudAccount/{id}/organizationalUnit
Update the ID of the Organizational Unit that this cloud account will be attached to. Use 'null' for the root organizational unit
#
PUT
/v2/AlibabaCloudAccount/organizationalUnit/move
Detach cloud accounts from an Organizational unit and attach them to another Organizational unit. Use 'null' for root organizational unit
#
PUT
/v2/AlibabaCloudAccount/organizationalUnit/moveAll
Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit
#
POST
/v2/AlibabaCloudAccount/organizationalUnit/attach
Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target
#
DELETE
/v2/AlibabaCloudAccount/{id}
Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba)
#
GET
/v2/AssessmentHistoryV2/bundleResults
Get most recent assessment results for a specific bundle, for a list of cloud accounts
#
GET
/v2/AssessmentHistoryV2/assessmentTrendOrganizationalUnit
Get the assessment trend for the selected time range (maximum of 93 days)
#
GET
/v2/AssessmentHistoryV2/assessmentTrendV2
Get the assessment trend for the selected time range (maximum of 93 days)
#
POST
/v2/AssessmentHistoryV2/LastAssessmentResults/view
Get last assessment results for selected cloud accounts and bundles. Does not return details for the tests or test entities.
#
POST
/v2/AssessmentHistoryV2/LastAssessmentResults
Get last assessment results for selected cloud accounts and bundles. Includes details of tests and test entities.
#
POST
/v2/AssessmentHistoryV2/LastAssessmentResults/minimized
Get last assessment results for selected cloud accounts and bundles as Minimized Entity.
#
GET
/v2/AssessmentHistoryV2/ExecutiveReport/{vendor}/{rulesetId}
Get an executive report of assessments for the selected ruleset and platform
#
POST
/v2/AssessmentHistoryV2/ExecutiveReport/email/{vendor}/{rulesetId}
Send email with link to s3 bucket to the Executive Report
#
GET
/v2/AssessmentHistoryV2/{assessmentId}/ExecutiveReport/csv
Get a csv executive report of assessment
#
POST
/v2/AssessmentHistoryV2/OrganizationalUnitsLastAssessmentStatistics
Get last assessment statistics for selected Organizational Units and bundles.
#
POST
/v2/AssessmentHistoryV2/view/timeRange
Get assessment history (list of assessments) for specified time range and filters
#
POST
/v2/auth/reset-password-request-by-email
request to reset password to a user without reCaptcha - ONLY to SuperUser
#
PUT
/v2/cloudaccounts/credentials
Update credentials for an AWS cloud account in Dome9. At least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"
#
GET
/v2/cloudaccounts/MissingPermissions
Get a list of missing permissions for all accounts. These are permissions needed by Dome9 to manage accounts.
#
GET
/v2/cloudaccounts/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts.
#
PUT
/v2/cloudaccounts/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts.
#
GET
/v2/cloudaccounts/{id}/MissingPermissions/EntityType
Get a list of missing permissions for a specific cloud entity type and cloud account
#
GET
/v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue
check if the cloud account's role has permission issues or was deleted
#
POST
/v2/cloudaccounts/{id}/SyncNow
Send a data sync command to immediately fetch cloud account data into Dome9's system caches. This API is used in conjunction with EntityFetchStatus API resource to query the fetch
#
PUT
/v2/cloudaccounts/{id}/organizationalUnit
Update the ID of the Organizational Unit that this cloud account will be attached to. Use 'null' for the root Organizational Unit
#
PUT
/v2/cloudaccounts/organizationalUnit/move
Detach cloud accounts from an Organizational unit and attach them to another Organizational unit Use 'null' for root organizational unit
#
PUT
/v2/cloudaccounts/organizationalUnit/moveAll
Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit
#
POST
/v2/cloudaccounts/organizationalUnit/attach
Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target
#
POST
/v2/CloudAccounts
Add a new AWS cloud account to CloudGuard
Onboarding an AWS cloud account manually (legacy method) requires CloudGuard to obtain permissions to access the account.
For #
Onboarding an AWS cloud account manually (legacy method) requires CloudGuard to obtain permissions to access the account.
For #
GET
/v2/AwsLoadBalancersNetworkInterfaces
Get all AWS Load Balancers with attached Network Interfaces
#
GET
/v2/AwsSecurityGroupPolicy/CloudAccount/{id}
Get all security groups policies of cloud account by cloud account id
#
GET
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}
Get security group policy by external security group id and cloud account id
#
DELETE
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}
Delete an AWS security group
#
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/ProtectionMode
Update protection mode to security group
#
PUT
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}
Update a service (rule) for an AWS security group
#
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}
Creat a new Service (rule) for the security group
#
DELETE
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}/{serviceId}
Delete a service (rule) from an AWS security group
#
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/tags
Update tags
#
POST
/v2/AwsUnifiedOnboarding/StackConfig
Returns the configuration should be set to the AWS cloud formation SDK for creating the Stack for the onboarding
#
GET
/v2/AwsUnifiedOnboarding/UpdateVersion/StackConfig/{onboardingId}
Returns the configuration should be set to the AWS cloud formation SDK for an update
#
GET
/v2/AzureApplicationSecurityGroup/{id}
get a specific Application Security Group by name and resource group
#
GET
/v2/AzureApplicationSecurityGroup/CloudAccountId/{cloudAccountId}/Region/{region}
get all application security group of cloudAccount by region
#
DELETE
/v2/AzureCloudAccount/{id}/DeleteForce
Delete an Azure account from a Dome9 account (the Azure account is not deleted from Azure) and linked entities
#
GET
/v2/AzureCloudAccount/OnboardingExecutionPreview
Get the script that performs Azure account onboarding
#
POST
/v2/AzureCloudAccount/OnboardingExecutionCommand
Get the cloud account command line execution for Azure shell Details for Azure cloud account.
#
GET
/v2/AzureCloudAccount/MissingPermissions
Get a list of missing permissions (required by Dome9) for all Azure accounts in a Dome9 account
#
GET
/v2/AzureCloudAccount/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts.
#
PUT
/v2/AzureCloudAccount/{id}/MissingPermissions
Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts.
#
GET
/v2/AzureCloudAccount/{id}/MissingPermissions/EntityType
Get a list of missing permissions for a specific cloud entity type and Azure cloud account
#
PUT
/v2/AzureCloudAccount/{id}/MissingPermissions/Reset
Reset (re-validate) the missing permissions indication for an Azure account in Dome9
#
PUT
/v2/AzureCloudAccount/{id}/OperationMode
Update the operations mode for an Azure account in Dome9. Modes can be Read-Only or Manage
#
PUT
/v2/AzureCloudAccount/{id}/AccountName
Update the account name (in Dome9) for an Azure account
#
PUT
/v2/AzureCloudAccount/{id}/organizationalUnit
Update the ID of the Organizational Unit that this cloud account will be attached to. Use 'null' for the root organizational unit
#
PUT
/v2/AzureCloudAccount/organizationalUnit/move
Detach cloud accounts from an Organizational unit and attach them to another Organizational unit. Use 'null' for root organizational unit
#
PUT
/v2/AzureCloudAccount/organizationalUnit/moveAll
Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit
#
POST
/v2/AzureCloudAccount/organizationalUnit/attach
Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target
#
DELETE
/v2/AzureCloudAccount/{id}
Delete an Azure account from a Dome9 account (the Azure account is not deleted from Azure)
#
Documentation
📖
Documentation
https://docs.cgn.portal.checkpoint.com/
📖
APIReference
https://docs.cgn.portal.checkpoint.com/reference/introduction
📖
GettingStarted
https://docs.cgn.portal.checkpoint.com/docs
📖
Authentication
https://docs.cgn.portal.checkpoint.com/reference/authentication