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 Network Security API

Cloud network security - AWS/Azure security group policies, cloud security groups, IP lists, IP address metadata and access leases for just-in-time network access.

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

Tagged areas include Cloud Firewall, Network Security, Security Groups, and Access Lease. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 49 operations across 31 paths, organized into 9 resource areas, and defines 29 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/.

49 operations 31 paths 29 schemas 9 DELETE19 GET1 PATCH13 POST7 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
9

Authentication & Security 1

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

Paths & Operations 49

Across 31 paths, the API surfaces 49 operations — 9 DELETE, 19 GET, 1 PATCH, 13 POST, 7 PUT. They span 9 resource areas: Access Lease, Access Lease Invitation, Aws Security Group, Aws Security Group Policy, Azure Security Group, Azure Security Group Policy, Cloud Security Group, Ip Address Metadata, Ip List. Each is listed below with its method, path, parameters, and response codes.

Access Lease 3
POST
/v2/accesslease/aws
Acquire Aws Lease
AccessLease_AcquireAwsLease_post_/v2/accesslease/aws body → 200
GET
/v2/AccessLease
Get
AccessLease_Get_get_/v2/AccessLease → 200
DELETE
/v2/AccessLease/{id}
Delete
AccessLease_Delete_delete_/v2/AccessLease/{id} 1 param → 204
Access Lease Invitation 4
GET
/v2/access-lease-invitation/access/{invitationId}
Access Invitation
AccessLeaseInvitation_AccessInvitation_get_/v2/access-lease-invitation/access/{invitationId} 1 param → 200
GET
/v2/AccessLeaseInvitation
Get Pending Invitations
AccessLeaseInvitation_GetPendingInvitations_get_/v2/AccessLeaseInvitation → 200
POST
/v2/AccessLeaseInvitation
Create Invitation
AccessLeaseInvitation_CreateInvitationAsync_post_/v2/AccessLeaseInvitation body → 200
DELETE
/v2/AccessLeaseInvitation/{id}
Delete
AccessLeaseInvitation_Delete_delete_/v2/AccessLeaseInvitation/{id} 1 param → 204
Aws Security Group 2
GET
/v2/AwsSecurityGroup/{id}/ReferencingGroups
Get All Referenced Security Groups
AwsSecurityGroup_GetAllReferencedSecurityGroups_get_/v2/AwsSecurityGroup/{id}/ReferencingGroups 1 param → 200
GET
/v2/AwsSecurityGroup
Get All Security Groups
AwsSecurityGroup_GetAllSecurityGroups_get_/v2/AwsSecurityGroup → 200
Aws Security Group Policy 10
GET
/v2/AwsSecurityGroupPolicy/CloudAccount/{id}
Get By Cloud Account
AwsSecurityGroupPolicy_GetByCloudAccount_get_/v2/AwsSecurityGroupPolicy/CloudAccount/{id} 1 param → 200
GET
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}
Get By External Security Group Id
AwsSecurityGroupPolicy_GetByExternalSecurityGroupId_get_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId} 2 params → 200
DELETE
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}
Delete Cloud Security Group
AwsSecurityGroupPolicy_DeleteCloudSecurityGroup_delete_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId} 2 params → 204
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/ProtectionMode
Post Protection Mode
AwsSecurityGroupPolicy_PostProtectionMode_post_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/ProtectionMode 2 params body → 200
PUT
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}
Update Service In Security Group
AwsSecurityGroupPolicy_UpdateServiceInSecurityGroup_put_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType} 3 params body → 200
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}
Add Service To Security Group
AwsSecurityGroupPolicy_AddServiceToSecurityGroup_post_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType} 3 params body → 200
DELETE
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}/{serviceId}
Delete Service From Security Group
AwsSecurityGroupPolicy_DeleteServiceFromSecurityGroup_delete_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/Services/{policyType}/{serviceId} 4 params → 204
POST
/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/tags
Update Tags
AwsSecurityGroupPolicy_UpdateTags_post_/v2/AwsSecurityGroupPolicy/CloudAccount/{cloudAccountId}/Policy/{externalId}/tags 2 params body → 200
GET
/v2/AwsSecurityGroupPolicy
Get All Security Groups Of Account
AwsSecurityGroupPolicy_GetAllSecurityGroupsOfAccount_get_/v2/AwsSecurityGroupPolicy → 200
POST
/v2/AwsSecurityGroupPolicy
Create Aws Security Group
AwsSecurityGroupPolicy_CreateAwsSecurityGroup_post_/v2/AwsSecurityGroupPolicy body → 200
Azure Security Group 2
GET
/v2/AzureSecurityGroup/{id}
Get
AzureSecurityGroup_Get_get_/v2/AzureSecurityGroup/{id} 1 param → 200
GET
/v2/AzureSecurityGroup
Get
AzureSecurityGroup_Get_get_/v2/AzureSecurityGroup 1 param → 200
Azure Security Group Policy 7
GET
/v2/AzureSecurityGroupPolicy/{id}
Get
AzureSecurityGroupPolicy_Get_get_/v2/AzureSecurityGroupPolicy/{id} 1 param → 200
PUT
/v2/AzureSecurityGroupPolicy/{id}
Put
AzureSecurityGroupPolicy_Put_put_/v2/AzureSecurityGroupPolicy/{id} 1 param body → 200
DELETE
/v2/AzureSecurityGroupPolicy/{id}
Delete
AzureSecurityGroupPolicy_Delete_delete_/v2/AzureSecurityGroupPolicy/{id} 1 param → 204
PUT
/v2/AzureSecurityGroupPolicy/{policyId}/TamperProtected
Update Protection Mode
AzureSecurityGroupPolicy_UpdateProtectionMode_put_/v2/AzureSecurityGroupPolicy/{policyId}/TamperProtected 2 params → 200
GET
/v2/AzureSecurityGroupPolicy/Stats
Get Stats
AzureSecurityGroupPolicy_GetStats_get_/v2/AzureSecurityGroupPolicy/Stats → 200
GET
/v2/AzureSecurityGroupPolicy
Get
AzureSecurityGroupPolicy_Get_get_/v2/AzureSecurityGroupPolicy → 200
POST
/v2/AzureSecurityGroupPolicy
Post
AzureSecurityGroupPolicy_Post_post_/v2/AzureSecurityGroupPolicy body → 200
Cloud Security Group 12
GET
/v2/cloudsecuritygroup/{id}
Get
CloudSecurityGroup_Get_get_/v2/cloudsecuritygroup/{id} 2 params → 200
PUT
/v2/cloudsecuritygroup/{id}
Put
CloudSecurityGroup_Put_put_/v2/cloudsecuritygroup/{id} 1 param body → 200
DELETE
/v2/cloudsecuritygroup/{id}
Delete Cloud Security Group
CloudSecurityGroup_DeleteCloudSecurityGroup_delete_/v2/cloudsecuritygroup/{id} 1 param → 204
PATCH
/v2/cloudsecuritygroup/{id}
Update Sec Group
CloudSecurityGroup_UpdateSecGroup_patch_/v2/cloudsecuritygroup/{id} 1 param body → 204
POST
/v2/cloudsecuritygroup/{id}/protection-mode
Change Protection Mode
CloudSecurityGroup_ChangeProtectionMode_post_/v2/cloudsecuritygroup/{id}/protection-mode 1 param body → 200
PUT
/v2/cloudsecuritygroup/{groupid}/services/{policyType}
Update Service For Cloud To Security Group
CloudSecurityGroup_UpdateServiceForCloudToSecurityGroup_put_/v2/cloudsecuritygroup/{groupid}/services/{policyType} 2 params body → 200
POST
/v2/cloudsecuritygroup/{groupid}/services/{policyType}
Add Service Cloud To Security Group
CloudSecurityGroup_AddServiceCloudToSecurityGroup_post_/v2/cloudsecuritygroup/{groupid}/services/{policyType} 2 params body → 200
DELETE
/v2/cloudsecuritygroup/{groupid}/services/{policyType}/{serviceid}
Delete Service For Cloud To Security Group
CloudSecurityGroup_DeleteServiceForCloudToSecurityGroup_delete_/v2/cloudsecuritygroup/{groupid}/services/{policyType}/{serviceid} 3 params → 204
POST
/v2/cloudsecuritygroup/{groupid}/tags
Update Tags
CloudSecurityGroup_UpdateTags_post_/v2/cloudsecuritygroup/{groupid}/tags 1 param body → 200
GET
/v2/cloudsecuritygroup/{groupid}/history
Get Security Group Revision History
CloudSecurityGroup_GetSecurityGroupRevisionHistory_get_/v2/cloudsecuritygroup/{groupid}/history 2 params → 200
GET
/v2/CloudSecurityGroup
Get
CloudSecurityGroup_Get_get_/v2/CloudSecurityGroup 2 params → 200
POST
/v2/CloudSecurityGroup
Create Cloud Security Group
CloudSecurityGroup_CreateCloudSecurityGroup_post_/v2/CloudSecurityGroup body → 200
Ip Address Metadata 4
GET
/v2/IpAddressMetadata
Get
IpAddressMetadata_Get_get_/v2/IpAddressMetadata → 200
PUT
/v2/IpAddressMetadata
Put
IpAddressMetadata_Put_put_/v2/IpAddressMetadata body → 200
POST
/v2/IpAddressMetadata
Post
IpAddressMetadata_Post_post_/v2/IpAddressMetadata body → 200
DELETE
/v2/IpAddressMetadata
Delete
IpAddressMetadata_Delete_delete_/v2/IpAddressMetadata 3 params → 204
Ip List 5
GET
/v2/IpList
Get
IpList_Get_get_/v2/IpList → 200
POST
/v2/IpList
Post
IpList_Post_post_/v2/IpList body → 200
GET
/v2/IpList/{id}
Get
IpList_Get_get_/v2/IpList/{id} 1 param → 200
PUT
/v2/IpList/{id}
Put
IpList_Put_put_/v2/IpList/{id} 1 param body → 204
DELETE
/v2/IpList/{id}
Delete
IpList_Delete_delete_/v2/IpList/{id} 1 param → 204

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Dome9.Web.Api.Models.AwsAccessLeaseViewModel (15 properties), Dome9.Web.Api.Models.AwsAccessLeasePostViewModel (15 properties), Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyGetViewModel (15 properties), Dome9.Web.Api.Models.CloudSecurityGroupPolicyViewModel (14 properties). Each schema is shown below with its type and property counts.

Dome9.Web.Api.Models.AwsAccessLeasePostViewModel
object
15 properties
Dome9.Web.Api.Models.AccessLeasesGroupedViewModel
object
2 properties
Dome9.Web.Api.Models.AwsAccessLeaseViewModel
object
15 properties
Dome9.Web.Api.Models.AgentAccessLeaseViewModel
object
13 properties
Dome9.Web.Api.Models.AccessLeaseInvitationViewModel
object
11 properties
Dome9.Web.Api.Shared.SharedViewModels.TagViewModel
object
2 properties
Dome9.Web.Api.AwsSecurityGroup.AwsSecurityGroupViewModel
object
6 properties
Dome9.Web.Api.Models.CloudSecurityGroupPolicyViewModel
object
14 properties
Dome9.Web.Api.Models.CloudSecurityGroupPolicyServiceViewModel
object
9 properties 3 required
Falconetix.WebApi.Models.ScopeElementViewModel
object
2 properties
Dome9.Web.Api.Models.CloudSecurityGroupProtectionModeChangeViewModel
object
2 properties 1 required
Dome9.Web.Api.Models.CloudSecurityGroupServiceViewModel
object
10 properties 3 required
Dome9.Web.Api.Models.CloudSecurityGroupTagsChangeViewModel
object
1 property
Dome9.Web.Api.Models.CloudSecurityGroupBaseViewModel
object
10 properties
Dome9.Web.Api.Models.AzureSecurityGroupViewModel
object
11 properties
Dome9.Web.Api.Models.AzureSecurityGroupServiceViewModel
object
11 properties
Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyGetViewModel
object
15 properties 4 required
Dome9.Web.Api.Azure.AzureErrorStateViewModel
object
2 properties
Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyServiceGetViewModel
object
11 properties 6 required
Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyPostViewModel
object
9 properties 4 required
Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyServiceViewModel
object
10 properties 6 required
Dome9.Web.Api.Azure.SecurityGroupPolicy.ViewModels.AzureSgPolicyStatsViewModel
object
8 properties
Dome9.Web.Api.Models.CloudSecurityGroupViewModel
object
12 properties
Dome9.Web.Api.Models.CloudSecurityGroupWithSrlViewModel
object
13 properties
Dome9.Web.Api.Models.CloudSecurityGroupRevisionViewModel
object
9 properties
Dome9.Web.Api.Models.IpAddressMetadataViewModel
object
5 properties
Dome9.Web.Api.IPList.IpListViewModel
object
4 properties
Falconetix.Model.IPDescriptor
object
2 properties 1 required
Dome9.Web.Api.IPList.IpListPutViewModel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudguard-network-security-openapi.yml Raw ↑

Other APIs CloudGuard publishes across the network.

CloudGuard Onboarding API
CloudGuard Posture Management API
CloudGuard Events API
CloudGuard Administration API
CloudGuard Risk Management API
CloudGuard Workload Protection (CWPP) 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 Network Security 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.