• Secure Private Access (ZPA) Help
• ZPA API
• API Developer & Reference Guide
• Reference Guide
• Privileged Credential Controller

• Understanding the ZPA API

• API Developer & Reference Guide
  • Getting Started
  • Configuring the Postman REST API Client
  • Understanding Rate Limiting
  • API Response Codes and Error Messages
  • Reference Guide
    • Application Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/application/getAppsByType
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/application
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/share
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/move
        • POST
    • Segment Group Controller
      • /mgmtconfig/v2/admin/customers/{customerId}/segmentGroup/{segmentGroupId}
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/segmentGroup/{segmentGroupId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/segmentGroup
        • GET
        • POST
    • AppProtection Control Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/controlTypes
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom
        • GET
        • POST
      • /mgmtconfig/v1/admin/inspectionControls/customControlTypes
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}/profiles
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/httpMethods
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/severityTypes
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/versions
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/actionTypes
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/{id}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined
        • GET
    • AppProtection Profile Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile/{inspectionProfileId}/dissociateAllPredefinedControls
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile/{inspectionProfileId}/associateAllPredefinedControls
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile/{inspectionProfileId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile/{inspectionProfileId}/patch
        • PATCH
      • /mgmtconfig/v1/admin/customers/{customerId}/inspectionProfile/{inspectionProfileId}/deAssociateAllPredefinedControls
        • PUT
    • App Connector Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/connector/bulkDelete
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/connector/{connectorId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/connector
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/connectorSchedule/{id}
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/connectorSchedule
        • GET
        • POST
    • App Connector Group Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/appConnectorGroup/{appConnectorGroupId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/appConnectorGroup
        • GET
        • POST
    • Certificate Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/clientlessCertificate/{certificateId}
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/clientlessCertificate/issued
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/certificate
        • GET
        • POST
      • /mgmtconfig/v2/admin/customers/{customerId}/certificate/issued
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/certificate/{certificateId}
        • GET
        • DELETE
    • Customer Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/authDomains
        • GET
    • Customer Version Profile Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/visible/versionProfiles
        • GET
    • Cloud Connector Group Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/cloudConnectorGroup/{id}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/cloudConnectorGroup
        • GET
    • Emergency Access Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/emergencyAccess/user/{userId}
        • GET
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/emergencyAccess/user/{userId}/deactivate
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/emergencyAccess/user/{userId}/activate
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/emergencyAccess/users
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/emergencyAccess/user
        • POST
    • Enrollment Certificate Controller
      • /mgmtconfig/v2/admin/customers/{customerId}/enrollmentCert
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/enrollmentCert/{enrollmentCertId}
        • GET
    • IdP Controller
      • /mgmtconfig/v2/admin/customers/{customerId}/idp
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/idp/{idpId}
        • GET
    • Isolation Profile Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/isolation/profiles
        • GET
    • Log Streaming Service (LSS) Configuration
      • /mgmtconfig/v2/admin/customers/{customerId}/lssConfig/{lssId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v2/admin/lssConfig/logType/formats
        • GET
      • /mgmtconfig/v2/admin/lssConfig/clientTypes
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/lssConfig
        • GET
        • POST
      • /mgmtconfig/v2/admin/customers/{customerId}/lssConfig/logType/formats
        • GET
      • /mgmtconfig/v2/admin/lssConfig/statusCodes
        • GET
      • /mgmtconfig/v2/admin/lssConfig/customers/{customerId}/clientTypes
        • GET
    • Machine Group Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/machineGroup/{Id}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/machineGroup
        • GET
    • Microtenant Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/microtenants/{microtenantId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/microtenants/summary
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/microtenants
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/microtenants/search
        • POST
      • /mgmtconfig/v1/admin/me
        • GET
    • Policy Set Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/policyType/{policyType}
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/reorder
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/platform
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}/reorder/{newOrder}
        • PUT
      • /mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}
        • PUT
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/rules/policyType/{policyType}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/clientTypes
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}
        • GET
        • PUT
        • DELETE
    • Posture Profile Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/posture/{id}
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/posture
        • GET
    • Private Service Edge Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/serviceEdge/{serviceEdgeId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/serviceEdge
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/serviceEdge/bulkDelete
        • POST
    • Private Service Edge Group Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/serviceEdgeGroup/{serviceEdgeGroupId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/serviceEdgeGroup
        • GET
        • POST
    • Privileged Approval Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/approval
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/approval/{id}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/approval/expired
        • DELETE
    • Privileged Console Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/praConsole/praPortal/{portalId}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/praConsole
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/praConsole/bulk
        • POST
    • Privileged Credential Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/credential/{id}/move
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/credential
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/credential/{id}
        • GET
        • PUT
        • DELETE
    • Privileged Portal Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/praPortal
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/praPortal/{id}
        • GET
        • PUT
        • DELETE
    • Provisioning Key Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/associationType/{associationType}/provisioningKey/{provisioningKeyId}
        • GET
        • PUT
        • DELETE
      • /mgmtconfig/v1/admin/customers/{customerId}/associationType/{associationType}/provisioningKey
        • GET
        • POST
    • SAML Attribute Controller
      • /mgmtconfig/v2/admin/customers/{customerId}/samlAttribute
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/samlAttribute/idp/{idpId}
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/samlAttribute/{attrId}
        • GET
    • SCIM Attribute Header Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/idp/{idpId}/scimattribute
        • GET
      • /mgmtconfig/v1/admin/customers/{customerId}/idp/{idpId}/scimattribute/{scimAttributeId}
        • GET
      • /userconfig/v1/customers/{customerId}/scimattribute/idpId/{idpId}/attributeId/{attributeId}
        • GET
    • SCIM Group Controller
      • /userconfig/v1/customers/{customerId}/scimgroup/{scimGroupId}
        • GET
      • /userconfig/v1/customers/{customerId}/scimgroup/idpId/{idpId}
        • GET
    • Server Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/server
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/server/{serverId}
        • GET
        • PUT
        • DELETE
    • Server Group Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/serverGroup
        • GET
        • POST
      • /mgmtconfig/v1/admin/customers/{customerId}/serverGroup/{groupId}
        • GET
        • PUT
        • DELETE
    • Trusted Network Controller
      • /mgmtconfig/v1/admin/customers/{customerId}/network/{id}
        • GET
      • /mgmtconfig/v2/admin/customers/{customerId}/network
        • GET
    • Zscaler Path Cloud Controller
      • /mgmtconfig/v1/admin/zpathCloud/getAltClouds
        • GET
  • Working with APIs
    • Obtaining Alternative Cloud Domain Details Using API
    • Configuring Application Segments Using API
    • Configuring Segment Groups Using API
    • Managing App Connectors Using API
    • Configuring Auto Delete for Disconnected App Connectors Using API
    • Configuring App Connector Groups Using API
    • Configuring Browser Access Application Segments Using API
    • Configuring Certificates Using API
    • Obtaining Cloud Connector Group Details Using API
    • Obtaining Customer Details Using API
    • Configuring Emergency Access Users Using API
    • Obtaining Enrollment Certificate Details Using API
    • Obtaining IdP Configuration Details Using API
    • Configuring AppProtection Controls Using API
    • Configuring AppProtection Profiles Using API
    • Obtaining Isolation Profile Details Using API
    • Managing Log Streaming Service Configurations Using API
    • Configuring Access Policies Using API
    • Configuring AppProtection Policies Using API
    • Configuring Client Forwarding Policies Using API
    • Configuring Isolation Policies Using API
    • Configuring Privileged Policies Using API
    • Configuring Redirection Policies Using API
    • Configuring Timeout Policies Using API
    • Obtaining Machine Group Details Using API
    • Configuring Microtenants Using API
    • Obtaining Posture Profile Details Using API
    • Configuring Privileged Approvals Using API
    • Configuring Privileged Credentials Using API
    • Configuring Privileged Consoles Using API
    • Configuring Privileged Portals Using API
    • Configuring Provisioning Keys Using API
    • Obtaining SAML Attribute Details Using API
    • Obtaining SCIM Attribute Details Using API
    • Obtaining SCIM Group Details Using API
    • Configuring Servers Using API
    • Configuring Server Groups Using API
    • Managing ZPA Private Service Edges Using API
    • Configuring ZPA Private Service Edge Groups Using API
    • Obtaining Trusted Network Details Using API
    • Obtaining Version Profile Details Using API