Get all configured segment groups for the specified tenant.

External Documentation

To learn more, visit the Zscaler Private Access documentation.

​
Basic Parameters

ParameterDescription
Microtenant IDThe unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, insert 0.
Page NumberThe number of the pages to return.
Page SizeThe size of each returned page. Valid range is 1-500.
SearchAn open search string to query the results by.
Tenant IDThe unique identifier of the ZPA tenant.

​
Advanced Parameters

ParameterDescription
Skip Detailed App InfoIndicates whether to include complete application details or not.

​
Example Output

{
	"list": [
		{
			"applicationNames": [
				{
					"id": 0,
					"name": "string"
				}
			],
			"applications": [
				{
					"adpEnabled": false,
					"autoAppProtectEnabled": false,
					"bypassType": "ALWAYS",
					"configSpace": "DEFAULT",
					"creationTime": 0,
					"defaultIdleTimeout": 0,
					"defaultMaxAge": 0,
					"description": "string",
					"domainName": "string",
					"domainNames": [
						"string"
					],
					"doubleEncrypt": true,
					"enabled": true,
					"healthCheckType": "DEFAULT",
					"icmpAccessType": "PING_TRACEROUTING",
					"id": 0,
					"inspectTrafficWithZia": true,
					"ipAnchored": true,
					"logFeatures": [
						"skip_discovery"
					],
					"matchStyle": "EXCLUSIVE",
					"modifiedBy": 0,
					"modifiedTime": 0,
					"name": "string",
					"passiveHealthEnabled": true,
					"microtenantId": 0,
					"microtenantName": "string",
					"selectConnectorCloseToApp": true,
					"serverGroups": [
						{
							"configSpace": "DEFAULT",
							"creationTime": 0,
							"description": "string",
							"enabled": true,
							"id": 0,
							"dynamicDiscovery": true,
							"modifiedBy": 0,
							"modifiedTime": 0,
							"name": "string",
							"microtenantId": 0,
							"microtenantName": "string"
						}
					],
					"sharedMicrotenantIds": [
						0
					],
					"tcpKeepAlive": 0,
					"tcpPortRange": [
						{
							"from": 0,
							"to": 0
						}
					],
					"tcpPortRanges": [
						0
					],
					"tcpPortsIn": [
						0
					],
					"tcpPortsOut": [
						0
					],
					"tcpProtocolsBitmasks": [
						0
					],
					"udpPortRange": [
						{
							"from": 0,
							"to": 0
						}
					],
					"udpPortRanges": [
						0
					],
					"udpProtocolsBitmasks": [
						0
					],
					"useInDrMode": true
				}
			],
			"configSpace": "DEFAULT",
			"creationTime": 0,
			"description": "string",
			"enabled": true,
			"id": 0,
			"modifiedBy": 0,
			"modifiedTime": 0,
			"name": "string",
			"policyMigrated": true,
			"microtenantId": 0,
			"microtenantName": "string",
			"tcpKeepAliveEnabled": 0
		}
	],
	"totalCount": 0,
	"totalPages": 0
}

​
Workflow Library Example

Get Segment Groups with Zscaler Private Access and Send Results Via Email

Preview this Workflow on desktop

Get all configured segment groups for the specified tenant.

External Documentation

To learn more, visit the Zscaler Private Access documentation.

​
Basic Parameters

ParameterDescription
Microtenant IDThe unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, insert 0.
Page NumberThe number of the pages to return.
Page SizeThe size of each returned page. Valid range is 1-500.
SearchAn open search string to query the results by.
Tenant IDThe unique identifier of the ZPA tenant.

​
Advanced Parameters

ParameterDescription
Skip Detailed App InfoIndicates whether to include complete application details or not.

​
Example Output

{
	"list": [
		{
			"applicationNames": [
				{
					"id": 0,
					"name": "string"
				}
			],
			"applications": [
				{
					"adpEnabled": false,
					"autoAppProtectEnabled": false,
					"bypassType": "ALWAYS",
					"configSpace": "DEFAULT",
					"creationTime": 0,
					"defaultIdleTimeout": 0,
					"defaultMaxAge": 0,
					"description": "string",
					"domainName": "string",
					"domainNames": [
						"string"
					],
					"doubleEncrypt": true,
					"enabled": true,
					"healthCheckType": "DEFAULT",
					"icmpAccessType": "PING_TRACEROUTING",
					"id": 0,
					"inspectTrafficWithZia": true,
					"ipAnchored": true,
					"logFeatures": [
						"skip_discovery"
					],
					"matchStyle": "EXCLUSIVE",
					"modifiedBy": 0,
					"modifiedTime": 0,
					"name": "string",
					"passiveHealthEnabled": true,
					"microtenantId": 0,
					"microtenantName": "string",
					"selectConnectorCloseToApp": true,
					"serverGroups": [
						{
							"configSpace": "DEFAULT",
							"creationTime": 0,
							"description": "string",
							"enabled": true,
							"id": 0,
							"dynamicDiscovery": true,
							"modifiedBy": 0,
							"modifiedTime": 0,
							"name": "string",
							"microtenantId": 0,
							"microtenantName": "string"
						}
					],
					"sharedMicrotenantIds": [
						0
					],
					"tcpKeepAlive": 0,
					"tcpPortRange": [
						{
							"from": 0,
							"to": 0
						}
					],
					"tcpPortRanges": [
						0
					],
					"tcpPortsIn": [
						0
					],
					"tcpPortsOut": [
						0
					],
					"tcpProtocolsBitmasks": [
						0
					],
					"udpPortRange": [
						{
							"from": 0,
							"to": 0
						}
					],
					"udpPortRanges": [
						0
					],
					"udpProtocolsBitmasks": [
						0
					],
					"useInDrMode": true
				}
			],
			"configSpace": "DEFAULT",
			"creationTime": 0,
			"description": "string",
			"enabled": true,
			"id": 0,
			"modifiedBy": 0,
			"modifiedTime": 0,
			"name": "string",
			"policyMigrated": true,
			"microtenantId": 0,
			"microtenantName": "string",
			"tcpKeepAliveEnabled": 0
		}
	],
	"totalCount": 0,
	"totalPages": 0
}

​
Workflow Library Example

Get Segment Groups with Zscaler Private Access and Send Results Via Email

Preview this Workflow on desktop