Skip to main content

ZTGroup Schema

Data structure for Z T Group objects.

Fields​

FieldTypeRequiredDescriptionNotes
auto_scalebooleanNo-API field: auto_scale
aws_availability_zonestringNo-API field: aws_availability_zone
aws_regionstringNo-API field: aws_region
azure_availability_zonestringNo-API field: azure_availability_zone
azure_regionstringNo-API field: azure_region
cellular_deploymentEntityReferenceNo-API field: cellular_deployment
cellular_deployment_modestringNo-API field: cellular_deployment_mode
deploy_typestringNo-API field: deploy_type
descstringNo--
fall_back_to_tlsbooleanNo-API field: fall_back_to_tls
gcp_availability_zonestringNo-API field: gcp_availability_zone
gcp_regionstringNo-API field: gcp_region
idintegerYes--
locationEntityReferenceNo--
max_ec_countintegerNo-API field: max_ec_count
max_user_per_MTunnelintegerNo-API field: max_user_per_MTunnel
meta_configEcGroupMetaConfigNo-API field: meta_config
namestringYes--
namespacestringNo-API field: namespace
platformstringNo--
statusStatusEnumCollectionNo--
tunnel_modestringNo-API field: tunnel_mode
zero_trust_gatewayEntityReferenceNo-API field: zero_trust_gateway
zero_trust_groupbooleanNo-API field: zero_trust_group
zpa_user_tunnelbooleanNo-API field: zpa_user_tunnel
zt_VMsZTVmWrapperCollectionNo-API field: zt_VMs

Example​

{
"auto_scale": true,
"aws_availability_zone": "string",
"aws_region": "string",
"azure_availability_zone": "string",
"azure_region": "string",
"cellular_deployment": {
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
},
"cellular_deployment_mode": "string",
"deploy_type": "string"
}
// ... more fields