• Secure Internet and SaaS Access (ZIA) Help
• ZIA API
• API Developer & Reference Guide
• Reference Guide
• Advanced Settings

• Understanding ZIA APIs

• API Developer & Reference Guide
  • Getting Started
  • Configuring the Postman REST API Client
  • Understanding Rate Limiting
  • API Response Codes and Error Messages
  • Reference Guide
    • 3rd-Party App Governance API
      • /apps/app
        • GET
        • POST
      • /apps/search
        • GET
      • /app_views/list
        • GET
      • /app_views/{appViewId}/apps
        • GET
    • Sandbox Submission API
      • /zscsb/submit
        • POST
      • /zscsb/discan
        • POST
    • Activation
      • /status
        • GET
      • /status/activate
        • POST
    • Admin Audit Logs
      • /auditlogEntryReport
        • GET
        • POST
        • DELETE
      • /auditlogEntryReport/download
        • GET
    • Admin & Role Management
      • /adminRoles
        • GET
        • POST
      • /adminRoles/{roleId}
        • GET
        • PUT
        • DELETE
      • /adminRoles/lite
        • GET
      • /adminUsers
        • GET
        • POST
      • /adminUsers/{userId}
        • PUT
        • DELETE
      • /adminUsers/me
        • GET
      • /adminUsers/{userId}/convertToUser
        • POST
    • Advanced Settings
      • /advancedSettings
        • GET
        • PUT
    • Advanced Threat Protection Policy
      • /cyberThreatProtection/advancedThreatSettings
        • GET
        • PUT
      • /cyberThreatProtection/maliciousUrls
        • GET
        • PUT
      • /cyberThreatProtection/securityExceptions
        • GET
        • PUT
    • API Authentication
      • /authenticatedSession
        • GET
        • POST
        • DELETE
    • Authentication Settings
      • /authSettings
        • GET
        • PUT
      • /authSettings/lite
        • GET
    • Browser Isolation
      • /browserIsolation/profiles
        • GET
    • Cloud Applications
      • /cloudApplications/policy
        • GET
      • /cloudApplications/sslPolicy
        • GET
    • Cloud App Control Policy
      • /webApplicationRules/ruleTypeMapping
        • GET
      • /webApplicationRules/{rule_type}
        • GET
        • POST
      • /webApplicationRules/{rule_type}/availableActions
        • POST
      • /webApplicationRules/{rule_type}/duplicate/{ruleId}
        • POST
      • /webApplicationRules/{rule_type}/{ruleId}
        • GET
        • PUT
        • DELETE
    • Cloud Nanolog Streaming Service (NSS)
      • /nssFeeds
        • GET
        • POST
      • /nssFeeds/{feedId}
        • GET
        • PUT
        • DELETE
      • /nssFeeds/feedOutputDefaults
        • GET
      • /nssFeeds/testConnectivity/{feedId}
        • GET
      • /nssFeeds/validateFeedFormat
        • POST
    • Data Loss Prevention
      • /dlpDictionaries
        • GET
        • POST
      • /dlpDictionaries/lite
        • GET
      • /dlpDictionaries/{dlpDictId}
        • GET
        • PUT
        • DELETE
      • /dlpDictionaries/{dictId}/predefinedIdentifiers
        • GET
      • /dlpDictionaries/validateDlpPattern
        • POST
      • /dlpEngines
        • GET
        • POST
      • /dlpEngines/lite
        • GET
      • /dlpEngines/validateDlpExpr
        • POST
      • /dlpEngines/{dlpEngineId}
        • GET
        • PUT
        • DELETE
      • /dlpExactDataMatchSchemas
        • GET
      • /dlpExactDataMatchSchemas/lite
        • GET
      • /dlpNotificationTemplates
        • GET
        • POST
      • /dlpNotificationTemplates/{templateId}
        • GET
        • PUT
        • DELETE
      • /icapServers
        • GET
      • /icapServers/lite
        • GET
      • /icapServers/{icapServerId}
        • GET
      • /idmprofile
        • GET
      • /idmprofile/lite
        • GET
      • /idmprofile/{profileId}
        • GET
      • /incidentReceiverServers
        • GET
      • /incidentReceiverServers/lite
        • GET
      • /incidentReceiverServers/{incidentReceiverServerId}
        • GET
      • /webDlpRules
        • GET
        • POST
      • /webDlpRules/lite
        • GET
      • /webDlpRules/{ruleId}
        • GET
        • PUT
        • DELETE
    • Device Groups
      • /deviceGroups
        • GET
      • /deviceGroups/devices
        • GET
      • /deviceGroups/devices/lite
        • GET
    • DNS Control Policy
      • /firewallDnsRules
        • GET
        • POST
      • /firewallDnsRules/{ruleId}
        • GET
        • PUT
        • DELETE
    • End User Notifications
      • /eun
        • GET
        • PUT
    • Event Logs
      • /eventlogEntryReport
        • GET
        • POST
        • DELETE
      • /eventlogEntryReport/download
        • GET
    • File Type Control Policy
      • /fileTypeRules
        • GET
        • POST
      • /fileTypeRules/lite
        • GET
      • /fileTypeRules/{ruleId}
        • GET
        • PUT
        • DELETE
    • Firewall Policies
      • /firewallFilteringRules
        • GET
        • POST
      • /firewallFilteringRules/{ruleId}
        • GET
        • PUT
        • DELETE
      • /ipDestinationGroups
        • GET
        • POST
      • /ipDestinationGroups/ipv6DestinationGroups
        • GET
      • /ipDestinationGroups/ipv6DestinationGroups/lite
        • GET
      • /ipDestinationGroups/lite
        • GET
      • /ipDestinationGroups/{ipGroupId}
        • GET
        • PUT
        • DELETE
      • /ipSourceGroups
        • GET
        • POST
      • /ipSourceGroups/ipv6SourceGroups
        • GET
      • /ipSourceGroups/ipv6SourceGroups/lite
        • GET
      • /ipSourceGroups/lite
        • GET
      • /ipSourceGroups/{ipGroupId}
        • GET
        • PUT
        • DELETE
      • /networkApplicationGroups
        • GET
        • POST
      • /networkApplicationGroups/lite
        • GET
      • /networkApplicationGroups/{groupId}
        • GET
        • PUT
        • DELETE
      • /networkApplications
        • GET
      • /networkApplications/{appId}
        • GET
      • /networkServiceGroups
        • GET
        • POST
      • /networkServiceGroups/lite
        • GET
      • /networkServiceGroups/{serviceGroupId}
        • GET
        • PUT
        • DELETE
      • /networkServices
        • GET
        • POST
      • /networkServices/lite
        • GET
      • /networkServices/{serviceId}
        • GET
        • PUT
        • DELETE
      • /timeWindows
        • GET
      • /timeWindows/lite
        • GET
    • Forwarding Control Policy
      • /forwardingRules
        • GET
        • POST
      • /forwardingRules/{ruleId}
        • GET
        • PUT
        • DELETE
      • /zpaGateways
        • GET
        • POST
      • /zpaGateways/{gatewayId}
        • GET
        • PUT
        • DELETE
      • /proxyGateways
        • GET
      • /proxyGateways/lite
        • GET
    • Intermediate CA Certificates
      • /intermediateCaCertificate
        • GET
        • POST
      • /intermediateCaCertificate/downloadAttestation/{certId}
        • GET
      • /intermediateCaCertificate/downloadCsr/{certId}
        • GET
      • /intermediateCaCertificate/downloadPublicKey/{certId}
        • GET
      • /intermediateCaCertificate/finalizeCert/{certId}
        • POST
      • /intermediateCaCertificate/generateCsr/{certId}
        • POST
      • /intermediateCaCertificate/keyPair/{certId}
        • POST
      • /intermediateCaCertificate/lite
        • GET
      • /intermediateCaCertificate/lite/{certId}
        • GET
      • /intermediateCaCertificate/makeDefault/{certId}
        • PUT
      • /intermediateCaCertificate/readyToUse
        • GET
      • /intermediateCaCertificate/showCert/{certId}
        • GET
      • /intermediateCaCertificate/showCsr/{certId}
        • GET
      • /intermediateCaCertificate/uploadCert/{certId}
        • POST
      • /intermediateCaCertificate/uploadCertChain/{certId}
        • POST
      • /intermediateCaCertificate/verifyKeyAttestation/{certId}
        • POST
      • /intermediateCaCertificate/{certId}
        • GET
        • PUT
        • DELETE
      • /sslSettings/downloadcsr
        • GET
      • /sslSettings/generatecsr
        • POST
      • /sslSettings/showcert
        • GET
      • /sslSettings/uploadcert/text
        • POST
      • /sslSettings/uploadcertchain/text
        • POST
      • /sslSettings/certchain
        • DELETE
      • /sslSettings/exemptedUrls
        • GET
        • POST
    • IoT Report
      • /iotDiscovery/deviceTypes
        • GET
      • /iotDiscovery/categories
        • GET
      • /iotDiscovery/classifications
        • GET
      • /iotDiscovery/deviceList
        • GET
    • IPS Control Policy
      • /firewallIpsRules
        • GET
        • POST
      • /firewallIpsRules/{ruleId}
        • GET
        • PUT
        • DELETE
    • Location Management
      • /locations
        • GET
        • POST
      • /locations/bulkDelete
        • POST
      • /locations/supportedCountries
        • GET
      • /locations/lite
        • GET
      • /locations/{locationId}
        • GET
        • PUT
        • DELETE
      • /locations/{locationId}/sublocations
        • GET
      • /locations/groups
        • GET
      • /locations/groups/count
        • GET
      • /locations/groups/lite
        • GET
      • /locations/groups/lite/{id}
        • GET
      • /locations/groups/{id}
        • GET
    • Malware Protection Policy
      • /cyberThreatProtection/atpMalwareInspection
        • GET
        • PUT
      • /cyberThreatProtection/atpMalwareProtocols
        • GET
        • PUT
      • /cyberThreatProtection/malwareSettings
        • GET
        • PUT
      • /cyberThreatProtection/malwarePolicy
        • GET
        • PUT
    • Organization Details
      • /orgInformation
        • GET
      • /orgInformation/lite
        • GET
      • /subscriptions
        • GET
    • PAC Files
      • /pacFiles
        • GET
        • POST
      • /pacFiles/validate
        • POST
      • /pacFiles/{pacId}
        • DELETE
      • /pacFiles/{pacId}/version
        • GET
      • /pacFiles/{pacId}/version/{clonedPacVersion}
        • POST
      • /pacFiles/{pacId}/version/{pacVersion}
        • GET
      • /pacFiles/{pacId}/version/{pacVersion}/action/{pacVersionAction}
        • PUT
    • Policy Export
      • /exportPolicies
        • POST
    • Remote Assistance Support
      • /remoteAssistance
        • GET
        • PUT
    • Rule Labels
      • /ruleLabels
        • GET
        • POST
      • /ruleLabels/{ruleLabelId}
        • GET
        • PUT
        • DELETE
    • Sandbox Policy & Settings
      • /sandboxRules
        • GET
        • POST
      • /sandboxRules/{ruleId}
        • GET
        • PUT
        • DELETE
      • /behavioralAnalysisAdvancedSettings
        • GET
        • PUT
      • /behavioralAnalysisAdvancedSettings/fileHashCount
        • GET
    • Sandbox Report
      • /sandbox/report/quota
        • GET
      • /sandbox/report/{md5Hash}
        • GET
    • Security Policy Settings
      • /security
        • GET
        • PUT
      • /security/advanced
        • GET
        • PUT
      • /security/advanced/blacklistUrls
        • POST
    • Shadow IT Report
      • /cloudApplications/bulkUpdate
        • PUT
      • /cloudApplications/lite
        • GET
      • /customTags
        • GET
      • /shadowIT/applications/export
        • POST
      • /shadowIT/applications/{entity}/exportCsv
        • POST
    • SSL Inspection Policy
      • /sslInspectionRules
        • GET
        • POST
      • /sslInspectionRules/{ruleId}
        • GET
        • PUT
        • DELETE
    • System Audit Report
      • /configAudit
        • GET
      • /configAudit/ipVisibility
        • GET
      • /configAudit/pacFile
        • GET
    • Traffic Forwarding
      • /subclouds
        • GET
      • /subclouds/isLastDcInCountry/{id}
        • GET
      • /subclouds/{id}
        • PUT
      • /extranet
        • GET
        • POST
        • PUT
      • /extranet/lite
        • GET
      • /extranet/{id}
        • GET
        • DELETE
      • /greTunnels
        • GET
        • POST
      • /greTunnels/availableInternalIpRanges
        • GET
      • /greTunnels/{Id}
        • GET
        • PUT
        • DELETE
      • /ipv6config
        • GET
      • /ipv6config/dns64prefix
        • GET
      • /ipv6config/nat64prefix
        • GET
      • /orgProvisioning/ipGreTunnelInfo
        • GET
      • /region/byGeoCoordinates
        • GET
      • /region/byIPAddress/{ip}
        • GET
      • /region/search
        • GET
      • /staticIP
        • GET
        • POST
      • /staticIP/validate
        • POST
      • /staticIP/{Id}
        • GET
        • PUT
        • DELETE
      • /vips
        • GET
      • /vips/groupByDatacenter
        • GET
      • /vips/recommendedList
        • GET
      • /vpnCredentials
        • GET
        • POST
      • /vpnCredentials/bulkDelete
        • POST
      • /vpnCredentials/{vpnId}
        • GET
        • PUT
        • DELETE
    • URL Categories
      • /urlCategories
        • GET
        • POST
      • /urlCategories/lite
        • GET
      • /urlCategories/review/domains
        • POST
        • PUT
      • /urlCategories/urlQuota
        • GET
      • /urlCategories/{categoryId}
        • GET
        • PUT
        • DELETE
      • /urlLookup
        • POST
    • URL Filtering Policy
      • /urlFilteringRules
        • GET
        • POST
      • /urlFilteringRules/{ruleId}
        • GET
        • PUT
        • DELETE
      • /timeWindows
        • GET
      • /timeWindows/lite
        • GET
    • URL & Cloud App Control Policy Settings
      • /advancedUrlFilterAndCloudAppSettings
        • GET
        • PUT
    • User Authentication Settings
      • /authSettings/exemptedUrls
        • GET
        • POST
    • User Management
      • /departments
        • GET
        • POST
      • /departments/lite
        • GET
      • /departments/{id}
        • GET
      • /departments/lite/{id}
        • GET
      • /departments/{departmentId}
        • PUT
        • DELETE
      • /groups
        • GET
        • POST
      • /groups/lite
        • GET
      • /groups/{groupId}
        • GET
        • PUT
        • DELETE
      • /groups/lite/{groupId}
        • GET
      • /users
        • GET
        • POST
      • /users/bulkDelete
        • POST
      • /users/references
        • GET
      • /users/{userId}
        • GET
        • PUT
        • DELETE
      • /users/auditors
        • GET
    • Workload Groups
      • /workloadGroups
        • GET
    • API Rate Limit Summary
  • Working with APIs
    • Generating Admin Audit Logs Using API
    • Managing Admins and Roles Using API
    • Managing Intermediate CA Certificates Using API
    • Managing Locations Using API
    • Obtaining Sandbox Reports Using API
    • SD-WAN Integrations Using API
    • Configuring VPN Credentials for IPSec Tunnels Using API
    • Managing URL Allowlist and Denylist Using API
    • Configuring URL Categories Using API
    • Managing Users Using API