| Method Signature |
Description |
Path |
Workflow? |
| getAuthenticatedSession(callback) |
Checks if there is an authenticated session |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| postAuthenticatedSession(credentials, callback) |
Creates an authenticated session |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| deleteAuthenticatedSession(callback) |
Ends an authenticated session |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| getAuditReport(callback) |
This endpoint is deprecated, use GET /auditlogEntryReport |
{base_path}/{version}/auditReport?{query} |
Yes |
| postAuditReport(callback) |
This endpoint is deprecated, use POST /auditlogEntryReport |
{base_path}/{version}/auditReport?{query} |
Yes |
| deleteAuditReport(callback) |
This endpoint is deprecated, use DELETE /auditlogEntryReport |
{base_path}/{version}/auditReport?{query} |
Yes |
| getAuditReportdownload(callback) |
This endpoint is deprecated, use GET /auditlogEntryReport/download |
{base_path}/{version}/auditReport/download?{query} |
Yes |
| getAuditlogEntryReport(callback) |
Gets the status of a request for an audit log report |
{base_path}/{version}/auditlogEntryReport?{query} |
Yes |
| postAuditlogEntryReport(request, callback) |
Creates an audit log report for the specified time period and saves it as a CSV file |
{base_path}/{version}/auditlogEntryReport?{query} |
Yes |
| deleteAuditlogEntryReport(callback) |
Cancels the request to create an audit log report |
{base_path}/{version}/auditlogEntryReport?{query} |
Yes |
| getAuditlogEntryReportdownload(callback) |
Downloads the most recently created audit log report |
{base_path}/{version}/auditlogEntryReport/download?{query} |
Yes |
| getDepartments(callback) |
Gets a list of departments |
{base_path}/{version}/departments?{query} |
Yes |
| getDepartmentsid(id, callback) |
Gets the department for the specified ID |
{base_path}/{version}/departments/{pathv1}?{query} |
Yes |
| getGroups(search, page, pageSize, callback) |
Gets a list of groups |
{base_path}/{version}/groups?{query} |
Yes |
| getGroupsgroupId(groupId, callback) |
Gets the group for the specified ID |
{base_path}/{version}/groups/{pathv1}?{query} |
Yes |
| getUsers(name, dept, group, page, pageSize, callback) |
Gets a list of all users and allows user filtering by name, department, or group |
{base_path}/{version}/users?{query} |
Yes |
| postUsers(user, callback) |
Adds a new user |
{base_path}/{version}/users?{query} |
Yes |
| postUsersbulkDelete(userIds, callback) |
Bulk delete users up to a maximum of 500 users per request |
{base_path}/{version}/users/bulkDelete?{query} |
Yes |
| getUsersuserId(userId, callback) |
Gets the user information for the specified ID |
{base_path}/{version}/users/{pathv1}?{query} |
Yes |
| putUsersuserId(userId, user, callback) |
Updates the user information for the specified ID |
{base_path}/{version}/users/{pathv1}?{query} |
Yes |
| deleteUsersuserId(userId, callback) |
Deletes the user for the specified ID |
{base_path}/{version}/users/{pathv1}?{query} |
Yes |
| getSecurity(callback) |
Gets a list of white-listed URLs |
{base_path}/{version}/security?{query} |
Yes |
| putSecurity(policy, callback) |
Updates the list of white-listed URLs |
{base_path}/{version}/security?{query} |
Yes |
| getSecurityadvanced(callback) |
Gets a list of black-listed URLs |
{base_path}/{version}/security/advanced?{query} |
Yes |
| putSecurityadvanced(advSettings, callback) |
Updates the list of black-listed URLs |
{base_path}/{version}/security/advanced?{query} |
Yes |
| postSecurityadvancedblacklistUrls(action, callback) |
Adds a URL to or removes a URL from the black list |
{base_path}/{version}/security/advanced/blacklistUrls?{query} |
Yes |
| deleteSslSettingscertchain(callback) |
Deletes the intermediate certificate chain |
{base_path}/{version}/sslSettings/certchain?{query} |
Yes |
| getSslSettingsdownloadcsr(callback) |
Downloads a Certificate Signing Request (CSR) |
{base_path}/{version}/sslSettings/downloadcsr?{query} |
Yes |
| postSslSettingsgeneratecsr(cert, callback) |
Generates a Certificate Signing Request (CSR) |
{base_path}/{version}/sslSettings/generatecsr?{query} |
Yes |
| getSslSettingsshowcert(callback) |
Shows information about the signed intermediate root certificate |
{base_path}/{version}/sslSettings/showcert?{query} |
Yes |
| postSslSettingsuploadcerttext(fileInputStream, callback) |
Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain |
{base_path}/{version}/sslSettings/uploadcert/text?{query} |
Yes |
| postSslSettingsuploadcertchaintext(fileInputStream, callback) |
Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain |
{base_path}/{version}/sslSettings/uploadcertchain/text?{query} |
Yes |
| getUrlCategoriesWithOptions(queryData, callback) |
Gets information about all or custom URL categories with query data |
{base_path}/{version}/urlCategories?{query} |
Yes |
| postUrlCategories(customCategory, callback) |
Adds a new custom URL category |
{base_path}/{version}/urlCategories?{query} |
Yes |
| getUrlCategorieslite(callback) |
Gets a lightweight key-value list of all or custom URL categories |
{base_path}/{version}/urlCategories/lite?{query} |
Yes |
| getUrlCategoriesurlQuota(callback) |
Gets the URL quota information for your organization |
{base_path}/{version}/urlCategories/urlQuota?{query} |
Yes |
| getUrlCategoriescategoryId(categoryId, callback) |
Gets the URL category information for the specified ID |
{base_path}/{version}/urlCategories/{pathv1}?{query} |
Yes |
| putUrlCategoriescategoryId(categoryId, action, customCategory, callback) |
Updates the URL category for the specified ID |
{base_path}/{version}/urlCategories/{pathv1}?{query} |
Yes |
| deleteUrlCategoriescategoryId(categoryId, callback) |
Deletes the custom URL category for the specified ID |
{base_path}/{version}/urlCategories/{pathv1}?{query} |
Yes |
| postUrlLookup(urls, callback) |
Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com'] |
{base_path}/{version}/urlLookup?{query} |
Yes |
| getVpnCredentials(search, type, includeOnlyWithoutLocation, locationId, managedBy, page, pageSize, callback) |
Gets VPN credentials that can be associated to locations |
{base_path}/{version}/vpnCredentials?{query} |
Yes |
| postVpnCredentials(vpnCred, callback) |
Adds VPN credentials that can be associated to locations |
{base_path}/{version}/vpnCredentials?{query} |
Yes |
| postVpnCredentialsbulkDelete(ids, callback) |
Bulk delete VPN credentials up to a maximum of 100 credentials per request |
{base_path}/{version}/vpnCredentials/bulkDelete?{query} |
Yes |
| getVpnCredentialsvpnId(vpnId, callback) |
Gets the VPN credentials for the specified ID |
{base_path}/{version}/vpnCredentials/{pathv1}?{query} |
Yes |
| putVpnCredentialsvpnId(vpnId, vpnCred, callback) |
Updates the VPN credentials for the specified ID |
{base_path}/{version}/vpnCredentials/{pathv1}?{query} |
Yes |
| deleteVpnCredentialsvpnId(vpnId, callback) |
Deletes the VPN credentials for the specified ID |
{base_path}/{version}/vpnCredentials/{pathv1}?{query} |
Yes |
| getLocations(search, sslScanEnabled, xffEnabled, authRequired, bwEnforced, page, pageSize, callback) |
Gets information on locations |
{base_path}/{version}/locations?{query} |
Yes |
| postLocations(location, callback) |
Adds a new location |
{base_path}/{version}/locations?{query} |
Yes |
| postLocationsbulkDelete(LocationIds, callback) |
Bulk delete locations up to a maximum of 100 locations per request |
{base_path}/{version}/locations/bulkDelete?{query} |
Yes |
| getLocationslite(sslScanEnabled, search, page, pageSize, callback) |
Gets a lightweight list of locations |
{base_path}/{version}/locations/lite?{query} |
Yes |
| getLocationslocationId(locationId, callback) |
Gets the location information for the specified ID |
{base_path}/{version}/locations/{pathv1}?{query} |
Yes |
| putLocationslocationId(locationId, location, callback) |
Updates the location information for the specified ID |
{base_path}/{version}/locations/{pathv1}?{query} |
Yes |
| deleteLocationslocationId(locationId, callback) |
Deletes the location for the specified ID |
{base_path}/{version}/locations/{pathv1}?{query} |
Yes |
| getSandboxreportquota(callback) |
Gets the Sandbox Report API quota information for your organization |
{base_path}/{version}/sandbox/report/quota?{query} |
Yes |
| getSandboxreportmd5Hash(md5Hash, details, callback) |
Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox |
{base_path}/{version}/sandbox/report/{pathv1}?{query} |
Yes |
| getStatus(callback) |
Gets the activation status for a configuration change |
{base_path}/{version}/status?{query} |
Yes |
| postStatusactivate(callback) |
Activates configuration changes |
{base_path}/{version}/status/activate?{query} |
Yes |
| submitFile(apiToken, force, callback) |
submitFile |
{base_path}/{version}/zscsb/submit?{query} |
Yes |
| submitFileForScan(apiToken, callback) |
submitFileForScan |
{base_path}/{version}/zscsb/discan?{query} |
Yes |
| getApp(appId, url, verbose, callback) |
getApp |
{base_path}/{version}/apps/app?{query} |
Yes |
| postApp(body, callback) |
postApp |
{base_path}/{version}/apps/app?{query} |
Yes |
| appsSearchGET(appName, limit, page, callback) |
AppsSearch_GET |
{base_path}/{version}/apps/search?{query} |
Yes |
| getViews(callback) |
getViews |
{base_path}/{version}/app_views/list?{query} |
Yes |
| getViewApps(appViewId, callback) |
getViewApps |
{base_path}/{version}/app_views/{pathv1}/apps?{query} |
Yes |
| getRoleSummary(includeAuditorRole, includePartnerRole, includeApiRole, callback) |
getRoleSummary |
{base_path}/{version}/adminRoles/lite?{query} |
Yes |
| getAdminUsers(includeAuditorUsers, includeAdminUsers, search, page, pageSize, callback) |
getAdminUsers |
{base_path}/{version}/adminUsers?{query} |
Yes |
| addAdminUser(associateWithExistingAdmin, body, callback) |
addAdminUser |
{base_path}/{version}/adminUsers?{query} |
Yes |
| updateAdminUser(userId, callback) |
updateAdminUser |
{base_path}/{version}/adminUsers/{pathv1}?{query} |
Yes |
| deleteAdminUser(userId, callback) |
deleteAdminUser |
{base_path}/{version}/adminUsers/{pathv1}?{query} |
Yes |
| convertAdminToEndUser(userId, body, callback) |
convertAdminToEndUser |
{base_path}/{version}/adminUsers/{pathv1}/convertToUser?{query} |
Yes |
| getCloudBrowserIsolationProfiles(callback) |
getCloudBrowserIsolationProfiles |
{base_path}/{version}/browserIsolation/profiles?{query} |
Yes |
| getDlpDictionaries(search, callback) |
getDlpDictionaries |
{base_path}/{version}/dlpDictionaries?{query} |
Yes |
| addCustomDLPDictionary(body, callback) |
addCustomDLPDictionary |
{base_path}/{version}/dlpDictionaries?{query} |
Yes |
| getDLPDictionarySummary(callback) |
getDLPDictionarySummary |
{base_path}/{version}/dlpDictionaries/lite?{query} |
Yes |
| getDlpDictionaryById(dlpDictId, callback) |
getDlpDictionaryById |
{base_path}/{version}/dlpDictionaries/{pathv1}?{query} |
Yes |
| updateDlpDictionary(dlpDictId, body, callback) |
updateDlpDictionary |
{base_path}/{version}/dlpDictionaries/{pathv1}?{query} |
Yes |
| deleteCustomDlpDictionary(dlpDictId, callback) |
deleteCustomDlpDictionary |
{base_path}/{version}/dlpDictionaries/{pathv1}?{query} |
Yes |
| getPredefinedHierarchicalIdentifiersByDictionaryId(dictId, callback) |
getPredefinedHierarchicalIdentifiersByDictionaryId |
{base_path}/{version}/dlpDictionaries/{pathv1}/predefinedIdentifiers?{query} |
Yes |
| validateDlpPattern(callback) |
validateDlpPattern |
{base_path}/{version}/dlpDictionaries/validateDlpPattern?{query} |
Yes |
| getDLPEngines(callback) |
getDLPEngines |
{base_path}/{version}/dlpEngines?{query} |
Yes |
| addCustomDLPEngine(body, callback) |
addCustomDLPEngine |
{base_path}/{version}/dlpEngines?{query} |
Yes |
| getDLPEnginesSummary(callback) |
getDLPEnginesSummary |
{base_path}/{version}/dlpEngines/lite?{query} |
Yes |
| postDlpEnginesValidateDlpExpr(body, callback) |
validateDlpPattern |
{base_path}/{version}/dlpEngines/validateDlpExpr?{query} |
Yes |
| getDLPEngineById(dlpEngineId, callback) |
getDLPEngineById |
{base_path}/{version}/dlpEngines/{pathv1}?{query} |
Yes |
| updateDlpEngine(dlpEngineId, body, callback) |
updateDlpEngine |
{base_path}/{version}/dlpEngines/{pathv1}?{query} |
Yes |
| deleteCustomDlpEngine(dlpEngineId, callback) |
deleteCustomDlpEngine |
{base_path}/{version}/dlpEngines/{pathv1}?{query} |
Yes |
| getSchemas(callback) |
getSchemas |
{base_path}/{version}/dlpExactDataMatchSchemas?{query} |
Yes |
| getSchemaLite(schemaName, activeOnly, fetchTokens, callback) |
getSchemaLite |
{base_path}/{version}/dlpExactDataMatchSchemas/lite?{query} |
Yes |
| gettemplates(callback) |
gettemplates |
{base_path}/{version}/dlpNotificationTemplates?{query} |
Yes |
| addtemplate(callback) |
addtemplate |
{base_path}/{version}/dlpNotificationTemplates?{query} |
Yes |
| getTemplateById(templateId, callback) |
getTemplateById |
{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query} |
Yes |
| updatetemplate(templateId, callback) |
updatetemplate |
{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query} |
Yes |
| deletetemplate(templateId, callback) |
deletetemplate |
{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query} |
Yes |
| getICAPServers(callback) |
getICAPServers |
{base_path}/{version}/icapServers?{query} |
Yes |
| getICAPServerSummary(callback) |
getICAPServerSummary |
{base_path}/{version}/icapServers/lite?{query} |
Yes |
| getICAPServer(icapServerId, callback) |
getICAPServer |
{base_path}/{version}/icapServers/{pathv1}?{query} |
Yes |
| getProfiles(callback) |
getProfiles |
{base_path}/{version}/idmprofile?{query} |
Yes |
| getSummary(activeOnly, callback) |
getSummary |
{base_path}/{version}/idmprofile/lite?{query} |
Yes |
| getProfileById(profileId, callback) |
getProfileById |
{base_path}/{version}/idmprofile/{pathv1}?{query} |
Yes |
| getIncidentReceiverServers(callback) |
getIncidentReceiverServers |
{base_path}/{version}/incidentReceiverServers?{query} |
Yes |
| getIncidentReceiverServerSummary(callback) |
getIncidentReceiverServerSummary |
{base_path}/{version}/incidentReceiverServers/lite?{query} |
Yes |
| getIncidentReceiverServer(incidentReceiverServerId, callback) |
getIncidentReceiverServer |
{base_path}/{version}/incidentReceiverServers/{pathv1}?{query} |
Yes |
| getRules(callback) |
getRules |
{base_path}/{version}/webDlpRules?{query} |
Yes |
| addRule(body, callback) |
addRule |
{base_path}/{version}/webDlpRules?{query} |
Yes |
| getWebDlpRulesLite(callback) |
getSummary |
{base_path}/{version}/webDlpRules/lite?{query} |
Yes |
| getRuleById(ruleId, callback) |
getRuleById |
{base_path}/{version}/webDlpRules/{pathv1}?{query} |
Yes |
| updateRule(ruleId, body, callback) |
updateRule |
{base_path}/{version}/webDlpRules/{pathv1}?{query} |
Yes |
| deleteRule(ruleId, callback) |
deleteRule |
{base_path}/{version}/webDlpRules/{pathv1}?{query} |
Yes |
| getDeviceGroups(includeDeviceInfo, includePseudoGroups, callback) |
getDeviceGroups |
{base_path}/{version}/deviceGroups?{query} |
Yes |
| getDevices(name, model, owner, osType, osVersion, deviceGroupId, userIds, searchAll, includeAll, page, pageSize, callback) |
getDevices |
{base_path}/{version}/deviceGroups/devices?{query} |
Yes |
| getDevicesLite(name, userIds, includeAll, page, pageSize, callback) |
getDevicesLite |
{base_path}/{version}/deviceGroups/devices/lite?{query} |
Yes |
| getEventReportEntryCsvExportStatus(callback) |
getEventReportEntryCsvExportStatus |
{base_path}/{version}/eventlogEntryReport?{query} |
Yes |
| startEventReportEntryCsvExport(body, callback) |
startEventReportEntryCsvExport |
{base_path}/{version}/eventlogEntryReport?{query} |
Yes |
| cancelEventReportEntryCsvExport(callback) |
cancelEventReportEntryCsvExport |
{base_path}/{version}/eventlogEntryReport?{query} |
Yes |
| getEventReportEntryCsvData(callback) |
getEventReportEntryCsvData |
{base_path}/{version}/eventlogEntryReport/download?{query} |
Yes |
| getFirewallFilteringRules(callback) |
getFirewallFilteringRules |
{base_path}/{version}/firewallFilteringRules?{query} |
Yes |
| createFirewallFilteringRule(body, callback) |
createFirewallFilteringRule |
{base_path}/{version}/firewallFilteringRules?{query} |
Yes |
| getFirewallFilteringRule(ruleId, callback) |
getFirewallFilteringRule |
{base_path}/{version}/firewallFilteringRules/{pathv1}?{query} |
Yes |
| updateFirewallFilteringRule(ruleId, body, callback) |
updateFirewallFilteringRule |
{base_path}/{version}/firewallFilteringRules/{pathv1}?{query} |
Yes |
| deleteFirewallFilteringRule(ruleId, callback) |
deleteFirewallFilteringRule |
{base_path}/{version}/firewallFilteringRules/{pathv1}?{query} |
Yes |
| getDestinationIpGroups(excludeType, callback) |
getDestinationIpGroups |
{base_path}/{version}/ipDestinationGroups?{query} |
Yes |
| addDestinationIpGroup(callback) |
addDestinationIpGroup |
{base_path}/{version}/ipDestinationGroups?{query} |
Yes |
| getDestinationIpv6Groups(excludeType, callback) |
getDestinationIpv6Groups |
{base_path}/{version}/ipDestinationGroups/ipv6DestinationGroups?{query} |
Yes |
| getDestinationIpv6GroupsLite(type, excludeType, callback) |
getDestinationIpv6GroupsLite |
{base_path}/{version}/ipDestinationGroups/ipv6DestinationGroups/lite?{query} |
Yes |
| getDestinationIpGroupsLite(type, excludeType, callback) |
getDestinationIpGroupsLite |
{base_path}/{version}/ipDestinationGroups/lite?{query} |
Yes |
| getDestinationIpGroupById(ipGroupId, callback) |
getDestinationIpGroupById |
{base_path}/{version}/ipDestinationGroups/{pathv1}?{query} |
Yes |
| editDestinationIpGroup(ipGroupId, callback) |
editDestinationIpGroup |
{base_path}/{version}/ipDestinationGroups/{pathv1}?{query} |
Yes |
| deleteDestinationIpGroup(ipGroupId, callback) |
deleteDestinationIpGroup |
{base_path}/{version}/ipDestinationGroups/{pathv1}?{query} |
Yes |
| getSourceIpGroups(search, callback) |
getSourceIpGroups |
{base_path}/{version}/ipSourceGroups?{query} |
Yes |
| addSourceIpGroup(callback) |
addSourceIpGroup |
{base_path}/{version}/ipSourceGroups?{query} |
Yes |
| getSourceIpv6Groups(callback) |
getSourceIpv6Groups |
{base_path}/{version}/ipSourceGroups/ipv6SourceGroups?{query} |
Yes |
| getSourceIpv6GroupsLite(callback) |
getSourceIpv6GroupsLite |
{base_path}/{version}/ipSourceGroups/ipv6SourceGroups/lite?{query} |
Yes |
| getSourceIpGroupsLite(callback) |
getSourceIpGroupsLite |
{base_path}/{version}/ipSourceGroups/lite?{query} |
Yes |
| getSourceIpGroupById(ipGroupId, callback) |
getSourceIpGroupById |
{base_path}/{version}/ipSourceGroups/{pathv1}?{query} |
Yes |
| editSourceIpGroup(ipGroupId, callback) |
editSourceIpGroup |
{base_path}/{version}/ipSourceGroups/{pathv1}?{query} |
Yes |
| deleteSourceIpGroup(ipGroupId, callback) |
deleteSourceIpGroup |
{base_path}/{version}/ipSourceGroups/{pathv1}?{query} |
Yes |
| getNetowrkApplicationGroups(search, callback) |
getNetowrkApplicationGroups |
{base_path}/{version}/networkApplicationGroups?{query} |
Yes |
| createNetworkApplicationGroup(callback) |
createNetworkApplicationGroup |
{base_path}/{version}/networkApplicationGroups?{query} |
Yes |
| getNetowrkApplicationGroupsLite(callback) |
getNetowrkApplicationGroupsLite |
{base_path}/{version}/networkApplicationGroups/lite?{query} |
Yes |
| getNetworkApplicationGroupById(groupId, callback) |
getNetworkApplicationGroupById |
{base_path}/{version}/networkApplicationGroups/{pathv1}?{query} |
Yes |
| updateNetworkApplicationGroup(groupId, callback) |
updateNetworkApplicationGroup |
{base_path}/{version}/networkApplicationGroups/{pathv1}?{query} |
Yes |
| deleteNetworkApplicationGroup(groupId, callback) |
deleteNetworkApplicationGroup |
{base_path}/{version}/networkApplicationGroups/{pathv1}?{query} |
Yes |
| getNetworkApplications(search, locale, callback) |
getNetworkApplications |
{base_path}/{version}/networkApplications?{query} |
Yes |
| getNetworkApplicationById(appId, locale, callback) |
getNetworkApplicationById |
{base_path}/{version}/networkApplications/{pathv1}?{query} |
Yes |
| getNetworkServiceGroups(search, callback) |
getNetworkServiceGroups |
{base_path}/{version}/networkServiceGroups?{query} |
Yes |
| addCustomNetworkServiceGroup(callback) |
addCustomNetworkServiceGroup |
{base_path}/{version}/networkServiceGroups?{query} |
Yes |
| getNetworkServiceGroupsLite(callback) |
getNetworkServiceGroupsLite |
{base_path}/{version}/networkServiceGroups/lite?{query} |
Yes |
| getNetworkServiceGroupById(serviceGroupId, callback) |
getNetworkServiceGroupById |
{base_path}/{version}/networkServiceGroups/{pathv1}?{query} |
Yes |
| editNetworkServiceGroup(serviceGroupId, callback) |
editNetworkServiceGroup |
{base_path}/{version}/networkServiceGroups/{pathv1}?{query} |
Yes |
| deleteCustomNetowrkServiceGroup(serviceGroupId, callback) |
deleteCustomNetowrkServiceGroup |
{base_path}/{version}/networkServiceGroups/{pathv1}?{query} |
Yes |
| getNetworkServices(search, protocol, locale, callback) |
getNetworkServices |
{base_path}/{version}/networkServices?{query} |
Yes |
| addCustomNetworkService(body, callback) |
addCustomNetworkService |
{base_path}/{version}/networkServices?{query} |
Yes |
| getNetworkServicesLite(locale, callback) |
getNetworkServicesLite |
{base_path}/{version}/networkServices/lite?{query} |
Yes |
| getNetworkServiceById(serviceId, locale, callback) |
getNetworkServiceById |
{base_path}/{version}/networkServices/{pathv1}?{query} |
Yes |
| editNetworkService(serviceId, callback) |
editNetworkService |
{base_path}/{version}/networkServices/{pathv1}?{query} |
Yes |
| deleteCustomNetworkService(serviceId, callback) |
deleteCustomNetworkService |
{base_path}/{version}/networkServices/{pathv1}?{query} |
Yes |
| getTimeWindows(callback) |
getTimeWindows |
{base_path}/{version}/timeWindows?{query} |
Yes |
| getTimeWindowSummary(callback) |
getTimeWindowSummary |
{base_path}/{version}/timeWindows/lite?{query} |
Yes |
| getUrlFilteringRules(callback) |
getRules |
{base_path}/{version}/urlFilteringRules?{query} |
Yes |
| postUrlFilteringRules(body, callback) |
addRule |
{base_path}/{version}/urlFilteringRules?{query} |
Yes |
| getUrlFilteringRulesRuleId(ruleId, callback) |
getRuleById |
{base_path}/{version}/urlFilteringRules/{pathv1}?{query} |
Yes |
| putUrlFilteringRulesRuleId(ruleId, body, callback) |
updateRule |
{base_path}/{version}/urlFilteringRules/{pathv1}?{query} |
Yes |
| deleteUrlFilteringRulesRuleId(ruleId, callback) |
deleteRule |
{base_path}/{version}/urlFilteringRules/{pathv1}?{query} |
Yes |
| getForwardingRules(callback) |
getForwardingRules |
{base_path}/{version}/forwardingRules?{query} |
Yes |
| createForwardingRule(body, callback) |
createForwardingRule |
{base_path}/{version}/forwardingRules?{query} |
Yes |
| getForwardingRule(ruleId, callback) |
getForwardingRule |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| updateForwardingRule(ruleId, body, callback) |
updateForwardingRule |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| deleteForwardingRule(ruleId, callback) |
deleteForwardingRule |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| getZpaGateways(search, appSegment, callback) |
getZpaGateways |
{base_path}/{version}/zpaGateways?{query} |
Yes |
| addZpaGateway(body, callback) |
addZpaGateway |
{base_path}/{version}/zpaGateways?{query} |
Yes |
| getZpaGatewayById(gatewayId, callback) |
getZpaGatewayById |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| editZpaGateway(gatewayId, body, callback) |
editZpaGateway |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| deleteZpaGateway(gatewayId, callback) |
deleteZpaGateway |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| getIntermediateCaCertificates(page, pageSize, callback) |
getIntermediateCaCertificates |
{base_path}/{version}/intermediateCaCertificate?{query} |
Yes |
| addIntermediateCaCertificate(body, callback) |
addIntermediateCaCertificate |
{base_path}/{version}/intermediateCaCertificate?{query} |
Yes |
| downloadAttestationStmt(certId, callback) |
downloadAttestationStmt |
{base_path}/{version}/intermediateCaCertificate/downloadAttestation/{pathv1}?{query} |
Yes |
| downloadCSR(certId, callback) |
downloadCSR |
{base_path}/{version}/intermediateCaCertificate/downloadCsr/{pathv1}?{query} |
Yes |
| downloadHsmPublicKey(certId, callback) |
downloadHsmPublicKey |
{base_path}/{version}/intermediateCaCertificate/downloadPublicKey/{pathv1}?{query} |
Yes |
| finalizeCert(certId, callback) |
finalizeCert |
{base_path}/{version}/intermediateCaCertificate/finalizeCert/{pathv1}?{query} |
Yes |
| generateCsr(certId, body, callback) |
generateCsr |
{base_path}/{version}/intermediateCaCertificate/generateCsr/{pathv1}?{query} |
Yes |
| generateHsmKeyPair(certId, callback) |
generateHsmKeyPair |
{base_path}/{version}/intermediateCaCertificate/keyPair/{pathv1}?{query} |
Yes |
| getIntermediateCaCertificatesLite(page, pageSize, callback) |
getIntermediateCaCertificatesLite |
{base_path}/{version}/intermediateCaCertificate/lite?{query} |
Yes |
| getIntermediateCaCertificateLite(certId, callback) |
getIntermediateCaCertificateLite |
{base_path}/{version}/intermediateCaCertificate/lite/{pathv1}?{query} |
Yes |
| makeDefaultCertificate(certId, callback) |
makeDefaultCertificate |
{base_path}/{version}/intermediateCaCertificate/makeDefault/{pathv1}?{query} |
Yes |
| getCertificatesInReadyToUseState(page, pageSize, callback) |
getCertificatesInReadyToUseState |
{base_path}/{version}/intermediateCaCertificate/readyToUse?{query} |
Yes |
| showCert(certId, callback) |
showCert |
{base_path}/{version}/intermediateCaCertificate/showCert/{pathv1}?{query} |
Yes |
| showCsr(certId, callback) |
showCsr |
{base_path}/{version}/intermediateCaCertificate/showCsr/{pathv1}?{query} |
Yes |
| uploadCert(certId, body, callback) |
uploadCert |
{base_path}/{version}/intermediateCaCertificate/uploadCert/{pathv1}?{query} |
Yes |
| uploadCertChain(certId, body, callback) |
uploadCertChain |
{base_path}/{version}/intermediateCaCertificate/uploadCertChain/{pathv1}?{query} |
Yes |
| verifyKeyAttestation(certId, callback) |
verifyKeyAttestation |
{base_path}/{version}/intermediateCaCertificate/verifyKeyAttestation/{pathv1}?{query} |
Yes |
| getIntermediateCaCertificate(certId, callback) |
getIntermediateCaCertificate |
{base_path}/{version}/intermediateCaCertificate/{pathv1}?{query} |
Yes |
| updateIntermediateCaCertificate(certId, body, callback) |
updateIntermediateCaCertificate |
{base_path}/{version}/intermediateCaCertificate/{pathv1}?{query} |
Yes |
| deleteIntermediateCaCertificate(certId, callback) |
deleteIntermediateCaCertificate |
{base_path}/{version}/intermediateCaCertificate/{pathv1}?{query} |
Yes |
| getSslExemptedUrls(callback) |
getSslExemptedUrls |
{base_path}/{version}/sslSettings/exemptedUrls?{query} |
Yes |
| updateSslExemptedUrls(action, callback) |
updateSslExemptedUrls |
{base_path}/{version}/sslSettings/exemptedUrls?{query} |
Yes |
| getDeviceTypes(callback) |
getDeviceTypes |
{base_path}/{version}/iotDiscovery/deviceTypes?{query} |
Yes |
| getCategories(callback) |
getCategories |
{base_path}/{version}/iotDiscovery/categories?{query} |
Yes |
| getClassifications(callback) |
getClassifications |
{base_path}/{version}/iotDiscovery/classifications?{query} |
Yes |
| getDeviceList(callback) |
getDeviceList |
{base_path}/{version}/iotDiscovery/deviceList?{query} |
Yes |
| getSubLocations(locationId, search, sslScanEnabled, xffEnabled, authRequired, bwEnforced, enforceAup, enableFirewall, enableIOT, callback) |
getSubLocations |
{base_path}/{version}/locations/{pathv1}/sublocations?{query} |
Yes |
| getGroupsCount(lastModUser, version, name, groupType, comments, locationId, callback) |
getGroupsCount |
{base_path}/{version}/locations/groups/count?{query} |
Yes |
| getGroupsSummary(page, pageSize, callback) |
getGroupsSummary |
{base_path}/{version}/locations/groups/lite?{query} |
Yes |
| getGroupSummary(id, callback) |
getGroupSummary |
{base_path}/{version}/locations/groups/lite/{pathv1}?{query} |
Yes |
| getGroupById(id, callback) |
getGroupById |
{base_path}/{version}/locations/groups/{pathv1}?{query} |
Yes |
| getRuleLabels(page, pageSize, callback) |
getRuleLabels |
{base_path}/{version}/ruleLabels?{query} |
Yes |
| addRuleLabel(callback) |
addRuleLabel |
{base_path}/{version}/ruleLabels?{query} |
Yes |
| getRuleLabelById(ruleLabelId, callback) |
getRuleLabelById |
{base_path}/{version}/ruleLabels/{pathv1}?{query} |
Yes |
| updateRuleLabel(ruleLabelId, callback) |
updateRuleLabel |
{base_path}/{version}/ruleLabels/{pathv1}?{query} |
Yes |
| deleteRuleLabel(ruleLabelId, callback) |
deleteRuleLabel |
{base_path}/{version}/ruleLabels/{pathv1}?{query} |
Yes |
| getCustomFileHash(callback) |
getCustomFileHash |
{base_path}/{version}/behavioralAnalysisAdvancedSettings?{query} |
Yes |
| updateCustomFileHash(body, callback) |
updateCustomFileHash |
{base_path}/{version}/behavioralAnalysisAdvancedSettings?{query} |
Yes |
| getCustomFileHashQuota(callback) |
getCustomFileHashQuota |
{base_path}/{version}/behavioralAnalysisAdvancedSettings/fileHashCount?{query} |
Yes |
| bulkUpdateCloudApplication(body, callback) |
bulkUpdateCloudApplication |
{base_path}/{version}/cloudApplications/bulkUpdate?{query} |
Yes |
| getCloudApplicationsLite(pageNumber, limit, callback) |
getCloudApplicationsLite |
{base_path}/{version}/cloudApplications/lite?{query} |
Yes |
| getAllCustomTags(callback) |
getAllCustomTags |
{base_path}/{version}/customTags?{query} |
Yes |
| getReportDataApplicationsExport(body, callback) |
getReportDataApplicationsExport |
{base_path}/{version}/shadowIT/applications/export?{query} |
Yes |
| getReportTransactionsExport(entity, body, callback) |
getReportTransactionsExport |
{base_path}/{version}/shadowIT/applications/{pathv1}/exportCsv?{query} |
Yes |
| getAllGreTunnels(page, pageSize, callback) |
getAllGreTunnels |
{base_path}/{version}/greTunnels?{query} |
Yes |
| addGreTunnel(body, callback) |
addGreTunnel |
{base_path}/{version}/greTunnels?{query} |
Yes |
| validateAndGetAvailableInternalIpRanges(internalIpRange, staticIp, limit, callback) |
validateAndGetAvailableInternalIpRanges |
{base_path}/{version}/greTunnels/availableInternalIpRanges?{query} |
Yes |
| getGreTunelById(id, callback) |
getGreTunelById |
{base_path}/{version}/greTunnels/{pathv1}?{query} |
Yes |
| updateGreTunnel(id, body, callback) |
updateGreTunnel |
{base_path}/{version}/greTunnels/{pathv1}?{query} |
Yes |
| deleteGreTunnel(id, callback) |
deleteGreTunnel |
{base_path}/{version}/greTunnels/{pathv1}?{query} |
Yes |
| getIPv6Configuration(callback) |
getIPv6Configuration |
{base_path}/{version}/ipv6config?{query} |
Yes |
| getDns64Prefixes(search, callback) |
getDns64Prefixes |
{base_path}/{version}/ipv6config/dns64prefix?{query} |
Yes |
| getNat64Prefixes(search, page, pageSize, callback) |
getNat64Prefixes |
{base_path}/{version}/ipv6config/nat64prefix?{query} |
Yes |
| getIPGWDetails(ipAddresses, callback) |
getIPGWDetails |
{base_path}/{version}/orgProvisioning/ipGreTunnelInfo?{query} |
Yes |
| getRegionByGeoCoordinates(latitude, longitude, callback) |
getRegionByGeoCoordinates |
{base_path}/{version}/region/byGeoCoordinates?{query} |
Yes |
| getRegionBySrcIPAddress(ip, callback) |
getRegionBySrcIPAddress |
{base_path}/{version}/region/byIPAddress/{pathv1}?{query} |
Yes |
| getRegionsByPrefix(prefix, page, pageSize, callback) |
getRegionsByPrefix |
{base_path}/{version}/region/search?{query} |
Yes |
| getAllStaticIPs(availableForGreTunnel, ipAddress, page, pageSize, callback) |
getAllStaticIPs |
{base_path}/{version}/staticIP?{query} |
Yes |
| addStaticIP(body, callback) |
addStaticIP |
{base_path}/{version}/staticIP?{query} |
Yes |
| validateIPAddress(body, callback) |
validateIPAddress |
{base_path}/{version}/staticIP/validate?{query} |
Yes |
| getStaticIPById(id, callback) |
getStaticIPById |
{base_path}/{version}/staticIP/{pathv1}?{query} |
Yes |
| updateStaticIP(id, body, callback) |
updateStaticIP |
{base_path}/{version}/staticIP/{pathv1}?{query} |
Yes |
| deleteStaticIP(id, callback) |
deleteStaticIP |
{base_path}/{version}/staticIP/{pathv1}?{query} |
Yes |
| getZscalerNodesDetails(dc, region, page, pageSize, include, subcloud, callback) |
getZscalerNodesDetails |
{base_path}/{version}/vips?{query} |
Yes |
| getRecommendedVipsGroupedByDC(routableIP, withinCountryOnly, includePrivateServiceEdge, includeCurrentVips, sourceIp, latitude, longitude, subcloud, callback) |
getRecommendedVipsGroupedByDC |
{base_path}/{version}/vips/groupByDatacenter?{query} |
Yes |
| getRecommendedGreVips(routableIP, withinCountryOnly, includePrivateServiceEdge, includeCurrentVips, sourceIp, latitude, longitude, subcloud, callback) |
getRecommendedGreVips |
{base_path}/{version}/vips/recommendedList?{query} |
Yes |
| getAuthExemptedUrls(callback) |
getAuthExemptedUrls |
{base_path}/{version}/authSettings/exemptedUrls?{query} |
Yes |
| updateAuthExemptedUrls(action, callback) |
updateAuthExemptedUrls |
{base_path}/{version}/authSettings/exemptedUrls?{query} |
Yes |
| getWorkloadGroups(page, pageSize, callback) |
getWorkloadGroups |
{base_path}/{version}/workloadGroups?{query} |
Yes |
| getLocationGroups(version, name, groupType, comments, locationId, lastModUser, page, pageSize, callback) |
getLocationGroups |
{base_path}/{version}/locations/groups?{query} |
Yes |
| postUrlCategoriesReviewDomain(body, callback) |
URL Categories - Review Domain |
{base_path}/{version}/urlCategories/review/domains?{query} |
Yes |
| putUrlCategoriesReviewDomainAddURLs(body, callback) |
URL Categories - Review Domain - Add URLs |
{base_path}/{version}/urlCategories/review/domains?{query} |
Yes |
| getWebApplicationRulesRuleTypeAvailableActions(ruleType, iapMetadata, callback) |
Fetches the granular actions supported for the applications. |
{base_path}/{version}/webApplicationRules/{pathv1}/availableActions?{query} |
Yes |
| getWebApplicationRulesRuleTypeMapping(iapMetadata, callback) |
Gets the backend keys that match the application type string. |
{base_path}/{version}/webApplicationRules/ruleTypeMapping?{query} |
Yes |
| getWebApplicationRulesRuleType(ruleType, search, body, iapMetadata, callback) |
Gets the list of cloud application rules by the type of rule. |
{base_path}/{version}/webApplicationRules/{pathv1}?{query} |
Yes |
| postWebApplicationRulesRuleType(ruleType, iapMetadata, callback) |
Adds a new cloud application rule. |
{base_path}/{version}/webApplicationRules/{pathv1}?{query} |
Yes |
| postWebApplicationRulesRuleTypeRuleId(ruleType, ruleId, name, iapMetadata, callback) |
Duplicates a Cloud App Control policy rule. |
{base_path}/{version}/webApplicationRules/{pathv1}/duplicate/{pathv2}?{query} |
Yes |
| getWebApplicationRulesRuleTypeRuleId(ruleType, ruleId, iapMetadata, callback) |
Gets a Cloud App Control policy rule by the rule type and ID. |
{base_path}/{version}/webApplicationRules/{pathv1}/{pathv2}?{query} |
Yes |
| putWebApplicationRulesRuleTypeRuleId(ruleType, ruleId, body, iapMetadata, callback) |
Updates the Cloud App Control policy rule. |
{base_path}/{version}/webApplicationRules/{pathv1}/{pathv2}?{query} |
Yes |
| deleteWebApplicationRulesRuleTypeRuleId(ruleType, ruleId, iapMetadata, callback) |
Deletes a Cloud App Control policy rule. |
{base_path}/{version}/webApplicationRules/{pathv1}/{pathv2}?{query} |
Yes |
| postForwardingRules(body, iapMetadata, callback) |
Adds a new forwarding rule. To learn more, see Configuring Forwarding Policy. |
{base_path}/{version}/forwardingRules?{query} |
Yes |
| getForwardingRulesRuleId(ruleId, iapMetadata, callback) |
Gets information for a forwarding rule using the specified ID |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| putForwardingRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates information for a forwarding rule using the specified ID |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| deleteForwardingRulesRuleId(ruleId, iapMetadata, callback) |
Deletes a forwarding rule using the specified ID |
{base_path}/{version}/forwardingRules/{pathv1}?{query} |
Yes |
| postZpaGateways(body, iapMetadata, callback) |
Adds a new custom ZPA gateway. The ZPA gateway can be used in a forwarding control policy to forwar |
{base_path}/{version}/zpaGateways?{query} |
Yes |
| getZpaGatewaysGatewayId(gatewayId, iapMetadata, callback) |
Gets information for a ZPA gateway using the specified ID |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| putZpaGatewaysGatewayId(gatewayId, body, iapMetadata, callback) |
Updates information for a ZPA gateway using the specified ID |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| deleteZpaGatewaysGatewayId(gatewayId, iapMetadata, callback) |
Deletes a ZPA gateway using the specified ID |
{base_path}/{version}/zpaGateways/{pathv1}?{query} |
Yes |
| getProxyGateways(iapMetadata, callback) |
Retrieves the proxy gateway information. To learn more, see About Gateways for Proxies. |
{base_path}/{version}/proxyGateways?{query} |
Yes |
| getProxyGatewaysLite(iapMetadata, callback) |
Retrieves the name and ID of the proxy. To learn more, see About Gateways for Proxies. |
{base_path}/{version}/proxyGateways/lite?{query} |
Yes |
| getAtpMalwareInspection(iapMetadata, callback) |
Retrieves the traffic inspection configurations of Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/atpMalwareInspection?{query} |
Yes |
| putAtpMalwareInspection(body, iapMetadata, callback) |
Updates the traffic inspection configurations of Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/atpMalwareInspection?{query} |
Yes |
| getAtpMalwareProtocols(iapMetadata, callback) |
Retrieves the protocol inspection configurations of Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/atpMalwareProtocols?{query} |
Yes |
| putAtpMalwareProtocols(body, iapMetadata, callback) |
Updates the protocol inspection configurations of Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/atpMalwareProtocols?{query} |
Yes |
| getMalwareSettings(iapMetadata, callback) |
Retrieves the malware protection policy configuration details |
{base_path}/{version}/cyberThreatProtection/malwareSettings?{query} |
Yes |
| putMalwareSettings(body, iapMetadata, callback) |
Updates the malware protection policy configuration details |
{base_path}/{version}/cyberThreatProtection/malwareSettings?{query} |
Yes |
| getMalwarePolicy(iapMetadata, callback) |
Retrieves information about the security exceptions configured for the Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/malwarePolicy?{query} |
Yes |
| putMalwarePolicy(iapMetadata, callback) |
Updates security exceptions for the Malware Protection policy |
{base_path}/{version}/cyberThreatProtection/malwarePolicy?{query} |
Yes |
| getAdvancedThreatSettings(iapMetadata, callback) |
Retrieves the advanced threat configuration settings in the ZIA Admin Portal |
{base_path}/{version}/cyberThreatProtection/advancedThreatSettings?{query} |
Yes |
| putAdvancedThreatSettings(body, iapMetadata, callback) |
Updates the advanced threat configuration settings. |
{base_path}/{version}/cyberThreatProtection/advancedThreatSettings?{query} |
Yes |
| getMaliciousUrls(iapMetadata, callback) |
Retrieves the malicious URLs added to the denylist in the Advanced Threat Protection (ATP) policy |
{base_path}/{version}/cyberThreatProtection/maliciousUrls?{query} |
Yes |
| putMaliciousUrls(body, iapMetadata, callback) |
Updates the malicious URLs added to the denylist in ATP policy |
{base_path}/{version}/cyberThreatProtection/maliciousUrls?{query} |
Yes |
| getSecurityExceptions(iapMetadata, callback) |
Retrieves information about the security exceptions configured for the ATP policy |
{base_path}/{version}/cyberThreatProtection/securityExceptions?{query} |
Yes |
| putSecurityExceptions(iapMetadata, callback) |
Updates security exceptions for the ATP policy. |
{base_path}/{version}/cyberThreatProtection/securityExceptions?{query} |
Yes |
| getfileTypeRules(iapMetadata, callback) |
Retrieves all the rules in the File Type Control policy. |
{base_path}/{version}/fileTypeRules?{query} |
Yes |
| postFileTypeRules(body, iapMetadata, callback) |
Adds a new File Type Control policy rule. |
{base_path}/{version}/fileTypeRules?{query} |
Yes |
| getLite(iapMetadata, callback) |
Retrieves all the rules in the File Type Control policy. |
{base_path}/{version}/fileTypeRules/lite?{query} |
Yes |
| getFileTypeRulesRuleId(ruleId, iapMetadata, callback) |
Retrieves the File Type Control policy rule information for the specified ID. |
{base_path}/{version}/fileTypeRules/{pathv1}?{query} |
Yes |
| putFileTypeRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates the File Type Control policy rule information for the specified ID. |
{base_path}/{version}/fileTypeRules/{pathv1}?{query} |
Yes |
| deleteFileTypeRulesRuleId(ruleId, iapMetadata, callback) |
Deletes a File Type Control policy rule information for the specified ID. |
{base_path}/{version}/fileTypeRules/{pathv1}?{query} |
Yes |
| getSandboxRules(iapMetadata, callback) |
Retrieves the list of all Sandbox policy rules configured in the ZIA Admin Portal. |
{base_path}/{version}/sandboxRules?{query} |
Yes |
| postSandboxRules(body, iapMetadata, callback) |
Adds a Sandbox policy rule. |
{base_path}/{version}/sandboxRules?{query} |
Yes |
| getSandboxRulesRuleId(ruleId, iapMetadata, callback) |
Retrieves the Sandbox policy rule information based on the specified ID |
{base_path}/{version}/sandboxRules/{pathv1}?{query} |
Yes |
| putSandboxRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates the Sandbox policy rule configuration for the specified ID |
{base_path}/{version}/sandboxRules/{pathv1}?{query} |
Yes |
| deleteSandboxRulesRuleId(ruleId, iapMetadata, callback) |
Deletes the Sandbox policy rule based on the specified ID |
{base_path}/{version}/sandboxRules/{pathv1}?{query} |
Yes |
| getBehavioralAnalysisAdvancedSettings(iapMetadata, callback) |
Gets the custom list of MD5 file hashes that are blocked by Sandbox |
{base_path}/{version}/behavioralAnalysisAdvancedSettings?{query} |
Yes |
| putBehavioralAnalysisAdvancedSettings(body, iapMetadata, callback) |
Updates the custom list of MD5 file hashes that are blocked by Sandbox. This overwrites a previousl |
{base_path}/{version}/behavioralAnalysisAdvancedSettings?{query} |
Yes |
| getBehavioralAnalysisAdvancedSettingsFileHashCount(iapMetadata, callback) |
Gets the used and unused quota for blocking MD5 file hashes with Sandbox |
{base_path}/{version}/behavioralAnalysisAdvancedSettings/fileHashCount?{query} |
Yes |
| getAdvancedUrlFilterAndCloudAppSettings(iapMetadata, callback) |
Retrieves information about URL and Cloud App Control advanced policy settings |
{base_path}/{version}/advancedUrlFilterAndCloudAppSettings?{query} |
Yes |
| putAdvancedUrlFilterAndCloudAppSettings(body, iapMetadata, callback) |
Updates the URL and Cloud App Control advanced policy settings |
{base_path}/{version}/advancedUrlFilterAndCloudAppSettings?{query} |
Yes |
| getFirewallDnsRules(iapMetadata, callback) |
Retrieves the list of DNS Control policy rules configured in the ZIA Admin Portal |
{base_path}/{version}/firewallDnsRules?{query} |
Yes |
| postFirewallDnsRules(body, iapMetadata, callback) |
Adds a new DNS Control policy rule. To learn more, see Configuring the DNS Control Policy. |
{base_path}/{version}/firewallDnsRules?{query} |
Yes |
| getFirewallDnsRulesRuleId(ruleId, iapMetadata, callback) |
Retrieves the DNS Control policy rule information based on the specified ID |
{base_path}/{version}/firewallDnsRules/{pathv1}?{query} |
Yes |
| putFirewallDnsRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates the DNS Control policy rule information based on the specified ID. To learn more about the |
{base_path}/{version}/firewallDnsRules/{pathv1}?{query} |
Yes |
| deleteFirewallDnsRulesRuleId(ruleId, iapMetadata, callback) |
Deletes the DNS Control policy rule information based on the specified ID |
{base_path}/{version}/firewallDnsRules/{pathv1}?{query} |
Yes |
| getFirewallIpsRules(iapMetadata, callback) |
Retrieves the list of IPS Control policy rules configured in the ZIA Admin Portal |
{base_path}/{version}/firewallIpsRules?{query} |
Yes |
| postFirewallIpsRules(body, iapMetadata, callback) |
Adds a new IPS Control policy rule. To learn more, see Configuring the IPS Control Policy. |
{base_path}/{version}/firewallIpsRules?{query} |
Yes |
| getFirewallIpsRulesRuleId(ruleId, iapMetadata, callback) |
Retrieves the IPS Control policy rule information based on the specified ID |
{base_path}/{version}/firewallIpsRules/{pathv1}?{query} |
Yes |
| putFirewallIpsRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates the IPS Control policy rule information based on the specified ID |
{base_path}/{version}/firewallIpsRules/{pathv1}?{query} |
Yes |
| deleteFirewallIpsRulesRuleId(ruleId, iapMetadata, callback) |
Deletes the IPS Control policy rule information based on the specified ID |
{base_path}/{version}/firewallIpsRules/{pathv1}?{query} |
Yes |
| getAdvancedSettings(iapMetadata, callback) |
Retrieves information about the advanced settings configured in the ZIA Admin Portal |
{base_path}/{version}/advancedSettings?{query} |
Yes |
| putAdvancedSettings(body, iapMetadata, callback) |
Updates the advanced settings configuration in the ZIA Admin Portal. To learn more, see Configuring |
{base_path}/{version}/advancedSettings?{query} |
Yes |
| getNssFeeds(iapMetadata, callback) |
Retrieves the cloud NSS feeds configured in the ZIA Admin Portal |
{base_path}/{version}/nssFeeds?{query} |
Yes |
| postNssFeeds(body, iapMetadata, callback) |
Adds a new cloud NSS feed. To learn more, see Adding Cloud NSS Feeds. |
{base_path}/{version}/nssFeeds?{query} |
Yes |
| getNssFeedsFeedId(feedId, iapMetadata, callback) |
Retrieves information about cloud NSS feed based on the specified ID |
{base_path}/{version}/nssFeeds/{pathv1}?{query} |
Yes |
| putNssFeedsFeedId(feedId, body, iapMetadata, callback) |
Updates cloud NSS feed configuration based on the specified ID. To learn more, see Adding Cloud NSS |
{base_path}/{version}/nssFeeds/{pathv1}?{query} |
Yes |
| deleteNssFeedsFeedId(feedId, cloudNss, iapMetadata, callback) |
Deletes cloud NSS feed configuration based on the specified ID |
{base_path}/{version}/nssFeeds/{pathv1}?{query} |
Yes |
| getNssFeedsFeedOutputDefaults(type, multiFeedType, fieldFormat, iapMetadata, callback) |
Retrieves the default cloud NSS feed output format for different log types |
{base_path}/{version}/nssFeeds/feedOutputDefaults?{query} |
Yes |
| getNssFeedsTestConnectivityFeedId(feedId, iapMetadata, callback) |
Tests the connectivity of cloud NSS feed based on the specified ID |
{base_path}/{version}/nssFeeds/testConnectivity/{pathv1}?{query} |
Yes |
| postNssFeedsValidateFeedFormat(type, iapMetadata, callback) |
Validates the cloud NSS feed format and returns the validation result |
{base_path}/{version}/nssFeeds/validateFeedFormat?{query} |
Yes |
| getOrgInformation(iapMetadata, callback) |
Retrieves detailed organization information, including headquarter location, geolocation, address, |
{base_path}/{version}/orgInformation?{query} |
Yes |
| getOrgInformationLite(iapMetadata, callback) |
Retrieves minimal organization information. |
{base_path}/{version}/orgInformation/lite?{query} |
Yes |
| getSubscriptions(iapMetadata, callback) |
Retrieves information about the list of subscriptions enabled for your tenant. Subscriptions define |
{base_path}/{version}/subscriptions?{query} |
Yes |
| getRemoteAssistance(iapMetadata, callback) |
Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal. Using |
{base_path}/{version}/remoteAssistance?{query} |
Yes |
| putRemoteAssistance(iapMetadata, callback) |
Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal. Using |
{base_path}/{version}/remoteAssistance?{query} |
Yes |
| getSslInspectionRules(iapMetadata, callback) |
Retrieves all SSL inspection rules |
{base_path}/{version}/sslInspectionRules?{query} |
Yes |
| postSslInspectionRules(body, iapMetadata, callback) |
Creates a new SSL inspection rule |
{base_path}/{version}/sslInspectionRules?{query} |
Yes |
| getSslInspectionRulesRuleId(ruleId, iapMetadata, callback) |
Retrieves the SSL inspection rule based on the specified ID |
{base_path}/{version}/sslInspectionRules/{pathv1}?{query} |
Yes |
| putSslInspectionRulesRuleId(ruleId, body, iapMetadata, callback) |
Updates the SSL inspection rule based on the specified ID |
{base_path}/{version}/sslInspectionRules/{pathv1}?{query} |
Yes |
| deleteSslInspectionRulesRuleId(ruleId, iapMetadata, callback) |
Deletes an existing SSL inspection rule based on the specified ID |
{base_path}/{version}/sslInspectionRules/{pathv1}?{query} |
Yes |
| getCloudApplicationsPolicy(search, pageSize, page, appClass, groupResults, iapMetadata, callback) |
Retrieves a list of Predefined and User Defined Cloud Applications associated with the DLP rules, C |
{base_path}/{version}/cloudApplications/policy?{query} |
Yes |
| getCloudApplicationsSslPolicy(search, pageSize, page, appClass, groupResults, iapMetadata, callback) |
Retrieves a list of Predefined and User Defined Cloud Applications associated with the SSL Inspecti |
{base_path}/{version}/cloudApplications/sslPolicy?{query} |
Yes |
| getAuthSettings(iapMetadata, callback) |
Retrieves the organization's default authentication settings information, including authentication |
{base_path}/{version}/authSettings?{query} |
Yes |
| putAuthSettings(body, iapMetadata, callback) |
Updates the organization's default authentication settings information. |
{base_path}/{version}/authSettings?{query} |
Yes |
| getAuthSettingsLite(iapMetadata, callback) |
Retrieves organization's default authentication settings information. |
{base_path}/{version}/authSettings/lite?{query} |
Yes |
| getTimeWindowsLite(iapMetadata, callback) |
Gets a name and ID dictionary of time intervals used by the Firewall policy or the URL Filtering po |
{base_path}/{version}/timeWindows/lite?{query} |
Yes |
| postAuthenticatedSession__v1(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| postAuthenticatedSession__v2(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| postAuthenticatedSession__v3(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| getWebApplicationRulesRuleTypeAvailableActions__v1(ruleType, body, iapMetadata, callback) |
Fetches the granular actions supported for the applications. |
{base_path}/{version}/webApplicationRules/{pathv1}/availableActions?{query} |
Yes |
| getNssFeedsFeedOutputDefaults__v1(type, multiFeedType, fieldFormat, iapMetadata, callback) |
Retrieves the default cloud NSS feed output format for different log types |
{base_path}/{version}/nssFeeds/feedOutputDefaults?{query} |
Yes |
| postAuthenticatedSession__v4(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| getWebApplicationRulesRuleTypeAvailableActions__v2(ruleType, body, iapMetadata, callback) |
Fetches the granular actions supported for the applications. |
{base_path}/{version}/webApplicationRules/{pathv1}/availableActions?{query} |
Yes |
| getNssFeedsFeedOutputDefaults__v2(type, multiFeedType, fieldFormat, iapMetadata, callback) |
Retrieves the default cloud NSS feed output format for different log types |
{base_path}/{version}/nssFeeds/feedOutputDefaults?{query} |
Yes |
| postAuthenticatedSession__v5(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| getWebApplicationRulesRuleTypeAvailableActions__v3(ruleType, body, iapMetadata, callback) |
Fetches the granular actions supported for the applications. |
{base_path}/{version}/webApplicationRules/{pathv1}/availableActions?{query} |
Yes |
| getNssFeedsFeedOutputDefaults__v3(type, multiFeedType, fieldFormat, iapMetadata, callback) |
Retrieves the default cloud NSS feed output format for different log types |
{base_path}/{version}/nssFeeds/feedOutputDefaults?{query} |
Yes |
| postAuthenticatedSession__v6(iapMetadata, callback) |
Creates an authenticated session. The response returns a cookie in the header called JSESSIONID tha |
{base_path}/{version}/authenticatedSession?{query} |
Yes |
| getWebApplicationRulesRuleTypeAvailableActions__v4(ruleType, body, iapMetadata, callback) |
Fetches the granular actions supported for the applications. |
{base_path}/{version}/webApplicationRules/{pathv1}/availableActions?{query} |
Yes |
| getNssFeedsFeedOutputDefaults__v4(type, multiFeedType, fieldFormat, iapMetadata, callback) |
Retrieves the default cloud NSS feed output format for different log types |
{base_path}/{version}/nssFeeds/feedOutputDefaults?{query} |
Yes |