/mgmtconfig/v1/admin/customers/{customerId}/policySet/policyType/{policyType}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policyType *required
string
(path)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.

creationTime
integer($int32)
The time the policy set is created.
description
string
The description of the policy set.
enabled
boolean
Whether or not the policy set is enabled.
id
integer($int64)
The unique identifier of the policy set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy set.
modifiedTime
integer($int32)
The time the policy set is modified.
name*
string
The name of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
rules
The list of rules for a particular policy.

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
sorted
boolean
Indicates if the policy set is sorted (true) or not (false).
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "creationTime": 0,
  "description": "string",
  "enabled": true,
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "policyType": 0,
  "rules": [
    {
      "action": "ALLOW",
      "actionId": 0,
      "appServerGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "appConnectorGroups": [
        {
          "connectors": [
            {
              "applicationStartTime": 0,
              "appConnectorGroupId": "string",
              "appConnectorGroupName": "string",
              "controlChannelStatus": "UNKNOWN",
              "creationTime": 0,
              "ctrlBrokerName": "string",
              "currentVersion": "string",
              "description": "string",
              "enabled": true,
              "expectedUpgradeTime": 0,
              "expectedVersion": "string",
              "fingerprint": "string",
              "id": 0,
              "ipAcl": [
                "string"
              ],
              "issuedCertId": 0,
              "lastBrokerConnectTime": 0,
              "lastBrokerConnectTimeDuration": "string",
              "lastBrokerDisconnectTime": 0,
              "lastBrokerDisconnectTimeDuration": "string",
              "lastUpgradeTime": 0,
              "latitude": 0,
              "location": "string",
              "longitude": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "provisioningKeyId": 0,
              "provisioningKeyName": "string",
              "platform": "string",
              "platformDetail": "string",
              "previousVersion": "string",
              "privateIp": "string",
              "publicIp": "string",
              "runtimeOS": "string",
              "sargeVersion": "string",
              "microtenantId": 0,
              "microtenantName": "string",
              "enrollmentCert": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "upgradeAttempt": 0,
              "upgradeStatus": "COMPLETE",
              "zpnSubModuleUpgradeList": [
                {
                  "creationTime": 0,
                  "currentVersion": "string",
                  "entityGid": 0,
                  "entityType": "ASSISTANT",
                  "expectedVersion": "string",
                  "id": 0,
                  "modifiedBy": 0,
                  "modifiedTime": 0,
                  "previousVersion": "string",
                  "role": "ASSISTANT",
                  "upgradeStatus": "COMPLETE",
                  "upgradeTime": 0
                }
              ]
            }
          ],
          "cityCountry": "string",
          "countryCode": "string",
          "creationTime": 0,
          "description": "string",
          "dnsQueryType": "IPV4_IPV6",
          "enabled": true,
          "geoLocationId": 0,
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "latitude": "string",
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "overrideVersionProfile": true,
          "praEnabled": false,
          "microtenantId": 0,
          "microtenantName": "string",
          "serverGroups": [
            {
              "configSpace": "DEFAULT",
              "creationTime": 0,
              "description": "string",
              "enabled": true,
              "id": 0,
              "dynamicDiscovery": true,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "microtenantId": 0,
              "microtenantName": "string"
            }
          ],
          "lssAppConnectorGroup": true,
          "tcpQuickAckApp": true,
          "tcpQuickAckAssistant": true,
          "tcpQuickAckReadAssistant": true,
          "upgradeDay": "string",
          "upgradeTimeInSecs": "string",
          "useInDrMode": false,
          "versionProfileId": 0,
          "versionProfileName": "string",
          "versionProfileVisibilityScope": "ALL",
          "wafDisabled": true
        }
      ],
      "conditions": [
        {
          "creationTime": 0,
          "id": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "negated": true,
          "operands": [
            {
              "creationTime": 0,
              "id": 0,
              "idpId": 0,
              "lhs": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "objectType": "USER",
              "rhs": "string",
              "microtenantId": 0
            }
          ],
          "operator": "AND",
          "microtenantId": 0
        }
      ],
      "creationTime": 0,
      "credential": {
        "id": 0,
        "name": "string"
      },
      "customMsg": "string",
      "defaultRule": true,
      "defaultRuleName": "string",
      "description": "string",
      "id": 0,
      "inconsistentConfigDetails": {
        "application": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "segmentGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "appConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "baCertificate": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "branchConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "cloudConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "idp": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "location": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "machineGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "postureProfile": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "samlAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "scimAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "serverGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "praApplication": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "trustedNetwork": [
          {
            "name": "string",
            "reason": "string"
          }
        ]
      },
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "operator": "AND",
      "policySetId": 0,
      "policyType": 0,
      "priority": 0,
      "privilegedCapabilities": {
        "capabilities": [
          "string"
        ],
        "creationTime": 0,
        "id": 0,
        "modifiedBy": 0,
        "modifiedTime": 0
      },
      "reauthIdleTimeout": 0,
      "reauthTimeout": 0,
      "ruleOrder": 0,
      "microtenantId": 0,
      "microtenantName": "string",
      "serviceEdgeGroups": [
        {
          "altCloud": "string",
          "cityCountry": "string",
          "countryCode": "string",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "geoLocationId": 0,
          "graceDistanceEnabled": true,
          "graceDistanceValue": 0,
          "graceDistanceValueUnit": "MILES",
          "id": 0,
          "isPublic": "string",
          "latitude": "string",
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "overrideVersionProfile": true,
          "serviceEdges": [
            {
              "applicationStartTime": 0,
              "controlChannelStatus": "UNKNOWN",
              "creationTime": 0,
              "ctrlBrokerName": "string",
              "currentVersion": "string",
              "description": "string",
              "enabled": true,
              "expectedUpgradeTime": 0,
              "expectedVersion": "string",
              "fingerprint": "string",
              "id": 0,
              "ipAcl": [
                "string"
              ],
              "issuedCertId": 0,
              "lastBrokerConnectTime": 0,
              "lastBrokerConnectTimeDuration": "string",
              "lastBrokerDisconnectTime": 0,
              "lastBrokerDisconnectTimeDuration": "string",
              "lastUpgradeTime": 0,
              "latitude": "string",
              "listenIps": [
                "string"
              ],
              "location": "string",
              "longitude": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "provisioningKeyId": 0,
              "provisioningKeyName": "string",
              "platform": "string",
              "platformDetail": "string",
              "previousVersion": "string",
              "serviceEdgeGroupId": "string",
              "serviceEdgeGroupName": "string",
              "privateIp": "string",
              "publicIp": "string",
              "publishIps": [
                "string"
              ],
              "runtimeOS": "string",
              "sargeVersion": "string",
              "microtenantId": 0,
              "microtenantName": "string",
              "enrollmentCert": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "upgradeAttempt": 0,
              "upgradeStatus": "COMPLETE",
              "zpnSubModuleUpgradeList": [
                {
                  "creationTime": 0,
                  "currentVersion": "string",
                  "entityGid": 0,
                  "entityType": "ASSISTANT",
                  "expectedVersion": "string",
                  "id": 0,
                  "modifiedBy": 0,
                  "modifiedTime": 0,
                  "previousVersion": "string",
                  "role": "ASSISTANT",
                  "upgradeStatus": "COMPLETE",
                  "upgradeTime": 0
                }
              ]
            }
          ],
          "microtenantId": 0,
          "microtenantName": "string",
          "trustedNetworks": [
            {
              "creationTime": 0,
              "domain": "string",
              "id": 0,
              "masterCustomerId": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "networkId": "string",
              "zscalerCloud": "string"
            }
          ],
          "upgradeDay": "string",
          "upgradeTimeInSecs": "string",
          "useInDrMode": true,
          "versionProfileId": 0,
          "versionProfileName": "string",
          "versionProfileVisibilityScope": "ALL"
        }
      ],
      "zpnIsolationProfileId": 0,
      "zpnInspectionProfileId": 0,
      "zpnInspectionProfileName": "string"
    }
  ],
  "microtenantId": 0,
  "microtenantName": "string",
  "sorted": true
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policyRuleResource *required
object
(body)
The object of the policy rule.
{
  "action": "ALLOW",
  "actionId": 0,
  "appServerGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "appConnectorGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "conditions": [
    {
      "creationTime": 0,
      "id": "string",
      "modifiedBy": "string",
      "modifiedTime": 0,
      "negated": true,
      "operands": [
        {
          "commonProperties": {
            "creationTime": 0,
            "id": 0,
            "idpId": 0,
            "lhs": "string",
            "modifiedBy": 0,
            "modifiedTime": 0,
            "name": "string",
            "objectType": "USER",
            "rhs": "string",
            "microtenantId": 0
          },
          "creationTime": 0,
          "entryValues": [
            {
              "lhs": "string",
              "rhs": "string"
            }
          ],
          "id": "string",
          "idpId": 0,
          "modifiedBy": "string",
          "modifiedTime": 0,
          "objectType": "USER",
          "values": [
            "string"
          ]
        }
      ],
      "operator": "AND",
      "setIds": [
        0
      ]
    }
  ],
  "creationTime": 0,
  "credential": {
    "id": 0,
    "name": "string"
  },
  "customMsg": "string",
  "description": "string",
  "id": "string",
  "modifiedBy": "string",
  "modifiedTime": 0,
  "name": "string",
  "operator": "AND",
  "policySetId": 0,
  "policyType": 0,
  "priority": 0,
  "privilegedCapabilities": {
    "capabilities": [
      "string"
    ]
  },
  "reauthIdleTimeout": 0,
  "reauthTimeout": 0,
  "ruleOrder": 0,
  "microtenantId": 0,
  "microtenantName": "string",
  "serviceEdgeGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "version": 0,
  "zpnIsolationProfileId": 0,
  "zpnInspectionProfileId": 0,
  "zpnInspectionProfileName": "string"
}

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

