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 Workload Protection (CWPP) API

Workload protection - Kubernetes image assurance, admission control, runtime protection, agentless workload posture, serverless function protection and ShiftLeft/Code Security accounts. 168 operations across 124 paths.

CloudGuard Workload Protection (CWPP) API is one of 25 APIs that CloudGuard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Container Security, CWPP, Image Assurance, Kubernetes, and Serverless. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 168 operations across 124 paths, organized into 20 resource areas, and defines 188 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/.

168 operations 124 paths 188 schemas 16 DELETE89 GET11 PATCH32 POST20 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
20

Authentication & Security 1

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

Paths & Operations 168

Across 124 paths, the API surfaces 168 operations — 16 DELETE, 89 GET, 11 PATCH, 32 POST, 20 PUT. They span 20 resource areas, including Agentless, Protego Statistics, Serverless, Serverless Policy, Shift Left, Workload Account Setting, Kubernetes Pod Group, Kubernetes Image Assurance, and 12 more. Each is listed below with its method, path, parameters, and response codes.

Agentless 21

Agentless Workload Posture

POST
/v2/workload/agentless/aws/accounts/{id}/enable
Enable Aws Account
Agentless_EnableAwsAccount_post_/v2/workload/agentless/aws/accounts/{id}/enable 2 params body → 200
POST
/v2/workload/agentless/azure/accounts/{id}/enable
Enable Azure Account
Agentless_EnableAzureAccount_post_/v2/workload/agentless/azure/accounts/{id}/enable 2 params body → 200
POST
/v2/workload/agentless/aws/accounts/{id}/enableCentralizedAccount
Add Aws Centralized Account
Agentless_AddAwsCentralizedAccount_post_/v2/workload/agentless/aws/accounts/{id}/enableCentralizedAccount 1 param body → 200
POST
/v2/workload/agentless/azure/accounts/{id}/enableCentralizedAccount
Add Azure Centralized Account
Agentless_AddAzureCentralizedAccount_post_/v2/workload/agentless/azure/accounts/{id}/enableCentralizedAccount 1 param body → 200
POST
/v2/workload/agentless/aws/accounts/{id}/enableSubAccount
Add Aws Sub Account
Agentless_AddAwsSubAccount_post_/v2/workload/agentless/aws/accounts/{id}/enableSubAccount 2 params body → 200
POST
/v2/workload/agentless/azure/accounts/{id}/enableSubAccount
Add Azure Sub Account
Agentless_AddAzureSubAccount_post_/v2/workload/agentless/azure/accounts/{id}/enableSubAccount 2 params body → 200
GET
/v2/workload/agentless/{cloudProvider}/accounts/states
Get Accounts States
Agentless_GetAccountsStates_get_/v2/workload/agentless/{cloudProvider}/accounts/states 1 param → 200
GET
/v2/workload/agentless/{cloudProvider}/accounts/states/{id}
Get Account State
Agentless_GetAccountState_get_/v2/workload/agentless/{cloudProvider}/accounts/states/{id} 2 params → 200
GET
/v2/workload/agentless/{cloudProvider}/accounts/{id}
Get Account
Agentless_GetAccount_get_/v2/workload/agentless/{cloudProvider}/accounts/{id} 2 params → 200
PATCH
/v2/workload/agentless/{cloudProvider}/accounts/{id}/settings
Modify Account Settings
Agentless_ModifyAccountSettings_patch_/v2/workload/agentless/{cloudProvider}/accounts/{id}/settings 2 params body → 200
PATCH
/v2/workload/agentless/{cloudProvider}/accounts/{id}/centralizedAccountSettings
Modify Centralized Account Settings
Agentless_ModifyCentralizedAccountSettings_patch_/v2/workload/agentless/{cloudProvider}/accounts/{id}/centralizedAccountSettings 2 params body → 200
DELETE
/v2/workload/agentless/aws/accounts/{id}
Disable Aws Account
Agentless_DisableAwsAccount_delete_/v2/workload/agentless/aws/accounts/{id} 2 params → 200
DELETE
/v2/workload/agentless/azure/accounts/{id}
Disable Azure Account
Agentless_DisableAzureAccount_delete_/v2/workload/agentless/azure/accounts/{id} 1 param → 200
GET
/v2/workload/agentless/aws/instances/{id}
Get Workload
Agentless_GetWorkload_get_/v2/workload/agentless/aws/instances/{id} 1 param → 200
POST
/v2/workload/agentless/aws/accounts/{id}/generate-onboarding-data
Generate Aws Onboarding Data
Agentless_GenerateAwsOnboardingData_post_/v2/workload/agentless/aws/accounts/{id}/generate-onboarding-data 1 param body → 200
POST
/v2/workload/agentless/azure/accounts/{id}/generate-onboarding-data
Generate Azure Onboarding Data
Agentless_GenerateAzureOnboardingData_post_/v2/workload/agentless/azure/accounts/{id}/generate-onboarding-data 1 param body → 200
GET
/v2/workload/agentless/azure/accounts/{id}/offboarding
Get Azure Offboarding Data
Agentless_GetAzureOffboardingData_get_/v2/workload/agentless/azure/accounts/{id}/offboarding 2 params → 200
GET
/v2/workload/agentless/{cloudProvider}/accounts/{id}/onboarding/checkForUpdate
Check For Onboarding Update
Agentless_CheckForOnboardingUpdate_get_/v2/workload/agentless/{cloudProvider}/accounts/{id}/onboarding/checkForUpdate 2 params → 200
GET
/v2/workload/agentless/azure/accounts/{id}/centralizedAccounts
Get Azure Centralized Accounts
Agentless_GetAzureCentralizedAccounts_get_/v2/workload/agentless/azure/accounts/{id}/centralizedAccounts 1 param → 200
GET
/v2/workload/agentless/accountSettings
Get Tenant Settings
Agentless_GetTenantSettings_get_/v2/workload/agentless/accountSettings → 200
PATCH
/v2/workload/agentless/accountSettings
Modify Tenant Settings
Agentless_ModifyTenantSettings_patch_/v2/workload/agentless/accountSettings body → 200
Protego Statistics 1
GET
/v2/protegoStatistics/invocations
Get
ProtegoStatistics_Get_get_/v2/protegoStatistics/invocations 2 params → 200
Serverless 49
POST
/v2/serverless/accounts
Post Account
Serverless_PostAccount_post_/v2/serverless/accounts body → 200201
GET
/v2/serverless/accounts/{cloudAccountId}
Get Account
Serverless_GetAccount_get_/v2/serverless/accounts/{cloudAccountId} 1 param → 200
PATCH
/v2/serverless/accounts/{cloudAccountId}
Put Account
Serverless_PutAccount_patch_/v2/serverless/accounts/{cloudAccountId} 2 params body → 200
PATCH
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}
Put Account
Serverless_PutAccount_patch_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId} 2 params body → 200
GET
/v2/serverless/accounts/states
Get Accounts State
Serverless_GetAccountsState_get_/v2/serverless/accounts/states 1 param → 200
GET
/v2/serverless/{cloudProvider}/accounts/states
Get Accounts State
Serverless_GetAccountsState_get_/v2/serverless/{cloudProvider}/accounts/states 1 param → 200
GET
/v2/serverless/accounts/states/{cloudAccountId}
Get Account State
Serverless_GetAccountState_get_/v2/serverless/accounts/states/{cloudAccountId} 2 params → 200
GET
/v2/serverless/{cloudProvider}/accounts/states/{cloudAccountId}
Get Account State
Serverless_GetAccountState_get_/v2/serverless/{cloudProvider}/accounts/states/{cloudAccountId} 2 params → 200
GET
/v2/serverless/accounts/{cloudAccountId}/exclusions
Get Account Exclusions
Serverless_GetAccountExclusions_get_/v2/serverless/accounts/{cloudAccountId}/exclusions 3 params → 200
POST
/v2/serverless/accounts/{cloudAccountId}/exclusions
Post Exclusion
Serverless_PostExclusion_post_/v2/serverless/accounts/{cloudAccountId}/exclusions 2 params body → 200
GET
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions
Get Account Exclusions
Serverless_GetAccountExclusions_get_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions 3 params → 200
POST
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions
Post Exclusion
Serverless_PostExclusion_post_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions 2 params body → 200
GET
/v2/serverless/accounts/{cloudAccountId}/rules
Get Account Rules
Serverless_GetAccountRules_get_/v2/serverless/accounts/{cloudAccountId}/rules 3 params → 200
POST
/v2/serverless/accounts/{cloudAccountId}/rules
Post Rule
Serverless_PostRule_post_/v2/serverless/accounts/{cloudAccountId}/rules 2 params body → 200
GET
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules
Get Account Rules
Serverless_GetAccountRules_get_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules 3 params → 200
POST
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules
Post Rule
Serverless_PostRule_post_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules 2 params body → 200
GET
/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId}
Get Rule
Serverless_GetRule_get_/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId} 4 params → 200
PUT
/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId}
Put Rule
Serverless_PutRule_put_/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId} 3 params body → 200
DELETE
/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId}
Delete Rule
Serverless_DeleteRule_delete_/v2/serverless/accounts/{cloudAccountId}/rules/{ruleId} 3 params → 200
GET
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId}
Get Rule
Serverless_GetRule_get_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId} 4 params → 200
PUT
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId}
Put Rule
Serverless_PutRule_put_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId} 3 params body → 200
DELETE
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId}
Delete Rule
Serverless_DeleteRule_delete_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/rules/{ruleId} 3 params → 200
GET
/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId}
Get Exclusion
Serverless_GetExclusion_get_/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId} 4 params → 200
PUT
/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId}
Put Exclusion
Serverless_PutExclusion_put_/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId} 3 params body → 200
DELETE
/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId}
Delete Exclusion
Serverless_DeleteExclusion_delete_/v2/serverless/accounts/{cloudAccountId}/exclusions/{exclusionId} 3 params → 200
GET
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId}
Get Exclusion
Serverless_GetExclusion_get_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId} 4 params → 200
PUT
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId}
Put Exclusion
Serverless_PutExclusion_put_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId} 3 params body → 200
DELETE
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId}
Delete Exclusion
Serverless_DeleteExclusion_delete_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/exclusions/{exclusionId} 3 params → 200
GET
/v2/serverless/aws/accounts/{cloudAccountId}/missingPermissions
Get Account Missing Permissions
Serverless_GetAccountMissingPermissions_get_/v2/serverless/aws/accounts/{cloudAccountId}/missingPermissions 1 param → 200
PUT
/v2/serverless/aws/accounts/{cloudAccountId}/missingPermissions/validate
Validate Account Missing Permissions
Serverless_ValidateAccountMissingPermissions_put_/v2/serverless/aws/accounts/{cloudAccountId}/missingPermissions/validate 1 param → 200
GET
/v2/serverless/functions/{id}
Get Function
Serverless_GetFunction_get_/v2/serverless/functions/{id} 1 param → 200
GET
/v2/serverless/aws/functions/{id}
Get Function
Serverless_GetFunction_get_/v2/serverless/aws/functions/{id} 1 param → 200
GET
/v2/serverless/azure/functions/{id}
Get Azure Function App
Serverless_GetAzureFunctionApp_get_/v2/serverless/azure/functions/{id} 1 param → 200
GET
/v2/serverless/kubernetes/functions/{id}
Get Kubernetes Pod Group
Serverless_GetKubernetesPodGroup_get_/v2/serverless/kubernetes/functions/{id} 1 param → 200
POST
/v2/serverless/aws/functions/{id}/addLogSubscription
Function Add Log Subscription
Serverless_FunctionAddLogSubscription_post_/v2/serverless/aws/functions/{id}/addLogSubscription 1 param → 200
PATCH
/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/functions
Put Functions
Serverless_PutFunctions_patch_/v2/serverless/{cloudProvider}/accounts/{cloudAccountId}/functions 2 params body → 200
PATCH
/v2/serverless/{cloudProvider}/functions/{id}
Put Function
Serverless_PutFunction_patch_/v2/serverless/{cloudProvider}/functions/{id} 2 params body → 200
PATCH
/v2/serverless/functions/{id}/fsp
Put Function Auto Fsp
Serverless_PutFunctionAutoFsp_patch_/v2/serverless/functions/{id}/fsp 1 param body → 200
PATCH
/v2/serverless/functions/{id}/fspMode
Put Function Fsp Block
Serverless_PutFunctionFspBlock_patch_/v2/serverless/functions/{id}/fspMode 2 params body → 200
PATCH
/v2/serverless/{cloudProvider}/functions/{id}/fspMode
Put Function Fsp Block
Serverless_PutFunctionFspBlock_patch_/v2/serverless/{cloudProvider}/functions/{id}/fspMode 2 params body → 200
GET
/v2/serverless/functions/{id}/whitelist
Get Function Whitelist
Serverless_GetFunctionWhitelist_get_/v2/serverless/functions/{id}/whitelist 2 params → 200
GET
/v2/serverless/{cloudProvider}/functions/{id}/whitelist
Get Function Whitelist
Serverless_GetFunctionWhitelist_get_/v2/serverless/{cloudProvider}/functions/{id}/whitelist 2 params → 200
GET
/v2/serverless/azure/functions/{id}/whitelist/{functionName}
Get Azure Function Whitelist
Serverless_GetAzureFunctionWhitelist_get_/v2/serverless/azure/functions/{id}/whitelist/{functionName} 2 params → 200
GET
/v2/serverless/functions/{id}/exclusions
Get Function Exclusions
Serverless_GetFunctionExclusions_get_/v2/serverless/functions/{id}/exclusions 3 params → 200
GET
/v2/serverless/{cloudProvider}/functions/{id}/exclusions
Get Function Exclusions
Serverless_GetFunctionExclusions_get_/v2/serverless/{cloudProvider}/functions/{id}/exclusions 3 params → 200
GET
/v2/serverless/functions/{id}/rules
Get Function Rules
Serverless_GetFunctionRules_get_/v2/serverless/functions/{id}/rules 3 params → 200
GET
/v2/serverless/{cloudProvider}/functions/{id}/rules
Get Function Rules
Serverless_GetFunctionRules_get_/v2/serverless/{cloudProvider}/functions/{id}/rules 3 params → 200
GET
/v2/serverless/fsp/versions
Get Fsp Versions
Serverless_GetFspVersions_get_/v2/serverless/fsp/versions → 200
GET
/v2/serverless/workloadProtection/runtimes
Get Supported Runtimes
Serverless_GetSupportedRuntimes_get_/v2/serverless/workloadProtection/runtimes → 200
Serverless Policy 5
GET
/v2/serverless/policy/{id}
Get
ServerlessPolicy_GetAsync_get_/v2/serverless/policy/{id} 1 param → 200
DELETE
/v2/serverless/policy/{id}
Delete
ServerlessPolicy_DeleteAsync_delete_/v2/serverless/policy/{id} 1 param → 204
GET
/v2/serverless/policy
Get
ServerlessPolicy_GetAsync_get_/v2/serverless/policy → 200
PUT
/v2/serverless/policy
Put
ServerlessPolicy_PutAsync_put_/v2/serverless/policy body → 200
POST
/v2/serverless/policy
Post
ServerlessPolicy_PostAsync_post_/v2/serverless/policy body → 200
Shift Left 3
GET
/v2/ShiftLeft/{url}
Get
ShiftLeft_Get_get_/v2/ShiftLeft/{url} 1 param → 200
GET
/v2/ShiftLeft/blades
Get Blades
ShiftLeft_GetBlades_get_/v2/ShiftLeft/blades → 200
GET
/v2/ShiftLeft/blades/{os}/{arch}
Get Blades Os
ShiftLeft_GetBladesOs_get_/v2/ShiftLeft/blades/{os}/{arch} 2 params → 200
Workload Account Setting 3
GET
/v2/workload/accountSetting
Get Account Settings
WorkloadAccountSetting_GetAccountSettings_get_/v2/workload/accountSetting → 200
PUT
/v2/workload/accountSetting
Set Account Settings
WorkloadAccountSetting_SetAccountSettings_put_/v2/workload/accountSetting body → 200
PATCH
/v2/workload/accountSetting
Update Account Settings
WorkloadAccountSetting_UpdateAccountSettings_patch_/v2/workload/accountSetting body → 200
Kubernetes Pod Group 10
GET
/v2/kubernetes/podGroup/daemonSet/{id}/podList
Get Daemon Set Pod List
KubernetesPodGroup_GetDaemonSetPodList_get_/v2/kubernetes/podGroup/daemonSet/{id}/podList 1 param → 200
GET
/v2/kubernetes/podGroup/deployment/{id}/podList
Get Deployment Pod List
KubernetesPodGroup_GetDeploymentPodList_get_/v2/kubernetes/podGroup/deployment/{id}/podList 1 param → 200
GET
/v2/kubernetes/podGroup/replicaSet/{id}/podList
Get Replica Set Pod List
KubernetesPodGroup_GetReplicaSetPodList_get_/v2/kubernetes/podGroup/replicaSet/{id}/podList 1 param → 200
GET
/v2/kubernetes/podGroup/statefulSet/{id}/podList
Get Stateful Set Pod List
KubernetesPodGroup_GetStatefulSetPodList_get_/v2/kubernetes/podGroup/statefulSet/{id}/podList 1 param → 200
GET
/v2/kubernetes/podGroup/pod/{id}/images
Get Pod Images
KubernetesPodGroup_GetPodImages_get_/v2/kubernetes/podGroup/pod/{id}/images 1 param → 200
GET
/v2/kubernetes/podGroup/cronJob/{id}/images
Get Cron Job Images
KubernetesPodGroup_GetCronJobImages_get_/v2/kubernetes/podGroup/cronJob/{id}/images 1 param → 200
GET
/v2/kubernetes/podGroup/daemonSet/{id}/images
Get Daemon Set Images
KubernetesPodGroup_GetDaemonSetImages_get_/v2/kubernetes/podGroup/daemonSet/{id}/images 1 param → 200
GET
/v2/kubernetes/podGroup/deployment/{id}/images
Get Deployment Images
KubernetesPodGroup_GetDeploymentImages_get_/v2/kubernetes/podGroup/deployment/{id}/images 1 param → 200
GET
/v2/kubernetes/podGroup/replicaSet/{id}/images
Get Replica Set Images
KubernetesPodGroup_GetReplicaSetImages_get_/v2/kubernetes/podGroup/replicaSet/{id}/images 1 param → 200
GET
/v2/kubernetes/podGroup/statefulSet/{id}/images
Get Stateful Set Images
KubernetesPodGroup_GetStatefulSetImages_get_/v2/kubernetes/podGroup/statefulSet/{id}/images 1 param → 200
Kubernetes Image Assurance 4
GET
/v2/kubernetes/imageAssurance/image
Get Image
KubernetesImageAssurance_GetImage_get_/v2/kubernetes/imageAssurance/image 1 param → 200
GET
/v2/kubernetes/imageAssurance/image/vulnerabilitiesdeprecated
Get Image Vulnerabilities
KubernetesImageAssurance_GetImageVulnerabilities_get_/v2/kubernetes/imageAssurance/image/vulnerabilities 3 params → 200
GET
/v2/kubernetes/imageAssurance/image/podGroups
Get Pod Groups
KubernetesImageAssurance_GetPodGroups_get_/v2/kubernetes/imageAssurance/image/podGroups 2 params → 200
GET
/v2/kubernetes/imageAssurance/account/{clusterId}/podsImages
Get Cluster Pod And Images
KubernetesImageAssurance_GetClusterPodAndImages_get_/v2/kubernetes/imageAssurance/account/{clusterId}/podsImages 1 param → 200
Kubernetes Image Assurance Policy 5
GET
/v2/kubernetes/imageAssurance/policy/{id}deprecated
Get
KubernetesImageAssurancePolicy_Get_get_/v2/kubernetes/imageAssurance/policy/{id} 1 param → 200
DELETE
/v2/kubernetes/imageAssurance/policy/{id}deprecated
Delete
KubernetesImageAssurancePolicy_Delete_delete_/v2/kubernetes/imageAssurance/policy/{id} 1 param → 200
GET
/v2/kubernetes/imageAssurance/policydeprecated
Get All
KubernetesImageAssurancePolicy_GetAll_get_/v2/kubernetes/imageAssurance/policy → 200
POST
/v2/kubernetes/imageAssurance/policydeprecated
Post
KubernetesImageAssurancePolicy_Post_post_/v2/kubernetes/imageAssurance/policy body → 200
PUT
/v2/kubernetes/imageAssurance/policydeprecated
Put
KubernetesImageAssurancePolicy_Put_put_/v2/kubernetes/imageAssurance/policy body → 200
Workload Image Assurance 9
GET
/v2/workload/imageAssurance/images
Get Workload Images By Dome9 Id
WorkloadImageAssurance_GetWorkloadImagesByDome9Id_get_/v2/workload/imageAssurance/images 1 param → 200
GET
/v2/workload/imageAssurance/image
Get Image
WorkloadImageAssurance_GetImage_get_/v2/workload/imageAssurance/image 2 params → 200
GET
/v2/workload/imageAssurance/image/workloads
Get Image Workloads By Image Id
WorkloadImageAssurance_GetImageWorkloadsByImageId_get_/v2/workload/imageAssurance/image/workloads 1 param → 200
GET
/v2/workload/imageAssurance/EcsTask/Images
Get Task Images
WorkloadImageAssurance_GetTaskImages_get_/v2/workload/imageAssurance/EcsTask/Images 1 param → 200
GET
/v2/workload/imageAssurance/EcsService/Images
Get Service Images
WorkloadImageAssurance_GetServiceImages_get_/v2/workload/imageAssurance/EcsService/Images 1 param → 200
GET
/v2/workload/imageAssurance/EcsCluster/Images
Get Cluster Images
WorkloadImageAssurance_GetClusterImages_get_/v2/workload/imageAssurance/EcsCluster/Images 1 param → 200
POST
/v2/workload/imageAssurance/scanImage
Scan Image
WorkloadImageAssurance_ScanImage_post_/v2/workload/imageAssurance/scanImage body → 200
POST
/v2/workload/imageAssurance/scanEnvironment/{environmentId}/all
Scan Environment All
WorkloadImageAssurance_ScanEnvironmentAll_post_/v2/workload/imageAssurance/scanEnvironment/{environmentId}/all 1 param → 200
POST
/v2/workload/imageAssurance/scanEnvironment/{environmentId}/failed
Scan Environment Failed
WorkloadImageAssurance_ScanEnvironmentFailed_post_/v2/workload/imageAssurance/scanEnvironment/{environmentId}/failed 1 param → 200
Shift Left Account 11
GET
/v2/ShiftLeftAccount
Get All
ShiftLeftAccount_GetAll_get_/v2/ShiftLeftAccount → 200
POST
/v2/ShiftLeftAccount
Post
ShiftLeftAccount_Post_post_/v2/ShiftLeftAccount body → 200
GET
/v2/ShiftLeftAccount/{id}
Get
ShiftLeftAccount_Get_get_/v2/ShiftLeftAccount/{id} 1 param → 200
DELETE
/v2/ShiftLeftAccount/{id}
Delete
ShiftLeftAccount_Delete_delete_/v2/ShiftLeftAccount/{id} 1 param → 200
PUT
/v2/ShiftLeftAccount/{id}/AccountName
Update Account Name
ShiftLeftAccount_UpdateAccountName_put_/v2/ShiftLeftAccount/{id}/AccountName 2 params → 200
PUT
/v2/ShiftLeftAccount/{id}/accountDescription
Update Account Description
ShiftLeftAccount_UpdateAccountDescription_put_/v2/ShiftLeftAccount/{id}/accountDescription 2 params → 200
DELETE
/v2/ShiftLeftAccount/{id}/DeleteForcedeprecated
Delete Force
ShiftLeftAccount_DeleteForce_delete_/v2/ShiftLeftAccount/{id}/DeleteForce 1 param → 200
PUT
/v2/ShiftLeftAccount/{id}/organizationalUnit
Update Organizational Id
ShiftLeftAccount_UpdateOrganizationalId_put_/v2/ShiftLeftAccount/{id}/organizationalUnit 1 param body → 200
PUT
/v2/ShiftLeftAccount/organizationalUnit/move
Move Cloud Accounts To Organizational Unit
ShiftLeftAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/ShiftLeftAccount/organizationalUnit/move body → 200
PUT
/v2/ShiftLeftAccount/organizationalUnit/moveAll
Move All Cloud Accounts To Organizational Unit
ShiftLeftAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/ShiftLeftAccount/organizationalUnit/moveAll body → 200
POST
/v2/ShiftLeftAccount/organizationalUnit/attach
Post Attach Multi
ShiftLeftAccount_PostAttachMulti_post_/v2/ShiftLeftAccount/organizationalUnit/attach body → 200
Shift Left Policy 5
GET
/v2/ShiftLeftPolicy/{id}deprecated
Get
ShiftLeftPolicy_Get_get_/v2/ShiftLeftPolicy/{id} 1 param → 200
GET
/v2/ShiftLeftPolicydeprecated
Get All
ShiftLeftPolicy_GetAll_get_/v2/ShiftLeftPolicy → 200
POST
/v2/ShiftLeftPolicydeprecated
Post
ShiftLeftPolicy_Post_post_/v2/ShiftLeftPolicy body → 200
PUT
/v2/ShiftLeftPolicydeprecated
Put
ShiftLeftPolicy_Put_put_/v2/ShiftLeftPolicy body → 200
DELETE
/v2/ShiftLeftPolicydeprecated
Delete
ShiftLeftPolicy_Delete_delete_/v2/ShiftLeftPolicy 1 param → 200
Kubernetes Admission Control 14
GET
/v2/kubernetes/admissionControl/policy/{id}
Get Policy
KubernetesAdmissionControl_GetPolicy_get_/v2/kubernetes/admissionControl/policy/{id} 1 param → 200
DELETE
/v2/kubernetes/admissionControl/policy/{id}
Delete Policy
KubernetesAdmissionControl_DeletePolicy_delete_/v2/kubernetes/admissionControl/policy/{id} 1 param → 200
GET
/v2/kubernetes/admissionControl/policy
Get Policy All
KubernetesAdmissionControl_GetPolicyAll_get_/v2/kubernetes/admissionControl/policy → 200
POST
/v2/kubernetes/admissionControl/policy
Post Policy
KubernetesAdmissionControl_PostPolicy_post_/v2/kubernetes/admissionControl/policy body → 207
PUT
/v2/kubernetes/admissionControl/policy
Put Policy
KubernetesAdmissionControl_PutPolicy_put_/v2/kubernetes/admissionControl/policy body → 207
GET
/v2/kubernetes/admissionControl/policiesSummary/{id}
Get Agent Policies Summary
KubernetesAdmissionControl_GetAgentPoliciesSummary_get_/v2/kubernetes/admissionControl/policiesSummary/{id} 1 param → 200
POST
/v2/kubernetes/admissionControl/validation/validateAssessment
Validate Assessment
KubernetesAdmissionControl_ValidateAssessment_post_/v2/kubernetes/admissionControl/validation/validateAssessment body → 200
POST
/v2/kubernetes/admissionControl/validation/validateRule
Validate Rule
KubernetesAdmissionControl_ValidateRule_post_/v2/kubernetes/admissionControl/validation/validateRule body → 200
POST
/v2/kubernetes/admissionControl/validation/validateHistorical
Validate Historical
KubernetesAdmissionControl_ValidateHistorical_post_/v2/kubernetes/admissionControl/validation/validateHistorical body → 200
GET
/v2/kubernetes/admissionControl/exclusions
Get Exclusions
KubernetesAdmissionControl_GetExclusions_get_/v2/kubernetes/admissionControl/exclusions → 200
POST
/v2/kubernetes/admissionControl/exclusions
Post Exclusion
KubernetesAdmissionControl_PostExclusion_post_/v2/kubernetes/admissionControl/exclusions body → 200
DELETE
/v2/kubernetes/admissionControl/exclusions
Delete Exclusion
KubernetesAdmissionControl_DeleteExclusion_delete_/v2/kubernetes/admissionControl/exclusions 1 param → 200
PUT
/v2/kubernetes/admissionControl/exclusions
Put Exclusion
KubernetesAdmissionControl_PutExclusion_put_/v2/kubernetes/admissionControl/exclusions body → 200
GET
/v2/kubernetes/admissionControl/exclusions/{id}
Get Exclusion
KubernetesAdmissionControl_GetExclusion_get_/v2/kubernetes/admissionControl/exclusions/{id} 1 param → 200
Image Admission Exclusion 5
GET
/v2/kubernetes/admissionControl/imageAdmissionExclusion/{id}
Get
ImageAdmissionExclusion_Get_get_/v2/kubernetes/admissionControl/imageAdmissionExclusion/{id} 1 param → 200
DELETE
/v2/kubernetes/admissionControl/imageAdmissionExclusion/{id}
Delete
ImageAdmissionExclusion_Delete_delete_/v2/kubernetes/admissionControl/imageAdmissionExclusion/{id} 1 param → 200
GET
/v2/kubernetes/admissionControl/imageAdmissionExclusion
Get All
ImageAdmissionExclusion_GetAll_get_/v2/kubernetes/admissionControl/imageAdmissionExclusion → 200
PUT
/v2/kubernetes/admissionControl/imageAdmissionExclusion
Put
ImageAdmissionExclusion_Put_put_/v2/kubernetes/admissionControl/imageAdmissionExclusion body → 207
POST
/v2/kubernetes/admissionControl/imageAdmissionExclusion
Post
ImageAdmissionExclusion_Post_post_/v2/kubernetes/admissionControl/imageAdmissionExclusion body → 207
Kubernetes Image Admission Exclusion 4
GET
/v2/kubernetes/imageAssurance/admissionExclusion/{id}deprecated
Get
KubernetesImageAdmissionExclusion_Get_get_/v2/kubernetes/imageAssurance/admissionExclusion/{id} 1 param → 200
DELETE
/v2/kubernetes/imageAssurance/admissionExclusion/{id}deprecated
Delete
KubernetesImageAdmissionExclusion_Delete_delete_/v2/kubernetes/imageAssurance/admissionExclusion/{id} 1 param → 200
GET
/v2/kubernetes/imageAssurance/admissionExclusiondeprecated
Get All
KubernetesImageAdmissionExclusion_GetAll_get_/v2/kubernetes/imageAssurance/admissionExclusion → 200
PUT
/v2/kubernetes/imageAssurance/admissionExclusiondeprecated
Put
KubernetesImageAdmissionExclusion_Put_put_/v2/kubernetes/imageAssurance/admissionExclusion body → 207
Ecs Image Scan 2
POST
/v2/cloudAccount/ecs/{cloudAccountId}
Enable Or Disable Ecs Image Scan
EcsImageScan_EnableOrDisableEcsImageScan_post_/v2/cloudAccount/ecs/{cloudAccountId} 1 param body → 200
GET
/v2/cloudAccount/ecs/{cloudAccountId}
Get Ecs Image Scan Config
EcsImageScan_GetEcsImageScanConfig_get_/v2/cloudAccount/ecs/{cloudAccountId} 1 param → 200
Vulnerability Policy 5
GET
/v2/vulnerability/policy/{id}
Get
VulnerabilityPolicy_Get_get_/v2/vulnerability/policy/{id} 1 param → 200
GET
/v2/vulnerability/policy
Get All
VulnerabilityPolicy_GetAll_get_/v2/vulnerability/policy → 200
POST
/v2/vulnerability/policy
Post
VulnerabilityPolicy_Post_post_/v2/vulnerability/policy body → 200
PUT
/v2/vulnerability/policy
Put
VulnerabilityPolicy_Put_put_/v2/vulnerability/policy body → 200
DELETE
/v2/vulnerability/policy
Delete
VulnerabilityPolicy_Delete_delete_/v2/vulnerability/policy 1 param → 200
SBOM Export 2
GET
/v2/sbom/formats
SBOM Format Versions
SBOMExport_SBOMFormatVersions_get_/v2/sbom/formats → 200
GET
/v2/sbom/export
ExportSBOM
SBOMExport_ExportSBOM_get_/v2/sbom/export 4 params → 200
Vulnerabilities 6

Vulnerabilities

GET
/v2/vulnerability/scan-resultsdeprecated
Get Scan Results
Vulnerabilities_GetScanResults_get_/v2/vulnerability/scan-results 4 params → 200
GET
/v2/vulnerability/scan-results-metadatadeprecated
Get Scan Results Metadata
Vulnerabilities_GetScanResultsMetadata_get_/v2/vulnerability/scan-results-metadata 3 params → 200
GET
/v2/vulnerability/scan-metadata
Get Scan Metadata
Vulnerabilities_GetScanMetadata_get_/v2/vulnerability/scan-metadata 3 params → 200
GET
/v2/vulnerability/scan
Get Scan
Vulnerabilities_GetScan_get_/v2/vulnerability/scan 5 params → 200
GET
/v2/vulnerability/scan-results-export-csvsdeprecated
Export Scan Results To Csv
Vulnerabilities_ExportScanResultsToCsv_get_/v2/vulnerability/scan-results-export-csvs 4 params → 200
GET
/v2/vulnerability/scan-export-csvs
Export Scan To Csv
Vulnerabilities_ExportScanToCsv_get_/v2/vulnerability/scan-export-csvs 5 params → 200
Vulnerability Exclusions 4
GET
/v2/vulnerability/exclusions
Get All Exclusions Vulnerabilities
VulnerabilityExclusions_GetAllExclusionsVulnerabilities_get_/v2/vulnerability/exclusions → 200
POST
/v2/vulnerability/exclusions
Create Exclusions Vulnerabilities
VulnerabilityExclusions_CreateExclusionsVulnerabilities_post_/v2/vulnerability/exclusions body → 200
PUT
/v2/vulnerability/exclusions
Update Exclusion
VulnerabilityExclusions_UpdateExclusion_put_/v2/vulnerability/exclusions body → 200
POST
/v2/vulnerability/exclusions/bulk-delete
Delete Exclusions
VulnerabilityExclusions_DeleteExclusions_post_/v2/vulnerability/exclusions/bulk-delete body → 200

Schemas 188

The contract defines 188 schemas that model the data the API accepts and returns. The most detailed are Dome9.Web.Api.Serverless.ServerlessFunctionViewModel (26 properties), RuleEntity (16 properties), Dome9.Web.Api.Serverless.ServerlessAccountViewModel (16 properties), UnifiedPackageCve (16 properties). Each schema is shown below with its type and property counts.

Dome9.Web.Api.Agentless.AddAgentlessAwsAccountRequestBody
object
6 properties 2 required
Dome9.Web.Api.Agentless.AgentlessAccountSettingsViewModel
object
7 properties
Dome9.Web.Api.Agentless.AddAgentlessAzureAccountRequestBody
object
4 properties
Dome9.Web.Api.Agentless.AzureOnboardingCustomizationViewModel
object
6 properties
Dome9.Web.Api.Agentless.AddAgentlessAwsCentralizedAccountRequestBody
object
5 properties 2 required
Dome9.Web.Api.Agentless.AgentlessCentralizedAccountSettingsViewModel
object
1 property
Dome9.Web.Api.Agentless.AddAgentlessAzureCentralizedAccountRequestBody
object
4 properties
Dome9.Web.Api.Agentless.CentralizedAccountOnboardingCustomizationViewModel
object
8 properties
Dome9.Web.Api.Agentless.AgentlessAzureCentralizedAccountSettingsViewModel
object
2 properties
Dome9.Web.Api.Agentless.AddAgentlessAwsSubAccountRequestBody
object
6 properties 3 required
Dome9.Web.Api.Agentless.AddAgentlessAzureSubAccountRequestBody
object
4 properties 1 required
Dome9.Web.Api.Agentless.SubAccountOnboardingCustomizationViewModel
object
1 property
Dome9.Web.Api.Agentless.AccountStateViewModel
object
9 properties
Dome9.Web.Api.Agentless.AccountViewModel
object
13 properties
Dome9.BL.Std.Services.Agentless.AccountIssues
object
2 properties
Dome9.BL.Std.Services.Agentless.IssueItem
object
1 property
Dome9.Web.Api.Agentless.AgentlessInstanceViewModel
object
3 properties
Dome9.Web.Api.Agentless.AgentlessInstanceStateDetailsViewModel
object
2 properties
Dome9.Web.Api.Agentless.GenerateAgentlessAwsOnboardingDataRequest
object
4 properties
Dome9.Web.Api.Agentless.AgentlessAwsOnboardingDataViewModel
object
3 properties
Dome9.Web.Api.Agentless.GenerateAgentlessAzureOnboardingDataRequest
object
6 properties
Dome9.Web.Api.Agentless.AzureOnboardingCustomizationDataViewModel
object
8 properties
Dome9.Web.Api.Agentless.AgentlessAzureOnboardingDataViewModel
object
3 properties
Dome9.Web.Api.Agentless.AgentlessAzureOffboardingDataViewModel
object
3 properties
Dome9.Web.Api.Agentless.AgentlessAwsValidateStackDataViewModel
object
3 properties
Dome9.Web.Api.Agentless.CentralizedAzureAccountViewModel
object
3 properties
Dome9.Web.Api.Agentless.AgentlessSettingsViewModel
object
4 properties
Falconetix.Model.Serverless.Protego.ProtegoInvocationsEntity
object
2 properties
Dome9.Web.Api.Serverless.ServerlessAddAccountRequest
object
2 properties 1 required
Dome9.Web.Api.Serverless.ServerlessAccountViewModel
object
16 properties
Dome9.Web.Api.Serverless.ServerlessPutAccountViewModel
object
3 properties
Falconetix.Model.Serverless.ServerlessPoliciesAction
object
2 properties
Dome9.Web.Api.Serverless.ServerlessAccountStatusViewModel
object
12 properties
Dome9.Web.Api.Serverless.ServerlessExclusionViewModel
object
7 properties
Dome9.Web.Api.Serverless.ServerlessExclusionModel
object
6 properties
Dome9.Web.Api.Serverless.ServerlessRuleViewModel
object
7 properties
Dome9.Web.Api.Serverless.ServerlessRuleModel
object
6 properties
Dome9.Web.Api.Serverless.ServerlessDeleteRuleViewModel
object
1 property
Dome9.Web.Api.Serverless.ServerlessMissingPermissionsViewModel
object
3 properties
Dome9.Web.Api.Serverless.ServerlessPermissionViewModel
object
4 properties
Dome9.Web.Api.Serverless.ServerlessPermissionResourceViewModel
object
2 properties
Falconetix.Model.ServiceInterfaces.Serverless.ServerlessApiResponse
object
4 properties
Dome9.Web.Api.Serverless.ServerlessFunctionViewModel
object
26 properties
Dome9.Web.Api.Serverless.FunctionPermissionViewModel
object
3 properties
Dome9.Web.Api.Serverless.ServerlessErrorViewModel
object
3 properties
Dome9.Web.Api.Serverless.FunctionPermissionResourceViewModel
object
5 properties
Dome9.Web.Api.Serverless.ServerlessFunctionAppViewModel
object
7 properties
Dome9.Web.Api.Serverless.ServerlessFunctionSummaryViewModel
object
2 properties
Dome9.Web.Api.Serverless.ServerlessPodGroupViewModel
object
6 properties
Dome9.Web.Api.Serverless.ServerlessPutFunctionsListViewModel
object
1 property
Dome9.Web.Api.Serverless.ServerlessPutFunctionViewModel
object
6 properties
Dome9.Web.Api.Serverless.ServerlessPutFunctionResponseViewModel
object
3 properties
Dome9.Web.Api.Serverless.ServerlessPutSingleFunctionViewModel
object
5 properties
Dome9.Web.Api.Serverless.EnableFSPViewModel
object
1 property
Dome9.Web.Api.Serverless.ServerlessEnableFunctionFSPBlockBody
object
1 property
Dome9.Web.Api.Serverless.ServerlessWhiteListViewModel
object
10 properties
Dome9.Web.Api.Serverless.WhiteListResourceTypeViewModel
object
2 properties
Dome9.Web.Api.Serverless.WhiteListResourceViewModel
object
4 properties
Dome9.Web.Api.Serverless.ServerlessFspVersioViewModel
object
3 properties
Dome9.Web.Api.Serverless.ServerlessFSPSupportedRuntimesViewModel
object
1 property
Dome9.Web.Api.Compliance.Serverless.Policy.ServerlessPolicyViewModel
object
6 properties
Dome9.Web.Api.Compliance.Serverless.Policy.ServerlessPolicyRequestModel
object
4 properties 3 required
ImageAssurancePolicyViewModel
object
9 properties 9 required
ImageAssurancePolicyType
string
ImageAssurancePolicyPlatform
string
ImageAssurancePolicyRequestModelOld
object
6 properties 6 required
ContinuousCompliancePolicyTargetType
string
KubernetesRuntimeAssuranceAction
string
RuleObject
object
5 properties 5 required
RuleSeverity
string
NotificationObject
object
2 properties 2 required
AssessmentExclusionEntity
AssessmentExclusion
object
13 properties 13 required
AssessmentCloudAccountType
string
DateTimeRange
object
2 properties 2 required
RootEntityBase
object
3 properties 3 required
KubernetesImageScanTotalsViewModel
object
10 properties 10 required
KubernetesImageViewModel
object
12 properties 12 required
KubernetesImageScanDetailsViewModel
object
5 properties 5 required
KubernetesImageScanVulnerabilitiesViewModel
object
1 property 1 required
KubernetesImageScanVulnerabilityViewModel
object
9 properties 9 required
CveFindingOnPackage
object
5 properties 5 required
CvssData
object
7 properties 3 required
CvssMetrics
object
11 properties 1 required
KubernetesImagePodGroupsViewModel
object
2 properties 2 required
KubernetesImagePodGroupDetailsViewModel
object
9 properties 9 required
KubernetesPodsImagesViewModel
object
2 properties 2 required
PodImagesViewModel
object
5 properties 5 required
ImageViewModel
object
3 properties 3 required
ContainerViewModel
object
1 property 1 required
CronJobViewModel
object
7 properties 7 required
ImageAssurancePolicyRequestModel
CloudVendor
string
UpdateIdViewModel
object
1 property 1 required
MoveOrganizationalUnitViewModel
object
2 properties 2 required
AttachCloudAccountsViewModel
object
2 properties 2 required
WorkloadImageViewModel
object
11 properties 11 required
ImageType
string
ImageStatus
string
ImageWorkloadsViewModel
object
2 properties 2 required
KubernetesImageWorkloadViewModel
object
11 properties 11 required
EcsImageWorkloadViewModel
object
11 properties 11 required
CloudRegion
string
ImageScanRequestModel
object
2 properties 2 required
ImageScanRequestViewModel
object
1 property 1 required
ShiftLeftAccountViewModel
object
8 properties 8 required
ShiftLeftPostViewModel
object
3 properties 3 required
ShiftLeftPolicyViewModel
object
9 properties 9 required
ShiftLeftPolicyRequestModel
object
8 properties 8 required
AdmissionControlPolicyViewModel
object
7 properties 7 required
KubernetesAdmissionControlPolicyType
string
AdmissionControlPolicyRequestModel
object
6 properties 6 required
AdmissionControlPoliciesSummaryViewModel
object
2 properties 2 required
AdmissionControlAgentPolicySummaryViewModel2
object
6 properties 6 required
KubernetesAdmissionControlVerifyResult
object
2 properties 2 required
KubernetesRuntimeAssuranceVerifyResult
object
3 properties 3 required
MultipleCloudAccountsAssessmentResultViewModelOfAssessmentHistoryMinimizedEntity
object
2 properties
SingleCloudAccountsAssessmentResultViewModelOfAssessmentHistoryMinimizedEntity
object
8 properties
AssessmentResultCloudAccountMetadataViewModel
object
3 properties 3 required
RuleTestResult
object
8 properties 8 required
RuleTestResultStats
object
3 properties 3 required
ValidationResult
object
8 properties 8 required
ValidationStatusResult
string
RuleEntity
object
16 properties 16 required
AssessmentHistoryMinimizedEntity
VpcMinimizedEntity
object
2 properties 2 required
TagRuleEntity
object
2 properties 2 required
AssessmentHistoryMinimizedEntityBase
object
2 properties 2 required
AssessmentDataSyncStatusEntityViewModel
object
4 properties 4 required
EntityWithPermissionIssueViewModel
object
3 properties 3 required
AdmissionControlVerifyRequestViewModel
object
3 properties 3 required
AdmissionControlVerifyResultViewModel
object
3 properties 3 required
AdmissionControlEvalResultViewModel
object
4 properties 4 required
AdmissionControlGSLRule
object
1 property 1 required
AdmissionControlExclusionPutRequestViewModel
AdmissionControlExclusionPostRequestModel
ExclusionPostRequestBaseModel
object
7 properties 7 required
RuleViewModel
object
16 properties 16 required
KubernetesImageAdmissionExclusionViewModel
KubernetesImageAdmissionPostExclusionViewModel
object
9 properties 9 required
DeprecatedKubernetesImageAdmissionExclusionViewModel
object
2 properties 2 required
ImageAdmissionExclusionModel
object
Use exclusions to bypass specific registries, specific images, usernames, roles, groups, or namespaces; Use "%" as a wildcard.
5 properties 5 required
VulnerabilityStats
object
8 properties 8 required
VulnerabilitySeverityStats
object
7 properties 7 required
EcsImageScanConfigViewModel
object
1 property 1 required
VlmScannedAsset
object
9 properties 9 required
VlmEntityType
string
VlmImageGroupDetails
object
2 properties 2 required
VlmImageGroupType
string
VlmScanInfo
object
2 properties 2 required
VlmWorkloadPolicyViewModel
object
9 properties 9 required
VlmWorkloadPolicyRequestModel
object
8 properties 8 required
UnifiedScanResultSBOMPackage
UnifiedPackageManager
object
2 properties 2 required
UnifiedLicense
object
3 properties 3 required
UnifiedLicenseLocation
object
2 properties 2 required
UnifiedScanResultBase
object
13 properties 13 required
VlmAffectedAssetSnapshot
object
7 properties 7 required
ImageMetadata
object
5 properties
VlmBaseImageDetails
object
3 properties 3 required
SBOMFormatVersions
object
1 property 1 required
SBOMFormatVersionDetails
object
2 properties 2 required
SBOMVersionFormatId
string
VlmEntityTypeBC
string
UnifiedScanResultScanSummary
UnifiedRemediationSummary
object
2 properties 1 required
UnifiedRemediationSummaryCategory
object
2 properties 2 required
UnifiedRemediationSummaryCategoryRemediations
object
4 properties 4 required
UnifiedScanResultPackage
UnifiedPackageParent
object
3 properties 3 required
UnifiedPackageCve
object
16 properties 14 required
UnifiedVulnerabilityExclusion
object
5 properties 5 required
UnifiedScanResultInsecureContent
UnifiedScanResultWithFiles
UnifiedScanResultFile
object
5 properties 4 required
UnifiedScanResultFileContent
object
3 properties 2 required
UnifiedScanResultMalware
Layer
object
5 properties 3 required
VlmScanResultMetadataViewModel
object
8 properties 8 required
VlmScanMetadataViewModel
object
4 properties 4 required
ScanResultViewModel
object
7 properties 4 required
VulnerabilityExclusionViewModel
object
9 properties 9 required
VulnerabilityExclusionTypeEnum
string
VulnerabilityExclusionFilterViewModel
object
11 properties 11 required
MaliciousCategory
string
VulnerabilityExclusionPostRequestModel
object
5 properties 5 required
VulnerabilityExclusionPutRequestModel
object
6 properties 6 required
VulnerabilityExclusionDeleteViewModel
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudguard-workload-protection-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 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 Workload Protection (CWPP) 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.