id
integer($int64)
The unique identifier of the Server Group resource.
name
string
The name of the Server Group resource.
appConnectorGroups

id
integer($int64)
The unique identifier of the App Connector Group resource.
name
string
The name of the App Connector Group resource.
conditions
This model is for providing the set of conditions for the policy.

creationTime
integer($int32)
The time the condition set resource is created. Only applicable in a GET request. Ignored in PUT, POST, and DELETE requests.
id
string
The unique identifier of the condition set resource. Only applicable in a GET request. Ignored in PUT, POST, and DELETE requests.
modifiedBy
string
The unique identifier of the tenant who modified the condition set resource. Only applicable in a GET request. Ignored in PUT, POST, and DELETE requests.
modifiedTime
integer($int32)
The time when the condition set resource is modified. Only applicable in a GET request. Ignored in PUT, POST, and DELETE requests.
negated
boolean
operands
The operands of the condition set resource.

commonProperties

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
creationTime
integer($int32)
The time the operand resource is created. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
entryValues
The lhs and rhs values.

lhs
string
The key for the object type. To learn more, see Configuring Access Policies Using API.
rhs
string
The value for the given object type. Its value depends upon the key. To learn more, see Configuring Access Policies Using API.
id
string
The unique identifier of the operand resource. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
idpId
integer($int64)
The unique identifier of the IdP.
modifiedBy
string
The unique identifier of the tenant who modified the operand resource. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
modifiedTime
integer($int32)
The time the operand resource is modified. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
objectType
string
The policy criteria.
[
...
]
18 items
values
array[string]
The list of values for the specified object type (e.g., IDs, applications).
operator
string
The operator of the condition set resource.
[
...
]
2 items
setIds
array[integer]
The unique identifier of the condition set.
creationTime
integer($int32)
The time the policy rule resource is created. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
description
string
The description of the policy rule resource.
id
string
The unique identifier of the policy rule resource. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
modifiedBy
string
The unique identifier of the tenant who modified the policy rule resource. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
modifiedTime
integer($int32)
The time the policy rule is modified. This field is only applicable in GET requests and ignored in PUT, POST, and DELETE requests.
name
string
The name of the policy rule resource.
operator
string
Denotes the operator type.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule resource.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
reauthIdleTimeout
integer($int32)
Denotes the idle connection timeout. This field is applicable only for timeout policy.
reauthTimeout
integer($int32)
Denotes the authentication timeout. This field is applicable only for timeout policy.
ruleOrder
integer($int32)
The order of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group resource.
name
string
The name of the ZPA Private Service Edge Group resource.
version
integer($int64)
zpnIsolationProfileId
integer($int64)
The unique identifier of the Isolation profile.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policy.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.

Parameters content type:

policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.
Responses
Response content type:
Code
201
Description
Created
Example Value
{
  "action": "ALLOW",
  "actionId": 0,
  "appServerGroups": [
    {
      "configSpace": "DEFAULT",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "id": 0,
      "dynamicDiscovery": true,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "appConnectorGroups": [
    {
      "connectors": [
        {
          "applicationStartTime": 0,
          "appConnectorGroupId": "string",
          "appConnectorGroupName": "string",
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": 0,
          "location": "string",
          "longitude": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "privateIp": "string",
          "publicIp": "string",
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "dnsQueryType": "IPV4_IPV6",
      "enabled": true,
      "geoLocationId": 0,
      "id": 0,
      "ipAcl": [
        "string"
      ],
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "praEnabled": false,
      "microtenantId": 0,
      "microtenantName": "string",
      "serverGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "lssAppConnectorGroup": true,
      "tcpQuickAckApp": true,
      "tcpQuickAckAssistant": true,
      "tcpQuickAckReadAssistant": true,
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": false,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL",
      "wafDisabled": true
    }
  ],
  "conditions": [
    {
      "creationTime": 0,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "negated": true,
      "operands": [
        {
          "creationTime": 0,
          "id": 0,
          "idpId": 0,
          "lhs": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "objectType": "USER",
          "rhs": "string",
          "microtenantId": 0
        }
      ],
      "operator": "AND",
      "microtenantId": 0
    }
  ],
  "creationTime": 0,
  "credential": {
    "id": 0,
    "name": "string"
  },
  "customMsg": "string",
  "defaultRule": true,
  "defaultRuleName": "string",
  "description": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "operator": "AND",
  "policySetId": 0,
  "policyType": 0,
  "priority": 0,
  "privilegedCapabilities": {
    "capabilities": [
      "string"
    ],
    "creationTime": 0,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0
  },
  "reauthIdleTimeout": 0,
  "reauthTimeout": 0,
  "ruleOrder": 0,
  "microtenantId": 0,
  "microtenantName": "string",
  "serviceEdgeGroups": [
    {
      "altCloud": "string",
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "geoLocationId": 0,
      "graceDistanceEnabled": true,
      "graceDistanceValue": 0,
      "graceDistanceValueUnit": "MILES",
      "id": 0,
      "isPublic": "string",
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "serviceEdges": [
        {
          "applicationStartTime": 0,
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": "string",
          "listenIps": [
            "string"
          ],
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "serviceEdgeGroupId": "string",
          "serviceEdgeGroupName": "string",
          "privateIp": "string",
          "publicIp": "string",
          "publishIps": [
            "string"
          ],
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string",
      "trustedNetworks": [
        {
          "creationTime": 0,
          "domain": "string",
          "id": 0,
          "masterCustomerId": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "networkId": "string",
          "zscalerCloud": "string"
        }
      ],
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": true,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL"
    }
  ],
  "zpnIsolationProfileId": 0,
  "zpnInspectionProfileId": 0,
  "zpnInspectionProfileName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
rule *required
object
(body)
The object of the policy rule.
{
  "action": "ALLOW",
  "actionId": 0,
  "appServerGroups": [
    {
      "configSpace": "DEFAULT",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "id": 0,
      "dynamicDiscovery": true,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "appConnectorGroups": [
    {
      "connectors": [
        {
          "applicationStartTime": 0,
          "appConnectorGroupId": "string",
          "appConnectorGroupName": "string",
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": 0,
          "location": "string",
          "longitude": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "privateIp": "string",
          "publicIp": "string",
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "dnsQueryType": "IPV4_IPV6",
      "enabled": true,
      "geoLocationId": 0,
      "id": 0,
      "ipAcl": [
        "string"
      ],
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "praEnabled": false,
      "microtenantId": 0,
      "microtenantName": "string",
      "serverGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "lssAppConnectorGroup": true,
      "tcpQuickAckApp": true,
      "tcpQuickAckAssistant": true,
      "tcpQuickAckReadAssistant": true,
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": false,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL",
      "wafDisabled": true
    }
  ],
  "conditions": [
    {
      "creationTime": 0,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "negated": true,
      "operands": [
        {
          "creationTime": 0,
          "id": 0,
          "idpId": 0,
          "lhs": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "objectType": "USER",
          "rhs": "string",
          "microtenantId": 0
        }
      ],
      "operator": "AND",
      "microtenantId": 0
    }
  ],
  "creationTime": 0,
  "credential": {
    "id": 0,
    "name": "string"
  },
  "customMsg": "string",
  "defaultRule": true,
  "defaultRuleName": "string",
  "description": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "operator": "AND",
  "policySetId": 0,
  "policyType": 0,
  "priority": 0,
  "privilegedCapabilities": {
    "capabilities": [
      "string"
    ],
    "creationTime": 0,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0
  },
  "reauthIdleTimeout": 0,
  "reauthTimeout": 0,
  "ruleOrder": 0,
  "microtenantId": 0,
  "microtenantName": "string",
  "serviceEdgeGroups": [
    {
      "altCloud": "string",
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "geoLocationId": 0,
      "graceDistanceEnabled": true,
      "graceDistanceValue": 0,
      "graceDistanceValueUnit": "MILES",
      "id": 0,
      "isPublic": "string",
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "serviceEdges": [
        {
          "applicationStartTime": 0,
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": "string",
          "listenIps": [
            "string"
          ],
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "serviceEdgeGroupId": "string",
          "serviceEdgeGroupName": "string",
          "privateIp": "string",
          "publicIp": "string",
          "publishIps": [
            "string"
          ],
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string",
      "trustedNetworks": [
        {
          "creationTime": 0,
          "domain": "string",
          "id": 0,
          "masterCustomerId": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "networkId": "string",
          "zscalerCloud": "string"
        }
      ],
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": true,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL"
    }
  ],
  "zpnIsolationProfileId": 0,
  "zpnInspectionProfileId": 0,
  "zpnInspectionProfileName": "string"
}

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.

Parameters content type:

microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.
Responses
Response content type:
Code
201
Description
Created
Example Value
{
  "action": "ALLOW",
  "actionId": 0,
  "appServerGroups": [
    {
      "configSpace": "DEFAULT",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "id": 0,
      "dynamicDiscovery": true,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "appConnectorGroups": [
    {
      "connectors": [
        {
          "applicationStartTime": 0,
          "appConnectorGroupId": "string",
          "appConnectorGroupName": "string",
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": 0,
          "location": "string",
          "longitude": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "privateIp": "string",
          "publicIp": "string",
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "dnsQueryType": "IPV4_IPV6",
      "enabled": true,
      "geoLocationId": 0,
      "id": 0,
      "ipAcl": [
        "string"
      ],
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "praEnabled": false,
      "microtenantId": 0,
      "microtenantName": "string",
      "serverGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "lssAppConnectorGroup": true,
      "tcpQuickAckApp": true,
      "tcpQuickAckAssistant": true,
      "tcpQuickAckReadAssistant": true,
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": false,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL",
      "wafDisabled": true
    }
  ],
  "conditions": [
    {
      "creationTime": 0,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "negated": true,
      "operands": [
        {
          "creationTime": 0,
          "id": 0,
          "idpId": 0,
          "lhs": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "objectType": "USER",
          "rhs": "string",
          "microtenantId": 0
        }
      ],
      "operator": "AND",
      "microtenantId": 0
    }
  ],
  "creationTime": 0,
  "credential": {
    "id": 0,
    "name": "string"
  },
  "customMsg": "string",
  "defaultRule": true,
  "defaultRuleName": "string",
  "description": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "operator": "AND",
  "policySetId": 0,
  "policyType": 0,
  "priority": 0,
  "privilegedCapabilities": {
    "capabilities": [
      "string"
    ],
    "creationTime": 0,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0
  },
  "reauthIdleTimeout": 0,
  "reauthTimeout": 0,
  "ruleOrder": 0,
  "microtenantId": 0,
  "microtenantName": "string",
  "serviceEdgeGroups": [
    {
      "altCloud": "string",
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "geoLocationId": 0,
      "graceDistanceEnabled": true,
      "graceDistanceValue": 0,
      "graceDistanceValueUnit": "MILES",
      "id": 0,
      "isPublic": "string",
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "serviceEdges": [
        {
          "applicationStartTime": 0,
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": "string",
          "listenIps": [
            "string"
          ],
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "serviceEdgeGroupId": "string",
          "serviceEdgeGroupName": "string",
          "privateIp": "string",
          "publicIp": "string",
          "publishIps": [
            "string"
          ],
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string",
      "trustedNetworks": [
        {
          "creationTime": 0,
          "domain": "string",
          "id": 0,
          "masterCustomerId": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "networkId": "string",
          "zscalerCloud": "string"
        }
      ],
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": true,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL"
    }
  ],
  "zpnIsolationProfileId": 0,
  "zpnInspectionProfileId": 0,
  "zpnInspectionProfileName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/reorder

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
ruleIds *required
array[integer]
(body)
The new order of rule IDs for the rules in the policy set.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/platform

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
Responses
Response content type:
Code
200
Description
OK
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}/reorder/{newOrder}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
newOrder *required
integer($int32)
(path)
The new order of the rule.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
ruleId *required
integer($int64)
(path)
The unique identifier of a rule in a policy.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policyRuleResource *required
object
(body)
The object of the rule in a policy.

Parameters content type:

policySetId *required
integer($int64)
(path)
The unique identifier of the policy.
ruleId *required
integer($int64)
(path)
The unique identifier of a rule in a policy.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/rules/policyType/{policyType}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
page
integer($int32)
(query)
Specifies the page number.
Example : 1
pagesize
integer($int32)
(query)
Specifies the page size. If not provided, the default page size is 20. The max page size is 500.
Example : 20
policyType *required
string
(path)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
search
string
(query)
The search string used to support search by features and fields for the API.

list
The total list of policy rules.

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.
totalCount
integer($int64)
The total count of resources per the search feature.
totalPages
integer($int32)
The total number of pages per the pagination attribute.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "list": [
    {
      "action": "ALLOW",
      "actionId": 0,
      "appServerGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "appConnectorGroups": [
        {
          "connectors": [
            {
              "applicationStartTime": 0,
              "appConnectorGroupId": "string",
              "appConnectorGroupName": "string",
              "controlChannelStatus": "UNKNOWN",
              "creationTime": 0,
              "ctrlBrokerName": "string",
              "currentVersion": "string",
              "description": "string",
              "enabled": true,
              "expectedUpgradeTime": 0,
              "expectedVersion": "string",
              "fingerprint": "string",
              "id": 0,
              "ipAcl": [
                "string"
              ],
              "issuedCertId": 0,
              "lastBrokerConnectTime": 0,
              "lastBrokerConnectTimeDuration": "string",
              "lastBrokerDisconnectTime": 0,
              "lastBrokerDisconnectTimeDuration": "string",
              "lastUpgradeTime": 0,
              "latitude": 0,
              "location": "string",
              "longitude": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "provisioningKeyId": 0,
              "provisioningKeyName": "string",
              "platform": "string",
              "platformDetail": "string",
              "previousVersion": "string",
              "privateIp": "string",
              "publicIp": "string",
              "runtimeOS": "string",
              "sargeVersion": "string",
              "microtenantId": 0,
              "microtenantName": "string",
              "enrollmentCert": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "upgradeAttempt": 0,
              "upgradeStatus": "COMPLETE",
              "zpnSubModuleUpgradeList": [
                {
                  "creationTime": 0,
                  "currentVersion": "string",
                  "entityGid": 0,
                  "entityType": "ASSISTANT",
                  "expectedVersion": "string",
                  "id": 0,
                  "modifiedBy": 0,
                  "modifiedTime": 0,
                  "previousVersion": "string",
                  "role": "ASSISTANT",
                  "upgradeStatus": "COMPLETE",
                  "upgradeTime": 0
                }
              ]
            }
          ],
          "cityCountry": "string",
          "countryCode": "string",
          "creationTime": 0,
          "description": "string",
          "dnsQueryType": "IPV4_IPV6",
          "enabled": true,
          "geoLocationId": 0,
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "latitude": "string",
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "overrideVersionProfile": true,
          "praEnabled": false,
          "microtenantId": 0,
          "microtenantName": "string",
          "serverGroups": [
            {
              "configSpace": "DEFAULT",
              "creationTime": 0,
              "description": "string",
              "enabled": true,
              "id": 0,
              "dynamicDiscovery": true,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "microtenantId": 0,
              "microtenantName": "string"
            }
          ],
          "lssAppConnectorGroup": true,
          "tcpQuickAckApp": true,
          "tcpQuickAckAssistant": true,
          "tcpQuickAckReadAssistant": true,
          "upgradeDay": "string",
          "upgradeTimeInSecs": "string",
          "useInDrMode": false,
          "versionProfileId": 0,
          "versionProfileName": "string",
          "versionProfileVisibilityScope": "ALL",
          "wafDisabled": true
        }
      ],
      "conditions": [
        {
          "creationTime": 0,
          "id": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "negated": true,
          "operands": [
            {
              "creationTime": 0,
              "id": 0,
              "idpId": 0,
              "lhs": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "objectType": "USER",
              "rhs": "string",
              "microtenantId": 0
            }
          ],
          "operator": "AND",
          "microtenantId": 0
        }
      ],
      "creationTime": 0,
      "credential": {
        "id": 0,
        "name": "string"
      },
      "customMsg": "string",
      "defaultRule": true,
      "defaultRuleName": "string",
      "description": "string",
      "id": 0,
      "inconsistentConfigDetails": {
        "application": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "segmentGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "appConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "baCertificate": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "branchConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "cloudConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "idp": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "location": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "machineGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "postureProfile": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "samlAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "scimAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "serverGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "praApplication": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "trustedNetwork": [
          {
            "name": "string",
            "reason": "string"
          }
        ]
      },
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "operator": "AND",
      "policySetId": 0,
      "policyType": 0,
      "priority": 0,
      "privilegedCapabilities": {
        "capabilities": [
          "string"
        ],
        "creationTime": 0,
        "id": 0,
        "modifiedBy": 0,
        "modifiedTime": 0
      },
      "reauthIdleTimeout": 0,
      "reauthTimeout": 0,
      "ruleOrder": 0,
      "microtenantId": 0,
      "microtenantName": "string",
      "serviceEdgeGroups": [
        {
          "altCloud": "string",
          "cityCountry": "string",
          "countryCode": "string",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "geoLocationId": 0,
          "graceDistanceEnabled": true,
          "graceDistanceValue": 0,
          "graceDistanceValueUnit": "MILES",
          "id": 0,
          "isPublic": "string",
          "latitude": "string",
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "overrideVersionProfile": true,
          "serviceEdges": [
            {
              "applicationStartTime": 0,
              "controlChannelStatus": "UNKNOWN",
              "creationTime": 0,
              "ctrlBrokerName": "string",
              "currentVersion": "string",
              "description": "string",
              "enabled": true,
              "expectedUpgradeTime": 0,
              "expectedVersion": "string",
              "fingerprint": "string",
              "id": 0,
              "ipAcl": [
                "string"
              ],
              "issuedCertId": 0,
              "lastBrokerConnectTime": 0,
              "lastBrokerConnectTimeDuration": "string",
              "lastBrokerDisconnectTime": 0,
              "lastBrokerDisconnectTimeDuration": "string",
              "lastUpgradeTime": 0,
              "latitude": "string",
              "listenIps": [
                "string"
              ],
              "location": "string",
              "longitude": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "provisioningKeyId": 0,
              "provisioningKeyName": "string",
              "platform": "string",
              "platformDetail": "string",
              "previousVersion": "string",
              "serviceEdgeGroupId": "string",
              "serviceEdgeGroupName": "string",
              "privateIp": "string",
              "publicIp": "string",
              "publishIps": [
                "string"
              ],
              "runtimeOS": "string",
              "sargeVersion": "string",
              "microtenantId": 0,
              "microtenantName": "string",
              "enrollmentCert": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "upgradeAttempt": 0,
              "upgradeStatus": "COMPLETE",
              "zpnSubModuleUpgradeList": [
                {
                  "creationTime": 0,
                  "currentVersion": "string",
                  "entityGid": 0,
                  "entityType": "ASSISTANT",
                  "expectedVersion": "string",
                  "id": 0,
                  "modifiedBy": 0,
                  "modifiedTime": 0,
                  "previousVersion": "string",
                  "role": "ASSISTANT",
                  "upgradeStatus": "COMPLETE",
                  "upgradeTime": 0
                }
              ]
            }
          ],
          "microtenantId": 0,
          "microtenantName": "string",
          "trustedNetworks": [
            {
              "creationTime": 0,
              "domain": "string",
              "id": 0,
              "masterCustomerId": "string",
              "modifiedBy": 0,
              "modifiedTime": 0,
              "name": "string",
              "networkId": "string",
              "zscalerCloud": "string"
            }
          ],
          "upgradeDay": "string",
          "upgradeTimeInSecs": "string",
          "useInDrMode": true,
          "versionProfileId": 0,
          "versionProfileName": "string",
          "versionProfileVisibilityScope": "ALL"
        }
      ],
      "zpnIsolationProfileId": 0,
      "zpnInspectionProfileId": 0,
      "zpnInspectionProfileName": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/clientTypes

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
Responses
Response content type:
Code
200
Description
OK
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
ruleId *required
integer($int64)
(path)
The unique identifier of a rule in a policy.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.

action
string
The action of the policy rule.
[
...
]
22 items
actionId
integer($int64)
The unique identifier of the action.
appServerGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
appConnectorGroups

connectors

applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
7 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
cityCountry
string
The city and country of the App Connector.
countryCode
string
The country code of the App Connector.
creationTime
integer($int32)
The time the App Connector Group is created.
description
string
The description of the App Connector Group.
dnsQueryType
string
Whether IPv4, IPv6, or both, are enabled for DNS resolution of all applications in the App Connector Group.
[
...
]
3 items
enabled
boolean
Whether or not this App Connector Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
id
integer($int64)
The unique identifier of the App Connector Group.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
latitude
string
The latitude of the App Connector.
location
string
The location of the App Connector.
longitude
string
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector Group.
modifiedTime
integer($int32)
The time the App Connector Group is modified.
name*
string
The name of the App Connector Group.
overrideVersionProfile
boolean
Whether the default version profile of the App Connector Group is applied or overridden.
praEnabled
boolean
Whether or not Privileged Remote Access is enabled on the App Connector Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
serverGroups

configSpace
string
Indicates if the configuration is created as part of the SIEM or Server Group.
[
...
]
2 items
creationTime
integer($int32)
The time the Server Group is created.
description
string
The description of the Server Group.
enabled
boolean
Whether the Server Group is enabled or disabled.
id
integer($int64)
The unique identifier of the Server Group.
dynamicDiscovery
boolean
Controls dynamic discovery of the servers.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the resource.
modifiedTime
integer($int32)
The time the resource is modified.
name*
string
The name of the Server Group.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
lssAppConnectorGroup
boolean
Whether or not the App Connector Group is configured for the Log Streaming Service (LSS).
tcpQuickAckApp
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
tcpQuickAckReadAssistant
boolean
Whether TCP Quick Acknowledgement is enabled or disabled for the application. The tcpQuickAckApp, tcpQuickAckAssistant, and tcpQuickAckReadAssistant fields must all share the same values.
upgradeDay
string
Indicates the day the App Connectors in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
App Connectors in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the App Connector Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
Name of the version profile. This field is only applicable in a GET request and ignored in PUT, POST, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
wafDisabled
boolean
Whether or not AppProtection is disabled for the App Connector Group.
conditions
Specifies the set of conditions for the policy rule.

creationTime
integer($int32)
The time the condition set is created.
id
integer($int64)
The unique identifier of the condition set.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the condition set.
modifiedTime
integer($int32)
The time the condition set is modified.
negated
boolean
operands
The operands of the condition set.

creationTime
integer($int32)
The time the operand is created.
id
integer($int64)
The unique identifier of the operand.
idpId
integer($int64)
The unique identifier of the IdP.
lhs
string
The key for the object type.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the operand.
modifiedTime
integer($int32)
The time the operand is modified.
name
string
The name of the operand.
objectType
string
The object type of the operand.
[
...
]
18 items
rhs
string
The value for the given object type. Its value depends upon the key.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
operator
string
The operator of the condition set.
[
...
]
2 items
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
creationTime
integer($int32)
The time the policy rule is created.
credential

id
integer($int64)
The list of unique identifiers for the entity type.
name
string
The list of names for the entity type.
customMsg
string
Specifies a custom message to the user.
defaultRule
boolean
Whether or not the rule returns as default.
defaultRuleName
string
The name of the default rule.
description
string
The description of the policy rule.
id
integer($int64)
The unique identifier of the policy rule.
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the policy rule.
modifiedTime
integer($int32)
The time the policy rule is modified.
name*
string
The name of the policy rule.
operator
string
Denotes the operation type. These are operands used between criteria.
[
...
]
2 items
policySetId
integer($int64)
The unique identifier of the policy set.
policyType
integer($int32)
The value for differentiating policy types. The supported values are:
  • ACCESS_POLICY or GLOBAL_POLICY
  • TIMEOUT_POLICY or REAUTH_POLICY
  • CLIENT_FORWARDING_POLICY or BYPASS_POLICY
  • INSPECTION_POLICY (i.e., AppProtection policy)
  • CREDENTIAL_POLICY
  • CAPABILITIES_POLICY
  • ISOLATION_POLICY
  • CLIENTLESS_SESSION_PROTECTION_POLICY
  • REDIRECTION_POLICY
priority
integer($int32)
The priority of the policy rule.
privilegedCapabilities

capabilities
array[string]

Indicates the type of capabilities for the privileged policy. The supported values are:

  • FILE_UPLOAD
  • INSPECT_FILE_UPLOAD
  • FILE_DOWNLOAD
creationTime
integer($int32)
The time the privileged capability is created.
id
integer($int64)
The unique identifier of the privileged capability.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged capability.
modifiedTime
integer($int32)
The time the privileged capability was modified.
reauthIdleTimeout
integer($int32)
The reauthentication idle timeout.
reauthTimeout
integer($int32)
The reauthentication timeout.
ruleOrder
integer($int32)
The policy evaluation order number of the rule.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
microtenantName
string
The name of the Microtenant.
serviceEdgeGroups

altCloud
string
The alternate cloud of the ZPA Private Service Edge that is associated to the ZPA Private Service Edge Group.
cityCountry
string
The city and country of the ZPA Private Service Edge.
countryCode
string
The country code of the ZPA Private Service Edge.
creationTime
integer($int32)
The time the ZPA Private Service Edge Group is created.
description
string
The description of the ZPA Private Service Edge Group.
enabled
boolean
Whether or not this ZPA Private Service Edge Group is enabled.
geoLocationId
integer($int64)
The unique identifier of the geographic location.
graceDistanceEnabled
boolean
If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge. To learn more, see Configuring ZPA Private Service Edges.
graceDistanceValue
number($double)
Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.
graceDistanceValueUnit
string
Indicates the grace distance unit of measure in miles or kilometers. This value is only required if graceDistanceEnabled is set to true.
[
...
]
2 items
id
integer($int64)
The unique identifier of the ZPA Private Service Edge Group.
isPublic
string
Whether or not the ZPA Private Service Edge Group is public.
latitude
string
The latitude of the ZPA Private Service Edge Group.
location
string
The location of the ZPA Private Service Edge Group.
longitude
string
The longitude of the ZPA Private Service Edge Group.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge Group.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge Group is modified.
name*
string
The name of the ZPA Private Service Edge Group.
overrideVersionProfile
boolean
Whether or not the default version profile of the ZPA Private Service Edge Group is applied or overridden. By default, this is false.
serviceEdges
The list of ZPA Private Service Edges in the ZPA Private Service Edge Group.

applicationStartTime
integer($int64)
The start time of the ZPA Private Service Edge.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the ZPA Private Service Edge is created.
ctrlBrokerName
string
The name of the Control ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
currentVersion
string
The current version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
description
string
The description of the ZPA Private Service Edge.
enabled
boolean
Whether or not this ZPA Private Service Edge is enabled.
expectedUpgradeTime
integer($int64)
The expected upgrade time of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
expectedVersion
string
The expected version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
fingerprint
string
The hardware fingerprint associated with the ZPA Private Service Edge.
id
integer($int64)
The unique identifier of the ZPA Private Service Edge.
ipAcl
array[string]
The IP Access List (IP ACL) to allow ZPA Private Service Edges on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the Service Edge last connected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerConnectTimeDuration
string
The last connection time duration of the Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Private Service Edge last disconnected. This field has read-only properties and is ignored in POST and PUT requests.
lastBrokerDisconnectTimeDuration
string
The last disconnect duration time of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
lastUpgradeTime
integer($int64)
The time the ZPA Private Service Edge last upgraded. This field has read-only properties and is ignored in POST and PUT requests.
latitude
string
The latitude of the ZPA Private Service Edge.
listenIps
array[string]
The list of IPs with a listen socket.
location
string
The location of the ZPA Private Service Edge.
longitude
string
The longitude of the ZPA Private Service Edge.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the ZPA Private Service Edge.
modifiedTime
integer($int32)
The time the ZPA Private Service Edge is modified.
name*
string
The name of the ZPA Private Service Edge.
provisioningKeyId
integer($int64)
The unique identifier of the ZPA Private Service Edge provisioning key.
provisioningKeyName
string
The name of the ZPA Private Service Edge provisioning key.
platform
string
The platform the ZPA Private Service Edge is deployed on.
platformDetail
string
The details of the ZPA Private platform the Service Edge is deployed on.
previousVersion
string
The previous version of the ZPA Private Service Edge. This field has read-only properties and is ignored in POST and PUT requests.
serviceEdgeGroupId
string
The unique identifier of the ZPA Private Service Edge Group.
serviceEdgeGroupName
string
The name of the ZPA Private Service Edge Group.
privateIp
string
The private IP of the ZPA Private Service Edge.
publicIp
string
The public IP of the ZPA Private Service Edge.
publishIps
array[string]
The IP addresses and domains that clients and App Connectors can use to open a connection to the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the ZPA Private Service Edge. To learn more, see About ZPA Private Service Edges.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate of the ZPA Private Service Edge.
{
   < * >: string
}
upgradeAttempt
integer($int32)
The number of attempts the ZPA Private Service Edge takes to upgrade. This field has read-only properties and is ignored in POST and PUT requests.
upgradeStatus
string
The status of the ZPA Private Service Edge upgrade. This field has read-only properties and is ignored in POST and PUT requests.
[
...
]
6 items
zpnSubModuleUpgradeList

creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]
4 items
expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]
4 items
upgradeStatus
string
The upgrade status of the supporting file.
[
...
]
6 items
upgradeTime
integer($int64)
The time the supporting file is upgraded.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
trustedNetworks
The list of trusted networks in the ZPA Private Service Edge Group.

creationTime
integer($int32)
The time the trusted network is created.
domain
string
The domain of the trusted network.
id
integer($int64)
The unique identifier of the trusted network.
masterCustomerId
string
The unique identifier of the ZPA and ZIA customer.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the trusted network.
modifiedTime
integer($int32)
The time the trusted network is modified.
name*
string
The name of the trusted network.
networkId
string
The unique identifier of the network.
zscalerCloud
string
The ZIA cloud.
upgradeDay
string
Indicates the day the ZPA Private Service Edges in this group attempt to update to a newer version of the software.
upgradeTimeInSecs
string
ZPA Private Service Edges in this group attempt to update to a newer version of the software during this specified time.
useInDrMode
boolean
Whether or not the ZPA Private Service Edge Group is designated for disaster recovery.
versionProfileId
integer($int64)
The unique identifier of the version profile.
versionProfileName
string
The name of the version profile. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
versionProfileVisibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
zpnIsolationProfileId
integer($int64)
The unique identifier of the Cloud Browser Isolation profile. This field is applicable only for isolation policies.
zpnInspectionProfileId
integer($int64)
The unique identifier of the inspection profile. This field is applicable only for inspection policies.
zpnInspectionProfileName
string
The name of the inspection profile. This field has read-only properties.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "action": "ALLOW",
  "actionId": 0,
  "appServerGroups": [
    {
      "configSpace": "DEFAULT",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "id": 0,
      "dynamicDiscovery": true,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "appConnectorGroups": [
    {
      "connectors": [
        {
          "applicationStartTime": 0,
          "appConnectorGroupId": "string",
          "appConnectorGroupName": "string",
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": 0,
          "location": "string",
          "longitude": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "privateIp": "string",
          "publicIp": "string",
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "dnsQueryType": "IPV4_IPV6",
      "enabled": true,
      "geoLocationId": 0,
      "id": 0,
      "ipAcl": [
        "string"
      ],
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "praEnabled": false,
      "microtenantId": 0,
      "microtenantName": "string",
      "serverGroups": [
        {
          "configSpace": "DEFAULT",
          "creationTime": 0,
          "description": "string",
          "enabled": true,
          "id": 0,
          "dynamicDiscovery": true,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string"
        }
      ],
      "lssAppConnectorGroup": true,
      "tcpQuickAckApp": true,
      "tcpQuickAckAssistant": true,
      "tcpQuickAckReadAssistant": true,
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": false,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL",
      "wafDisabled": true
    }
  ],
  "conditions": [
    {
      "creationTime": 0,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "negated": true,
      "operands": [
        {
          "creationTime": 0,
          "id": 0,
          "idpId": 0,
          "lhs": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "objectType": "USER",
          "rhs": "string",
          "microtenantId": 0
        }
      ],
      "operator": "AND",
      "microtenantId": 0
    }
  ],
  "creationTime": 0,
  "credential": {
    "id": 0,
    "name": "string"
  },
  "customMsg": "string",
  "defaultRule": true,
  "defaultRuleName": "string",
  "description": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "operator": "AND",
  "policySetId": 0,
  "policyType": 0,
  "priority": 0,
  "privilegedCapabilities": {
    "capabilities": [
      "string"
    ],
    "creationTime": 0,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0
  },
  "reauthIdleTimeout": 0,
  "reauthTimeout": 0,
  "ruleOrder": 0,
  "microtenantId": 0,
  "microtenantName": "string",
  "serviceEdgeGroups": [
    {
      "altCloud": "string",
      "cityCountry": "string",
      "countryCode": "string",
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "geoLocationId": 0,
      "graceDistanceEnabled": true,
      "graceDistanceValue": 0,
      "graceDistanceValueUnit": "MILES",
      "id": 0,
      "isPublic": "string",
      "latitude": "string",
      "location": "string",
      "longitude": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "overrideVersionProfile": true,
      "serviceEdges": [
        {
          "applicationStartTime": 0,
          "controlChannelStatus": "UNKNOWN",
          "creationTime": 0,
          "ctrlBrokerName": "string",
          "currentVersion": "string",
          "description": "string",
          "enabled": true,
          "expectedUpgradeTime": 0,
          "expectedVersion": "string",
          "fingerprint": "string",
          "id": 0,
          "ipAcl": [
            "string"
          ],
          "issuedCertId": 0,
          "lastBrokerConnectTime": 0,
          "lastBrokerConnectTimeDuration": "string",
          "lastBrokerDisconnectTime": 0,
          "lastBrokerDisconnectTimeDuration": "string",
          "lastUpgradeTime": 0,
          "latitude": "string",
          "listenIps": [
            "string"
          ],
          "location": "string",
          "longitude": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "provisioningKeyId": 0,
          "provisioningKeyName": "string",
          "platform": "string",
          "platformDetail": "string",
          "previousVersion": "string",
          "serviceEdgeGroupId": "string",
          "serviceEdgeGroupName": "string",
          "privateIp": "string",
          "publicIp": "string",
          "publishIps": [
            "string"
          ],
          "runtimeOS": "string",
          "sargeVersion": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "enrollmentCert": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "upgradeAttempt": 0,
          "upgradeStatus": "COMPLETE",
          "zpnSubModuleUpgradeList": [
            {
              "creationTime": 0,
              "currentVersion": "string",
              "entityGid": 0,
              "entityType": "ASSISTANT",
              "expectedVersion": "string",
              "id": 0,
              "modifiedBy": 0,
              "modifiedTime": 0,
              "previousVersion": "string",
              "role": "ASSISTANT",
              "upgradeStatus": "COMPLETE",
              "upgradeTime": 0
            }
          ]
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string",
      "trustedNetworks": [
        {
          "creationTime": 0,
          "domain": "string",
          "id": 0,
          "masterCustomerId": "string",
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "networkId": "string",
          "zscalerCloud": "string"
        }
      ],
      "upgradeDay": "string",
      "upgradeTimeInSecs": "string",
      "useInDrMode": true,
      "versionProfileId": 0,
      "versionProfileName": "string",
      "versionProfileVisibilityScope": "ALL"
    }
  ],
  "zpnIsolationProfileId": 0,
  "zpnInspectionProfileId": 0,
  "zpnInspectionProfileName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
rule *required
object
(body)
The object of the rule in a policy.

Parameters content type:

ruleId *required
integer($int64)
(path)
The unique identifier of a rule in a policy.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
policySetId *required
integer($int64)
(path)
The unique identifier of the policy set.
ruleId *required
integer($int64)
(path)
The unique identifier of a rule in a policy.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Responses
Response content type:
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden