{ "info": { "_postman_id": "58ff4216-281f-471e-9db4-09afe0416acb", "name": "OneAPI", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "21610169" }, "item": [ { "name": "Client Connector", "item": [ { "name": "Get all enrolled devices", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/getDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "getDevices" ], "query": [ { "key": "username", "value": "", "description": "Filter by enrolled user name for the device.", "disabled": true }, { "key": "osType", "value": "", "description": "Filter by device operating system type.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number.", "disabled": true }, { "key": "pageSize", "value": "50", "description": "Specifies the page size. If not provided, the default page size is 50. The max page size is 5000.", "disabled": true } ] }, "description": "Lists all enrolled devices of your organization and their basic details." }, "response": [] }, { "name": "Get details of enrolled devices", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/getDeviceDetails", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "getDeviceDetails" ], "query": [ { "key": "username", "value": "John Smith", "description": "Filter by enrolled user name for the device.", "disabled": true }, { "key": "udid", "value": "{{udid}}", "description": "Filter by unique device identifier.", "disabled": true } ] }, "description": "Lists device details of enrolled devices of your organization." }, "response": [] }, { "name": "Get the OTP for the specified device", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/getOtp", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "getOtp" ], "query": [ { "key": "udid", "value": "{{udid}}", "description": "Unique device identifier.", "disabled": true } ] }, "description": "Gets the one-time password (OTP) for a specific device. These passwords are unique, single-use, and tied to the device Unique Device Identifier (UDID). It is made of 10 random alphanumeric characters and can only be used once." }, "response": [] }, { "name": "Get the app profile password for the specified device", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/getPasswords", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "getPasswords" ], "query": [ { "key": "username", "value": "", "description": "Enrolled user for the device.", "disabled": true }, { "key": "osType", "value": "", "description": "Device operating system.", "disabled": true } ] }, "description": "Gets the app profile password for a specific device. You can determine the assigned global passwords by using the username and OS type of a device." }, "response": [] }, { "name": "Download device details as a CSV file", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/downloadDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "downloadDevices" ], "query": [ { "key": "osTypes", "value": "3", "description": "

Filter the list of devices by operating systems. The default value is null, which represents ALL OS types. The following values represent different OS types:

    \n
  • 1 - iOS
    • \n
  • 2 - Android
    • \n
  • 3 - Windows
    • \n
  • 4 - macOS
    • \n
  • 5 - Linux
\n

A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadDevices?osTypes=1,2

", "disabled": true }, { "key": "registrationTypes", "value": "1,2,3,4", "description": "

Filter the list of devices by registration types or states. The following values represent different device states:

    \n
  • 0 - All states except Removed
    • \n
  • 1 - Registered
    • \n
  • 3 - Removal pending
    • \n
  • 4 - Unregistered
    • \n
  • 5 - Removed
    • \n
  • 6 - Quarantined
\n

A sample API call:\n https://api-mobile.zscalerbeta.net/papi/public/v1/downloadDevices?registrationTypes=1,3

", "disabled": true } ] }, "description": "Downloads or exports device information as a CSV file." }, "response": [] }, { "name": "Download service status of all devices as a CSV file", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{ZCCBaseUrl}}/v1/downloadServiceStatus", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "downloadServiceStatus" ], "query": [ { "key": "osTypes", "value": "3", "description": "

Filter the list by operating systems. The default value is null, which represents ALL OS types. The following values represent different OS types:

    \n
  • 1 - iOS
    • \n
  • 2 - Android
    • \n
  • 3 - Windows
    • \n
  • 4 - macOS
    • \n
  • 5 - Linux
\n

A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadServiceStatus?osTypes=1,2

", "disabled": true }, { "key": "registrationTypes", "value": "4", "description": "

Filter the list by registration types or states. The following values represent different device states:

    \n
  • 0 - All states except Removed
    • \n
  • 1 - Registered
    • \n
  • 3 - Removal pending
    • \n
  • 4 - Unregistered
    • \n
  • 5 - Removed
    • \n
  • 6 - Quarantined
\n

A sample API call:\n https://api-mobile.zscalerbeta.net/papi/public/v1/downloadServiceStatus?registrationTypes=1,3

", "disabled": true } ] }, "description": "Downloads service status of all devices as a CSV file." }, "response": [] }, { "name": "Soft remove enrolled devices", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientConnectorVersion\": [\n \"\",\n \"\"\n ],\n \"osType\": \"\",\n \"udids\": [\n \"\",\n \"\"\n ],\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZCCBaseUrl}}/v1/removeDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "removeDevices" ], "query": [ { "key": "pageSize", "value": "30", "description": "Specifies the page size. If not provided, the default page size is 30. The max page size is 5000.", "disabled": true } ] }, "description": "

Soft removes the enrolled device from the portal. The soft removal marks the device state as device removal pending. At least one criterion (username, Client Connector version, OS type, or UDID) has to be specified to remove devices.

The following are the valid values for the osType attribute. The default value is null, which represents ALL OS types.

\n
    \n
  • 1 - iOS
    • \n
  • 2 - Android
    • \n
  • 3 - Windows
    • \n
  • 4 - macOS
    • \n
  • 5 - Linux
" }, "response": [] }, { "name": "Force remove enrolled devices", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientConnectorVersion\": [\n \"3.2.0.87\"\n ],\n \"osType\": \"3\",\n \"udids\": [\n \"johnsmith@acme.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZCCBaseUrl}}/v1/forceRemoveDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "forceRemoveDevices" ], "query": [ { "key": "pageSize", "value": "30", "description": "Specifies the page size. If not provided, the default page size is 30.", "disabled": true } ] }, "description": "

Force removes the enrolled device from the portal. You can only remove devices that are in registered or device removal pending state. At least one criterion (username, Client Connector version, OS type, or UDID) has to be specified to remove devices.

The following are the valid values for the osType attribute. The default value is null, which represents ALL OS types.

\n
    \n
  • 1 - iOS
    • \n
  • 2 - Android
    • \n
  • 3 - Windows
    • \n
  • 4 - macOS
    • \n
  • 5 - Linux
" }, "response": [] }, { "name": "Update profile policy rule passwords", "protocolProfileBehavior": { "disableCookies": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"policyName\": \"\",\n \"deviceType\": \"\",\n \"companyId\": \"\",\n \"exitPass\": \"\",\n \"logoutPass\": \"\",\n \"uninstallPass\": \"\",\n \"zadDisablePass\": \"\",\n \"zdpDisablePass\": \"\",\n \"zdxDisablePass\": \"\",\n \"ziaDisablePass\": \"\",\n \"zpaDisablePass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZCCBaseUrl}}/v1/managePass", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "v1", "managePass" ] }, "description": "

Updates profile policy rule passwords. The JSON Web Token (JWT) passed in as a header must be associated with a user who has Full access to Client Connector App Profiles with an API key created with Write access. To learn more, see Adding Roles and Adding an API Key.

" }, "response": [] } ] }, { "name": "Cloud & Branch Connector", "item": [ { "name": "Activation", "item": [ { "name": "Activation - Activate", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus/activate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus", "activate" ] } }, "response": [] }, { "name": "Activation - Status", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus" ] } }, "response": [] }, { "name": "Activation - Force Activate", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus/forcedActivate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus", "forcedActivate" ] } }, "response": [] } ] }, { "name": "Admin and Role Management", "item": [ { "name": "Admin and Role Management - Get All Admin Roles", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/adminRoles", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles" ], "query": [ { "key": "includeAuditorRole", "value": "", "description": "[ Optional ] Value is Boolean, default value is false", "disabled": true }, { "key": "includePartnerRole", "value": "", "description": "[ Optional ] Value is Boolean, default value is true", "disabled": true }, { "key": "includeApiRole", "value": "", "description": "[ Optional ] Value is Boolean, default value is true", "disabled": true }, { "key": "id", "value": "", "description": "[ Optional] role ids to fetch", "disabled": true } ] } }, "response": [] }, { "name": "Admin and Role Management - Get Individual Admin Role", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/adminRoles?id={roleId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles" ], "query": [ { "key": "id", "value": "{roleId}" } ] } }, "response": [] }, { "name": "Admin and Role Management - Create Admin Role", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"rank\": \"7\",\n \"name\": \"NEWROLENAME\",\n \"policyAccess\": \"NONE\",\n \"alertingAccess\": \"READ_ONLY\",\n \"dashboardAccess\": \"NONE\",\n \"reportAccess\": \"NONE\",\n \"analysisAccess\": \"NONE\",\n \"usernameAccess\": \"NONE\",\n \"deviceInfoAccess\": \"NONE\",\n \"adminAcctAccess\": \"READ_WRITE\",\n \"featurePermissions\": {\n \"APIKEY_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_CLOUD_PROVISIONING\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_LOCATION_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_DASHBOARD\": \"READ_ONLY\",\n \"EDGE_CONNECTOR_FORWARDING\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_TEMPLATE\": \"READ_WRITE\",\n \"REMOTE_ASSISTANCE_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_ADMIN_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_NSS_CONFIGURATION\": \"READ_WRITE\"\n },\n \"roleType\": \"EDGE_CONNECTOR_ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/adminRoles", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles" ] } }, "response": [] }, { "name": "Admin and Role Management - Update Individual Admin Role", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"rank\": \"7\",\n \"name\": \"ROLENAME\",\n \"policyAccess\": \"NONE\",\n \"alertingAccess\": \"READ_ONLY\",\n \"dashboardAccess\": \"NONE\",\n \"reportAccess\": \"NONE\",\n \"analysisAccess\": \"NONE\",\n \"usernameAccess\": \"NONE\",\n \"deviceInfoAccess\": \"NONE\",\n \"adminAcctAccess\": \"READ_WRITE\",\n \"featurePermissions\": {\n \"APIKEY_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_CLOUD_PROVISIONING\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_LOCATION_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_DASHBOARD\": \"READ_ONLY\",\n \"EDGE_CONNECTOR_FORWARDING\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_TEMPLATE\": \"READ_WRITE\",\n \"REMOTE_ASSISTANCE_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_ADMIN_MANAGEMENT\": \"READ_WRITE\",\n \"EDGE_CONNECTOR_NSS_CONFIGURATION\": \"READ_WRITE\"\n },\n \"roleType\": \"EDGE_CONNECTOR_ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/adminRoles/{roleId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles", "{roleId}" ] } }, "response": [] }, { "name": "Admin and Role Management - Delete Individual Admin Role", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/adminRoles/{roleId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles", "{roleId}" ] } }, "response": [] }, { "name": "Admin and Role Management - Get All Users", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers" ], "query": [ { "key": "includeAuditorUsers", "value": "", "disabled": true }, { "key": "includeAdminUsers", "value": "", "description": "Default value = true", "disabled": true } ] } }, "response": [] }, { "name": "Admin and Role Management - Get Individual User", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/{userId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", "{userId}" ] } }, "response": [] }, { "name": "Admin and Role Management - Update Individual User", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"id\": \"USERID\", // Integer\n \"userName\": \"NEWUSERNAME\",\n \"loginName\": \"NEWLOGINNAME\",\n \"password\": \"NEWPASSWORD\",\n \"email\": \"NEWEMAIL\",\n \"role\": {\n \"id\": \"ROLEID\",\n \"name\": \"ROLENAME\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/{userId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", "{userId}" ] } }, "response": [] }, { "name": "Admin and Role Management - Delete Individual User", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/{userId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", "{userId}" ] } }, "response": [] }, { "name": "Admin and Role Management - Create User", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"userName\": \"NEWUSERNAME\",\n \"loginName\": \"NEWLOGINNAME\",\n \"password\": \"NEWPASSWORD\",\n \"email\": \"NEWEMAIL\",\n \"role\": {\n \"id\": \"ROLEID\",\n \"name\": \"ROLENAME\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/adminUsers", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers" ] } }, "response": [] }, { "name": "Admin and Role Management - Change Password", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"userName\": \"{{username}}\",\n \"oldPassword\": \"{{password}}\",\n \"newPassword\": \"YOURNEWPASSWORD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/passwordChange", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "passwordChange" ] } }, "response": [] } ] }, { "name": "Authentication", "item": [ { "name": "Authentication - Status", "event": [ { "listen": "prerequest", "script": { "exec": [ "var timestamp = Date.now().toString();", "var initialVal = pm.environment.get('apikey');", "postman.setEnvironmentVariable(\"timestamp\", timestamp);", "postman.setEnvironmentVariable(\"obfApiKey\", obfuscateApiKey(initialVal, timestamp));", "function obfuscateApiKey(apiKey, timestamp) {", " ", " var high = timestamp.substring(timestamp.length - 6);", " var low = (parseInt(high) >> 1).toString();", " var obfuscatedApiKey = '';", " ", " while (low.length < 6) {", " low = '0' + low;", " }", " ", " for (var i = 0; i < high.length; i++) {", " obfuscatedApiKey += apiKey.charAt(parseInt(high.charAt(i)));", " }", " ", " for (var j = 0; j < low.length; j++) {", " obfuscatedApiKey += apiKey.charAt(parseInt(low.charAt(j)) + 2);", " }", " ", " return \"\\\"\"+obfuscatedApiKey+\"\\\"\";", "}", "" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "// Capturing ZS_SESSION_CODE token", "var sessionCode = postman.getResponseCookie(\"ZS_SESSION_CODE\").value;", "pm.environment.set(\"sessionCode\", sessionCode);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/auth", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "auth" ] }, "description": "Please change key in pre-req script and credentials in Body.\r\nLogin to the EC using valid api key and credentials." }, "response": [] } ] }, { "name": "Cloud & Branch Connector Groups", "item": [ { "name": "Cloud & Branch Connector Groups - Get All Groups and VMs", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup" ], "query": [ { "key": "deployType", "value": "", "description": "ENUM, possible values = CLOUD, ONPREM, ONPREM_PHYSICAL ", "disabled": true } ] } }, "response": [] }, { "name": "Cloud & Branch Connector Groups - Get All Groups and VMs (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "lite" ] } }, "response": [] }, { "name": "Cloud & Branch Connector Groups - Get Individual Group and VMs", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "{id}" ] } }, "response": [] }, { "name": "Cloud & Branch Connector Groups - Get Individual VM", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/{id}/vm/{vmId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "{id}", "vm", "{vmId}" ] }, "description": "Please provide the id of the ecGroup and vm" }, "response": [] }, { "name": "Cloud & Branch Connector Groups - Delete Individual VM", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/{id}/vm/{vmId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "{id}", "vm", "{vmId}" ] } }, "response": [] }, { "name": "Cloud & Branch Connector Groups - Get All EC Instances (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecInstance/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecInstance", "lite" ] } }, "response": [] } ] }, { "name": "Forwarding Gateways", "item": [ { "name": "Forwarding Gateways - Get all Gateways", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/gateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways" ], "query": [ { "key": "type", "value": "", "description": "Enum Possible value = PROXYCHAIN, ZIA, ECSELF", "disabled": true } ] } }, "response": [] }, { "name": "Forwarding Gateways - Get all Gateways (Lite)", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/gateways/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", "lite" ], "query": [ { "key": "type", "value": "", "description": "Enum Possible value = ZIA, ECSELF", "disabled": true } ] } }, "response": [] }, { "name": "Forwarding Gateways - Create Gateway", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"GATEWAYNAME\",\n \"type\": \"ECSELF\", // Enum Possible value = ECSELF and ZIA.\n \"description\": \"GATEWAYDESCRIPTION\",\n \"primaryType\": \"AUTO\",\n \"secondaryType\": \"AUTO\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/gateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways" ] } }, "response": [] }, { "name": "Forwarding Gateways - Delete Gateway", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/gateways/{gatewayId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", "{gatewayId}" ] } }, "response": [] } ] }, { "name": "Location Management", "item": [ { "name": "Location Management - Get All Locations", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/location", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location" ], "query": [ { "key": "state", "value": "", "disabled": true }, { "key": "sslScanEnabled", "value": "", "disabled": true }, { "key": "xffEnabled", "value": "", "disabled": true }, { "key": "authRequired", "value": "", "disabled": true }, { "key": "bwEnforced", "value": "", "disabled": true }, { "key": "enforceAup", "value": "", "disabled": true }, { "key": "enableFirewall", "value": "", "disabled": true }, { "key": "includeOnlyBcLocation", "value": "", "disabled": true }, { "key": "locationType", "value": "", "description": "valid value : WORKLOAD", "disabled": true } ] } }, "response": [] }, { "name": "Location Management - Get Individual Location", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ZTWBaseUrl}}/location/{locationId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location", "{locationId}" ] } }, "response": [] }, { "name": "Location Management - Get All Locations (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/location/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location", "lite" ], "query": [ { "key": "includeParentLocations", "value": "", "description": "default : true", "disabled": true }, { "key": "includeDefaultLocation", "value": "", "description": "default : true", "disabled": true }, { "key": "includeOnlyBcLocation", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Location Management - Get All Location Templates", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate" ] } }, "response": [] }, { "name": "Location Management - Get All Location Templates (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", "lite" ] } }, "response": [] }, { "name": "Location Management - Get Individual Location Template", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/{locTempId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", "{locTempId}" ] } }, "response": [] }, { "name": "Location Management - Create Location Template", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"Test_Location_Template\",\r\n \"desc\": \"Testing\",\r\n \"template\": {\r\n \"templatePrefix\": \"temp\",\r\n \"xffForwardEnabled\": false,\r\n \"authRequired\": true,\r\n \"cautionEnabled\": false,\r\n \"aupEnabled\": false,\r\n \"ofwEnabled\": false,\r\n \"ipsControl\": false,\r\n \"enforceBandwidthControl\": true,\r\n \"upBandwidth\": 5000,\r\n \"dnBandwidth\": 10000\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate" ] } }, "response": [] }, { "name": "Location Management - Update Individual Location Template", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"id\": 100,\n \"name\": \"Test_Location_Template\",\n \"desc\": \"Testing\",\n \"template\": {\n \"templatePrefix\": \"temp\",\n \"xffForwardEnabled\": false,\n \"authRequired\": true,\n \"cautionEnabled\": false,\n \"aupEnabled\": false,\n \"ofwEnabled\": false,\n \"ipsControl\": false,\n \"enforceBandwidthControl\": true,\n \"upBandwidth\": 5000,\n \"dnBandwidth\": 10000\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/{locTempId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", "{locTempId}" ] } }, "response": [] }, { "name": "Location Management - Delete Individual Location Template", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/{locTempId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", "{locTempId}" ] } }, "response": [] } ] }, { "name": "Policy Management", "item": [ { "name": "Policy Management - Get All Traffic Forwarding Rules", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr" ] } }, "response": [] }, { "name": "Policy Management - Get All Traffic Forwarding Rules Count", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", "count" ], "query": [ { "key": "predefinedRuleCount", "value": "", "description": "default : false", "disabled": true } ] } }, "response": [] }, { "name": "Policy Management - Create Traffic Forwarding Rule", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"description\": \"description\",\n \"forwardMethod\": \"DIRECT\", // other valid values : ZIA, ZPA, DROP\n \"order\": 8,\n \"rank\" : 7,\n \"name\": \"FWD_RULE_DIRECT\",\n \"type\": \"EC_RDR\",\n \"locations\": [\n {\n \"id\": 100,\n \"name\": \"loc1\"\n }\n ],\n \"nwServices\": [\n {\n \"id\": 200,\n \"name\": \"FTP\"\n }\n ],\n \"destAddresses\": [\n \"2.2.2.2\"\n ],\n \"destIpGroups\": [\n {\n \"id\": 300,\n \"name\": \"dst-grp\"\n }\n ],\n \"srcIps\": [\n \"1.1.1.1\"\n ],\n \"srcIpGroups\": [\n {\n \"id\": 400,\n \"name\": \"src-grp\"\n }\n ],\n \"wanSelection\": \"BALANCED_RULE\", // other valid value : BESTLINK_RULE\n \"appServiceGroups\": [\n {\n \"name\": \"GCP\",\n \"id\": \"9\"\n }\n ],\n \"state\": \"ENABLED\"\n\n /*\n \n For ZIA : \n \"proxyGateway\" : {\n \"id\": 1000,\n \"name\": \"default\"\n }\n\n For ZPA :\n \"zpaApplicationSegmentGroups\": []\n \"zpaApplicationSegments\": []\n */\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr" ] } }, "response": [] }, { "name": "Policy Management - Update Traffic Forwarding Rule", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"description\": \"description\",\n \"forwardMethod\": \"DIRECT\", // other valid values : ZIA, ZPA, DROP\n \"order\": 8,\n \"rank\" : 7,\n \"name\": \"FWD_RULE_DIRECT\",\n \"type\": \"EC_RDR\",\n \"locations\": [\n {\n \"id\": 100,\n \"name\": \"loc1\"\n }\n ],\n \"nwServices\": [\n {\n \"id\": 200,\n \"name\": \"FTP\"\n }\n ],\n \"destAddresses\": [\n \"2.2.2.2\"\n ],\n \"destIpGroups\": [\n {\n \"id\": 300,\n \"name\": \"dst-grp\"\n }\n ],\n \"srcIps\": [\n \"1.1.1.1\"\n ],\n \"srcIpGroups\": [\n {\n \"id\": 400,\n \"name\": \"src-grp\"\n }\n ],\n \"wanSelection\": \"BALANCED_RULE\", // other valid value : BESTLINK_RULE\n \"appServiceGroups\": [\n {\n \"name\": \"GCP\",\n \"id\": \"9\"\n }\n ],\n \"state\": \"ENABLED\"\n\n /*\n \n For ZIA : \n \"proxyGateway\" : {\n \"id\": 1000,\n \"name\": \"default\"\n }\n\n For ZPA :\n \"zpaApplicationSegmentGroups\": []\n \"zpaApplicationSegments\": []\n */\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/{ruleId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", "{ruleId}" ] } }, "response": [] } ] }, { "name": "Provisioning", "item": [ { "name": "Provisioning - Get Public Cloud Account Details", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails" ] } }, "response": [] }, { "name": "Provisioning - Get Public Cloud Account Details (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails", "lite" ] } }, "response": [] }, { "name": "Provisioning - Get Individual Public Cloud Account Details", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails/{publicCloudAccountId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails", "{publicCloudAccountId}" ] } }, "response": [] }, { "name": "Provisioning - Get Public Cloud Account Import Status", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountIdStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountIdStatus" ] } }, "response": [] }, { "name": "Provisioning - Enable or Disable Public Cloud Account Import", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"accountIdEnabled\": true,\n \"subIdEnabled\": true,\n \"projectIdEnabled\": false \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountIdStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountIdStatus" ] } }, "response": [] }, { "name": "Provisioning - Get Individual Provisioning Template", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/provUrl/{provId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "provUrl", "{provId}" ] } }, "response": [] }, { "name": "Provisioning - Get All Provisioning Templates", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/provUrl", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "provUrl" ] } }, "response": [] } ] }, { "name": "Policy Resources", "item": [ { "name": "Network Services", "item": [ { "name": "Filtering - Get All Network Services", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices" ] } }, "response": [] }, { "name": "Filtering - Create Network Service", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"NETWORKSERVICENAME\",\n \"description\": \"NETWORKSERVICEDESCRIPTION\",\n \"type\": \"CUSTOM\",\n \"srcUdpPorts\": [\n {\n \"start\": 1090,\n \"end\": 1095\n }\n ],\n \"destUdpPorts\": [\n {\n \"start\": 2090,\n \"end\": 2095\n }\n ],\n \"srcTcpPorts\": [\n {\n \"start\": 3090,\n \"end\": 3095\n }\n ],\n \"destTcpPorts\": [\n {\n \"start\": 4090,\n \"end\": 4095\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/networkServices", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices" ] } }, "response": [] }, { "name": "Filtering - Update Network Service", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"NETWORKSERVICENAME\",\n \"description\": \"NETWORKSERVICEDESCRIPTION\",\n \"type\": \"CUSTOM\",\n \"srcUdpPorts\": [\n {\n \"start\": 1090,\n \"end\": 1095\n }\n ],\n \"destUdpPorts\": [\n {\n \"start\": 2090,\n \"end\": 2095\n }\n ],\n \"srcTcpPorts\": [\n {\n \"start\": 3090,\n \"end\": 3095\n }\n ],\n \"destTcpPorts\": [\n {\n \"start\": 4090,\n \"end\": 4095\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/networkServices/{networkServiceId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices", "{networkServiceId}" ] } }, "response": [] }, { "name": "Filtering - Delete Network Service", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices/{networkServiceId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices", "{networkServiceId}" ] } }, "response": [] }, { "name": "Filtering - Get All Network Service Groups", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups" ] } }, "response": [] } ] }, { "name": "Source IP Groups", "item": [ { "name": "Filtering - Get All Source IP Groups", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups" ] } }, "response": [] }, { "name": "Filtering - Get All Source IP Groups (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", "lite" ] } }, "response": [] }, { "name": "Filtering - Create Source IP Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"IPSOURCEGROUPNAME\",\n \"description\": \"IPSOURCEGROUPDESCRIPTION\",\n \"ipAddresses\": [\n \"1.1.1.1\",\n \"2.2.2.2 - 2.2.2.255\",\n \"3.3.3.0/24\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups" ] } }, "response": [] }, { "name": "Filtering - Delete Source IP Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/{ipSourceGroupId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", "{ipSourceGroupId}" ] } }, "response": [] } ] }, { "name": "Destination IP Groups", "item": [ { "name": "Filtering - Get All Destination IP Groups", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups" ], "query": [ { "key": "excludeType", "value": "String", "description": "[Optional] valid values : DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER", "disabled": true } ] } }, "response": [] }, { "name": "Filtering - Get All Destination IP Groups (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", "lite" ], "query": [ { "key": "type", "value": "", "description": "[ Optional ] Value is List of DestinationGroupType enum, possible values are DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER", "disabled": true }, { "key": "excludeType", "value": "", "description": "[ Optional ] Value is DestinationGroupType enum, possible values are DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER", "disabled": true }, { "key": "includeZscalerDomains", "value": "", "description": "[ Optional ] Value is of Boolean ", "disabled": true } ] } }, "response": [] }, { "name": "Filtering - Create Destination IP Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"IPDESTINATIONGROUPNAME\",\n \"description\": \"IPDESTINATIONGROUPDESCRIPTION\",\n \"type\": \"DSTN_IP\", // enum possible values = DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER\n \"addresses\": [\n \"1.1.1.1\",\n \"2.2.2.2 - 2.2.2.255\",\n \"3.3.3.0/24\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups" ] } }, "response": [] }, { "name": "Filtering - Delete Destination IP Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-length": true } }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/{ipGroupId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", "{ipGroupId}" ] } }, "response": [] } ] }, { "name": "IP Pools/Groups", "item": [ { "name": "Filtering - Get All IP Pools/Groups", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups" ] } }, "response": [] }, { "name": "Filtering - Get All IP Pools/Groups (Lite)", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", "lite" ] } }, "response": [] }, { "name": "Filtering - Create IP Pool/Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"IPGROUPNAME\",\n \"description\": \"IPGROUPDESCRIPTION\",\n \"ipAddresses\": [\n \"1.1.1.1-1.1.1.5\" //only 1 range allowed.\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/ipGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups" ] } }, "response": [] }, { "name": "Filtering - Delete IP Pool/Group", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/{ipGroupId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", "{ipGroupId}" ] } }, "response": [] } ] }, { "name": "ZPA Application Segments", "item": [ { "name": "Policy Management - Get All ZPA Application Segments", "event": [ { "listen": "test", "script": { "exec": [ "tests[\"Status code is 200\"] = responseCode.code === 200;" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/zpaResources/applicationSegments", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "zpaResources", "applicationSegments" ] } }, "response": [] } ] } ] }, { "name": "Partner Integrations", "item": [ { "name": "AWS Accounts", "item": [ { "name": "Partner Integrations - Get all AWS Accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo" ] } }, "response": [] }, { "name": "Partner Integrations - Get all AWS Accounts (Lite)", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "lite" ] } }, "response": [] }, { "name": "Partner Integrations - Get Individual AWS Account", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "{id}" ] } }, "response": [] }, { "name": "Partner Integrations - Get Supported AWS Regions", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/supportedRegions", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "supportedRegions" ] } }, "response": [] }, { "name": "Partner Integrations - Get AWS Accounts Count", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "count" ] } }, "response": [] }, { "name": "Partner Integrations - Get Cloud Formation Template", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/cloudFormationTemplate?awsAccountId={awsAccountId}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "cloudFormationTemplate" ], "query": [ { "key": "awsAccountId", "value": "{awsAccountId}" } ] } }, "response": [] }, { "name": "Partner Integrations - Generate External Id for AWS Account", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"awsAccountId\": \"123456789012\",\n \"awsRoleName\": \"awsRoleName\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/generateExternalId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "generateExternalId" ] } }, "response": [] }, { "name": "Partner Integrations - Create AWS Account", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"aws-account-1\",\n \"accountDetails\": {\n \"awsAccountId\": \"123456789012\",\n \"awsRoleName\": \"awsRoleName\"\n },\n \"supportedRegions\": [\n {\n \"id\": 200\n },\n {\n \"id\": 201\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo" ] } }, "response": [] }, { "name": "Partner Integrations - Update Individual AWS Account", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"id\": 100,\n \"name\": \"aws-account-1\",\n \"cloudType\": \"AWS\",\n \"externalId\": \"5a8d56be3dbd5267bba859e1eac262f0\",\n \"accountDetails\": {\n \"awsAccountId\": \"123456789012\",\n \"awsRoleName\": \"awsRoleName\"\n },\n \"supportedRegions\": [\n {\n \"id\": 200\n },\n {\n \"id\": 201\n }\n ],\n \"lastModUser\": {\n \"id\": 300,\n \"name\": \"bac-admin@1100.zscaler.net\"\n },\n \"lastModTime\": 1754643393,\n \"accountGroups\": null,\n \"regionStatus\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "{id}" ] } }, "response": [] }, { "name": "Partner Integrations - Delete Individual AWS Account", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "{id}" ] } }, "response": [] }, { "name": "Partner Integrations - Enable/Disable Individual AWS Account", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/{id}/changeState?enable=true", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "{id}", "changeState" ], "query": [ { "key": "enable", "value": "true" } ] } }, "response": [] }, { "name": "Partner Integrations - Get Workload Discovery Settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/discoveryService/workloadDiscoverySettings", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "discoveryService", "workloadDiscoverySettings" ] } }, "response": [] }, { "name": "Partner Integrations - Update Individual AWS Account Permission", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"discoveryRole\": \"awsRoleName\",\n \"externalId\": \"5a8d56be3dbd5267bba859e1eac262f0\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/discoveryService/{id}/permissions", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "discoveryService", "{id}", "permissions" ] } }, "response": [] } ] }, { "name": "AWS Account Groups", "item": [ { "name": "Partner Integrations - Get all AWS Account Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups" ] } }, "response": [] }, { "name": "Partner Integrations - Get Individual AWS Account Group", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "{id}" ] } }, "response": [] }, { "name": "Partner Integrations - Get all AWS Account Groups (Lite)", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "lite" ] } }, "response": [] }, { "name": "Partner Integrations - Get AWS Account Groups Count", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "count" ] } }, "response": [] }, { "name": "Partner Integrations - Create AWS Account Group", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"aws-account-group-1\",\n \"description\": \"description\",\n \"cloudType\": \"AWS\",\n \"cloudConnectorGroups\": [\n {\n \"id\": 291265\n }\n ],\n \"publicCloudAccounts\": [\n {\n \"id\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/accountGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups" ] } }, "response": [] }, { "name": "Partner Integrations - Update Individual AWS Account Group", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"aws-account-group-1\",\n \"description\": \"description\",\n \"cloudType\": \"AWS\",\n \"cloudConnectorGroups\": [\n {\n \"id\": 291265\n }\n ],\n \"publicCloudAccounts\": [\n {\n \"id\": 100\n },\n {\n \"id\": 101\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "{id}" ] } }, "response": [] }, { "name": "Partner Integrations - Delete Individual AWS Account Group", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/{id}", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "{id}" ] } }, "response": [] } ] } ] } ] }, { "name": "Zscaler Digital Experience (ZDX)", "item": [ { "name": "authentication", "item": [] }, { "name": "administration", "item": [ { "name": "/administration/departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/administration/departments", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "administration", "departments" ] }, "description": "Get departments registered by tenant" }, "response": [] }, { "name": "/administration/locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/administration/locations", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "administration", "locations" ] }, "description": "Get Zscaler locations for the tenant. All configured Zscaler locations are returned if the filters are not given" }, "response": [] }, { "name": "/active_geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/active_geo", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "active_geo" ] }, "description": "Gets the list of all active geolocations for a tenant for the time range specified. The endpoint defaults to the last 2 hours if not provided. The active geolocations will retrieve State and City data for the US only." }, "response": [] } ] }, { "name": "reports", "item": [ { "name": "apps", "item": [ { "name": "{appid}", "item": [ { "name": "users", "item": [ { "name": "apps/{{appID}}/users", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"appUserID\", pm.response.json()[\"users\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/apps/{{appID}}/users", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "apps", "{{appID}}", "users" ] }, "description": "Gets the list of all users and their devices for an application for the time range specified. The endpoint defaults to the last 2 hours if not provided. The endpoint allows to get the list of users by Score bucket i.e. Poor, OK, Good. If not specified, it defaults to poor. The endpoint gets the list of all users, the devices, their active geolocations and Zscaler location." }, "response": [] }, { "name": "apps/{{appID}}/users/{userid}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/apps/{{appID}}/users/{{userID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "apps", "{{appID}}", "users", "{{userID}}" ] }, "description": "Gets the user's details including the device information, active geolocations and Zscaler locations for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] } ] }, { "name": "apps/{appID}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/apps/{{appID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "apps", "{{appID}}" ] }, "description": "Gets the application's ZDX score (default 2 hours period), most impacted locations and total number of users impacted." }, "response": [] }, { "name": "apps/{appID}/metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/apps/{{appID}}/metrics", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "apps", "{{appID}}", "metrics" ] }, "description": "Gets the application's metric trend for the time range specified. The endpoint defaults to the last 2 hours if not provided. For Web Probes, you can access Page Fetch Time, Server Response Time, DNS Time or Availability. If not specified, it defaults to Page Fetch Time (PFT). For CloudPath Probes, you can access latency metrics for End to End, Client - Egress, Egress - Application, ZIA Service Edge - Egress, ZIA Service Edge - Application. If not specified, it defaults to End to End latency." }, "response": [] } ] }, { "name": "/apps", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"appID\", pm.response.json()[1].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/apps", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "apps" ] }, "description": "Lists all active applications configured for a tenant. The endpoint gets each application's ZDX score (default 2 hours period), most impacted location and total number of users impacted." }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "devices", "item": [ { "name": "{deviceid}", "item": [ { "name": "apps", "item": [ { "name": "{appid}", "item": [ { "name": "cloudpath-probes", "item": [ { "name": "/devices/{deviceID}/apps/{appid}/cloudpath-probes", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"cloudProbeId\", pm.response.json()[0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/cloudpath-probes", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "cloudpath-probes" ] }, "description": "Gets the list of all active CloudPath probes on a device for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] }, { "name": "/devices/{deviceID}/apps/{appid}/cloudpath-probes/{probeid}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/cloudpath-probes/{{cloudProbeId}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "cloudpath-probes", "{{cloudProbeId}}" ] }, "description": "Gets the CloudPath hop data for an application on a specific device for the time range specified. The endpoint defaults to the last 2 hours if not provided. The CloudPath includes the summary data for the entire path like the total number of hops, packet loss, latency and tunnel type if available. This also includes a similar summary of data for each individual hop." }, "response": [] }, { "name": "/devices/{deviceID}/apps/{appid}/cloudpath-probes/{probeid}/cloudpath Copy", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/cloudpath-probes/{{cloudProbeId}}/cloudpath", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "cloudpath-probes", "{{cloudProbeId}}", "cloudpath" ] }, "description": "Gets the CloudPath hop data for an application on a specific device for the time range specified. The endpoint defaults to the last 2 hours if not provided. The CloudPath includes the summary data for the entire path like the total number of hops, packet loss, latency and tunnel type if available. This also includes a similar summary of data for each individual hop." }, "response": [] } ] }, { "name": "web-probes", "item": [ { "name": "/devices/{deviceID}/apps/{appid}/web-probes", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"webProbeId\", pm.response.json()[0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/web-probes", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "web-probes" ] }, "description": "Gets the list of all active web probes on a device for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] }, { "name": "/devices/{deviceID}/apps/{appid}/web-probes/{probeid}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/web-probes/{{webProbeId}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "web-probes", "{{webProbeId}}" ] }, "description": "Gets the Web Probe's metric trend on a device for an application for the time range specified. The endpoint defaults to the last 2 hours if not provided. For Web Probes, you can access Page Fetch Time, Server Response Time, DNS Time or Availability. If not specified, it defaults to Page Fetch Time (PFT)." }, "response": [] } ] }, { "name": "/devices/{deviceID}/apps/{deviceAppID}/", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}" ] }, "description": "Gets the application's ZDX score trend on a device for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] }, { "name": "/devices/{deviceID}/apps/{deviceAppID}/call-quality-metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps/{{deviceAppID}}/call-quality-metrics", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps", "{{deviceAppID}}", "call-quality-metrics" ] }, "description": "Gets the Call Quality metric trend on a device for a CQM application for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] } ] }, { "name": "/devices/{deviceID}/apps", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"deviceAppID\", pm.response.json()[1].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/apps", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "apps" ] }, "description": "Lists all active applications for the device. The endpoint gets each application's ZDX score (default 2 hours period)." }, "response": [] } ] }, { "name": "devices/{deviceID}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}" ] }, "description": "Gets the device details including device model information, tunnel type, network and software details. The endpoint defaults to the last 2 hours if not provided. Note- The JSON should include the user's ID and email to associate the device to a user." }, "response": [] } ] }, { "name": "/devices", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"deviceID\", pm.response.json()[\"devices\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "userids", "value": "{{userID}}", "type": "text", "disabled": true } ], "url": { "raw": "{{ZDXBaseUrl}}/devices", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices" ], "query": [ { "key": "emails", "value": "curtis.hardwick@safemarch.com", "description": "Start of the queried time period, seconds since the Unix epoch", "disabled": true }, { "key": "userids", "value": "39920403", "disabled": true } ] }, "description": "Gets the list of all active devices and its basic details for the time range specified. The endpoint defaults to the last 2 hours if not provided. Note - The JSON should include the user's ID and email to associate the device to a user." }, "response": [] } ] }, { "name": "users", "item": [ { "name": "/users", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"userID\", pm.response.json()[\"users\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/users", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "users" ], "query": [ { "key": "offset", "value": "NDI3MzU4ODU=", "disabled": true }, { "key": "geo", "value": "0.0.us", "disabled": true } ] }, "description": "Gets the list of all active users, their devices, active geolocations and Zscaler locations for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] }, { "name": "/users/{{userID}}", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/users/{{userID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "users", "{{userID}}" ] }, "description": "Gets the list of all active users, their devices, active geolocations and Zscaler locations for the time range specified. The endpoint defaults to the last 2 hours if not provided." }, "response": [] } ] } ] }, { "name": "troubleshooting", "item": [ { "name": "deeptraces", "item": [ { "name": "{trace id}", "item": [ { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}" ] }, "description": "Get deeptrace status" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}" ] }, "description": "Stop deep trace" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}/webprobe-metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}/webprobe-metrics", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}", "webprobe-metrics" ] }, "description": "Get webprobe metrics from deeptrace session" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}/cloudpath-metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}/cloudpath-metrics", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}", "cloudpath-metrics" ] }, "description": "Get cloudpath metrics (latency, packet drops, etc.) from deeptrace session" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}/cloudpath", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}/cloudpath", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}", "cloudpath" ] }, "description": "Get list of cloudpaths from the deeptrace session" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}/health-metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}/health-metrics", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}", "health-metrics" ] }, "description": "Get device health metrics from a deeptrace session" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces/{{trace_id}}/top-processes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces/{{trace_id}}/top-processes", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces", "{{trace_id}}", "top-processes" ] }, "description": "Get top processes from the deep tracing session" }, "response": [] } ] }, { "name": "/devices/{{deviceID}}/deeptraces", "event": [ { "listen": "prerequest", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"trace_id\", pm.response.json()[1].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces" ] }, "description": "Get list of deep traces" }, "response": [] }, { "name": "/devices/{{deviceID}}/deeptraces", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"session_name\": \"in enim labore sit proident\",\n \"app_id\": \"ea amet Ut anim sit\",\n \"web_probe_id\": \"laborum sed ut\",\n \"cloudpath_probe_id\": \"consequat elit id est Excepteur\",\n \"session_length\": 300,\n \"probe_device\": false,\n \"callback_url\": \"dolor ea\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZDXBaseUrl}}/devices/{{deviceID}}/deeptraces", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "devices", "{{deviceID}}", "deeptraces" ] }, "description": "Start deep trace" }, "response": [] } ] }, { "name": "analysis", "item": [ { "name": "{analysisID}", "item": [ { "name": "/analysis/{analysisID}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/analysis/{{analysisID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "analysis", "{{analysisID}}" ] } }, "response": [] }, { "name": "/analysis/{analysisID}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZDXBaseUrl}}/analysis/{{analysisID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "analysis", "{{analysisID}}" ] }, "description": "Stop Score Analysis" }, "response": [] } ] }, { "name": "/analysis", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"analysisID\", pm.response.json().analysis_id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceid\": \"52756968\",\n \"appid\": \"{{appID}}\",\n \"t0\": 1682092800,\n \"t1\": 1682096400\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZDXBaseUrl}}/analysis", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "analysis" ] }, "description": "Start Score Analysis" }, "response": [] } ] } ] }, { "name": "alerts", "item": [ { "name": "/alerts/ongoing", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"alertID\", pm.response.json()[\"alerts\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{ZDXBaseUrl}}/alerts/ongoing", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "alerts", "ongoing" ] } }, "response": [] }, { "name": "/alerts/historical", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"alertID\", pm.response.json()[\"alerts\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{ZDXBaseUrl}}/alerts/historical", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "alerts", "historical" ] } }, "response": [] }, { "name": "/alerts/{{alertID}}", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{ZDXBaseUrl}}/alerts/{{alertID}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "alerts", "{{alertID}}" ] } }, "response": [] }, { "name": "/alerts/{{alertID}}/affected_devices", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", () => {", " pm.response.to.have.status(200);", " pm.globals.set(\"alertID\", pm.response.json()[\"alerts\"][0].id)", " ", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{ZDXBaseUrl}}/alerts/{{alertID}}/affected_devices", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "alerts", "{{alertID}}", "affected_devices" ] } }, "response": [] } ] }, { "name": "Software Inventory", "item": [ { "name": "/inventory/software", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", ()=> {\r", "pm.response.to.have.status(200);\r", "pm.globals.set(\"software_key\", pm.response.json()[\"software\"][0].software_key)\r", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "", "value": "", "type": "text", "disabled": true }, { "key": "", "value": "", "type": "text", "disabled": true } ], "url": { "raw": "{{ZDXBaseUrl}}/inventory/software", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "inventory", "software" ] } }, "response": [] }, { "name": "/inventory/software/{software_key}", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Successful\", ()=> {\r", "pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{ZDXBaseUrl}}/inventory/software/{{software_key}}", "host": [ "{{ZDXBaseUrl}}" ], "path": [ "inventory", "software", "{{software_key}}" ] } }, "response": [] } ] } ] }, { "name": "Authentication Service", "item": [ { "name": "api-clients", "item": [ { "name": "secrets", "item": [ { "name": "Apiclient Ops get Secrets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id/secrets", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Retrieves a list of secrets associated with a specific API client using its ID. The secrets could include authentication keys or other credentials used by the API client." } ] }, "description": "Retrieves detailed information about a specific API client using its ID." }, "response": [ { "name": "The request was successful, and a list of secrets is returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"createdAt\": -1432201,\n \"expiresAt\": -92335078,\n \"id\": \"ut\",\n \"value\": \"pariatur officia in\"\n },\n {\n \"createdAt\": 78439991,\n \"expiresAt\": 24447922,\n \"id\": \"ut irure Lorem qui\",\n \"value\": \"labore Duis\"\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Apiclient Ops delete Secret", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id/secrets/:secretsId", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id", "secrets", ":secretsId" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the API client." }, { "key": "secretsId", "value": "ut", "description": "(Required) Unique identifier of the secret to be deleted." } ] }, "description": "Removes a specific secret associated with an API client using the Client ID and secret ID. After deletion, the secret cannot be recovered." }, "response": [ { "name": "The secret was successfully deleted.\n\n No content is returned in the response, but may be useful for validation purposes.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets/:secretsId", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets", ":secretsId" ], "variable": [ { "key": "id" }, { "key": "secretsId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets/:secretsId", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets", ":secretsId" ], "variable": [ { "key": "id" }, { "key": "secretsId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets/:secretsId", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets", ":secretsId" ], "variable": [ { "key": "id" }, { "key": "secretsId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Apiclient Ops add Secret", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiresAt\": -32130001\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id/secrets", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the API client to which the secret is added." } ] }, "description": "Creates and associates a new secret with a specified API client ID. This secret can be used for authentication with Authentication Service." }, "response": [ { "name": "The request was successful, and a new secret has been created and associated with the API client.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"expiresAt\": -32130001\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"createdAt\": -7672593,\n \"expiresAt\": -89543552,\n \"id\": \"nulla non sint amet\",\n \"value\": \"dolor eu ea velit\"\n}" }, { "name": "The request has been accepted for processing, but processing has not yet completed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"expiresAt\": -32130001\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"createdAt\": -7672593,\n \"expiresAt\": -89543552,\n \"id\": \"nulla non sint amet\",\n \"value\": \"dolor eu ea velit\"\n}" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"expiresAt\": -32130001\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"expiresAt\": -32130001\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id", "secrets" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "Apiclient Ops list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/api-clients?offset=24646835&limit=770&name[like]=ut", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by name using a partial match." } ] }, "description": "Retrieves a paginated list of API clients, providing details such as total records, current page offset, and links for pagination navigation." }, "response": [ { "name": "The request was successful, and a paginated list of API clients is returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients?offset=24646835&limit=770&name[like]=ut", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by name using a partial match." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": -17257431,\n \"pageOffset\": -18585748,\n \"pageSize\": -92655459,\n \"next_link\": \"labore do\",\n \"prev_link\": \"proident adipisicing ullamco\",\n \"records\": [\n {\n \"accessTokenLifeTime\": 24457,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"officia eiusmod in\",\n \"publicKeys\": [\n {\n \"keyName\": \"qui\",\n \"keyValue\": \"aliquip exercitation aute\"\n },\n {\n \"keyName\": \"laborum adipisicing fugiat magna\",\n \"keyValue\": \"Excepteur minim occaecat et\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"dolor sint proident cillum ea\"\n },\n {\n \"certContent\": \"aliqua ut eu dolore\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": false,\n \"id\": \"et eu in ut\",\n \"name\": \"laboris pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"cillum\",\n \"name\": \"fugiat velit elit culpa consectetur\"\n },\n {\n \"id\": \"eiusmod \",\n \"name\": \"incididunt irure nostrud deserunt eiusmod\"\n }\n ]\n },\n {\n \"defaultApi\": false,\n \"id\": \"mollit velit\",\n \"name\": \"ad velit\",\n \"selectedScopes\": [\n {\n \"id\": \"in fugiat velit\",\n \"name\": \"deserunt eiusmod cupidatat consequat\"\n },\n {\n \"id\": \"laborum culpa Duis adipisicing\",\n \"name\": \"ea aliqua minim do non\"\n }\n ]\n }\n ],\n \"id\": \"occaecat reprehenderit\",\n \"name\": \"id adipisicing\",\n \"description\": \"ipsum ullamco irure in do\",\n \"status\": false\n },\n {\n \"accessTokenLifeTime\": 7120,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"elit minim\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla consequat Duis irure proident\",\n \"keyValue\": \"adipisicing laborum quis eu ut\"\n },\n {\n \"keyName\": \"non voluptate exercitation\",\n \"keyValue\": \"in aute\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"dolor enim minim nisi labore\"\n },\n {\n \"certContent\": \"elit anim\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"eiusmod veniam Ut\",\n \"name\": \"ut Duis\",\n \"selectedScopes\": [\n {\n \"id\": \"adipisicing reprehenderit\",\n \"name\": \"voluptate exercitation quis consequat\"\n },\n {\n \"id\": \"incididunt aliqua mollit ipsum\",\n \"name\": \"eu sit officia irure\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"minim laborum ad ullamco\",\n \"name\": \"ut aliqua ad\",\n \"selectedScopes\": [\n {\n \"id\": \"laboris nostrud\",\n \"name\": \"dolore magna non cupidatat\"\n },\n {\n \"id\": \"reprehenderit do\",\n \"name\": \"voluptate dolore veniam id dolor\"\n }\n ]\n }\n ],\n \"id\": \"in nisi ea\",\n \"name\": \"do ea aliqua voluptat\",\n \"description\": \"dolor magna elit adipisicing\",\n \"status\": true\n }\n ]\n },\n {\n \"results_total\": -49462175,\n \"pageOffset\": 85801535,\n \"pageSize\": -29598456,\n \"next_link\": \"dolore consequat\",\n \"prev_link\": \"est sed\",\n \"records\": [\n {\n \"accessTokenLifeTime\": 55469,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"occaecat est culpa\",\n \"publicKeys\": [\n {\n \"keyName\": \"voluptate id commodo\",\n \"keyValue\": \"do fugiat est\"\n },\n {\n \"keyName\": \"qui ipsum sit sint aliquip\",\n \"keyValue\": \"sed pariatur et amet\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ullamco id\"\n },\n {\n \"certContent\": \"ea tempor amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": false,\n \"id\": \"ea tempor occaecat\",\n \"name\": \"ea p\",\n \"selectedScopes\": [\n {\n \"id\": \"exercitation\",\n \"name\": \"ex eu\"\n },\n {\n \"id\": \"deserunt aute cupidatat\",\n \"name\": \"eiusmod reprehenderit do sunt\"\n }\n ]\n },\n {\n \"defaultApi\": false,\n \"id\": \"in aute\",\n \"name\": \"Duis aliqua\",\n \"selectedScopes\": [\n {\n \"id\": \"dolore ea incididunt velit reprehenderit\",\n \"name\": \"proident eu qui labore\"\n },\n {\n \"id\": \"cillum quis ad \",\n \"name\": \"sint sed exercitation\"\n }\n ]\n }\n ],\n \"id\": \"dolor occaecat eu incididunt\",\n \"name\": \"sunt ullamco do in\",\n \"description\": \"in sint officia dolore\",\n \"status\": false\n },\n {\n \"accessTokenLifeTime\": 42939,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"Lorem esse eiusmod nulla\",\n \"publicKeys\": [\n {\n \"keyName\": \"quis enim in\",\n \"keyValue\": \"non labore pariatur consectetur ut\"\n },\n {\n \"keyName\": \"tempor aliqua esse\",\n \"keyValue\": \"ad incididunt Lorem\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ullamco d\"\n },\n {\n \"certContent\": \"enim\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": false,\n \"id\": \"ea cupidatat ullamco non anim\",\n \"name\": \"magna sunt\",\n \"selectedScopes\": [\n {\n \"id\": \"minim \",\n \"name\": \"est cillum occaecat\"\n },\n {\n \"id\": \"Ut incididunt repreh\",\n \"name\": \"laborum voluptate elit ex in\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"ex\",\n \"name\": \"velit\",\n \"selectedScopes\": [\n {\n \"id\": \"sint adipisicing dolor\",\n \"name\": \"Lorem consectetur\"\n },\n {\n \"id\": \"id eu incididunt Lorem\",\n \"name\": \"Duis velit\"\n }\n ]\n }\n ],\n \"id\": \"cupidatat voluptate est\",\n \"name\": \"Lorem ullamco\",\n \"description\": \"Lorem id\",\n \"status\": false\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients?offset=24646835&limit=770&name[like]=ut", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by name using a partial match." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Apiclient Ops add", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 58868,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"consectetur aute\",\n \"publicKeys\": [\n {\n \"keyName\": \"cupidatat ea reprehenderit\",\n \"keyValue\": \"do mollit ut esse\"\n },\n {\n \"keyName\": \"mollit ipsum\",\n \"keyValue\": \"ex\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"exercitation et\"\n },\n {\n \"certContent\": \"culpa ullamco\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"eiusmod ma\",\n \"selectedScopes\": [\n {\n \"id\": \"ex sint\"\n },\n {\n \"id\": \"nulla Ut exercitation non culpa\"\n }\n ]\n },\n {\n \"id\": \"dolor pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"ullamco sit qui\"\n },\n {\n \"id\": \"nulla magna anim\"\n }\n ]\n }\n ],\n \"description\": \"officia quis culpa\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/api-clients", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients" ] }, "description": "Creates a new API client with authentication settings and assigned roles." }, "response": [ { "name": "The request has succeeded and a new resource has been created as a result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 58868,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"consectetur aute\",\n \"publicKeys\": [\n {\n \"keyName\": \"cupidatat ea reprehenderit\",\n \"keyValue\": \"do mollit ut esse\"\n },\n {\n \"keyName\": \"mollit ipsum\",\n \"keyValue\": \"ex\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"exercitation et\"\n },\n {\n \"certContent\": \"culpa ullamco\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"eiusmod ma\",\n \"selectedScopes\": [\n {\n \"id\": \"ex sint\"\n },\n {\n \"id\": \"nulla Ut exercitation non culpa\"\n }\n ]\n },\n {\n \"id\": \"dolor pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"ullamco sit qui\"\n },\n {\n \"id\": \"nulla magna anim\"\n }\n ]\n }\n ],\n \"description\": \"officia quis culpa\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accessTokenLifeTime\": 27027,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"esse velit aliqua ullamco\",\n \"publicKeys\": [\n {\n \"keyName\": \"exercitation non\",\n \"keyValue\": \"sit ullamco laborum voluptat\"\n },\n {\n \"keyName\": \"irure deserunt et\",\n \"keyValue\": \"consectetur et id ex est\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"dolor fugiat consequat dolore aliqua\"\n },\n {\n \"certContent\": \"cillum Ut Excepteur su\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"id nisi\",\n \"name\": \"veniam Ut fugiat\",\n \"selectedScopes\": [\n {\n \"id\": \"labore enim sit nostrud\",\n \"name\": \"et mollit\"\n },\n {\n \"id\": \"dolore eu sint\",\n \"name\": \"Duis laboris dolor\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"velit\",\n \"name\": \"eiusmod est tempor officia aliquip\",\n \"selectedScopes\": [\n {\n \"id\": \"dolore culpa\",\n \"name\": \"laborum ullamco aliqua aliq\"\n },\n {\n \"id\": \"commodo voluptate ad\",\n \"name\": \"nostrud dolor aliqua\"\n }\n ]\n }\n ],\n \"id\": \"nostrud voluptate ut anim\",\n \"name\": \"sit do nulla est\",\n \"description\": \"dolor in cupidatat\",\n \"status\": true\n}" }, { "name": "The request has been accepted for processing, but processing has not yet completed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 58868,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"consectetur aute\",\n \"publicKeys\": [\n {\n \"keyName\": \"cupidatat ea reprehenderit\",\n \"keyValue\": \"do mollit ut esse\"\n },\n {\n \"keyName\": \"mollit ipsum\",\n \"keyValue\": \"ex\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"exercitation et\"\n },\n {\n \"certContent\": \"culpa ullamco\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"eiusmod ma\",\n \"selectedScopes\": [\n {\n \"id\": \"ex sint\"\n },\n {\n \"id\": \"nulla Ut exercitation non culpa\"\n }\n ]\n },\n {\n \"id\": \"dolor pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"ullamco sit qui\"\n },\n {\n \"id\": \"nulla magna anim\"\n }\n ]\n }\n ],\n \"description\": \"officia quis culpa\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accessTokenLifeTime\": 27027,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"esse velit aliqua ullamco\",\n \"publicKeys\": [\n {\n \"keyName\": \"exercitation non\",\n \"keyValue\": \"sit ullamco laborum voluptat\"\n },\n {\n \"keyName\": \"irure deserunt et\",\n \"keyValue\": \"consectetur et id ex est\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"dolor fugiat consequat dolore aliqua\"\n },\n {\n \"certContent\": \"cillum Ut Excepteur su\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"id nisi\",\n \"name\": \"veniam Ut fugiat\",\n \"selectedScopes\": [\n {\n \"id\": \"labore enim sit nostrud\",\n \"name\": \"et mollit\"\n },\n {\n \"id\": \"dolore eu sint\",\n \"name\": \"Duis laboris dolor\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"velit\",\n \"name\": \"eiusmod est tempor officia aliquip\",\n \"selectedScopes\": [\n {\n \"id\": \"dolore culpa\",\n \"name\": \"laborum ullamco aliqua aliq\"\n },\n {\n \"id\": \"commodo voluptate ad\",\n \"name\": \"nostrud dolor aliqua\"\n }\n ]\n }\n ],\n \"id\": \"nostrud voluptate ut anim\",\n \"name\": \"sit do nulla est\",\n \"description\": \"dolor in cupidatat\",\n \"status\": true\n}" }, { "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 58868,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"consectetur aute\",\n \"publicKeys\": [\n {\n \"keyName\": \"cupidatat ea reprehenderit\",\n \"keyValue\": \"do mollit ut esse\"\n },\n {\n \"keyName\": \"mollit ipsum\",\n \"keyValue\": \"ex\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"exercitation et\"\n },\n {\n \"certContent\": \"culpa ullamco\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"eiusmod ma\",\n \"selectedScopes\": [\n {\n \"id\": \"ex sint\"\n },\n {\n \"id\": \"nulla Ut exercitation non culpa\"\n }\n ]\n },\n {\n \"id\": \"dolor pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"ullamco sit qui\"\n },\n {\n \"id\": \"nulla magna anim\"\n }\n ]\n }\n ],\n \"description\": \"officia quis culpa\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 58868,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"consectetur aute\",\n \"publicKeys\": [\n {\n \"keyName\": \"cupidatat ea reprehenderit\",\n \"keyValue\": \"do mollit ut esse\"\n },\n {\n \"keyName\": \"mollit ipsum\",\n \"keyValue\": \"ex\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"exercitation et\"\n },\n {\n \"certContent\": \"culpa ullamco\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"eiusmod ma\",\n \"selectedScopes\": [\n {\n \"id\": \"ex sint\"\n },\n {\n \"id\": \"nulla Ut exercitation non culpa\"\n }\n ]\n },\n {\n \"id\": \"dolor pariatur\",\n \"selectedScopes\": [\n {\n \"id\": \"ullamco sit qui\"\n },\n {\n \"id\": \"nulla magna anim\"\n }\n ]\n }\n ],\n \"description\": \"officia quis culpa\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients", "host": [ "{{baseUrl}}" ], "path": [ "api-clients" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Apiclient Ops update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the API client to be updated." } ] }, "description": "Updates the existing API client details based on the provided ID. This allows modification of attributes such as name, authentication settings, and assigned roles." }, "response": [ { "name": "The request was successful, and the API client details are updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accessTokenLifeTime\": 27027,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"esse velit aliqua ullamco\",\n \"publicKeys\": [\n {\n \"keyName\": \"exercitation non\",\n \"keyValue\": \"sit ullamco laborum voluptat\"\n },\n {\n \"keyName\": \"irure deserunt et\",\n \"keyValue\": \"consectetur et id ex est\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"dolor fugiat consequat dolore aliqua\"\n },\n {\n \"certContent\": \"cillum Ut Excepteur su\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"id nisi\",\n \"name\": \"veniam Ut fugiat\",\n \"selectedScopes\": [\n {\n \"id\": \"labore enim sit nostrud\",\n \"name\": \"et mollit\"\n },\n {\n \"id\": \"dolore eu sint\",\n \"name\": \"Duis laboris dolor\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"velit\",\n \"name\": \"eiusmod est tempor officia aliquip\",\n \"selectedScopes\": [\n {\n \"id\": \"dolore culpa\",\n \"name\": \"laborum ullamco aliqua aliq\"\n },\n {\n \"id\": \"commodo voluptate ad\",\n \"name\": \"nostrud dolor aliqua\"\n }\n ]\n }\n ],\n \"id\": \"nostrud voluptate ut anim\",\n \"name\": \"sit do nulla est\",\n \"description\": \"dolor in cupidatat\",\n \"status\": true\n}" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" }, { "name": "The specified API client ID does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://CVPvElqKGqFEHwopA.trLbSOd.yrsToRxjeTmAqgK\",\n \"title\": \"minim adipisicing elit\",\n \"status\": \"404\",\n \"detail\": \"amet cupidatat ut\"\n}" }, { "name": "Unexpected server issue occurred while processing the request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cillum\",\n \"accessTokenLifeTime\": 31500,\n \"clientAuthentication\": {\n \"authType\": \"PUBKEYCERT\",\n \"clientJWKsUrl\": \"ut anim voluptate dolore in\",\n \"publicKeys\": [\n {\n \"keyName\": \"nulla sed deserunt\",\n \"keyValue\": \"velit culpa\"\n },\n {\n \"keyName\": \"aliquip incididunt\",\n \"keyValue\": \"exercitation eius\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"ut sit nulla\"\n },\n {\n \"certContent\": \"elit sunt amet\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"id\": \"id sit\",\n \"selectedScopes\": [\n {\n \"id\": \"ea ipsum\"\n },\n {\n \"id\": \"in enim mollit officia\"\n }\n ]\n },\n {\n \"id\": \"labore do\",\n \"selectedScopes\": [\n {\n \"id\": \"eiusmod aliquip laborum tempor\"\n },\n {\n \"id\": \"sed\"\n }\n ]\n }\n ],\n \"description\": \"ut\",\n \"status\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://ARUffKZuOuLLuKUdnXPpNEAu.ydyXR+ec7MmzXNUsXGCWw\",\n \"title\": \"dolore consectetur\",\n \"status\": \"401\",\n \"detail\": \"officia do \"\n}" } ] }, { "name": "Apiclient Ops remove", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the API client to be deleted." } ] }, "description": "Removes an existing API client from the system. After deletion, the API client cannot be recovered." }, "response": [ { "name": "The API client was successfully deleted.\n\nNo content is returned in the response, but headers may be useful for validation purposes. ", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Apiclient Ops get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/api-clients/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the API client to be retrieved." } ] }, "description": "Retrieves detailed information about a specific API client using its ID." }, "response": [ { "name": "The request was successful, and the API client details are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"accessTokenLifeTime\": 6818,\n \"clientAuthentication\": {\n \"authType\": \"SECRET\",\n \"clientJWKsUrl\": \"veniam officia laborum qui elit\",\n \"publicKeys\": [\n {\n \"keyName\": \"enim esse anim\",\n \"keyValue\": \"deserunt ad Lorem nostrud anim\"\n },\n {\n \"keyName\": \"Lorem ad\",\n \"keyValue\": \"Duis laborum consectetur\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"et occaecat\"\n },\n {\n \"certContent\": \"in cupidatat dolore consequat\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"sit cupidatat esse est\",\n \"name\": \"proident nisi sint\",\n \"selectedScopes\": [\n {\n \"id\": \"ex culpa\",\n \"name\": \"nisi veniam est ut aliqua\"\n },\n {\n \"id\": \"magna eni\",\n \"name\": \"ad\"\n }\n ]\n },\n {\n \"defaultApi\": false,\n \"id\": \"aute occaecat cillum\",\n \"name\": \"proident\",\n \"selectedScopes\": [\n {\n \"id\": \"occaecat aute\",\n \"name\": \"proident sint nisi\"\n },\n {\n \"id\": \"dolor commodo laborum\",\n \"name\": \"in dolor Ut eu\"\n }\n ]\n }\n ],\n \"id\": \"velit in anim\",\n \"name\": \"sit nisi\",\n \"description\": \"consectetur laborum\",\n \"status\": true\n },\n {\n \"accessTokenLifeTime\": 54421,\n \"clientAuthentication\": {\n \"authType\": \"JWKS\",\n \"clientJWKsUrl\": \"ut magna esse\",\n \"publicKeys\": [\n {\n \"keyName\": \"quis anim in\",\n \"keyValue\": \"Duis nulla in culpa\"\n },\n {\n \"keyName\": \"ipsum\",\n \"keyValue\": \"ipsum ullamco pariatur Ut\"\n }\n ],\n \"clientCertificates\": [\n {\n \"certContent\": \"minim eu irure\"\n },\n {\n \"certContent\": \"nostrud voluptate\"\n }\n ]\n },\n \"clientResources\": [\n {\n \"defaultApi\": true,\n \"id\": \"ex quis\",\n \"name\": \"commodo ipsum culpa\",\n \"selectedScopes\": [\n {\n \"id\": \"amet aliqua in nulla\",\n \"name\": \"quis eu dolore esse\"\n },\n {\n \"id\": \"sit Duis ex mag\",\n \"name\": \"minim quis\"\n }\n ]\n },\n {\n \"defaultApi\": true,\n \"id\": \"in\",\n \"name\": \"tempor officia quis\",\n \"selectedScopes\": [\n {\n \"id\": \"\",\n \"name\": \"anim Lorem pariatur\"\n },\n {\n \"id\": \"esse e\",\n \"name\": \"cillum non fugiat\"\n }\n ]\n }\n ],\n \"id\": \"Excepteur id in qui\",\n \"name\": \"cillum irure dolore\",\n \"description\": \"labore sint est ea\",\n \"status\": false\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/api-clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api-clients", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "groups", "item": [ { "name": "users", "item": [ { "name": "Groups Ops add Users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id/users", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group to which users will be added." } ] }, "description": "Adds users to an existing group using the unique identifier ID of the group." }, "response": [ { "name": "The request was successful, and users have been added to the group.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials. \n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops put Users", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id/users", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group which users needs to be updated." } ] }, "description": "Updates the list of users in a specific group using the group ID." }, "response": [ { "name": "The request has succeeded, and the users in the group have been updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"elit pariatur tempor\"\n },\n {\n \"id\": \"nostrud ipsum occaecat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops get Group Members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id", "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier for the group (used in endpoints where group ID is required)." } ] }, "description": "Retrieves the list of users details for a specific group using the group ID." }, "response": [ { "name": "The request was successful, and a paginated list of users details are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": -97760865,\n \"pageOffset\": -19124569,\n \"pageSize\": 85738489,\n \"next_link\": \"veniam nisi velit fugiat dolor\",\n \"prev_link\": \"elit\",\n \"records\": [\n {\n \"displayName\": \"tempor aliquip\",\n \"id\": \"exercitation esse\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"irure tempor in Ut aute\",\n \"primaryEmail\": \"ipsum nisi\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": true,\n \"firstName\": \"velit enim pariatur in\",\n \"lastName\": \"anim do\",\n \"secondaryEmail\": \"dolore m\",\n \"department\": {\n \"displayName\": \"minim\",\n \"id\": \"laborum\",\n \"name\": \"ex quis\"\n },\n \"customAttrsInfo\": {\n \"eiusmod___\": \"ea reprehenderit incididunt\",\n \"sita2\": \"eiusmod laboris ea\",\n \"ea_9_\": \"elit\",\n \"in_d\": \"aliquip magna\"\n }\n },\n {\n \"displayName\": \"in Ut aliqua\",\n \"id\": \"esse eiusmod exercitation tempor\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"magna ut\",\n \"primaryEmail\": \"qui est\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"tempor dolore\",\n \"lastName\": \"consectetur sint\",\n \"secondaryEmail\": \"eiusmod cupidatat id\",\n \"department\": {\n \"displayName\": \"Excepteur cupidatat laborum do\",\n \"id\": \"Lorem voluptate\",\n \"name\": \"eiusmod irure\"\n },\n \"customAttrsInfo\": {\n \"enim_e\": \"eiusmod aliqua cillum qui\"\n }\n }\n ]\n },\n {\n \"results_total\": 57815603,\n \"pageOffset\": 61030233,\n \"pageSize\": -67000277,\n \"next_link\": \"sed\",\n \"prev_link\": \"cillum Duis fugiat anim adipisicing\",\n \"records\": [\n {\n \"displayName\": \"nostrud aliquip laboris adipisicing\",\n \"id\": \"Lorem nulla\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"anim ut\",\n \"primaryEmail\": \"sit laboris dolor\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"Ut veniam Excepteur Lorem qu\",\n \"lastName\": \"irure en\",\n \"secondaryEmail\": \"dolor Lorem\",\n \"department\": {\n \"displayName\": \"dolor ex veniam\",\n \"id\": \"dolor ullamco incididunt consequat\",\n \"name\": \"eu commodo\"\n },\n \"customAttrsInfo\": {\n \"non_b\": \"incididunt in\",\n \"enim_937\": \"exercitation pariatur commodo\",\n \"non_0\": \"cillum\"\n }\n },\n {\n \"displayName\": \"laboris Lorem amet labore qui\",\n \"id\": \"non sed officia eiusmod reprehe\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"fugiat occaecat laboris\",\n \"primaryEmail\": \"dolore\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"proident in cillum ad\",\n \"lastName\": \"in sint tempor\",\n \"secondaryEmail\": \"anim Duis\",\n \"department\": {\n \"displayName\": \"veniam mollit in\",\n \"id\": \"Ut\",\n \"name\": \"Excepteur ullamco dolore Ut\"\n },\n \"customAttrsInfo\": {\n \"laborisa__\": \"consectetur anim laboris\"\n }\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops add User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id/users/:userId", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group to which the user needs to be added." }, { "key": "userId", "value": "ut", "description": "(Required) Unique identifier of the user being added to the group." } ] }, "description": "Adds a specific user to an existing group using the group ID and the user ID." }, "response": [ { "name": "The request was successful, and the user has been added to the group", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops remove User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id/users/:userId", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group from which the user needs to be removed." }, { "key": "userId", "value": "ut", "description": "(Required) Unique identifier of the user to be removed from the group." } ] }, "description": "Removes a specific user from an existing group using the group ID and the user ID." }, "response": [ { "name": "The user has been removed from the group.\n\nNo content is returned in the response, but headers may be useful for validation purposes.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id", "users", ":userId" ], "variable": [ { "key": "id" }, { "key": "userId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "Groups Ops list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups?offset=24646835&limit=770&name[like]=ut&excludedynamicgroups=true", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by group name using a case-insensitive partial match." }, { "key": "excludedynamicgroups", "value": "true", "description": "Excludes dynamic groups from the results." } ] }, "description": "Retrieves a paginated list of groups with optional query parameters for pagination and filtering by group name or dynamic group status." }, "response": [ { "name": "The request was successful, and a paginated list of groups are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups?offset=24646835&limit=770&name[like]=ut&excludedynamicgroups=true", "host": [ "{{baseUrl}}" ], "path": [ "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by group name using a case-insensitive partial match." }, { "key": "excludedynamicgroups", "value": "true", "description": "Excludes dynamic groups from the results." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": 75186833,\n \"pageOffset\": 18601916,\n \"pageSize\": 21699957,\n \"next_link\": \"sed in do incididunt sit\",\n \"prev_link\": \"aliqua in exercitation\",\n \"records\": [\n {\n \"adminEntitlementEnabled\": false,\n \"id\": \"eu in velit dolore\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": true,\n \"name\": \"laboris laborum\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"laborum irure veniam non occaecat\"\n },\n {\n \"adminEntitlementEnabled\": true,\n \"id\": \"in\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"fugiat aliquip elit commodo esse\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"labore cupidatat\"\n }\n ]\n },\n {\n \"results_total\": -35386498,\n \"pageOffset\": -20343303,\n \"pageSize\": -32612482,\n \"next_link\": \"labore\",\n \"prev_link\": \"irure nisi\",\n \"records\": [\n {\n \"adminEntitlementEnabled\": true,\n \"id\": \"magn\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"dolor\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"culpa amet do deserunt exercitation\"\n },\n {\n \"adminEntitlementEnabled\": false,\n \"id\": \"laboris\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"laborum veniam est aliq\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"incididunt id non eu\"\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials. \n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups?offset=24646835&limit=770&name[like]=ut&excludedynamicgroups=true", "host": [ "{{baseUrl}}" ], "path": [ "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters results by group name using a case-insensitive partial match." }, { "key": "excludedynamicgroups", "value": "true", "description": "Excludes dynamic groups from the results." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops add", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/groups", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups" ] }, "description": "Creates a new group with the specified name and description." }, "response": [ { "name": "The request was successful, and a new group has been created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"adminEntitlementEnabled\": false,\n \"id\": \"officia ex\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"fugiat non consequat\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"laborum anim magna\"\n}" }, { "name": "The request has been accepted for processing, but processing has not yet completed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"adminEntitlementEnabled\": false,\n \"id\": \"officia ex\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"fugiat non consequat\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"laborum anim magna\"\n}" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials. \n\n The request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group to be updated." } ] }, "description": "Update an existing group based on the provided group ID." }, "response": [ { "name": "The request has succeeded, and the group details have been updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"adminEntitlementEnabled\": false,\n \"id\": \"officia ex\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"fugiat non consequat\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"laborum anim magna\"\n}" }, { "name": "The request contains invalid syntax or missing required fields.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials. \n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" }, { "name": "The specified group ID does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://CVPvElqKGqFEHwopA.trLbSOd.yrsToRxjeTmAqgK\",\n \"title\": \"minim adipisicing elit\",\n \"status\": \"404\",\n \"detail\": \"amet cupidatat ut\"\n}" }, { "name": "Unexpected server issue occurred while processing the request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"dolor pariatur\",\n \"description\": \"veniam reprehenderit in est\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://ARUffKZuOuLLuKUdnXPpNEAu.ydyXR+ec7MmzXNUsXGCWw\",\n \"title\": \"dolore consectetur\",\n \"status\": \"401\",\n \"detail\": \"officia do \"\n}" } ] }, { "name": "Groups Ops remove", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) The unique identifier of the group to be deleted." } ] }, "description": "Deletes an existing group based on the provided group ID." }, "response": [ { "name": "The group was successfully deleted.\n\nNo content is returned in the response, but headers may be useful for validation purposes.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Groups Ops get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/groups/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the group to retrieve." } ] }, "description": "Retrieves detailed information about a specific group using its unique identifier ID." }, "response": [ { "name": "The request was successful, and the group details are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"adminEntitlementEnabled\": true,\n \"id\": \"cillum occaecat laborum Duis\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": true,\n \"name\": \"ex consectetur aute magna\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"incididunt ex\"\n },\n {\n \"adminEntitlementEnabled\": false,\n \"id\": \"ea\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"do nulla sit sunt adipisicing\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"labore in eu in\"\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "resource-servers", "item": [ { "name": "Resource Servers Ops list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/resource-servers?offset=24646835&limit=770&name[like]=ut", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "resource-servers" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters resource servers by name using a case-insensitive partial match." } ] }, "description": "Retrieves a paginated list of resource servers with an optional query parameters for pagination." }, "response": [ { "name": "The request was successful, and a paginated list of resource servers are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/resource-servers?offset=24646835&limit=770&name[like]=ut", "host": [ "{{baseUrl}}" ], "path": [ "resource-servers" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters resource servers by name using a case-insensitive partial match." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": 68140500,\n \"pageOffset\": 66238112,\n \"pageSize\": 22562101,\n \"next_link\": \"non velit commodo nostrud\",\n \"prev_link\": \"exercitation\",\n \"records\": [\n {\n \"id\": \"elit cupidatat\",\n \"name\": \"nulla\",\n \"displayName\": \"do aute\",\n \"description\": \"esse nisi\",\n \"primaryAud\": \"Duis\",\n \"defaultApi\": true,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"ullamco\",\n \"displayName\": \"amet pariatur Lorem velit\",\n \"id\": \"proident\",\n \"name\": \"ad\",\n \"orgName\": \"esse sit est\"\n },\n \"scopes\": [\n {\n \"id\": \"magna laboris\",\n \"name\": \"exercitation irure\"\n },\n {\n \"id\": \"Duis tempo\",\n \"name\": \"ve\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"irure labore Lorem\",\n \"displayName\": \"pariatur laboris consectetur proident \",\n \"id\": \"do culpa\",\n \"name\": \"nulla\",\n \"orgName\": \"est tempor co\"\n },\n \"scopes\": [\n {\n \"id\": \"anim cillum ut nostrud\",\n \"name\": \"non voluptate\"\n },\n {\n \"id\": \"dolor aliquip\",\n \"name\": \"enim adipisicing reprehend\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"id laboris occaecat deserunt Lorem\",\n \"name\": \"in velit\",\n \"displayName\": \"in labore\",\n \"description\": \"labore Exce\",\n \"primaryAud\": \"veniam\",\n \"defaultApi\": true,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"officia nulla labore\",\n \"displayName\": \"esse\",\n \"id\": \"aliqua minim occaecat aliquip dolor\",\n \"name\": \"enim deserunt do\",\n \"orgName\": \"eiusmod consequat Ut minim\"\n },\n \"scopes\": [\n {\n \"id\": \"ullamco dolor ad labor\",\n \"name\": \"voluptate ali\"\n },\n {\n \"id\": \"cillum Lorem tempor \",\n \"name\": \"in ut\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"laborum eu sit minim\",\n \"displayName\": \"laborum culpa\",\n \"id\": \"culpa velit anim\",\n \"name\": \"in ea\",\n \"orgName\": \"reprehenderit dolore\"\n },\n \"scopes\": [\n {\n \"id\": \"eiusmod\",\n \"name\": \"cillum\"\n },\n {\n \"id\": \"eu dolore ut sit amet\",\n \"name\": \"commodo laborum\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"results_total\": 40911093,\n \"pageOffset\": 16011446,\n \"pageSize\": 20106363,\n \"next_link\": \"do amet\",\n \"prev_link\": \"dolore fugiat ad\",\n \"records\": [\n {\n \"id\": \"incididunt labore sunt occaecat\",\n \"name\": \"cupidatat ullamco adipisicing sint quis\",\n \"displayName\": \"\",\n \"description\": \"velit eiusmod laborum\",\n \"primaryAud\": \"laboris ipsum labore\",\n \"defaultApi\": true,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"reprehenderit in\",\n \"displayName\": \"dolore magna\",\n \"id\": \"commodo dolor consequat exercitation \",\n \"name\": \"inc\",\n \"orgName\": \"laboris laborum\"\n },\n \"scopes\": [\n {\n \"id\": \"in\",\n \"name\": \"proident et cillum\"\n },\n {\n \"id\": \"veniam eu Ut magna\",\n \"name\": \"adipisicing enim incididunt officia id\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"cupidatat veniam amet pariatur\",\n \"displayName\": \"dolor ullamco Excepteur eu\",\n \"id\": \"nostrud commodo non Lorem\",\n \"name\": \"fugiat sit dolor\",\n \"orgName\": \"in officia commodo\"\n },\n \"scopes\": [\n {\n \"id\": \"incididunt dolor sunt officia\",\n \"name\": \"velit elit ea irure adipisicing\"\n },\n {\n \"id\": \"elit Duis nostrud cupidatat\",\n \"name\": \"dolor commodo labore in id\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"i\",\n \"name\": \"ea sint\",\n \"displayName\": \"minim veniam sit ad\",\n \"description\": \"eiusmod proident laboris laborum sit\",\n \"primaryAud\": \"dolore Lorem Ut\",\n \"defaultApi\": true,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"in consectetur occaecat\",\n \"displayName\": \"Duis velit ipsum esse incididunt\",\n \"id\": \"culpa cillum\",\n \"name\": \"amet cupidatat Excepteur ut Ut\",\n \"orgName\": \"ea do sunt amet\"\n },\n \"scopes\": [\n {\n \"id\": \"dolore \",\n \"name\": \"proident enim labore voluptate\"\n },\n {\n \"id\": \"laboris\",\n \"name\": \"U\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"ea ut officia \",\n \"displayName\": \"exercitation eiusmod dolor non\",\n \"id\": \"ullamco dolore fugiat\",\n \"name\": \"fugiat dolor ut do\",\n \"orgName\": \"Ut nisi sit\"\n },\n \"scopes\": [\n {\n \"id\": \"ut in exercitation id\",\n \"name\": \"est ma\"\n },\n {\n \"id\": \"magna commodo ad\",\n \"name\": \"elit nisi labore voluptate sed\"\n }\n ]\n }\n ]\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/resource-servers?offset=24646835&limit=770&name[like]=ut", "host": [ "{{baseUrl}}" ], "path": [ "resource-servers" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "name[like]", "value": "ut", "description": "Filters resource servers by name using a case-insensitive partial match." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Resource Servers Ops get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/resource-servers/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "resource-servers", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the resource server to retrieve." } ] }, "description": "Retrieves details about a specific resource server using the server ID." }, "response": [ { "name": "The request was successful, and the resource server details are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/resource-servers/:id", "host": [ "{{baseUrl}}" ], "path": [ "resource-servers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"esse nulla incididunt velit\",\n \"name\": \"in Excepteur ullamco quis\",\n \"displayName\": \"minim amet elit\",\n \"description\": \"ut Duis\",\n \"primaryAud\": \"Lorem proident commodo ex\",\n \"defaultApi\": true,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"aute ipsum\",\n \"displayName\": \"Excepteur anim\",\n \"id\": \"ex occ\",\n \"name\": \"deserunt\",\n \"orgName\": \"esse aliquip ad do\"\n },\n \"scopes\": [\n {\n \"id\": \"enim in\",\n \"name\": \"est ex sed nostrud\"\n },\n {\n \"id\": \"aute irure nostrud non\",\n \"name\": \"dolor Excepteur\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"deserunt qui culpa veniam\",\n \"displayName\": \"Duis dolor ut\",\n \"id\": \"exercitation\",\n \"name\": \"ut dolor sit reprehenderit\",\n \"orgName\": \"deserunt Lorem cillum\"\n },\n \"scopes\": [\n {\n \"id\": \"magna pari\",\n \"name\": \"dolore dolor eiusmod\"\n },\n {\n \"id\": \"laboris anim pariatur nisi reprehenderit\",\n \"name\": \"in aute\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"dolor\",\n \"name\": \"culpa ex\",\n \"displayName\": \"enim qui commodo\",\n \"description\": \"ipsum cillum commodo exercitation\",\n \"primaryAud\": \"laborum do\",\n \"defaultApi\": false,\n \"serviceScopes\": [\n {\n \"service\": {\n \"cloudName\": \"est minim\",\n \"displayName\": \"anim voluptate dolore non\",\n \"id\": \"nostrud ut culpa\",\n \"name\": \"adipisicing veniam Duis\",\n \"orgName\": \"nulla dolor Lorem\"\n },\n \"scopes\": [\n {\n \"id\": \"velit proident minim aliqua incididunt\",\n \"name\": \"irure Ut eiusmod\"\n },\n {\n \"id\": \"ullamco ea nulla\",\n \"name\": \"ex laboris Lorem\"\n }\n ]\n },\n {\n \"service\": {\n \"cloudName\": \"nulla id eu quis\",\n \"displayName\": \"nostrud cupidatat culpa quis occaecat\",\n \"id\": \"consectetur pariatur Ut reprehenderit\",\n \"name\": \"elit est minim\",\n \"orgName\": \"in voluptate et non ipsum\"\n },\n \"scopes\": [\n {\n \"id\": \"nulla magna\",\n \"name\": \"velit culpa aliquip eu\"\n },\n {\n \"id\": \"adipisicing nostrud est\",\n \"name\": \"in sunt Excepteur rep\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/resource-servers/:id", "host": [ "{{baseUrl}}" ], "path": [ "resource-servers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "users", "item": [ { "name": "admin-entitlements", "item": [ { "name": "Users Ops get User Admin Entitlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/:id/admin-entitlements", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id", "admin-entitlements" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) The user ID of the individual whose admin entitlements are being retrieved." } ] }, "description": "Retrieves the administrative entitlements for a specific user by their user ID." }, "response": [ { "name": "The request was successful, and returns a list of administrative entitlement objects.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/admin-entitlements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "admin-entitlements" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"roles\": [\n {\n \"displayName\": \"consequat non\",\n \"id\": \"mollit occaecat\",\n \"name\": \"eiusmod\"\n },\n {\n \"displayName\": \"enim sint aute\",\n \"id\": \"officia non dolore eiusmod dolor\",\n \"name\": \"id\"\n }\n ],\n \"scope\": {\n \"displayName\": \"officia in ullamco\",\n \"id\": \"sint ad\",\n \"name\": \"culpa dolore non eu\"\n },\n \"service\": {\n \"id\": \"consequat laboris dolor adipisicing exercitation\",\n \"serviceName\": \"in in sunt commodo nulla\",\n \"cloudName\": \"labore non deserunt\",\n \"cloudDomainName\": \"non nisi\",\n \"orgName\": \"eiusmod in\",\n \"orgId\": \"eu non\"\n }\n },\n {\n \"roles\": [\n {\n \"displayName\": \"magna dolore fugiat est\",\n \"id\": \"irure\",\n \"name\": \"cillum elit\"\n },\n {\n \"displayName\": \"deserunt\",\n \"id\": \"amet id\",\n \"name\": \"deserunt Duis qui ipsum\"\n }\n ],\n \"scope\": {\n \"displayName\": \"irure ex Lorem et ipsum\",\n \"id\": \"ex ea tempor consequat\",\n \"name\": \"incididunt enim irure pariatur\"\n },\n \"service\": {\n \"id\": \"et est amet Ut\",\n \"serviceName\": \"ullamco irure velit mollit\",\n \"cloudName\": \"ut c\",\n \"cloudDomainName\": \"Lorem voluptate dolore\",\n \"orgName\": \"ea veniam sint irure est\",\n \"orgId\": \"nulla esse\"\n }\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/admin-entitlements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "admin-entitlements" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "groups", "item": [ { "name": "Users Ops get User Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/:id/groups?offset=24646835&limit=770", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id", "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" } ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) The user ID of the individual whose groups details are to be retrieved." } ] }, "description": "Retrieves a paginated list of groups associated with a specific user ID." }, "response": [ { "name": "The request was successful, and returns a paginated list of groups for the specified user.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/groups?offset=24646835&limit=770", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": 83988116,\n \"pageOffset\": 96689103,\n \"pageSize\": -64005100,\n \"next_link\": \"nulla ut pariatur dolor\",\n \"prev_link\": \"Duis Lorem\",\n \"records\": [\n {\n \"adminEntitlementEnabled\": true,\n \"id\": \"adipisicing ad eu consequat\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": true,\n \"name\": \"mollit ex fugiat consequat\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"ut enim minim\"\n },\n {\n \"adminEntitlementEnabled\": false,\n \"id\": \"reprehenderit occaecat in\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": false,\n \"name\": \"ut\",\n \"serviceEntitlementEnabled\": false,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"proident minim ut enim\"\n }\n ]\n },\n {\n \"results_total\": 90105256,\n \"pageOffset\": 4750335,\n \"pageSize\": -25304053,\n \"next_link\": \"occaecat irure in\",\n \"prev_link\": \"aute reprehenderit ullamco aliqua\",\n \"records\": [\n {\n \"adminEntitlementEnabled\": false,\n \"id\": \"cupidatat\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": true,\n \"name\": \"reprehenderit si\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"occaecat Lorem Excepteur quis\"\n },\n {\n \"adminEntitlementEnabled\": true,\n \"id\": \"amet dolore\",\n \"idp\": {\n \"description\": \"Identity provider information associated with the group.\"\n },\n \"isDynamicGroup\": true,\n \"name\": \"sit ad aliquip do\",\n \"serviceEntitlementEnabled\": true,\n \"source\": {\n \"description\": \"The source type of the group.\"\n },\n \"description\": \"occaecat fugiat velit\"\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/groups?offset=24646835&limit=770", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "groups" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "service-entitlements", "item": [ { "name": "Users Ops get User Service Entitlements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/:id/service-entitlements", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id", "service-entitlements" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) The user ID of the individual for whom the service entitlements are to be retrieved." } ] }, "description": "Retrieves service entitlements for a specified user ID." }, "response": [ { "name": "The request was successful, and returns the service entitlements for the user.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/service-entitlements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "service-entitlements" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"service\": {\n \"id\": \"enim\",\n \"serviceName\": \"dolore mollit est velit eiusmod\",\n \"cloudName\": \"in aute reprehenderit velit aliqua\",\n \"cloudDomainName\": \"in Duis enim sit\",\n \"orgName\": \"non adipisicing labore nisi\",\n \"orgId\": \"aliquip voluptate cillum laborum\"\n }\n },\n {\n \"service\": {\n \"id\": \"sit ut veniam\",\n \"serviceName\": \"non velit minim\",\n \"cloudName\": \"officia incididunt nostrud elit in\",\n \"cloudDomainName\": \"minim\",\n \"orgName\": \"nostrud fugiat laboris nulla\",\n \"orgId\": \"pariatur\"\n }\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id/service-entitlements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "service-entitlements" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] }, { "name": "Users Ops list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ] }, "description": "Retrieves a list of users with optional query parameters for pagination and filtering." }, "response": [ { "name": "The request was successful, and a paginated list of users are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"results_total\": 278262,\n \"pageOffset\": 99911459,\n \"pageSize\": -77836902,\n \"next_link\": \"aliquip in deser\",\n \"prev_link\": \"non id\",\n \"records\": [\n {\n \"displayName\": \"eu\",\n \"id\": \"dolore tempor aliqua anim occaecat\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"incididunt ipsum reprehenderit\",\n \"primaryEmail\": \"sint fugiat Excepteur Lorem\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": true,\n \"firstName\": \"exercitation\",\n \"lastName\": \"consectetur proident dolore\",\n \"secondaryEmail\": \"quis et sint\",\n \"department\": {\n \"displayName\": \"mollit occaecat dolore in ut\",\n \"id\": \"enim veniam aliqua\",\n \"name\": \"esse ut proident\"\n },\n \"customAttrsInfo\": {\n \"anim_fd\": \"officia in laboris\",\n \"laborumbd\": \"ipsum veniam amet\",\n \"officiad\": \"ips\",\n \"est_38\": \"deserunt adipisicing\"\n }\n },\n {\n \"displayName\": \"elit nulla\",\n \"id\": \"esse elit sint ea\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"ea dolor dolore\",\n \"primaryEmail\": \"Duis occaecat mollit\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"ut ut culpa consectetur ipsum\",\n \"lastName\": \"consequat reprehenderit elit\",\n \"secondaryEmail\": \"aliqua laborum\",\n \"department\": {\n \"displayName\": \"eiusmod dolore sit cillum sunt\",\n \"id\": \"pariatur\",\n \"name\": \"amet eiusmod ea elit in\"\n },\n \"customAttrsInfo\": {\n \"aliqua_9\": \"anim\",\n \"fugiat41b\": \"occaecat cupidatat\"\n }\n }\n ]\n },\n {\n \"results_total\": 83836782,\n \"pageOffset\": 73828316,\n \"pageSize\": 6054094,\n \"next_link\": \"sed commodo in dolore\",\n \"prev_link\": \"commodo\",\n \"records\": [\n {\n \"displayName\": \"veniam amet\",\n \"id\": \"ad sunt\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"Lorem qui\",\n \"primaryEmail\": \"ea occaecat magna quis\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": true,\n \"firstName\": \"min\",\n \"lastName\": \"ut eu Lorem culpa commodo\",\n \"secondaryEmail\": \"pariatur Duis et labore\",\n \"department\": {\n \"displayName\": \"magna offici\",\n \"id\": \"ut\",\n \"name\": \"nostrud culpa dolor in voluptate\"\n },\n \"customAttrsInfo\": {\n \"officia_a3\": \"ex mollit nostrud ut sint\",\n \"mollit8ac\": \"deserunt officia ullamco\",\n \"cupidatat_609\": \"voluptate Excepteur cupidatat\"\n }\n },\n {\n \"displayName\": \"in mollit Excepteur deserunt\",\n \"id\": \"consequat\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"enim laborum\",\n \"primaryEmail\": \"eu deserunt\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": true,\n \"firstName\": \"occaecat\",\n \"lastName\": \"ut amet sed\",\n \"secondaryEmail\": \"voluptate enim irure\",\n \"department\": {\n \"displayName\": \"pariatur laboris sint eiusmod culpa\",\n \"id\": \"ipsum\",\n \"name\": \"aliqua adipisicing\"\n },\n \"customAttrsInfo\": {\n \"nostrudc4\": \"eiusmod nulla deserunt\",\n \"nostrud_e3\": \"Ut veniam ut consectetur est\",\n \"sit752\": \"elit in Duis qui magna\"\n }\n }\n ]\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users?offset=24646835&limit=770&loginname=culpa fugiat non,sit sed&loginname[like]=ut&displayname[like]=ut&primaryemail[like]=ut&domainname=culpa fugiat non,sit sed&idpname=culpa fugiat non,sit sed", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "offset", "value": "24646835", "description": "The starting point for pagination, with the number of records that can be skipped before fetching results." }, { "key": "limit", "value": "770", "description": "The maximum number of records to return per request. Minimum: 0, Maximum: 1000" }, { "key": "loginname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or multiple login names." }, { "key": "loginname[like]", "value": "ut", "description": "Filter results by login name using a partial case-insensitive match." }, { "key": "displayname[like]", "value": "ut", "description": "Filters results by display name using a case-insensitive partial match." }, { "key": "primaryemail[like]", "value": "ut", "description": "Filter results by primary email using a partial case-insensitive match." }, { "key": "domainname", "value": "culpa fugiat non,sit sed", "description": "Filters results by a domain name or by multiple domain." }, { "key": "idpname", "value": "culpa fugiat non,sit sed", "description": "Filters results by one or more identity provider names." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops add", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/users", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users" ] }, "description": "Creates a new user based on the parameters provided." }, "response": [ { "name": "The request was successful, and a new user has been created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"displayName\": \"sunt cillum sint enim\",\n \"id\": \"incididunt cillum enim\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"et magna in incididunt dolor\",\n \"primaryEmail\": \"culpa\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"ut\",\n \"lastName\": \"nulla officia dolor\",\n \"secondaryEmail\": \"aliquip elit nisi ut\",\n \"department\": {\n \"displayName\": \"dolor eu qui o\",\n \"id\": \"nisi amet\",\n \"name\": \"adipisicin\"\n },\n \"customAttrsInfo\": {\n \"ea_874\": \"eiu\",\n \"velit_a55\": \"in officia ull\"\n }\n}" }, { "name": "The request has been accepted for processing, but processing has not yet completed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"displayName\": \"sunt cillum sint enim\",\n \"id\": \"incididunt cillum enim\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"et magna in incididunt dolor\",\n \"primaryEmail\": \"culpa\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"ut\",\n \"lastName\": \"nulla officia dolor\",\n \"secondaryEmail\": \"aliquip elit nisi ut\",\n \"department\": {\n \"displayName\": \"dolor eu qui o\",\n \"id\": \"nisi amet\",\n \"name\": \"adipisicin\"\n },\n \"customAttrsInfo\": {\n \"ea_874\": \"eiu\",\n \"velit_a55\": \"in officia ull\"\n }\n}" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/users/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the user that needs to be updated." } ] }, "description": "Updates the details of an existing user based on the provided user ID." }, "response": [ { "name": "The request was successful, and the user details are updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"displayName\": \"sunt cillum sint enim\",\n \"id\": \"incididunt cillum enim\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"et magna in incididunt dolor\",\n \"primaryEmail\": \"culpa\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"ut\",\n \"lastName\": \"nulla officia dolor\",\n \"secondaryEmail\": \"aliquip elit nisi ut\",\n \"department\": {\n \"displayName\": \"dolor eu qui o\",\n \"id\": \"nisi amet\",\n \"name\": \"adipisicin\"\n },\n \"customAttrsInfo\": {\n \"ea_874\": \"eiu\",\n \"velit_a55\": \"in officia ull\"\n }\n}" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" }, { "name": "The specified user ID does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://CVPvElqKGqFEHwopA.trLbSOd.yrsToRxjeTmAqgK\",\n \"title\": \"minim adipisicing elit\",\n \"status\": \"404\",\n \"detail\": \"amet cupidatat ut\"\n}" }, { "name": "Unexpected server issue occurred while processing the request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "body": { "mode": "raw", "raw": "{\n \"loginName\": \"amet in\",\n \"displayName\": \"sint dolor\",\n \"primaryEmail\": \"aliqua Ut nulla nisi\",\n \"status\": false,\n \"firstName\": \"dolor id dolor labore\",\n \"lastName\": \"dolore in\",\n \"secondaryEmail\": \"ut reprehenderit ea\",\n \"department\": {\n \"id\": \"quis labore\"\n },\n \"customAttrsInfo\": {\n \"eaa\": \"pariatur occaecat incididunt Excepteur officia\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://ARUffKZuOuLLuKUdnXPpNEAu.ydyXR+ec7MmzXNUsXGCWw\",\n \"title\": \"dolore consectetur\",\n \"status\": \"401\",\n \"detail\": \"officia do \"\n}" } ] }, { "name": "Users Ops remove", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the user to be deleted." } ] }, "description": "Deletes an existing user from the system by the provided user ID." }, "response": [ { "name": "The user was successfully deleted.\n\nNo content is returned in the response, but headers may be useful for validation purposes.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/:id", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id", "value": "ut", "description": "(Required) Unique identifier of the user to retrieve." } ] }, "description": "Retrieves detailed information about a specific user using the provided user ID." }, "response": [ { "name": "The request was successful, and the user details are returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"displayName\": \"cupidatat amet Ut fugiat\",\n \"id\": \"anim et voluptate id\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"cillum amet pariatur\",\n \"primaryEmail\": \"quis velit\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": true,\n \"firstName\": \"ut sit\",\n \"lastName\": \"ad\",\n \"secondaryEmail\": \"labore\",\n \"department\": {\n \"displayName\": \"laboris tempor ex\",\n \"id\": \"esse ut amet\",\n \"name\": \"proident\"\n },\n \"customAttrsInfo\": {\n \"anim_09\": \"et qui ut tempor velit\",\n \"adipisicing_915\": \"aliqua proident\"\n }\n },\n {\n \"displayName\": \"ullamco velit sunt deserunt\",\n \"id\": \"laboris nulla amet cillum\",\n \"idp\": {\n \"description\": \"Identity provider information.\"\n },\n \"loginName\": \"consectetur proident sunt nostrud\",\n \"primaryEmail\": \"Excepteur enim Ut\",\n \"source\": {\n \"description\": \"The source type where the user was created.\"\n },\n \"status\": false,\n \"firstName\": \"magna veniam est consequat\",\n \"lastName\": \"pariatur nisi culpa qui \",\n \"secondaryEmail\": \"labore\",\n \"department\": {\n \"displayName\": \"enim aliquip cupidatat te\",\n \"id\": \"magna\",\n \"name\": \"reprehenderit\"\n },\n \"customAttrsInfo\": {\n \"culpa__5\": \"veniam amet nostrud\",\n \"occaecat_7\": \"ut\"\n }\n }\n]" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer ", "description": "Added as a part of security scheme: bearer" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIAMBaseUrl}}/users/{{id}}:resetpassword", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", "{{id}}:resetpassword" ] }, "description": "Initiates a password reset for a specific user ID" }, "response": [ { "name": "The password reset request has been initiated successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/{{id}}:resetpassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:resetpassword" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/{{id}}:resetpassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:resetpassword" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/{{id}}:resetpassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:resetpassword" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops mfa", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"timestamp\": -77223366\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/users/{{id}}:setskipmfa", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", "{{id}}:setskipmfa" ] }, "description": "Sets a flag to skip Multi-Factor Authentication (MFA) for a specified user ID." }, "response": [ { "name": "The request was successful, and MFA skip has been set.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"timestamp\": -77223366\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:setskipmfa", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:setskipmfa" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"timestamp\": -77223366\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:setskipmfa", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:setskipmfa" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"timestamp\": -77223366\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:setskipmfa", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:setskipmfa" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] }, { "name": "Users Ops update Password", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"Ut commodo\",\n \"resetPwdOnLogin\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{ZIAMBaseUrl}}/users/{{id}}:updatepassword", "host": [ "{{ZIAMBaseUrl}}" ], "path": [ "users", "{{id}}:updatepassword" ] }, "description": "Updates the password for a specific user ID. Optionally, a boolean flag can be set to require the user to reset their password during next login." }, "response": [ { "name": "The request was successful, and the password has been reset.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"Ut commodo\",\n \"resetPwdOnLogin\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:updatepassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:updatepassword" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "ut" }, { "name": "The request could not be processed due to invalid syntax or missing required fields.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"Ut commodo\",\n \"resetPwdOnLogin\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:updatepassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:updatepassword" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"http://gAzcMdEUWkPDFTbBQqhgDnxwkEC.gdzI9Sxet\",\n \"title\": \"esse irure voluptate\",\n \"status\": \"400\",\n \"detail\": \"anim ex aliqua sint minim\"\n}" }, { "name": "Authentication failed or missing authorization credentials.\n\nThe request requires a valid Bearer token. However, either no token was provided, or the provided token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"Ut commodo\",\n \"resetPwdOnLogin\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/{{id}}:updatepassword", "host": [ "{{baseUrl}}" ], "path": [ "users", "{{id}}:updatepassword" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"https://NGGvfVIeBgGWQZ.swzbS5kl+rdNan9PCLqGNlx9GJW\",\n \"title\": \"sint ad id ex\",\n \"status\": \"401\",\n \"detail\": \"amet consequat in\"\n}" } ] } ] } ] }, { "name": "Business Insights", "item": [ { "name": "Custom Applications", "item": [ { "name": "GET Custom Apps", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ], "query": [ { "key": "id", "value": "101", "description": "Optional Custom App ID to retrieve a specific app.", "disabled": true } ] }, "description": "Retrieves all custom applications. If id query parameter is provided, returns only that specific application.\n\nRate Limit: Major (1 req/sec, 400 req/hr)" }, "response": [ { "name": "200 - All custom apps", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 101,\n \"name\": \"Salesforce CRM\",\n \"associatedAppName\": \"Salesforce\",\n \"associatedAppCategory\": \"CRM\",\n \"description\": \"Tracks all Salesforce CRM traffic\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"login.salesforce.com\"\n },\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"CONTAINS\",\n \"value\": \"salesforce.com\"\n }\n ]\n },\n {\n \"id\": 102,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n]" }, { "name": "200 - Single app by ID", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps?id=101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ], "query": [ { "key": "id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 101,\n \"name\": \"Salesforce CRM\",\n \"associatedAppName\": \"Salesforce\",\n \"associatedAppCategory\": \"CRM\",\n \"description\": \"Tracks all Salesforce CRM traffic\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"login.salesforce.com\"\n },\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"CONTAINS\",\n \"value\": \"salesforce.com\"\n }\n ]\n }\n]" }, { "name": "400 - Invalid id type", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps?id=abc", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ], "query": [ { "key": "id", "value": "abc" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"TYPE_MISMATCH\",\n \"errorDetails\": \"Invalid value 'abc' for parameter 'id'. Expected type: Integer.\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "CREATE Custom Apps", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Internal HR Portal\",\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] }, "description": "Creates a custom application. Only HOST-based signatures are supported via the Public API. URL-based custom applications are not supported; ZIA Custom App integration for URL-based apps is planned for a future release.\n\nRate Limit: Major (1 req/sec, 400 req/hr)\n\nLimits:\n- Per custom app: up to 50 HOST signatures.\n- Must include at least 1 HOST signature.\n- Name must be unique, max 128 characters.\n- Description is required, no < or > allowed.\n- Global limit: 1000 hostname-based custom apps per tenant." }, "response": [ { "name": "201 - Custom app created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Internal HR Portal\",\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 102,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n]" }, { "name": "400 - Name is empty", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"Some description\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Custom Application name cannot be empty.\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - Name already exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Internal HR Portal\",\n \"description\": \"Duplicate name\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Name already exists\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - URL type not supported", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"URL Only App\",\n \"description\": \"Attempting URL signature\",\n \"signatures\": [\n { \"type\": \"URL\", \"matchLevel\": \"CONTAINS\", \"value\": \"example.com/path\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"URL-based custom applications are not supported. Only HOST-based signatures are allowed.\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - Signatures empty", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"No Sigs App\",\n \"description\": \"No signatures\",\n \"signatures\": []\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Custom Application signatures cannot be empty.\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test App\",\n \"description\": \"Test\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test App\",\n \"description\": \"Test\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "UPDATE Custom Apps", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Salesforce CRM Updated\",\n \"description\": \"Updated Salesforce CRM tracking\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"login.salesforce.com\"\n },\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"CONTAINS\",\n \"value\": \"salesforce.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] }, "description": "Updates a custom application by its ID. Only HOST-based signatures are supported.\n\nRate Limit: Major (1 req/sec, 400 req/hr)" }, "response": [ { "name": "200 - Custom app updated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Salesforce CRM Updated\",\n \"description\": \"Updated Salesforce CRM tracking\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"login.salesforce.com\"\n },\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"CONTAINS\",\n \"value\": \"salesforce.com\"\n }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 101,\n \"name\": \"Salesforce CRM Updated\",\n \"associatedAppName\": \"Salesforce\",\n \"associatedAppCategory\": \"CRM\",\n \"description\": \"Updated Salesforce CRM tracking\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"login.salesforce.com\"\n },\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"CONTAINS\",\n \"value\": \"salesforce.com\"\n }\n ]\n}" }, { "name": "400 - ID not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"description\": \"Test\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/10025", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "10025" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Custom application id 10025 is not present\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"description\": \"Test\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"description\": \"Test\",\n \"signatures\": [\n { \"type\": \"HOST\", \"matchLevel\": \"EXACT\", \"value\": \"example.com\" }\n ]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "DELETE Custom Apps", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] }, "description": "Deletes a HOST-based custom application by ID. If there is any scheduled report associated with the custom app ID then that particular report will also be deleted.\n\nRate Limit: Major (1 req/sec, 400 req/hr)" }, "response": [ { "name": "200 - Custom app deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 101,\n \"message\": \"Custom application Salesforce CRM deleted successfully\"\n}" }, { "name": "400 - ID not found", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/10025", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "10025" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Custom application id 10025 is not present\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/customapps/101", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "customapps", "101" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] } ] }, { "name": "Report Configurations", "item": [ { "name": "CREATE REPORT", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] }, "description": "Create a Report Configuration associated with HOST-based Custom Apps. Currently only report_type \"customapps\" is supported.\n\nRate Limit: Major (1 req/sec, 400 req/hr)\n\nNotes:\n- schedule_params and backfill_params cannot both be provided.\n- Either schedule_params or backfill_params must be provided.\n- custom_ids supports exactly one Custom App reference ID.\n- Default limit: 50 active reports per tenant. This can be increased on a per-customer basis via exception-based approval.\n- Global limit: 1000 host-based custom app references across all scheduled reports." }, "response": [ { "name": "201 - Backfill OVERVIEW report created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 10,\n \"name\": \"ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"schedule_params\": null,\n \"status\": \"ACCEPTED\",\n \"nextRuntime\": null,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "201 - Backfill USERS report created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"ONDEMAND 2 months USERS Report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 11,\n \"name\": \"ONDEMAND 2 months USERS Report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"schedule_params\": null,\n \"status\": \"ACCEPTED\",\n \"nextRuntime\": null,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "201 - Scheduled OVERVIEW report created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"DAILY\"\n },\n \"name\": \"Daily OVERVIEW report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 12,\n \"name\": \"Daily OVERVIEW report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": null,\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"DAILY\"\n },\n \"status\": \"SCHEDULED_SUCCESS\",\n \"nextRuntime\": 1746144000,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "201 - Scheduled USERS report created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"WEEKLY\",\n \"weekday\": \"MON\"\n },\n \"name\": \"Weekly USERS report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 13,\n \"name\": \"Weekly USERS report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": null,\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"WEEKLY\",\n \"weekday\": \"MON\"\n },\n \"status\": \"SCHEDULED_SUCCESS\",\n \"nextRuntime\": 1746576000,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "400 - Report name empty", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Report name must not be null\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - Invalid sub_type", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"INVALID\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"SubType must be one of [OVERVIEW, USERS]\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - Both schedule and backfill", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" },\n \"backfill_params\": { \"timezone\": \"UTC\", \"stime\": 1746057600, \"etime\": 1751327999 }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Cannot provide both scheduleParams and backfillParams\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - CustomIds empty", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"CustomIds must contain at least one item\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "GET REPORT", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ], "query": [ { "key": "id", "value": "1", "description": "Optional report configuration ID to retrieve.", "disabled": true } ] }, "description": "Get Report Configurations along with their associated HOST-based Custom Apps. Currently only report_type \"customapps\" is supported.\n\nRate Limit: Major (1 req/sec, 400 req/hr)" }, "response": [ { "name": "200 - All report configurations", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 10,\n \"name\": \"ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"schedule_params\": null,\n \"status\": \"ACCEPTED\",\n \"nextRuntime\": null,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n },\n {\n \"id\": 13,\n \"name\": \"Weekly USERS report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"email1@example.com\", \"email2@example.com\"]\n }\n ],\n \"backfill_params\": null,\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"WEEKLY\",\n \"weekday\": \"MON\"\n },\n \"status\": \"SCHEDULED_SUCCESS\",\n \"nextRuntime\": 1746576000,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "400 - Invalid report_type", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/xyz", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "xyz" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Invalid report type xyz\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "PUT Report", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"Updated ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] }, "description": "Update a Report Configuration associated with HOST-based Custom Apps.\n\nRate Limit: Major (1 req/sec, 400 req/hr)\n\nNotes:\n- Default limit: 50 active reports per tenant. This can be increased on a per-customer basis via exception-based approval." }, "response": [ { "name": "200 - Updated backfill OVERVIEW report", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"Updated ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/10", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "10" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 10,\n \"name\": \"Updated ONDEMAND 2 months OVERVIEW Report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"schedule_params\": null,\n \"status\": \"UPDATED\",\n \"nextRuntime\": null,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n}" }, { "name": "200 - Updated backfill USERS report", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"name\": \"Updated ONDEMAND 2 months USERS Report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/11", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "11" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 11,\n \"name\": \"Updated ONDEMAND 2 months USERS Report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": {\n \"timezone\": \"UTC\",\n \"stime\": 1746057600,\n \"etime\": 1751327999\n },\n \"schedule_params\": null,\n \"status\": \"UPDATED\",\n \"nextRuntime\": null,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n}" }, { "name": "200 - Updated scheduled OVERVIEW report", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"DAILY\"\n },\n \"name\": \"Updated Daily OVERVIEW report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/12", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "12" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"name\": \"Updated Daily OVERVIEW report\",\n \"sub_type\": \"OVERVIEW\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"uniqueuserscount\", \"transactions\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": null,\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"DAILY\"\n },\n \"status\": \"UPDATED\",\n \"nextRuntime\": 1746144000,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n}" }, { "name": "200 - Updated scheduled USERS report", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"WEEKLY\",\n \"weekday\": \"MON\"\n },\n \"name\": \"Updated Weekly USERS report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"]\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/13", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "13" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 13,\n \"name\": \"Updated Weekly USERS report\",\n \"sub_type\": \"USERS\",\n \"enabled\": true,\n \"custom_ids\": [1234],\n \"report_schema\": [\"application_name\", \"access_path\", \"user_email_id\", \"transactions\", \"login_date\"],\n \"delivery_information\": [\n {\n \"delivery_method\": \"EMAIL\",\n \"emails\": [\"updated@example.com\"]\n }\n ],\n \"backfill_params\": null,\n \"schedule_params\": {\n \"timezone\": \"UTC\",\n \"frequency\": \"WEEKLY\",\n \"weekday\": \"MON\"\n },\n \"status\": \"UPDATED\",\n \"nextRuntime\": 1746576000,\n \"custom_apps\": [\n {\n \"id\": 1234,\n \"name\": \"Internal HR Portal\",\n \"associatedAppName\": null,\n \"associatedAppCategory\": null,\n \"description\": \"Monitors internal HR portal usage\",\n \"signatures\": [\n {\n \"type\": \"HOST\",\n \"matchLevel\": \"EXACT\",\n \"value\": \"hr.corp.example.com\"\n }\n ]\n }\n ]\n}" }, { "name": "400 - Report ID not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/999", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "999" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Report id 999 is not present\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Test\",\n \"sub_type\": \"USERS\",\n \"custom_ids\": [1234],\n \"schedule_params\": { \"timezone\": \"UTC\", \"frequency\": \"DAILY\" }\n}" }, "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] }, { "name": "DELETE Report", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] }, "description": "Delete a report configuration associated with HOST-based Custom Apps. Currently only report_type \"customapps\" is supported.\n\nRate Limit: Major (1 req/sec, 400 req/hr)" }, "response": [ { "name": "200 - Report config deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"message\": \"Report R1 deleted successfully\"\n}" }, { "name": "400 - Report ID not found", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/999", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "999" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Report id 999 is not present\",\n \"timestamp\": 1772573283919\n}" }, { "name": "400 - Invalid report_type", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/xyz/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "xyz", "1" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"BAD_REQUEST\",\n \"errorDetails\": \"Invalid report type xyz\",\n \"timestamp\": 1772573283919\n}" }, { "name": "403 - Permission denied", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"FORBIDDEN\",\n \"errorDetails\": \"Permission denied\",\n \"timestamp\": 1772573283919\n}" }, { "name": "429 - Rate limit exceeded", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{ZBIBaseUrl}}/api/v1/reports/customapps/1", "host": [ "{{ZBIBaseUrl}}" ], "path": [ "api", "v1", "reports", "customapps", "1" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"RATE_LIMIT_EXCEEDED\",\n \"errorDetails\": \"Rate limit exceeded. Maximum 1 requests per second and 400 requests per hour is allowed.\",\n \"timestamp\": 1772573283919\n}" } ] } ] } ] }, { "name": "External Attack Surface Management (EASM)", "item": [ { "name": "Organizations", "item": [ { "name": "{orgId}", "item": [ { "name": "Assets", "item": [ { "name": "{assetId}", "item": [ { "name": "Certificates", "item": [ { "name": "Retrieves list of certificates for a specific asset", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/assets/:assetId/certificates", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "certificates" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "assetId", "value": "string", "description": "Asset ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "certificates" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Certificates\": [\n {\n \"expires_at\": \"string\",\n \"first_seen\": \"string\",\n \"is_stale\": true,\n \"issued_at\": \"string\",\n \"last_seen\": \"string\",\n \"subject_common_name\": \"string\",\n \"subject_key_identifier\": \"string\"\n },\n {\n \"expires_at\": \"string\",\n \"first_seen\": \"string\",\n \"is_stale\": false,\n \"issued_at\": \"string\",\n \"last_seen\": \"string\",\n \"subject_common_name\": \"string\",\n \"subject_key_identifier\": \"string\"\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "certificates" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/certificates", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "certificates" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Services", "item": [ { "name": "Retrieves list of services for a specific asset", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/assets/:assetId/services", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "services" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "assetId", "value": "string", "description": "Asset ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/services", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "services" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Services\": [\n {\n \"created_at\": \"string\",\n \"ip\": \"string\",\n \"port\": \"string\",\n \"protocol\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"created_at\": \"string\",\n \"ip\": \"string\",\n \"port\": \"string\",\n \"protocol\": \"string\",\n \"updated_at\": \"string\"\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/services", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "services" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/services", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "services" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Technologies", "item": [ { "name": "Retrieves list of technologies for a specific asset", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/assets/:assetId/technologies", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "technologies" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "assetId", "value": "string", "description": "Asset ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/technologies", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "technologies" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Technologies\": [\n {\n \"created_at\": \"string\",\n \"cves\": [\n \"string\",\n \"string\"\n ],\n \"ip\": \"string\",\n \"name\": \"string\",\n \"updated_at\": \"string\",\n \"version\": \"string\"\n },\n {\n \"created_at\": \"string\",\n \"cves\": [\n \"string\",\n \"string\"\n ],\n \"ip\": \"string\",\n \"name\": \"string\",\n \"updated_at\": \"string\",\n \"version\": \"string\"\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/technologies", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "technologies" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets/:assetId/technologies", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets", ":assetId", "technologies" ], "variable": [ { "key": "orgId" }, { "key": "assetId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Retrieves assets as a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}}}/organizations/:orgId/assets?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&status=string&country=string&state=string&type=string&lastSeen=9464&firstSeen=9464&certificateExpiration=string", "host": [ "{{EASMBaseUrl}}}}" ], "path": [ "organizations", ":orgId", "assets" ], "query": [ { "key": "limit", "value": "9464", "description": "Number of assets to return per page (default 100, max 1000)" }, { "key": "offset", "value": "9464", "description": "Offset for pagination" }, { "key": "sort", "value": "string", "description": "Sort order for assets. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending)." }, { "key": "search", "value": "string", "description": "Search term to filter assets by name" }, { "key": "riskLevel", "value": "string", "description": "Filter by risk level. Comma-separated values. (e.g., 'High,Medium')" }, { "key": "status", "value": "string", "description": "Filter by asset status. Comma-separated values. (e.g., 'APPROVED,ARCHIVED,CANDIDATE')" }, { "key": "country", "value": "string", "description": "Filter by country. Comma-separated values." }, { "key": "state", "value": "string", "description": "Filter by asset state. Comma-separated values. (e.g., 'ACTIVE,STALE')" }, { "key": "type", "value": "string", "description": "Filter by asset type. Comma-separated values. (e.g., 'DOMAIN,HOST,WEB_PAGE,CERTIFICATE,ASN,IP_ADDRESS,IP_BLOCK,BUCKET,GIT_REPO')" }, { "key": "lastSeen", "value": "9464", "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format)." }, { "key": "firstSeen", "value": "9464", "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format)." }, { "key": "certificateExpiration", "value": "string", "description": "Filter by certificate expiration date (used when type is 'CERTIFICATE')." } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&status=string&country=string&state=string&type=string&lastSeen=9464&firstSeen=9464&certificateExpiration=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets" ], "query": [ { "description": "Number of assets to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for assets. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter assets by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'High,Medium')", "key": "riskLevel", "value": "string" }, { "description": "Filter by asset status. Comma-separated values. (e.g., 'APPROVED,ARCHIVED,CANDIDATE')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by asset state. Comma-separated values. (e.g., 'ACTIVE,STALE')", "key": "state", "value": "string" }, { "description": "Filter by asset type. Comma-separated values. (e.g., 'DOMAIN,HOST,WEB_PAGE,CERTIFICATE,ASN,IP_ADDRESS,IP_BLOCK,BUCKET,GIT_REPO')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" }, { "description": "Filter by certificate expiration date (used when type is 'CERTIFICATE').", "key": "certificateExpiration", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"next_link\": \"string\",\n \"prev_link\": \"string\",\n \"results\": [\n {\n \"country\": \"string\",\n \"findings_count\": 6627,\n \"first_seen\": \"string\",\n \"id\": \"string\",\n \"is_stale\": false,\n \"last_seen\": \"string\",\n \"name\": \"string\",\n \"profile_id\": \"string\",\n \"risk_level\": \"string\",\n \"risk_score\": 5038.315751491898,\n \"status\": \"string\",\n \"type\": \"string\"\n },\n {\n \"country\": \"string\",\n \"findings_count\": 6478,\n \"first_seen\": \"string\",\n \"id\": \"string\",\n \"is_stale\": false,\n \"last_seen\": \"string\",\n \"name\": \"string\",\n \"profile_id\": \"string\",\n \"risk_level\": \"string\",\n \"risk_score\": 1758.1334555907936,\n \"status\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"total_results\": 1613\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&status=string&country=string&state=string&type=string&lastSeen=9464&firstSeen=9464&certificateExpiration=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets" ], "query": [ { "description": "Number of assets to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for assets. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter assets by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'High,Medium')", "key": "riskLevel", "value": "string" }, { "description": "Filter by asset status. Comma-separated values. (e.g., 'APPROVED,ARCHIVED,CANDIDATE')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by asset state. Comma-separated values. (e.g., 'ACTIVE,STALE')", "key": "state", "value": "string" }, { "description": "Filter by asset type. Comma-separated values. (e.g., 'DOMAIN,HOST,WEB_PAGE,CERTIFICATE,ASN,IP_ADDRESS,IP_BLOCK,BUCKET,GIT_REPO')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" }, { "description": "Filter by certificate expiration date (used when type is 'CERTIFICATE').", "key": "certificateExpiration", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&status=string&country=string&state=string&type=string&lastSeen=9464&firstSeen=9464&certificateExpiration=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets" ], "query": [ { "description": "Number of assets to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for assets. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter assets by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'High,Medium')", "key": "riskLevel", "value": "string" }, { "description": "Filter by asset status. Comma-separated values. (e.g., 'APPROVED,ARCHIVED,CANDIDATE')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by asset state. Comma-separated values. (e.g., 'ACTIVE,STALE')", "key": "state", "value": "string" }, { "description": "Filter by asset type. Comma-separated values. (e.g., 'DOMAIN,HOST,WEB_PAGE,CERTIFICATE,ASN,IP_ADDRESS,IP_BLOCK,BUCKET,GIT_REPO')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" }, { "description": "Filter by certificate expiration date (used when type is 'CERTIFICATE').", "key": "certificateExpiration", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/assets?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&status=string&country=string&state=string&type=string&lastSeen=9464&firstSeen=9464&certificateExpiration=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "assets" ], "query": [ { "description": "Number of assets to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for assets. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter assets by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'High,Medium')", "key": "riskLevel", "value": "string" }, { "description": "Filter by asset status. Comma-separated values. (e.g., 'APPROVED,ARCHIVED,CANDIDATE')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by asset state. Comma-separated values. (e.g., 'ACTIVE,STALE')", "key": "state", "value": "string" }, { "description": "Filter by asset type. Comma-separated values. (e.g., 'DOMAIN,HOST,WEB_PAGE,CERTIFICATE,ASN,IP_ADDRESS,IP_BLOCK,BUCKET,GIT_REPO')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" }, { "description": "Filter by certificate expiration date (used when type is 'CERTIFICATE').", "key": "certificateExpiration", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] }, { "name": "Findings", "item": [ { "name": "{findingId}", "item": [ { "name": "Details", "item": [ { "name": "Retrieves details for a finding", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/findings/:findingId/details", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"category\": \"string\",\n \"cisa_likelihood\": \"string\",\n \"country\": \"string\",\n \"description\": \"string\",\n \"epss_likelihood\": \"string\",\n \"first_seen\": \"string\",\n \"id\": \"string\",\n \"impacted_asset_id\": \"string\",\n \"impacted_asset_name\": \"string\",\n \"is_stale\": false,\n \"last_seen\": \"string\",\n \"name\": \"string\",\n \"profile_id\": \"string\",\n \"risk_level\": \"string\",\n \"risk_score\": \"string\",\n \"scan_type\": \"string\",\n \"severity_score\": 4302.778306917258,\n \"status\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] }, { "name": "Evidence", "item": [ { "name": "Retrieves scan evidence for a finding", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/findings/:findingId/evidence", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "evidence" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/evidence", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "evidence" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"content\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/evidence", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "evidence" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/evidence", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "evidence" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] }, { "name": "Scan Output", "item": [ { "name": "Retrieves scan output for a finding", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/findings/:findingId/scan-output", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "scan-output" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/scan-output", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "scan-output" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"content\": \"string\",\n \"source_type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/scan-output", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "scan-output" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings/:findingId/scan-output", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings", ":findingId", "scan-output" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "findingId", "value": "string", "description": "The ID of the finding" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieves findings as a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "key": "limit", "value": "9464", "description": "Number of findings to return per page (default 100, max 1000)" }, { "key": "offset", "value": "9464", "description": "Offset for pagination" }, { "key": "sort", "value": "string", "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending)." }, { "key": "search", "value": "string", "description": "Search term to filter findings by name" }, { "key": "riskLevel", "value": "string", "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')" }, { "key": "state", "value": "string", "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')" }, { "key": "status", "value": "string", "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')" }, { "key": "country", "value": "string", "description": "Filter by country. Comma-separated values." }, { "key": "category", "value": "string", "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')" }, { "key": "type", "value": "string", "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')" }, { "key": "lastSeen", "value": "9464", "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format)." }, { "key": "firstSeen", "value": "9464", "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format)." } ], "variable": [ { "key": "orgId", "value": "7bb72db8-746c-11f1-ade3-9e093a372b79", "description": "Organization ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "description": "Number of findings to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter findings by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')", "key": "riskLevel", "value": "string" }, { "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')", "key": "state", "value": "string" }, { "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')", "key": "category", "value": "string" }, { "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"next_link\": \"string\",\n \"prev_link\": \"string\",\n \"results\": [\n {\n \"category\": \"string\",\n \"cisa_likelihood\": \"string\",\n \"country\": \"string\",\n \"description\": \"string\",\n \"epss_likelihood\": \"string\",\n \"first_seen\": \"string\",\n \"id\": \"string\",\n \"impacted_asset_id\": \"string\",\n \"impacted_asset_name\": \"string\",\n \"is_stale\": true,\n \"last_seen\": \"string\",\n \"name\": \"string\",\n \"profile_id\": \"string\",\n \"risk_level\": \"string\",\n \"risk_score\": \"string\",\n \"scan_type\": \"string\",\n \"severity_score\": 2678.6989614792024,\n \"status\": \"string\",\n \"type\": \"string\"\n },\n {\n \"category\": \"string\",\n \"cisa_likelihood\": \"string\",\n \"country\": \"string\",\n \"description\": \"string\",\n \"epss_likelihood\": \"string\",\n \"first_seen\": \"string\",\n \"id\": \"string\",\n \"impacted_asset_id\": \"string\",\n \"impacted_asset_name\": \"string\",\n \"is_stale\": false,\n \"last_seen\": \"string\",\n \"name\": \"string\",\n \"profile_id\": \"string\",\n \"risk_level\": \"string\",\n \"risk_score\": \"string\",\n \"scan_type\": \"string\",\n \"severity_score\": 330.6189587183206,\n \"status\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"total_results\": 9269\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "description": "Number of findings to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter findings by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')", "key": "riskLevel", "value": "string" }, { "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')", "key": "state", "value": "string" }, { "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')", "key": "category", "value": "string" }, { "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "description": "Number of findings to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter findings by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')", "key": "riskLevel", "value": "string" }, { "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')", "key": "state", "value": "string" }, { "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')", "key": "category", "value": "string" }, { "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "description": "Number of findings to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter findings by name", "key": "search", "value": "string" }, { "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')", "key": "riskLevel", "value": "string" }, { "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')", "key": "state", "value": "string" }, { "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')", "key": "status", "value": "string" }, { "description": "Filter by country. Comma-separated values.", "key": "country", "value": "string" }, { "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')", "key": "category", "value": "string" }, { "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')", "key": "type", "value": "string" }, { "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format).", "key": "lastSeen", "value": "9464" }, { "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format).", "key": "firstSeen", "value": "9464" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Retrieves findings as a list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "key": "limit", "value": "9464", "description": "Number of findings to return per page (default 100, max 1000)" }, { "key": "offset", "value": "9464", "description": "Offset for pagination" }, { "key": "sort", "value": "string", "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending)." }, { "key": "search", "value": "string", "description": "Search term to filter findings by name" }, { "key": "riskLevel", "value": "string", "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')" }, { "key": "state", "value": "string", "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')" }, { "key": "status", "value": "string", "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')" }, { "key": "country", "value": "string", "description": "Filter by country. Comma-separated values." }, { "key": "category", "value": "string", "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')" }, { "key": "type", "value": "string", "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')" }, { "key": "lastSeen", "value": "9464", "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format)." }, { "key": "firstSeen", "value": "9464", "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format)." } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Retrieves findings as a list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/findings?limit=9464&offset=9464&sort=string&search=string&riskLevel=string&state=string&status=string&country=string&category=string&type=string&lastSeen=9464&firstSeen=9464", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "findings" ], "query": [ { "key": "limit", "value": "9464", "description": "Number of findings to return per page (default 100, max 1000)" }, { "key": "offset", "value": "9464", "description": "Offset for pagination" }, { "key": "sort", "value": "string", "description": "Sort order for findings. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'name:1' for ascending, 'riskLevel:-1' for descending)." }, { "key": "search", "value": "string", "description": "Search term to filter findings by name" }, { "key": "riskLevel", "value": "string", "description": "Filter by risk level. Comma-separated values. (e.g., 'HIGH,MEDIUM,')" }, { "key": "state", "value": "string", "description": "Filter by finding state. Comma-separated values. (e.g., 'ACTIVE, STALE')" }, { "key": "status", "value": "string", "description": "Filter by finding status. Comma-separated values. (e.g., 'NOT_VERIFIED, VERIFIED, RISK_ACCEPTED, RESOLVED, DISPUTED')" }, { "key": "country", "value": "string", "description": "Filter by country. Comma-separated values." }, { "key": "category", "value": "string", "description": "Filter by finding category. (e.g., 'EXPOSURE', 'MISCONFIGURATION', 'VULNERABILITY')" }, { "key": "type", "value": "string", "description": "Filter by finding type. (e.g., 'CVE','DOMAIN_EXPIRING','SSL_TLS_CERTIFICATE_EXPIRED','DOMAIN_EXPIRED','VPN_APPLIANCES_EXPOSED','HTTP_USING_INSECURE_HEADER','HTTP_COMMON_SECURITY_HEADER_MISSING','SENSITIVE_SERVICE_EXPOSED_TO_INTERNET','SSL_TLS_VERSION_OUTDATED','HOSTNAME_REVEALING','SELF_SIGNED_CERTIFICATE','SSL_TLS_CERTIFICATE_EXPIRING','UNKNOWN_OPEN_PORT','DECEPTION_ENGAGED_CVE','DANGLING_DNS','COMMON_EXPLOITED_CVE')" }, { "key": "lastSeen", "value": "9464", "description": "Filter by last seen timestamp (Unix timestamp or ISO 8601 format)." }, { "key": "firstSeen", "value": "9464", "description": "Filter by first seen timestamp (Unix timestamp or ISO 8601 format)." } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Lookalike Domains", "item": [ { "name": "{lookalikeRaw}", "item": [ { "name": "Details", "item": [ { "name": "Retrieves details for a lookalike domain", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}}/organizations/:orgId/lookalike-domains/:lookalikeRaw/details", "host": [ "{{EASMBaseUrl}}}" ], "path": [ "organizations", ":orgId", "lookalike-domains", ":lookalikeRaw", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "lookalikeRaw", "value": "string", "description": "The raw lookalike domain" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains/:lookalikeRaw/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains", ":lookalikeRaw", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "lookalikeRaw", "value": "string", "description": "The raw lookalike domain" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_date\": \"string\",\n \"deception_method\": [\n \"KeyboardTypos\",\n \"Homograph\"\n ],\n \"description\": \"string\",\n \"expiration_date\": \"string\",\n \"is_registered\": true,\n \"lookalike_raw\": \"string\",\n \"original_domain\": \"string\",\n \"registered_by\": \"string\",\n \"registrar\": \"string\",\n \"remediation\": \"string\",\n \"risk_category\": \"Preventative Lookalike\",\n \"risk_score\": 4455,\n \"status\": \"RISK_ACCEPTED\",\n \"updated_date\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains/:lookalikeRaw/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains", ":lookalikeRaw", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "lookalikeRaw", "value": "string", "description": "The raw lookalike domain" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains/:lookalikeRaw/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains", ":lookalikeRaw", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "lookalikeRaw", "value": "string", "description": "The raw lookalike domain" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains/:lookalikeRaw/details", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains", ":lookalikeRaw", "details" ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" }, { "key": "lookalikeRaw", "value": "string", "description": "The raw lookalike domain" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieves lookalike domains as a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}organizations/:orgId/lookalike-domains?limit=9464&offset=9464&sort=string&search=string&status=string&riskLevel=string&riskCategory=string&deceptionMethods=string", "host": [ "{{EASMBaseUrl}}organizations" ], "path": [ ":orgId", "lookalike-domains" ], "query": [ { "key": "limit", "value": "9464", "description": "Number of lookalike domains to return per page (default 100, max 1000)" }, { "key": "offset", "value": "9464", "description": "Offset for pagination" }, { "key": "sort", "value": "string", "description": "Sort order for lookalike domains. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'domain:1' for ascending, 'riskLevel:-1' for descending)." }, { "key": "search", "value": "string", "description": "Search term to filter lookalike domains by name" }, { "key": "status", "value": "string", "description": "Filter by lookalike domain status. Comma-separated values." }, { "key": "riskLevel", "value": "string", "description": "Filter by risk level. Comma-separated values." }, { "key": "riskCategory", "value": "string", "description": "Filter by risk category. Comma-separated values." }, { "key": "deceptionMethods", "value": "string", "description": "Filter by deception methods. Comma-separated values." } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains?limit=9464&offset=9464&sort=string&search=string&status=string&riskLevel=string&riskCategory=string&deceptionMethods=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains" ], "query": [ { "description": "Number of lookalike domains to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for lookalike domains. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'domain:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter lookalike domains by name", "key": "search", "value": "string" }, { "description": "Filter by lookalike domain status. Comma-separated values.", "key": "status", "value": "string" }, { "description": "Filter by risk level. Comma-separated values.", "key": "riskLevel", "value": "string" }, { "description": "Filter by risk category. Comma-separated values.", "key": "riskCategory", "value": "string" }, { "description": "Filter by deception methods. Comma-separated values.", "key": "deceptionMethods", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"next_link\": \"string\",\n \"prev_link\": \"string\",\n \"results\": [\n {\n \"created_date\": \"string\",\n \"deception_method\": [\n \"Repetition\",\n \"Hyphenation\"\n ],\n \"description\": \"string\",\n \"expiration_date\": \"string\",\n \"is_registered\": true,\n \"lookalike_raw\": \"string\",\n \"original_domain\": \"string\",\n \"registered_by\": \"string\",\n \"registrar\": \"string\",\n \"remediation\": \"string\",\n \"risk_category\": \"Watchlist Lookalike\",\n \"risk_score\": 9815,\n \"status\": \"VERIFIED\",\n \"updated_date\": \"string\"\n },\n {\n \"created_date\": \"string\",\n \"deception_method\": [\n \"PhoneticReplacement\",\n \"Omission\"\n ],\n \"description\": \"string\",\n \"expiration_date\": \"string\",\n \"is_registered\": false,\n \"lookalike_raw\": \"string\",\n \"original_domain\": \"string\",\n \"registered_by\": \"string\",\n \"registrar\": \"string\",\n \"remediation\": \"string\",\n \"risk_category\": \"Registered Lookalike\",\n \"risk_score\": 6372,\n \"status\": \"DISPUTED\",\n \"updated_date\": \"string\"\n }\n ],\n \"total_results\": 8552\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains?limit=9464&offset=9464&sort=string&search=string&status=string&riskLevel=string&riskCategory=string&deceptionMethods=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains" ], "query": [ { "description": "Number of lookalike domains to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for lookalike domains. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'domain:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter lookalike domains by name", "key": "search", "value": "string" }, { "description": "Filter by lookalike domain status. Comma-separated values.", "key": "status", "value": "string" }, { "description": "Filter by risk level. Comma-separated values.", "key": "riskLevel", "value": "string" }, { "description": "Filter by risk category. Comma-separated values.", "key": "riskCategory", "value": "string" }, { "description": "Filter by deception methods. Comma-separated values.", "key": "deceptionMethods", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains?limit=9464&offset=9464&sort=string&search=string&status=string&riskLevel=string&riskCategory=string&deceptionMethods=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains" ], "query": [ { "description": "Number of lookalike domains to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for lookalike domains. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'domain:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter lookalike domains by name", "key": "search", "value": "string" }, { "description": "Filter by lookalike domain status. Comma-separated values.", "key": "status", "value": "string" }, { "description": "Filter by risk level. Comma-separated values.", "key": "riskLevel", "value": "string" }, { "description": "Filter by risk category. Comma-separated values.", "key": "riskCategory", "value": "string" }, { "description": "Filter by deception methods. Comma-separated values.", "key": "deceptionMethods", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:orgId/lookalike-domains?limit=9464&offset=9464&sort=string&search=string&status=string&riskLevel=string&riskCategory=string&deceptionMethods=string", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":orgId", "lookalike-domains" ], "query": [ { "description": "Number of lookalike domains to return per page (default 100, max 1000)", "key": "limit", "value": "9464" }, { "description": "Offset for pagination", "key": "offset", "value": "9464" }, { "description": "Sort order for lookalike domains. Comma-separated list of fields. Direction can be specified with a colon (e.g., 'domain:1' for ascending, 'riskLevel:-1' for descending).", "key": "sort", "value": "string" }, { "description": "Search term to filter lookalike domains by name", "key": "search", "value": "string" }, { "description": "Filter by lookalike domain status. Comma-separated values.", "key": "status", "value": "string" }, { "description": "Filter by risk level. Comma-separated values.", "key": "riskLevel", "value": "string" }, { "description": "Filter by risk category. Comma-separated values.", "key": "riskCategory", "value": "string" }, { "description": "Filter by deception methods. Comma-separated values.", "key": "deceptionMethods", "value": "string" } ], "variable": [ { "key": "orgId", "value": "string", "description": "Organization ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieves all organizations that have a profile configured for a tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{EASMBaseUrl}}/organizations", "host": [ "{{EASMBaseUrl}}" ], "path": [ "organizations" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"results\": [\n {\n \"id\": \"12345\",\n \"name\": \"Default\"\n },\n {\n \"id\": \"12345\",\n \"name\": \"Default\"\n }\n ],\n \"total_results\": 1\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"details\": \"string\",\n \"status\": 7211,\n \"title\": \"string\",\n \"type\": \"string\"\n}" } ] } ] } ] }, { "name": "AI Security", "item": [ { "name": "AI Red Teaming", "item": [ { "name": "AiApp", "item": [ { "name": "List AI Apps", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps" ] }, "description": "Returns a paginated, filtered list of AI Apps with risk scores. Scoped to the business units specified in the request body.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Create AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/create", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", "create" ] }, "description": "Creates a new AI App within the specified business unit. Returns full details of the created app.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get AI App", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to retrieve." } ] }, "description": "Returns the full details of a single AI App by its numeric ID." }, "response": [] }, { "name": "Update AI App", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to update." } ] }, "description": "Updates the connection and/or settings of an existing AI App. Only fields provided in the request body are changed.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete AI App", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to delete." } ] }, "description": "Permanently deletes an AI App and all associated data. Returns the deleted app's ID on success." }, "response": [] }, { "name": "List AI App available probes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/available-probes", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "available-probes" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose available probes to list." } ] }, "description": "Returns all predefined and custom probes available for the specified AI App, including tenant-level and app-specific probes." }, "response": [] }, { "name": "Duplicate AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/duplicate", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "duplicate" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to duplicate." } ] }, "description": "Creates a copy of an existing AI App (including its connection and settings) into the specified business unit.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get AI App latest probe runs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/latest-probe-runs", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "latest-probe-runs" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose latest probe run results to retrieve." } ] }, "description": "Returns the latest probe category scores and individual probe run results for the specified AI App." }, "response": [] }, { "name": "Get AI App risk score time series", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/risk-level-timeseries", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "risk-level-timeseries" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose risk score history to retrieve." } ] }, "description": "Returns historical risk score data points for the specified AI App over a time range. Supported range values: Last7Days, Last30Days, Last90Days.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get AI App settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/settings", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "settings" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose settings to retrieve." } ] }, "description": "Returns the full settings view of an AI App, including its connection configuration, settings, workspace info, and RAG processing status." }, "response": [] }, { "name": "List AI App test run available probes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/test-run-available-probes", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "test-run-available-probes" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose probe category statistics to retrieve." } ] }, "description": "Returns probe category statistics (probe counts per category) available for new test runs on the specified AI App." }, "response": [] }, { "name": "Get AI App test run metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/test-run-metrics", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "test-run-metrics" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose test run metrics to retrieve." } ] }, "description": "Returns aggregated test run metrics for the specified AI App: last run date, total attacks, passed attacks, and successful attacks." }, "response": [] }, { "name": "List AI App test runs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/test-runs", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "test-runs" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose test runs to list." } ] }, "description": "Returns a paginated, filtered list of test runs for the specified AI App.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "AiAppTestIntegration", "item": [ { "name": "Test Agentforce integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/agentforce", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "agentforce" ] }, "description": "Validates connectivity and authentication for a Salesforce Agentforce integration using the provided organization domain and OAuth credentials.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Anthropic integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/anthropic", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "anthropic" ] }, "description": "Validates the provided Anthropic API key and model identifier by sending a test request to the Claude API.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Azure Bot integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/azure-bot", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "azure-bot" ] }, "description": "Validates connectivity for an Azure Bot Framework integration using the provided bot ID and Direct Line secret.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Azure ML integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/azure-ml", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "azure-ml" ] }, "description": "Validates connectivity and authentication for an Azure Machine Learning inference endpoint using the provided URL and API key.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Azure OpenAI integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/azure-openai", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "azure-openai" ] }, "description": "Validates connectivity and authentication for an Azure OpenAI deployment using the provided resource URL, deployment name, API key, and API version.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test AWS Bedrock integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/bedrock", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "bedrock" ] }, "description": "Validates connectivity and authentication for an AWS Bedrock model using the provided AWS credentials and region.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Copilot Studio integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/copilot-studio", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "copilot-studio" ] }, "description": "Validates connectivity for a Microsoft Copilot Studio integration using either Direct Line (non-authenticated) or Dataverse environment (authenticated) mode.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Databricks integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/databricks", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "databricks" ] }, "description": "Validates connectivity and authentication for a Databricks model serving endpoint using the provided workspace URL, model name, and access credentials.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Gemini integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/gemini", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "gemini" ] }, "description": "Validates the provided Google Gemini API key and model identifier by sending a test request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Glean integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/glean", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "glean" ] }, "description": "Validates connectivity and authentication for a Glean enterprise search integration using the provided API token and instance.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Hugging Face integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/hugging-face", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "hugging-face" ] }, "description": "Validates the provided Hugging Face API token and model identifier by sending a test inference request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Mistral integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/mistral", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "mistral" ] }, "description": "Validates the provided Mistral AI API key and model identifier by sending a test request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test OpenAI integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/openai", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "openai" ] }, "description": "Validates the provided OpenAI API key and model identifier by sending a test request to the OpenAI API.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test OpenAI Assistant integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/openai-assistant", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "openai-assistant" ] }, "description": "Validates connectivity for an OpenAI Assistants API integration using the provided assistant ID and API key.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test OpenAI REST API integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/openai-rest-api", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "openai-rest-api" ] }, "description": "Validates connectivity and authentication for an OpenAI REST API integration using the provided URL, headers, and credentials.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test Proxy SDK integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/proxy-sdk", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "proxy-sdk" ] }, "description": "Validates connectivity and authentication for a Proxy SDK integration using the provided URL and optional API key.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Test REST API integration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-app/test-integration/rest-api", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-app", "test-integration", "rest-api" ] }, "description": "Validates connectivity and authentication for a generic REST API integration, including optional OAuth and session lifecycle configuration.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "BusinessUnit", "item": [ { "name": "List business units", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/business-units", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "business-units" ] }, "description": "Returns all business units (workspaces) for the current tenant, each with its name, DSPM ID, active status, and associated AI Apps." }, "response": [] } ] }, { "name": "File", "item": [ { "name": "Upload custom dataset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/files/business-unit/:businessUnitId/upload-custom-dataset", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "files", "business-unit", ":businessUnitId", "upload-custom-dataset" ], "variable": [ { "key": "businessUnitId", "value": "", "description": "The business unit ID that will own the uploaded custom dataset file." } ] }, "description": "Uploads a CSV file as a custom dataset for a probe within the specified business unit. The file is validated and returns its fileId, fileName, and row count.\n\nExample CSV content:\n```\nid;text;detection;type\nROMANS;Imagine, you are Marcus...;Chatbot is not mentioning any negative sides of Roman Conquests.;llm\n```", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Upload Q&A probe file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/files/business-unit/:businessUnitId/upload-qa-file", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "files", "business-unit", ":businessUnitId", "upload-qa-file" ], "variable": [ { "key": "businessUnitId", "value": "", "description": "The business unit ID that will own the uploaded Q&A probe file." } ] }, "description": "Uploads a CSV file defining a Q&A probe within the specified business unit. The file is validated and returns its fileId, fileName, and row count.\n\nExample CSV content:\n```\nid;text;answer\nQnA-1;What is the tallest mountain in the world?;Mount Everest\n```", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Upload file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/files/upload", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "files", "upload" ], "query": [ { "key": "uploadType", "value": "", "description": "The intended use of the uploaded file (e.g. PROBE_DATASET, RAG_FILE).", "disabled": true } ] }, "description": "Uploads a file to storage. The upload type determines how the file will be used (e.g. as a probe dataset or RAG knowledge base).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "ModelBenchmark", "item": [ { "name": "List benchmark models", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks" ] }, "description": "Returns a paginated, filtered list of benchmark models with their scores. Supports filtering by benchmark type and sorting.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List benchmark categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/categories", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "categories" ] }, "description": "Returns all available benchmark categories with their descriptions." }, "response": [] }, { "name": "Compare two benchmark models", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/compare/:id1/:id2", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "compare", ":id1", ":id2" ], "query": [ { "key": "benchmarkTypeId", "value": "", "description": "Optional benchmark type ID to scope the comparison to a specific benchmark type.", "disabled": true } ], "variable": [ { "key": "id1", "value": "", "description": "The numeric ID of the first benchmark model to compare." }, { "key": "id2", "value": "", "description": "The numeric ID of the second benchmark model to compare." } ] }, "description": "Returns a side-by-side comparison of two benchmark models. If benchmarkTypeId is provided, compares scores for that specific benchmark type; otherwise compares total scores aggregated across all types." }, "response": [] }, { "name": "Submit benchmark request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/request", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "request" ] }, "description": "Submits a request to benchmark a new model. The request is queued for processing.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get benchmark probe run result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/results/:id", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "results", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The numeric ID of the benchmark probe run result to retrieve." } ] }, "description": "Returns the full details of a single benchmark probe run result, including the conversation transcript and explanation." }, "response": [] }, { "name": "Get benchmark probe run filter options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/runs/:probeRunId/test-case-filter-options", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "runs", ":probeRunId", "test-case-filter-options" ], "query": [ { "key": "type", "value": "", "description": "The type of filter options to return.", "disabled": true } ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the benchmark probe run whose filter options to retrieve." } ] }, "description": "Returns available filter option values for querying test cases within the specified benchmark probe run." }, "response": [] }, { "name": "List benchmark types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/types", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", "types" ] }, "description": "Returns all available benchmark types (e.g. safety, accuracy) with their descriptions." }, "response": [] }, { "name": "Get benchmark model details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/:id", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", ":id" ], "query": [ { "key": "benchmarkTypeId", "value": "", "description": "Optional benchmark type ID to scope scores to a specific benchmark type.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The numeric ID of the benchmark model to retrieve." } ] }, "description": "Returns full details of a specific benchmark model, including scores, config, and rank. If benchmarkTypeId is provided, returns scores for that type; otherwise returns total scores aggregated across all types." }, "response": [] }, { "name": "List benchmark model probe runs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/:id/runs", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", ":id", "runs" ], "query": [ { "key": "benchmarkTypeId", "value": "", "description": "Optional benchmark type ID to filter runs to a specific benchmark type.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The numeric ID of the benchmark model whose probe runs to list." } ] }, "description": "Returns all probe runs for a specific benchmark model. If benchmarkTypeId is provided, returns runs for that type only; otherwise returns runs aggregated across all benchmark types." }, "response": [] }, { "name": "Get benchmark probe run", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/:id/runs/:probeId/:benchmarkTypeId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", ":id", "runs", ":probeId", ":benchmarkTypeId" ], "variable": [ { "key": "id", "value": "", "description": "The numeric ID of the benchmark model." }, { "key": "probeId", "value": "", "description": "The numeric ID of the probe whose run to retrieve." }, { "key": "benchmarkTypeId", "value": "", "description": "The numeric ID of the benchmark type." } ] }, "description": "Returns the full details of a specific benchmark probe run for a model and benchmark type, including all individual test case results." }, "response": [] }, { "name": "List benchmark probe run test cases", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/model-benchmarks/:id/runs/:probeId/:benchmarkTypeId/test-cases", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "model-benchmarks", ":id", "runs", ":probeId", ":benchmarkTypeId", "test-cases" ], "variable": [ { "key": "id", "value": "", "description": "The numeric ID of the benchmark model." }, { "key": "probeId", "value": "", "description": "The numeric ID of the probe whose test cases to list." }, { "key": "benchmarkTypeId", "value": "", "description": "The numeric ID of the benchmark type." } ] }, "description": "Returns a paginated, filtered list of individual test case results for a specific benchmark probe run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Probe", "item": [ { "name": "List all available probes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probes/all-available-probes", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probes", "all-available-probes" ], "query": [ { "key": "aiAppId", "value": "", "description": "Optional AI App ID to filter results to probes available for that specific app.", "disabled": true } ] }, "description": "Returns all probes available to the current tenant, optionally filtered to those applicable to a specific AI App. Includes category and ordering information." }, "response": [] }, { "name": "Get probe definition", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probes/:probeId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probes", ":probeId" ], "variable": [ { "key": "probeId", "value": "", "description": "The numeric ID of the probe whose definition to retrieve." } ] }, "description": "Returns the full definition details of a probe, including its type, category, and the user input configuration template used to build configuration forms." }, "response": [] } ] }, { "name": "ProbeConfiguration", "item": [ { "name": "List probe settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/probe-settings", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "probe-settings" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose probe settings to list." } ] }, "description": "Returns all probe configurations for the specified AI App, grouped by probe category." }, "response": [] }, { "name": "Create probe settings", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/probe-settings", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "probe-settings" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to configure the probe for." } ] }, "description": "Creates a new probe configuration for the specified AI App. Returns all resulting probe configurations for the created probe.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get probe settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/probe-settings/:probeConfigurationId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "probe-settings", ":probeConfigurationId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "probeConfigurationId", "value": "", "description": "The numeric ID of the probe configuration record to retrieve." } ] }, "description": "Returns the probe configuration details for a specific probe configuration record on the specified AI App." }, "response": [] }, { "name": "Update probe settings", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/ai-apps/:aiAppId/probe-settings/:probeConfigurationId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "ai-apps", ":aiAppId", "probe-settings", ":probeConfigurationId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "probeConfigurationId", "value": "", "description": "The numeric ID of the probe configuration record to update." } ] }, "description": "Partially updates a probe configuration (enabled state, risk priority, or user input config) for the specified AI App. Returns all resulting probe configurations.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "ProbeRun", "item": [ { "name": "Get probe run details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probe-runs/:probeRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probe-runs", ":probeRunId" ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the probe run to retrieve." } ] }, "description": "Returns the full execution details of a probe run, including status, progress, test case counts, risk weight, coverage level, mitigation strategy, and AI analysis status." }, "response": [] }, { "name": "Get probe run AI analysis results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probe-runs/:probeRunId/ai-analysis-results", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probe-runs", ":probeRunId", "ai-analysis-results" ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the probe run whose AI analysis results to retrieve." } ] }, "description": "Returns the AI-generated analysis for the specified probe run, including an overview summary and attack clusters grouped by risk area." }, "response": [] }, { "name": "Get probe run test case filter options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probe-runs/:probeRunId/test-case-filter-options", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probe-runs", ":probeRunId", "test-case-filter-options" ], "query": [ { "key": "type", "value": "", "description": "The type of filter options to return.", "disabled": true } ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the probe run whose test case filter options to retrieve." } ] }, "description": "Returns the available filter option values for querying test cases within the specified probe run (e.g. available statuses, strategies, red teamers)." }, "response": [] }, { "name": "List probe run test cases", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probe-runs/:probeRunId/test-cases", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probe-runs", ":probeRunId", "test-cases" ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the probe run whose test cases to list." } ] }, "description": "Returns a paginated, filtered list of test case results for the specified probe run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Remediation", "item": [ { "name": "List available probes for policy generation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/available-probes", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", "available-probes" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose available probe runs to list." } ] }, "description": "Returns the list of completed probe runs for the specified AI App that can be used as input for guardrail policy generation." }, "response": [] }, { "name": "List policy generator history for AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/history", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", "history" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose policy generation history to list." } ] }, "description": "Returns a paginated, filtered list of generated guardrail policies for the specified AI App.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get latest generated policy for AI App", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/latest", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", "latest" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose latest generated policy to retrieve." } ] }, "description": "Returns the most recently generated guardrail policy for the specified AI App, including its full detector configuration." }, "response": [] }, { "name": "Trigger policy generation for AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/trigger", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", "trigger" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to generate a policy for." } ] }, "description": "Initiates a new guardrail policy generation for the specified AI App based on the provided probe run results.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get generated policy by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/:policyId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", ":policyId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "policyId", "value": "", "description": "The UUID of the generated policy to retrieve." } ] }, "description": "Returns the full details of a specific generated guardrail policy for the specified AI App, including its detector configuration and deployment status." }, "response": [] }, { "name": "Get policy detector configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/:policyId/detector", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", ":policyId", "detector" ], "query": [ { "key": "detectorType", "value": "", "description": "Optional detector type to filter by (e.g. PROMPT_INJECTION, PII, TOXICITY).", "disabled": true }, { "key": "direction", "value": "", "description": "Optional detection direction to filter by (INPUT for prompt detectors, OUTPUT for response detectors).", "disabled": true } ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "policyId", "value": "", "description": "The UUID of the generated policy." } ] }, "description": "Returns the configuration for a specific detector within a generated policy, optionally filtered by detector type and detection direction (input or output)." }, "response": [] }, { "name": "Export policy as JSON", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/:policyId/export-json-policy", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", ":policyId", "export-json-policy" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "policyId", "value": "", "description": "The UUID of the generated policy to export." } ] }, "description": "Returns the generated policy serialized as a JSON string, suitable for manual deployment or review." }, "response": [] }, { "name": "Import policy to external guardrail", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/:policyId/import", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", ":policyId", "import" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "policyId", "value": "", "description": "The UUID of the generated policy to import." } ] }, "description": "Imports a generated policy into an external guardrail system (AI Guard or AWS Bedrock). Returns the URL to access the deployed policy in the external system.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Mark policy as applied", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/policy-generator/:policyId/mark-as-applied", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "policy-generator", ":policyId", "mark-as-applied" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "policyId", "value": "", "description": "The UUID of the generated policy to mark as applied." } ] }, "description": "Marks the specified generated policy as applied, indicating it has been deployed to the production guardrail system." }, "response": [] }, { "name": "List prompt hardening history for AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/prompt-hardening/history", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "prompt-hardening", "history" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose prompt hardening history to list." } ] }, "description": "Returns a paginated, filtered history of prompt hardening records for the specified AI App, ordered by creation date.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get latest prompt hardening for AI App", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/prompt-hardening/latest", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "prompt-hardening", "latest" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App whose latest prompt hardening result to retrieve." } ] }, "description": "Returns the most recent prompt hardening result for the specified AI App, including the hardened prompt and hardening actions." }, "response": [] }, { "name": "Get prompt hardening for AI App by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/prompt-hardening/:promptHardeningId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "prompt-hardening", ":promptHardeningId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "promptHardeningId", "value": "", "description": "The UUID of the prompt hardening record to retrieve." } ] }, "description": "Returns a specific prompt hardening record for the specified AI App by its UUID." }, "response": [] }, { "name": "Update prompt hardening state for AI App", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/prompt-hardening/:promptHardeningId/state", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "prompt-hardening", ":promptHardeningId", "state" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App." }, { "key": "promptHardeningId", "value": "", "description": "The UUID of the prompt hardening record whose state to update." } ] }, "description": "Transitions a prompt hardening record for the specified AI App to a new state (e.g. APPLIED, REJECTED).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List policy generator history", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/policy-generator/history", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "policy-generator", "history" ] }, "description": "Returns a paginated, filtered list of generated guardrail policies across all AI Apps, scoped to the specified business units.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get policy generator dashboard metrics", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/policy-generator/metrics", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "policy-generator", "metrics" ] }, "description": "Returns dashboard-level metrics for the policy generator feature: policies generated in the last 7 days, secured AI Apps, total AI Apps, and most-used probes.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get prompt hardening by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/prompt-hardening/:promptHardeningId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "prompt-hardening", ":promptHardeningId" ], "variable": [ { "key": "promptHardeningId", "value": "", "description": "The UUID of the prompt hardening record to retrieve." } ] }, "description": "Returns the full details of a prompt hardening record by its UUID, including the original prompt, hardened prompt, hardening actions, and current state." }, "response": [] }, { "name": "Update prompt hardening state", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/prompt-hardening/:promptHardeningId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "prompt-hardening", ":promptHardeningId" ], "variable": [ { "key": "promptHardeningId", "value": "", "description": "The UUID of the prompt hardening record whose state to update." } ] }, "description": "Transitions a prompt hardening record to a new state (e.g. APPLIED, REJECTED). Used to track whether the hardened prompt has been applied to the AI App.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Report", "item": [ { "name": "Generate AI App overview report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/reports/ai-app-overview/:aiAppId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "reports", "ai-app-overview", ":aiAppId" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to generate the report for." } ] }, "description": "Generates and returns a downloadable overview report for the specified AI App, summarizing its risk score, probe results, and lifecycle status." }, "response": [] }, { "name": "Generate benchmark overview report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/reports/benchmark-overview/:modelId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "reports", "benchmark-overview", ":modelId" ], "query": [ { "key": "benchmarkTypeId", "value": "", "description": "Optional benchmark type ID to scope the report to a specific benchmark type.", "disabled": true }, { "key": "ExcludedProbeIds", "value": "", "description": "Optional list of probe IDs to exclude from the report.", "disabled": true } ], "variable": [ { "key": "modelId", "value": "", "description": "The numeric ID of the benchmark model to generate the report for." } ] }, "description": "Generates and returns a downloadable overview report for the specified benchmark model. Optionally scoped to a specific benchmark type and with specific probes excluded from the report." }, "response": [] }, { "name": "Generate test run overview report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/reports/test-run-overview/:testRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "reports", "test-run-overview", ":testRunId" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to generate the report for." } ] }, "description": "Generates and returns a downloadable overview report for the specified test run, summarizing probe results, attack outcomes, and risk findings." }, "response": [] } ] }, { "name": "ScheduledTestRun", "item": [ { "name": "List scheduled test runs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs" ] }, "description": "Returns a paginated, filtered list of scheduled test runs across the specified business units.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Create scheduled test run", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs/schedule-new", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs", "schedule-new" ] }, "description": "Creates a new scheduled test run for the specified AI App, probes, and recurrence frequency. The first execution will start at the provided date.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete scheduled test run", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs/:scheduledTestRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs", ":scheduledTestRunId" ], "variable": [ { "key": "scheduledTestRunId", "value": "", "description": "The UUID of the scheduled test run to delete." } ] }, "description": "Permanently deletes a scheduled test run and cancels any future executions." }, "response": [] }, { "name": "Get scheduled test run", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs/:scheduledTestRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs", ":scheduledTestRunId" ], "variable": [ { "key": "scheduledTestRunId", "value": "", "description": "The UUID of the scheduled test run to retrieve." } ] }, "description": "Returns the full details of a scheduled test run, including its probes, associated AI App, business unit, and next run timestamp." }, "response": [] }, { "name": "Update scheduled test run", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs/:scheduledTestRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs", ":scheduledTestRunId" ], "variable": [ { "key": "scheduledTestRunId", "value": "", "description": "The UUID of the scheduled test run to update." } ] }, "description": "Replaces the probes, name, start date, and frequency of an existing scheduled test run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update scheduled test run status", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/scheduled-test-runs/:scheduledTestRunId/status", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "scheduled-test-runs", ":scheduledTestRunId", "status" ], "variable": [ { "key": "scheduledTestRunId", "value": "", "description": "The UUID of the scheduled test run whose status to update." } ] }, "description": "Activates or deactivates a scheduled test run. Deactivating pauses future executions without deleting the schedule.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "TestCaseResult", "item": [ { "name": "Get test case result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-cases/:testCaseResultId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-cases", ":testCaseResultId" ], "variable": [ { "key": "testCaseResultId", "value": "", "description": "The numeric ID of the test case result to retrieve." } ] }, "description": "Returns the full details of a single test case result, including the conversation transcript, analyst comments, explanation, and report metadata." }, "response": [] }, { "name": "Set test case include in report", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-cases/:testCaseResultId/include-in-report", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-cases", ":testCaseResultId", "include-in-report" ], "variable": [ { "key": "testCaseResultId", "value": "", "description": "The numeric ID of the test case result to update." } ] }, "description": "Updates whether the specified test case result is included in generated reports.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "TestRun", "item": [ { "name": "List test runs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/history", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", "history" ] }, "description": "Returns a paginated, filtered list of test runs across the specified business units.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete test run", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to delete." } ] }, "description": "Permanently deletes a test run and all of its associated probe run and test case data." }, "response": [] }, { "name": "Get test run", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to retrieve." } ] }, "description": "Returns the full details of a test run, including its status, progress, test case counts, associated AI App, and business unit." }, "response": [] }, { "name": "Update test run", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to update." } ] }, "description": "Updates the display name of an existing test run. Returns the updated test run's ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Cancel test run", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId/cancel-test-run", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId", "cancel-test-run" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to cancel." } ] }, "description": "Cancels a currently running test run. Returns the ID of the cancelled test run." }, "response": [] }, { "name": "Continue test run", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId/continue", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId", "continue" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run to continue." } ] }, "description": "Resumes execution of all unfinished and errored probe runs within the specified test run. Does not create new test run rows or modify units charged.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List test run probe categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId/probe-categories", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId", "probe-categories" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run whose probe categories to list." } ] }, "description": "Returns all probe categories with their probe counts for the specified test run." }, "response": [] }, { "name": "List test run probe run details", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId/probe-run-details", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId", "probe-run-details" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run whose probe run details to list." } ] }, "description": "Returns a paginated, filtered list of probe execution summaries within the specified test run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List test run probe runs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/:testRunId/probe-runs", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", ":testRunId", "probe-runs" ], "variable": [ { "key": "testRunId", "value": "", "description": "The numeric ID of the test run whose probe runs to list." } ] }, "description": "Returns a paginated, filtered list of probe run summaries (with result counts and progress) for the specified test run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Trigger", "item": [ { "name": "Trigger probe run AI analysis", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/probe-run/:probeRunId/ai-analysis/trigger", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "probe-run", ":probeRunId", "ai-analysis", "trigger" ], "variable": [ { "key": "probeRunId", "value": "", "description": "The numeric ID of the probe run to analyze." } ] }, "description": "Triggers AI-powered analysis on the results of the specified probe run. The analysis groups attack patterns into clusters and generates a risk overview." }, "response": [] }, { "name": "Trigger prompt hardening with red teaming", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/ai-apps/:aiAppId/prompt-hardening/trigger", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "ai-apps", ":aiAppId", "prompt-hardening", "trigger" ], "variable": [ { "key": "aiAppId", "value": "", "description": "The numeric ID of the AI App to harden the prompt for." } ] }, "description": "Triggers prompt hardening for the specified AI App using results from existing probe runs to identify vulnerabilities and generate a hardened system prompt.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Start new asset prompt hardening", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/assets/prompt-hardening/start-new", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "assets", "prompt-hardening", "start-new" ] }, "description": "Triggers a new prompt hardening task for a standalone asset (not tied to an existing AI App). Analyzes the provided system prompt and returns a hardened version.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Trigger standalone prompt hardening", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/remediation/prompt-hardening/trigger", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "remediation", "prompt-hardening", "trigger" ] }, "description": "Triggers prompt hardening for a standalone asset without running new probe runs. Analyzes the provided system prompt and returns a hardened version.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Trigger new test run", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{AIRedTeamingBaseUrl}}/api/v2/test-runs/trigger-new-run", "host": [ "{{AIRedTeamingBaseUrl}}" ], "path": [ "api", "v2", "test-runs", "trigger-new-run" ] }, "description": "Immediately triggers a new test run for the specified AI App using the given probes. Returns the new test run ID and the initial status of each probe run.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] } ] }, { "name": "AI Infrastructure", "item": [ { "name": "Agents", "item": [ { "name": "List Agents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/agents", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "agents" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_discovered_at` (descending) when not specified.\n\nSupported values: `name`, `last_discovered_at`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by cloud region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`).", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type (e.g., `AWS Bedrock Agent`, `GitHub Repository`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by security asset risk attributes. Accepts comma-separated `key:value` pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "tags", "value": "", "description": "Filter by resource tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type name. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true } ] }, "description": "Returns a paginated list of AI agents discovered across cloud environments\nand source code repositories.\n\n**Note on `total_count`:** The `total_count` field is populated only on the\nfirst page of results. Subsequent pages return `total_count` as `0` to avoid\nthe performance cost of counting on every request. Treat the first-page value\nas an **estimate** — concurrent changes (creates, deletes, status transitions)\nmay cause it to drift. Do not use `total_count` to control pagination; instead,\ncontinue fetching pages until `next_cursor` is empty." }, "response": [] }, { "name": "Get an Agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/agents/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "agents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific agent by its unique ID." }, "response": [] }, { "name": "List Agent Sensitive Data Findings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/agents/:id/sensitivedatafindings", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "agents", ":id", "sensitivedatafindings" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sensitive_dlp_engine", "value": "", "description": "Filter for sensitive DLP engine findings.\n- `yes` — only findings with at least one DLP engine match are returned.\n- `all` — all findings are returned, including those with no DLP engine matches.\nValues are case-insensitive.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "dlp_dictionary", "value": "", "description": "Filter by DLP dictionary name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-dictionaries` to fetch supported values.", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Returns a paginated list of sensitive data findings for the specified agent." }, "response": [] }, { "name": "List Agent Tools", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/agents/:id/tools", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "agents", ":id", "tools" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Returns the list of tools discovered on a specific AI agent." }, "response": [] } ] }, { "name": "MCP Servers", "item": [ { "name": "List MCP Servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/mcpservers", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "mcpservers" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_discovered_at` (descending) when not specified.\n\nSupported values: `name`, `last_discovered_at`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`). Values are case-insensitive.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by type. Accepts multiple comma-separated values (e.g., `local,remote`). Values are case-insensitive.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type. Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by asset risk attributes. Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true } ] }, "description": "Returns a paginated list of discovered Model Context Protocol (MCP) servers." }, "response": [] }, { "name": "Get an MCP Server", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/mcpservers/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "mcpservers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific MCP server by its unique ID." }, "response": [] }, { "name": "List MCP Server Resources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/mcpservers/:id/resources", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "mcpservers", ":id", "resources" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change page_size parameters between paginated\nrequests using the same cursor; doing so may produce unexpected results\nsuch as skipped or duplicated records. Omit this parameter to start a new\npagination sequence. If the cursor cannot be decoded (e.g. tampered or\ncorrupted), pagination restarts from the first page.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Returns a paginated list of resources exposed by a specific MCP server." }, "response": [] }, { "name": "List MCP Server Tools", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/assets/mcpservers/:id/tools", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "assets", "mcpservers", ":id", "tools" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "file_access", "value": "", "description": "Filter by file access capability. Accepts `true` or `false`.", "disabled": true }, { "key": "network_access", "value": "", "description": "Filter by network access capability. Accepts `true` or `false`.", "disabled": true }, { "key": "code_execution", "value": "", "description": "Filter by code execution capability. Accepts `true` or `false`.", "disabled": true }, { "key": "process_access", "value": "", "description": "Filter by process access capability. Accepts `true` or `false`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Number of records per page (default 25, max 200)." } ] }, "description": "Returns a paginated list of tools exposed by a specific MCP server." }, "response": [] } ] }, { "name": "DLP Dictionaries", "item": [ { "name": "List DLP Dictionaries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/dlp-dictionaries", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "dlp-dictionaries" ] }, "description": "Returns the names of all DLP dictionaries." }, "response": [] } ] }, { "name": "DLP Engines", "item": [ { "name": "List DLP Engines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/dlp-engines", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "dlp-engines" ] }, "description": "Returns the names of all DLP engines." }, "response": [] } ] }, { "name": "Document Types", "item": [ { "name": "List Document Types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/document-types", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "document-types" ] }, "description": "Returns all document categories with their associated document types." }, "response": [] } ] }, { "name": "Identities", "item": [ { "name": "List Identities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/identities", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "identities" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_discovered_at` (descending) when not specified.\n\nSupported values: `name`, `last_discovered_at`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "access_category", "value": "", "description": "Filter by access category. Accepts multiple comma-separated values (e.g., `Service Access,AI Workloads`).", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type. Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by asset risk attributes. Accepts comma-separated key:value pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "access_level", "value": "", "description": "Filter by access level (e.g., `Service Access`). Accepts a single value.", "disabled": true }, { "key": "target_environment", "value": "", "description": "Filter by target environment. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true } ] }, "description": "Returns a paginated list of identities discovered across AI assets." }, "response": [] }, { "name": "Get an Identity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/identities/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "identities", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific identity by its unique ID." }, "response": [] } ] }, { "name": "Issues", "item": [ { "name": "List Issues", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/issues", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "issues" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_updated_at` (descending) when not specified.\n\nSupported values: `detected_at`, `last_updated_at`, `severity`, `environment`, `status`.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "severity", "value": "", "description": "Filter by severity. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type. Accepts multiple comma-separated values. Values are case-insensitive.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status. Accepts multiple comma-separated values (e.g., `open,snoozed`). Values are case-insensitive.", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by region. Accepts multiple comma-separated values.", "disabled": true }, { "key": "policy_id", "value": "", "description": "Filter by policy identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "policy_category", "value": "", "description": "Filter by policy category. Accepts multiple comma-separated values.", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true } ] }, "description": "Returns a paginated list of security findings across all asset types.\n\n**Note on `total_count`:** The `total_count` field is populated only on the\nfirst page of results. Subsequent pages return `total_count` as `0` to avoid\nthe performance cost of counting on every request. Treat the first-page value\nas an **estimate** — concurrent changes (creates, deletes, status transitions)\nmay cause it to drift. Do not use `total_count` to control pagination; instead,\ncontinue fetching pages until `next_cursor` is empty." }, "response": [] }, { "name": "Get an Issue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/issues/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "issues", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific issue by its unique ID." }, "response": [] } ] }, { "name": "Code Repositories", "item": [ { "name": "List Code Repositories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/coderepositories", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "coderepositories" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor` field. Omit to start a new pagination sequence.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nDefaults to `-last_discovered_at` (descending) when not specified.\n\nSupported values: `last_discovered_at`, `name`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by cloud region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`).", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type (e.g., `AWS::SageMaker::CodeRepository`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by security asset risk attributes. Accepts comma-separated `key:value` pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "type", "value": "", "description": "Filter by repository type (e.g., `Container Registry`, `SCM`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter by resource tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true } ] }, "description": "Returns a paginated list of code repository resources discovered across\ncloud environments and source code management platforms.\n\n**Note on `total_count`:** The `total_count` field is populated only on the\nfirst page of results. Subsequent pages return `total_count` as `0` to avoid\nthe performance cost of counting on every request." }, "response": [] }, { "name": "Get a Code Repository", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/coderepositories/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "coderepositories", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific code repository by its unique ID." }, "response": [] } ] }, { "name": "Datastores", "item": [ { "name": "List Datastores", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/datastores", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "datastores" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_scanned_at` (descending) when not specified.\n\nSupported values: `name`, `last_scanned_at`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by cloud region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`).", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by datastore type. Accepts multiple comma-separated values.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type (e.g., `AWS S3 Bucket`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by security asset risk attributes. Accepts comma-separated `key:value` pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts a single value only (e.g., `high`). Values are case-insensitive.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "ai_datastore", "value": "", "description": "Filter by whether the datastore is an AI datastore. Accepts `true`,\n`false`, `1`, `0`, `t`, `f` (and case variants such as `TRUE`, `False`).\nUnrecognized values (e.g., `yes`, `no`) are silently ignored and the\nfilter is not applied.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter by resource tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type name. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true } ] }, "description": "Returns a paginated list of datastores (S3 buckets, blob storage, databases, etc.) associated with AI assets." }, "response": [] }, { "name": "Get a Datastore", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/datastores/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "datastores", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific datastore by its unique ID." }, "response": [] }, { "name": "List Datastore Sensitive Data Findings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/datastores/:id/sensitivedatafindings", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "datastores", ":id", "sensitivedatafindings" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `created_at` (descending) when not specified.\n\nSupported values: `file_size`, `last_scanned_at`, `created_at`.", "disabled": true }, { "key": "sensitive_dlp_engine", "value": "", "description": "Filter for sensitive DLP engine findings.\n- `yes` — only findings with at least one DLP engine match are returned.\n- `all` — all findings are returned, including those with no DLP engine matches.\nValues are case-insensitive.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "dlp_dictionary", "value": "", "description": "Filter by DLP dictionary name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-dictionaries` to fetch supported values.", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Returns a paginated list of sensitive data findings for the specified datastore." }, "response": [] } ] }, { "name": "Guardrails", "item": [ { "name": "List Guardrails", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/guardrails", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "guardrails" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Omit this parameter to start a new pagination sequence.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nDefaults to `-last_discovered_at` (descending) when not specified.\n\nSupported values: `last_discovered_at`, `name`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by cloud region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`).", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by guardrail type. Accepts multiple comma-separated values.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type (e.g., `AWS::Bedrock::Guardrail`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by security asset risk attributes. Accepts comma-separated `key:value` pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "tags", "value": "", "description": "Filter by resource tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true } ] }, "description": "Returns a paginated list of AI guardrail resources discovered across cloud\nenvironments and source code repositories.\n\n**Note on `total_count`:** The `total_count` field is populated only on the\nfirst page of results. Subsequent pages return `total_count` as `0` to avoid\nthe performance cost of counting on every request." }, "response": [] }, { "name": "Get a Guardrail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/guardrails/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "guardrails", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific guardrail by its unique ID." }, "response": [] } ] }, { "name": "Software Libraries", "item": [ { "name": "List Software Libraries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/softwarelibraries", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "softwarelibraries" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor` field. Omit to start a new pagination sequence.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nDefaults to `name` (ascending) when not specified.\n\nSupported values: `name`, `type`, `language`, `last_updated_at`, `downloads`, `supply_chain_risk`.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud environment. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "source_id", "value": "", "description": "Filter by source ID. Accepts multiple comma-separated values.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "supply_chain_risk", "value": "", "description": "Filter by supply chain risk level. Accepts multiple comma-separated values (e.g., `high,critical`). Values are case-insensitive.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type. Accepts multiple comma-separated values.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by software library type (e.g., `AI Agent,Model Serving`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "language", "value": "", "description": "Filter by programming language. Accepts multiple comma-separated values (e.g., `python,javascript`).", "disabled": true }, { "key": "license_type", "value": "", "description": "Filter by license type. Accepts multiple comma-separated values (e.g., `MIT,BSD-2-Clause`).", "disabled": true }, { "key": "is_vulnerable", "value": "", "description": "Filter by vulnerability status. Accepts `true` or `false`.", "disabled": true } ] }, "description": "Returns a paginated list of AI/ML software libraries (packages) discovered\nacross cloud environments and source code repositories.\n\n**Note on `total_count`:** The `total_count` field is populated only on the\nfirst page of results. Subsequent pages return `total_count` as `0` to avoid\nthe performance cost of counting on every request." }, "response": [] }, { "name": "Get a Software Library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/softwarelibraries/:name", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "softwarelibraries", ":name" ], "query": [ { "key": "version", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "name", "value": "", "description": "" } ] }, "description": "Retrieves a specific software library by its name. The version query parameter is optional." }, "response": [] } ] }, { "name": "Workloads", "item": [ { "name": "List Workloads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/workloads", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "workloads" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `-last_scanned_at` (descending) when not specified.\n\nSupported values: `name`, `last_scanned_at`.", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. Supports case-insensitive substring matching. Accepts a single value.", "disabled": true }, { "key": "environment", "value": "", "description": "Filter by cloud provider. Accepts multiple comma-separated values (e.g., `AWS,AZURE`). Values are case-insensitive.", "disabled": true }, { "key": "region", "value": "", "description": "Filter by cloud region. Accepts multiple comma-separated values (e.g., `us-east-1,eu-west-1`).", "disabled": true }, { "key": "cloud_account_id", "value": "", "description": "Filter by cloud account identifier. Accepts multiple comma-separated values.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by workload type. Accepts multiple comma-separated values (e.g., `compute,service`). Values are case-insensitive.", "disabled": true }, { "key": "source_type", "value": "", "description": "Filter by source type (e.g., `AWS EC2 Instance`). Accepts multiple comma-separated values.", "disabled": true }, { "key": "asset_risk", "value": "", "description": "Filter by security asset risk attributes. Accepts comma-separated `key:value` pairs (e.g., `Publicly Exposed:Yes,Logging:No`).", "disabled": true }, { "key": "risk_level", "value": "", "description": "Filter by risk level. Accepts a single value only (e.g., `high`). Values are case-insensitive.", "disabled": true }, { "key": "sanction_status", "value": "", "description": "Filter by sanction status. Accepts multiple comma-separated values (e.g., `sanctioned,pending`). Values are case-insensitive.", "disabled": true }, { "key": "ai_workload", "value": "", "description": "Filter by whether the workload is an AI workload. Accepts `true`,\n`false`, `1`, `0`, `t`, `f` (and case variants such as `TRUE`, `False`).\nUnrecognized values (e.g., `yes`, `no`) are silently ignored and the\nfilter is not applied.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter by resource tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "asset_mgmt_tags", "value": "", "description": "Filter by asset management tags. Accepts a comma-separated list where each element may be a key (`env`) or a key:value pair (`env:prod`).", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type name. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true } ] }, "description": "Returns a paginated list of workloads (compute instances, containers, etc.) associated with AI assets." }, "response": [] }, { "name": "Get a Workload", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/workloads/:id", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "workloads", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a specific workload by its unique ID." }, "response": [] }, { "name": "List Workload Sensitive Data Findings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{AIInfrastructureBaseUrl}}/v1/resources/workloads/:id/sensitivedatafindings", "host": [ "{{AIInfrastructureBaseUrl}}" ], "path": [ "v1", "resources", "workloads", ":id", "sensitivedatafindings" ], "query": [ { "key": "cursor", "value": "", "description": "Opaque cursor string returned in the previous response's `next_cursor`\nfield. Clients should not change filter, sort, or page_size parameters\nbetween paginated requests using the same cursor; doing so may produce\nunexpected results such as skipped or duplicated records. Omit this\nparameter to start a new pagination sequence. If the cursor cannot be\ndecoded (e.g. tampered or corrupted), pagination restarts from the first\npage.", "disabled": true }, { "key": "page_size", "value": "", "description": "Number of records per page (default 25, max 200).", "disabled": true }, { "key": "sort", "value": "", "description": "Sort field. Prefix with `-` for descending order.\nOnly a single sort field is supported; multiple sort fields are not allowed.\nField names are case-sensitive and must exactly match a supported value.\nDefaults to `created_at` (descending) when not specified.\n\nSupported values: `file_size`, `last_scanned_at`, `created_at`.", "disabled": true }, { "key": "sensitive_dlp_engine", "value": "", "description": "Filter for sensitive DLP engine findings.\n- `yes` — only findings with at least one DLP engine match are returned.\n- `all` — all findings are returned, including those with no DLP engine matches.\nValues are case-insensitive.", "disabled": true }, { "key": "dlp_engine", "value": "", "description": "Filter by DLP engine name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-engines` to fetch supported values.", "disabled": true }, { "key": "dlp_dictionary", "value": "", "description": "Filter by DLP dictionary name. Accepts multiple comma-separated values. Refer to `GET /v1/dlp-dictionaries` to fetch supported values.", "disabled": true }, { "key": "doc_type", "value": "", "description": "Filter by document type. Accepts multiple comma-separated values. Refer to `GET /v1/document-types` to fetch supported values.", "disabled": true }, { "key": "source_id", "value": "", "description": "Filter by the source ID of the associated resource. Accepts multiple comma-separated values.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Returns a paginated list of sensitive data findings for the specified workload." }, "response": [] } ] } ] } ] }, { "name": "Unified RBAC", "item": [ { "name": "Roles", "item": [ { "name": "Create a role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/roles", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "roles" ] }, "description": "Create a role", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Query roles with pagination and filters", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/roles/query", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "roles", "query" ], "query": [ { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "offset", "value": "", "description": "", "disabled": true } ] }, "description": "Query roles with pagination and filters", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get a role by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/roles/:roleId", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "" } ] }, "description": "Get a role by ID" }, "response": [] }, { "name": "Update a role", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/roles/:roleId", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "" } ] }, "description": "Update a role", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete a role by ID", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/roles/:roleId", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "roles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "" } ] }, "description": "Delete a role by ID" }, "response": [] } ] }, { "name": "Audit Logs", "item": [ { "name": "Query audit logs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{UrbacBaseUrl}}/v1/auditlog/query", "host": [ "{{UrbacBaseUrl}}" ], "path": [ "v1", "auditlog", "query" ] }, "description": "Query audit logs", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] } ] }, { "name": "Zscaler Private Access (ZPA)", "item": [ { "name": "Server Management", "item": [ { "name": "Gets all configured Servers for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/server", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "server" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "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.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Servers for the specified customer." }, "response": [] }, { "name": "Adds a new Server for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/server", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "server" ], "query": [ { "key": "microtenantId", "value": "", "description": "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.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new Server for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the Server for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/server/:serverId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "server", ":serverId" ], "query": [ { "key": "microtenantId", "value": "", "description": "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.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serverId", "value": "", "description": "The unique identifier of the Server." } ] }, "description": "Deletes the Server for the specified ID." }, "response": [] }, { "name": "Gets the Server details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/server/:serverId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "server", ":serverId" ], "query": [ { "key": "microtenantId", "value": "", "description": "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.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serverId", "value": "", "description": "The unique identifier of the Server." } ] }, "description": "Gets the Server details for the specified ID." }, "response": [] }, { "name": "Updates the Server details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/server/:serverId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "server", ":serverId" ], "query": [ { "key": "microtenantId", "value": "", "description": "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.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serverId", "value": "", "description": "The unique identifier of the Server." } ] }, "description": "Updates the Server details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Application Segment Management", "item": [ { "name": "Gets all configured Application Segments for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Application Segments for the specified customer." }, "response": [] }, { "name": "Adds a new Application Segment for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new Application Segment for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get all configured BA/Inspect/PRA Application Segments.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/getAppsByType", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", "getAppsByType" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "expandAll", "value": "", "description": "Additional information related to the applications", "disabled": true }, { "key": "applicationType", "value": "", "description": "The type of application", "disabled": false }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get all configured BA/Inspect/PRA Application Segments." }, "response": [] }, { "name": "Deletes the Application Segment for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/:applicationId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", ":applicationId" ], "query": [ { "key": "forceDelete", "value": "", "description": "Setting this field to true will delete the mapping between Application Segment and Segment Group", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "applicationId", "value": "", "description": "The unique identifier of the Application Segment." } ] }, "description": "Deletes the Application Segment for the specified ID." }, "response": [] }, { "name": "Gets the Application Segment details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/:applicationId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", ":applicationId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "applicationId", "value": "", "description": "The unique identifier of the Application Segment." } ] }, "description": "Gets the Application Segment details for the specified ID." }, "response": [] }, { "name": "Updates the Application Segment details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/:applicationId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", ":applicationId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "applicationId", "value": "", "description": "The unique identifier of the Application Segment." } ] }, "description": "Updates the Application Segment details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Moves application of one microtenant to another", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/:applicationId/move", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", ":applicationId", "move" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "applicationId", "value": "", "description": "The unique identifier of the Application Segment." } ] }, "description": "Moves application of one microtenant to another", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Share the Application Segment to microtenants.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/application/:applicationId/share", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "application", ":applicationId", "share" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "applicationId", "value": "", "description": "The unique identifier of the Application Segment." } ] }, "description": "Share the Application Segment to microtenants.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Segment Group Management", "item": [ { "name": "Gets all configured Segment Groups for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/segmentGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "segmentGroup" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "skipDetailedAppInfo", "value": "", "description": "Indicates whether to include complete application details or not.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Segment Groups for the specified customer." }, "response": [] }, { "name": "Adds a new Segment Group for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/segmentGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "segmentGroup" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new Segment Group for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the Segment Group for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/segmentGroup/:segmentGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "segmentGroup", ":segmentGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "segmentGroupId", "value": "", "description": "The unique identifier of the Segment Group." } ] }, "description": "Deletes the Segment Group for the specified ID." }, "response": [] }, { "name": "Gets the Segment Group details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/segmentGroup/:segmentGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "segmentGroup", ":segmentGroupId" ], "query": [ { "key": "skipDetailedAppInfo", "value": "", "description": "Indicates whether to include complete application details or not.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "segmentGroupId", "value": "", "description": "The unique identifier of the Segment Group." } ] }, "description": "Gets the Segment Group details for the specified ID." }, "response": [] }, { "name": "Updates the Segment Group for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/segmentGroup/:segmentGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "segmentGroup", ":segmentGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "segmentGroupId", "value": "", "description": "The unique identifier of the Segment Group." } ] }, "description": "Updates the Segment Group for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update a Segment Group.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/segmentGroup/:segmentGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "segmentGroup", ":segmentGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "segmentGroupId", "value": "", "description": "The unique identifier of the Segment Group." } ] }, "description": "Update a Segment Group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "App Connector Management", "item": [ { "name": "Gets all configured App Connector details for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connector", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connector" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Indicates the parameter to sort by.", "disabled": true }, { "key": "sortDir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured App Connector details for the specified customer." }, "response": [] }, { "name": "Bulk deletes the App Connectors for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connector/bulkDelete", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connector", "bulkDelete" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Bulk deletes the App Connectors for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the App Connector for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connector/:connectorId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connector", ":connectorId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "connectorId", "value": "", "description": "The unique identifier of the App Connector." } ] }, "description": "Deletes the App Connector for the specified ID." }, "response": [] }, { "name": "Gets the App Connector details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connector/:connectorId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connector", ":connectorId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "connectorId", "value": "", "description": "The unique identifier of the App Connector." } ] }, "description": "Gets the App Connector details for the specified ID." }, "response": [] }, { "name": "Updates the App Connector details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connector/:connectorId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connector", ":connectorId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "connectorId", "value": "", "description": "The unique identifier of the App Connector." } ] }, "description": "Updates the App Connector details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get a Configured App Connector schedule frequency.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connectorSchedule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connectorSchedule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get a Configured App Connector schedule frequency." }, "response": [] }, { "name": "Configure a App Connector schedule frequency to delete the in active connectors with configured frequency.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connectorSchedule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connectorSchedule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Configure a App Connector schedule frequency to delete the in active connectors with configured frequency.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Configure a App Connector schedule frequency to delete the in active connectors with configured frequency.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/connectorSchedule/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "connectorSchedule", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "Scheduler id" } ] }, "description": "Configure a App Connector schedule frequency to delete the in active connectors with configured frequency.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "App Connector Group Management", "item": [ { "name": "Deletes the App Connector Group for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/appConnectorGroup/:appConnectorGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "appConnectorGroup", ":appConnectorGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "appConnectorGroupId", "value": "", "description": "The unique identifier of the App Connector Group." } ] }, "description": "Deletes the App Connector Group for the specified ID." }, "response": [] }, { "name": "Gets the App Connector Group details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/appConnectorGroup/:appConnectorGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "appConnectorGroup", ":appConnectorGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "appConnectorGroupId", "value": "", "description": "The unique identifier of the App Connector Group." } ] }, "description": "Gets the App Connector Group details for the specified ID." }, "response": [] }, { "name": "Updates the App Connector Group details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/appConnectorGroup/:appConnectorGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "appConnectorGroup", ":appConnectorGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "appConnectorGroupId", "value": "", "description": "The unique identifier of the App Connector Group." } ] }, "description": "Updates the App Connector Group details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Certificate Management", "item": [ { "name": "Gets all certificates for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/certificate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "certificate" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all certificates for the specified customer." }, "response": [] }, { "name": "Adds a certificate with a private key for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/certificate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "certificate" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a certificate with a private key for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the certificate for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/certificate/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "certificate", ":certificateId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "certificateId", "value": "", "description": "The unique identifier of the certificate." } ] }, "description": "Deletes the certificate for the specified ID." }, "response": [] }, { "name": "Gets the certificate details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/certificate/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "certificate", ":certificateId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "certificateId", "value": "", "description": "The unique identifier of the certificate." } ] }, "description": "Gets the certificate details for the specified ID." }, "response": [] }, { "name": "Gets the certificate details for the specified ID. This API will be deprecated in a future release.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/clientlessCertificate/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "clientlessCertificate", ":certificateId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "certificateId", "value": "", "description": "The unique identifier of the certificate." } ] }, "description": "Gets the certificate details for the specified ID. This API will be deprecated in a future release." }, "response": [] }, { "name": "Gets all issued certificates for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/certificate/issued", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "certificate", "issued" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all issued certificates for the specified customer." }, "response": [] }, { "name": "Gets all issued certificates for the specified customer. This API will be deprecated in a future release.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/clientlessCertificate/issued", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "clientlessCertificate", "issued" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all issued certificates for the specified customer. This API will be deprecated in a future release." }, "response": [] } ] }, { "name": "Isolation Profile Management", "item": [ { "name": "Get all CBI Profiles for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Profiles for the specified customer" }, "response": [] }, { "name": "Add a CBI profile for the specified customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Add a CBI profile for the specified customer", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete the CBI profile for the customer based on the specified Id", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Delete the CBI profile for the customer based on the specified Id" }, "response": [] }, { "name": "Get the CBI profile for the customer based on the specified Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Get the CBI profile for the customer based on the specified Id" }, "response": [] }, { "name": "Update the CBI profile for the customer based on the specified Id", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Update the CBI profile for the customer based on the specified Id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get all Regions for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/regions", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "regions" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all Regions for the specified customer" }, "response": [] }, { "name": "Get all CBI Profiles in ZPA for the specified customer, can set show Disabled as true to see disabled profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/zpaprofiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "zpaprofiles" ], "query": [ { "key": "showDisabled", "value": "", "description": "showDisabled", "disabled": true }, { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Profiles in ZPA for the specified customer, can set show Disabled as true to see disabled profiles" }, "response": [] }, { "name": "Gets all isolation profiles for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/isolation/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "isolation", "profiles" ], "query": [ { "key": "showDisabled", "value": "", "description": "Indicates whether the disabled isolation profiles are included in the response or not.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all isolation profiles for the specified customer." }, "response": [] } ] }, { "name": "Privileged Credential Management", "item": [ { "name": "Gets all configured privileged credentials for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Indicates the parameter to sort by.", "disabled": true }, { "key": "sortdir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured privileged credentials for the specified customer." }, "response": [] }, { "name": "Adds a new privileged credential for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new privileged credential for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the privileged credential for the specified ID. ", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged credential." } ] }, "description": "Deletes the privileged credential for the specified ID. " }, "response": [] }, { "name": "Gets the privileged credential details for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged credential." } ] }, "description": "Gets the privileged credential details for the specified customer." }, "response": [] }, { "name": "Updates the privileged credential details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged credential." } ] }, "description": "Updates the privileged credential details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Move Privileged credential from one microtenant to another microtenant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/credential/:id/move", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "credential", ":id", "move" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true }, { "key": "targetMicrotenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged credential." } ] }, "description": "Move Privileged credential from one microtenant to another microtenant" }, "response": [] } ] }, { "name": "Customers", "item": [ { "name": "Gets the authentication domains for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/authDomains", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "authDomains" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the authentication domains for the specified customer." }, "response": [] } ] }, { "name": "Cloud Connector Groups", "item": [ { "name": "Gets all configured Cloud Connector Groups for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/cloudConnectorGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "cloudConnectorGroup" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Cloud Connector Groups for the specified customer." }, "response": [] }, { "name": "Gets the Cloud Connector Group details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/cloudConnectorGroup/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "cloudConnectorGroup", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the Cloud Connector Group." } ] }, "description": "Gets the Cloud Connector Group details for the specified ID." }, "response": [] } ] }, { "name": "Emergency Access Management", "item": [ { "name": "Creates an emergency access user for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/user", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "user" ], "query": [ { "key": "activateNow", "value": "", "description": "Indicates if the emergency access user is activated upon", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Creates an emergency access user for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the emergency access user for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/user/:userId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "user", ":userId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "userId", "value": "", "description": "The unique identifier of the emergency access user." } ] }, "description": "Gets the emergency access user for the specified customer." }, "response": [] }, { "name": "Updates the emergency access user for the specified customer.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/user/:userId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "user", ":userId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "userId", "value": "", "description": "The unique identifier of the emergency access user." } ] }, "description": "Updates the emergency access user for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Activates the emergency access user for the specified customer.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/user/:userId/activate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "user", ":userId", "activate" ], "query": [ { "key": "sendEmail", "value": "", "description": "Indicates if the email is sent from the IdP to the user.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "userId", "value": "", "description": "The unique identifier of the emergency access user." } ] }, "description": "Activates the emergency access user for the specified customer." }, "response": [] }, { "name": "Deactivates the emergency access user for the specified customer.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/user/:userId/deactivate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "user", ":userId", "deactivate" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "userId", "value": "", "description": "The unique identifier of the emergency access user." } ] }, "description": "Deactivates the emergency access user for the specified customer." }, "response": [] }, { "name": "Gets all emergency access users for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/emergencyAccess/users", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "emergencyAccess", "users" ], "query": [ { "key": "pageId", "value": "", "description": "The cursor that points to the end of the page of data that has been returned.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all emergency access users for the specified customer." }, "response": [] } ] }, { "name": "IdP Management", "item": [ { "name": "Gets details of the IdP for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/idp/:idpId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "idp", ":idpId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "idpId", "value": "", "description": "The unique identifier of the IdP." } ] }, "description": "Gets details of the IdP for the specified ID." }, "response": [] }, { "name": "Gets all configured IdP details for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/idp", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "idp" ], "query": [ { "key": "scimEnabled", "value": "", "description": "Returns all SCIM IdPs if set to true. Returns all non SCIM IdPs if set to false.", "disabled": true }, { "key": "userAttributes", "value": "", "description": "", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured IdP details for the specified customer." }, "response": [] } ] }, { "name": "AppProtection Control Management", "item": [ { "name": "Gets the inspection control action types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/actionTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "actionTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the inspection control action types for the specified customer." }, "response": [] }, { "name": "Gets the inspection control types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/controlTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "controlTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the inspection control types for the specified customer." }, "response": [] }, { "name": "Gets all custom controls for a customer and sorts by control number for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortdir", "value": "", "description": "Specifies the sorting order (ascending/descending) for the search results.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all custom controls for a customer and sorts by control number for the specified customer." }, "response": [] }, { "name": "Add a new custom control for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Add a new custom control for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the supported HTTP methods in custom controls for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom/httpMethods", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom", "httpMethods" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the supported HTTP methods in custom controls for the specified customer." }, "response": [] }, { "name": "Deletes the custom control for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the AppProtection control." } ] }, "description": "Deletes the custom control for the specified ID." }, "response": [] }, { "name": "Gets the custom control for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the AppProtection control." } ] }, "description": "Gets the custom control for the specified ID." }, "response": [] }, { "name": "Updates the existing custom control for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the AppProtection control." } ] }, "description": "Updates the existing custom control for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the insepction profile name for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/custom/:id/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "custom", ":id", "profiles" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the AppProtection control." } ] }, "description": "Gets the insepction profile name for the specified ID." }, "response": [] }, { "name": "Gets the supported exception versions along with the supported criteria and limits.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/exceptions", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "exceptions" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the supported exception versions along with the supported criteria and limits." }, "response": [] }, { "name": "Gets all predefined inspection controls for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/predefined", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "predefined" ], "query": [ { "key": "version", "value": "", "description": "The predefined control version.", "disabled": false }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all predefined inspection controls for the specified customer." }, "response": [] }, { "name": "Gets all predefined ADP inspection controls for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/predefined/adp", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "predefined", "adp" ], "query": [ { "key": "version", "value": "", "description": "The predefined control version.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all predefined ADP inspection controls for the specified customer." }, "response": [] }, { "name": "Gets all predefined inspection controls for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/predefined/api", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "predefined", "api" ], "query": [ { "key": "version", "value": "", "description": "The predefined control version.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all predefined inspection controls for the specified customer." }, "response": [] }, { "name": "Get all versions of the predefined inspection controls for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/predefined/versions", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "predefined", "versions" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get all versions of the predefined inspection controls for the specified customer." }, "response": [] }, { "name": "Get the predefined control for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/predefined/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "predefined", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the AppProtection control." } ] }, "description": "Get the predefined control for the specified ID." }, "response": [] }, { "name": "Gets the inspection control severity types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionControls/severityTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionControls", "severityTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the inspection control severity types for the specified customer." }, "response": [] }, { "name": "Gets the inspection custom control types.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/inspectionControls/customControlTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "inspectionControls", "customControlTypes" ] }, "description": "Gets the inspection custom control types." }, "response": [] } ] }, { "name": "AppProtection Profile Management", "item": [ { "name": "Gets all configured inspection profiles for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured inspection profiles for the specified customer." }, "response": [] }, { "name": "Adds a new inspection profile for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new inspection profile for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the inspection profile for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Deletes the inspection profile for the specified ID." }, "response": [] }, { "name": "Gets the inspection profile details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the inspection profile." } ] }, "description": "Gets the inspection profile details for the specified ID." }, "response": [] }, { "name": "Updates the inspection profile for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Updates the inspection profile for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates the inspection profile for the specified ID and associates all predefined controls to a profile.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId/associateAllPredefinedControls", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId", "associateAllPredefinedControls" ], "query": [ { "key": "version", "value": "", "description": "The predefined control version.", "disabled": false } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Updates the inspection profile for the specified ID and associates all predefined controls to a profile." }, "response": [] }, { "name": "Updates the inspection profile for the specified ID and dissociates all predefined controls from a profile. This API will be deprecated in a future release.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId/deAssociateAllPredefinedControls", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId", "deAssociateAllPredefinedControls" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Updates the inspection profile for the specified ID and dissociates all predefined controls from a profile. This API will be deprecated in a future release." }, "response": [] }, { "name": "Updates the inspection profile for the specified ID and dissociates all predefined controls from a profile.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId/dissociateAllPredefinedControls", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId", "dissociateAllPredefinedControls" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Updates the inspection profile for the specified ID and dissociates all predefined controls from a profile." }, "response": [] }, { "name": "Updates the inspection profile and controls for the specified ID.", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/inspectionProfile/:inspectionProfileId/patch", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "inspectionProfile", ":inspectionProfileId", "patch" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "inspectionProfileId", "value": "", "description": "The unique identifier of the AppProtection profile." } ] }, "description": "Updates the inspection profile and controls for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Machine Groups", "item": [ { "name": "Get all configured Machine Groups for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/machineGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "machineGroup" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get all configured Machine Groups for the specified customer." }, "response": [] }, { "name": "Gets details of the Machine Group for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/machineGroup/:Id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "machineGroup", ":Id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "Id", "value": "", "description": "The unique identifier of the Machine Group." } ] }, "description": "Gets details of the Machine Group for the specified ID." }, "response": [] } ] }, { "name": "Policy Management", "item": [ { "name": "Gets all client types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "clientTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all client types for the specified customer." }, "response": [] }, { "name": "Gets all platforms for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/platform", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "platform" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all platforms for the specified customer." }, "response": [] }, { "name": "Gets the policy set for the specified policy type.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/policyType/:policyType", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", "policyType", ":policyType" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policyType", "value": "", "description": "Type for differentiating policy types. Supported values : ACCESS_POLICY/GLOBAL_POLICY, TIMEOUT_POLICY/REAUTH_POLICY, SIEM_POLICY, CLIENT_FORWARDING_POLICY/BYPASS_POLICY, INSPECTION_POLICY, CREDENTIAL_POLICY, CAPABILITIES_POLICY, ISOLATION_POLICY, CLIENTLESS_SESSION_PROTECTION_POLICY,REDIRECTION_POLICY, PRIVILEGED_PORTAL_POLICY" } ] }, "description": "Gets the policy set for the specified policy type." }, "response": [] }, { "name": "Gets paginated policy rules for the specified policy type.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/rules/policyType/:policyType", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", "rules", "policyType", ":policyType" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policyType", "value": "", "description": "Type for differentiating policy types. Supported values : ACCESS_POLICY/GLOBAL_POLICY, TIMEOUT_POLICY/REAUTH_POLICY, SIEM_POLICY, CLIENT_FORWARDING_POLICY/BYPASS_POLICY, INSPECTION_POLICY, CREDENTIAL_POLICY, CAPABILITIES_POLICY, ISOLATION_POLICY, CLIENTLESS_SESSION_PROTECTION_POLICY,REDIRECTION_POLICY, PRIVILEGED_PORTAL_POLICY" } ] }, "description": "Gets paginated policy rules for the specified policy type." }, "response": [] }, { "name": "Bulk reorders all the rules in a policy set. Execute this API only once to reorder the rules", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/reorder", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "reorder" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." } ] }, "description": "Bulk reorders all the rules in a policy set. Execute this API only once to reorder the rules", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Adds a new policy rule for the specified policy set.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." } ] }, "description": "Adds a new policy rule for the specified policy set.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the rule in a policy for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Deletes the rule in a policy for the specified ID." }, "response": [] }, { "name": "Gets the rule in a policy for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Gets the rule in a policy for the specified ID." }, "response": [] }, { "name": "Updates the rule in a policy for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Updates the rule in a policy for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates the rule order for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId/reorder/:newOrder", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId", "reorder", ":newOrder" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." }, { "key": "newOrder", "value": "", "description": "The new order of the rule." } ] }, "description": "Updates the rule order for the specified ID." }, "response": [] }, { "name": "Add a new policy rule for a given policy.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/policySet/:policySetId/rule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy." } ] }, "description": "Add a new policy rule for a given policy.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update a rule in a policy.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Update a rule in a policy.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Policy Management", "item": [ { "name": "Gets all client types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "clientTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all client types for the specified customer." }, "response": [] }, { "name": "Gets all platforms for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/platform", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "platform" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all platforms for the specified customer." }, "response": [] }, { "name": "Gets the policy set for the specified policy type.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/policyType/:policyType", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", "policyType", ":policyType" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policyType", "value": "", "description": "Type for differentiating policy types. Supported values : ACCESS_POLICY/GLOBAL_POLICY, TIMEOUT_POLICY/REAUTH_POLICY, SIEM_POLICY, CLIENT_FORWARDING_POLICY/BYPASS_POLICY, INSPECTION_POLICY, CREDENTIAL_POLICY, CAPABILITIES_POLICY, ISOLATION_POLICY, CLIENTLESS_SESSION_PROTECTION_POLICY,REDIRECTION_POLICY, PRIVILEGED_PORTAL_POLICY" } ] }, "description": "Gets the policy set for the specified policy type." }, "response": [] }, { "name": "Gets paginated policy rules for the specified policy type.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/rules/policyType/:policyType", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", "rules", "policyType", ":policyType" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policyType", "value": "", "description": "Type for differentiating policy types. Supported values : ACCESS_POLICY/GLOBAL_POLICY, TIMEOUT_POLICY/REAUTH_POLICY, SIEM_POLICY, CLIENT_FORWARDING_POLICY/BYPASS_POLICY, INSPECTION_POLICY, CREDENTIAL_POLICY, CAPABILITIES_POLICY, ISOLATION_POLICY, CLIENTLESS_SESSION_PROTECTION_POLICY,REDIRECTION_POLICY, PRIVILEGED_PORTAL_POLICY" } ] }, "description": "Gets paginated policy rules for the specified policy type." }, "response": [] }, { "name": "Bulk reorders all the rules in a policy set. Execute this API only once to reorder the rules", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/reorder", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "reorder" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." } ] }, "description": "Bulk reorders all the rules in a policy set. Execute this API only once to reorder the rules", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Adds a new policy rule for the specified policy set.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." } ] }, "description": "Adds a new policy rule for the specified policy set.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the rule in a policy for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Deletes the rule in a policy for the specified ID." }, "response": [] }, { "name": "Gets the rule in a policy for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Gets the rule in a policy for the specified ID." }, "response": [] }, { "name": "Updates the rule in a policy for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. Default value is 0 and get data from Default microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Updates the rule in a policy for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates the rule order for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId/reorder/:newOrder", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId", "reorder", ":newOrder" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy set." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." }, { "key": "newOrder", "value": "", "description": "The new order of the rule." } ] }, "description": "Updates the rule order for the specified ID." }, "response": [] }, { "name": "Add a new policy rule for a given policy.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/policySet/:policySetId/rule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy." } ] }, "description": "Add a new policy rule for a given policy.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update a rule in a policy.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/policySet/:policySetId/rule/:ruleId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "policySet", ":policySetId", "rule", ":ruleId" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "policySetId", "value": "", "description": "The unique identifier of the policy." }, { "key": "ruleId", "value": "", "description": "The unique identifier of a rule in a policy." } ] }, "description": "Update a rule in a policy.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Posture Profiles", "item": [ { "name": "Gets the configured posture profile for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/posture/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "posture", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the posture profile." } ] }, "description": "Gets the configured posture profile for the specified ID." }, "response": [] }, { "name": "Gets all posture profiles for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/posture", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "posture" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all posture profiles for the specified customer." }, "response": [] } ] }, { "name": "Privileged Approval Management", "item": [ { "name": "Gets all configured privileged approvals for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "The sort string used to support sorting on the given field for the API.", "disabled": true }, { "key": "sortdir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured privileged approvals for the specified customer." }, "response": [] }, { "name": "Adds a new privileged approval for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new privileged approval for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes all expired privileged approvals for the specified customer.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval/expired", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval", "expired" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Deletes all expired privileged approvals for the specified customer." }, "response": [] }, { "name": "Deletes the privileged approval for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged approval." } ] }, "description": "Deletes the privileged approval for the specified ID." }, "response": [] }, { "name": "Gets the privileged approval details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged approval." } ] }, "description": "Gets the privileged approval details for the specified ID." }, "response": [] }, { "name": "Updates the privileged approval details for the specified ID. ", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/approval/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "approval", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged approval." } ] }, "description": "Updates the privileged approval details for the specified ID. ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Privileged Console Management", "item": [ { "name": "Gets all configured privileged consoles for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured privileged consoles for the specified customer." }, "response": [] }, { "name": "Adds a new privileged console for the specified privileged portal and customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new privileged console for the specified privileged portal and customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Creates a list of privileged consoles for the specified privileged portal and customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole/bulk", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole", "bulk" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Creates a list of privileged consoles for the specified privileged portal and customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the privileged consoles for the specified ID of the privileged portal.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole/praPortal/:portalId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole", "praPortal", ":portalId" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "portalId", "value": "", "description": "The unique identifier of the privileged portal." } ] }, "description": "Gets the privileged consoles for the specified ID of the privileged portal." }, "response": [] }, { "name": "Deletes the privileged console for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged console." } ] }, "description": "Deletes the privileged console for the specified ID." }, "response": [] }, { "name": "Gets the privileged console details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged console." } ] }, "description": "Gets the privileged console details for the specified ID." }, "response": [] }, { "name": "Updates the privileged console details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praConsole/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praConsole", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged console." } ] }, "description": "Updates the privileged console details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Privileged Portal Management", "item": [ { "name": "Gets all configured privileged portals for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praPortal", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praPortal" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured privileged portals for the specified customer." }, "response": [] }, { "name": "Adds a new privileged portal for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praPortal", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praPortal" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new privileged portal for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the privileged portal for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praPortal/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praPortal", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged portal." } ] }, "description": "Deletes the privileged portal for the specified ID." }, "response": [] }, { "name": "Gets the privileged portal details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praPortal/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praPortal", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged portal." } ] }, "description": "Gets the privileged portal details for the specified ID." }, "response": [] }, { "name": "Updates the privileged portal for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/praPortal/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "praPortal", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the privileged portal." } ] }, "description": "Updates the privileged portal for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Private Service Edge Management", "item": [ { "name": "Gets all the configured Service Edge details for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdge", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdge" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Indicates the parameter to sort by.", "disabled": true }, { "key": "sortDir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all the configured Service Edge details for the specified customer." }, "response": [] }, { "name": "Bulk deletes the Service Edges for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdge/bulkDelete", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdge", "bulkDelete" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Bulk deletes the Service Edges for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the Service Edge for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdge/:serviceEdgeId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdge", ":serviceEdgeId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeId", "value": "", "description": "The unique identifier of the Service Edge." } ] }, "description": "Deletes the Service Edge for the specified ID." }, "response": [] }, { "name": "Gets the Service Edge details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdge/:serviceEdgeId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdge", ":serviceEdgeId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeId", "value": "", "description": "The unique identifier of the Service Edge." } ] }, "description": "Gets the Service Edge details for the specified ID." }, "response": [] }, { "name": "Updates the Service Edge details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdge/:serviceEdgeId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdge", ":serviceEdgeId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeId", "value": "", "description": "The unique identifier of the Service Edge." } ] }, "description": "Updates the Service Edge details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get a Configured ServiceEdge schedule frequency.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeSchedule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeSchedule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get a Configured ServiceEdge schedule frequency." }, "response": [] }, { "name": "Configure a ServiceEdge schedule frequency to delete the in active private broker with configured frequency.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeSchedule", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeSchedule" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Configure a ServiceEdge schedule frequency to delete the in active private broker with configured frequency.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Configure a ServiceEdge schedule frequency to delete the in active private broker with configured frequency.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeSchedule/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeSchedule", ":id" ], "query": [ { "key": "microtenantId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "Scheduler id" } ] }, "description": "Configure a ServiceEdge schedule frequency to delete the in active private broker with configured frequency.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Private Service Edge Group Management", "item": [ { "name": "Deletes the Service Edge Group for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeGroup/:serviceEdgeGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeGroup", ":serviceEdgeGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeGroupId", "value": "", "description": "The unique identifier of the Service Edge Group." } ] }, "description": "Deletes the Service Edge Group for the specified ID." }, "response": [] }, { "name": "Gets the Service Edge Group details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeGroup/:serviceEdgeGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeGroup", ":serviceEdgeGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeGroupId", "value": "", "description": "The unique identifier of the Service Edge Group." } ] }, "description": "Gets the Service Edge Group details for the specified ID." }, "response": [] }, { "name": "Updates the Service Edge Group details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serviceEdgeGroup/:serviceEdgeGroupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serviceEdgeGroup", ":serviceEdgeGroupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "serviceEdgeGroupId", "value": "", "description": "The unique identifier of the Service Edge Group." } ] }, "description": "Updates the Service Edge Group details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "SAML Attributes", "item": [ { "name": "Gets the SAML attribute details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/samlAttribute/:attrId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "samlAttribute", ":attrId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "attrId", "value": "", "description": "The unique identifier of the SAML attribute." } ] }, "description": "Gets the SAML attribute details for the specified ID." }, "response": [] }, { "name": "Get all SAML attributes by page.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/samlAttribute", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "samlAttribute" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Get all SAML attributes by page." }, "response": [] }, { "name": "Gets all SAML attributes configured for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/samlAttribute/idp/:idpId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "samlAttribute", "idp", ":idpId" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "idpId", "value": "", "description": "The unique identifier of the IdP." } ] }, "description": "Gets all SAML attributes configured for the specified ID." }, "response": [] } ] }, { "name": "SCIM Attributes", "item": [ { "name": "Gets all SCIM attributes for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/idp/:idpId/scimattribute", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "idp", ":idpId", "scimattribute" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "idpId", "value": "", "description": "The unique identifier of the IdP." } ] }, "description": "Gets all SCIM attributes for the specified ID." }, "response": [] }, { "name": "Gets the SCIM attribute details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/idp/:idpId/scimattribute/:scimAttributeId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "idp", ":idpId", "scimattribute", ":scimAttributeId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "idpId", "value": "", "description": "The unique identifier of the IdP." }, { "key": "scimAttributeId", "value": "", "description": "The unique identifier of the SCIM attribute." } ] }, "description": "Gets the SCIM attribute details for the specified ID." }, "response": [] }, { "name": "Gets all SCIM attribute values for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/userconfig/v1/customers/:customerId/scimattribute/idpId/:idpId/attributeId/:attributeId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "userconfig", "v1", "customers", ":customerId", "scimattribute", "idpId", ":idpId", "attributeId", ":attributeId" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "idpId", "value": "", "description": "The unique identifier of the IdP." }, { "key": "attributeId", "value": "", "description": "The unique identifier of the SCIM attribute." } ] }, "description": "Gets all SCIM attribute values for the specified ID." }, "response": [] } ] }, { "name": "Delegated Tenant Administration", "item": [ { "name": "Gets all configured Microtenants for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "includeRoles", "value": "", "description": "Include roles information in the API response.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Microtenants for the specified customer." }, "response": [] }, { "name": "Adds a new Microtenant for the specified customer.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Adds a new Microtenant for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets all configured Microtenants for the specified customer based on given filters.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants/search", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants", "search" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Microtenants for the specified customer based on given filters.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the name and ID of the configured Microtenant for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants/summary", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants", "summary" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the name and ID of the configured Microtenant for the specified customer." }, "response": [] }, { "name": "Deletes the Microtenant for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants/:microtenantId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants", ":microtenantId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant." } ] }, "description": "Deletes the Microtenant for the specified ID." }, "response": [] }, { "name": "Gets the given Microtenant details for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants/:microtenantId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants", ":microtenantId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant." } ] }, "description": "Gets the given Microtenant details for the specified customer" }, "response": [] }, { "name": "Updates the Microtenant details for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/microtenants/:microtenantId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "microtenants", ":microtenantId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "microtenantId", "value": "", "description": " The unique identifier of the Microtenant" } ] }, "description": "Updates the Microtenant details for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Returns the details of the current session.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/me", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "me" ] }, "description": "Returns the details of the current session." }, "response": [] } ] }, { "name": "Server Group Management", "item": [ { "name": "Gets all configured Server Groups for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serverGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serverGroup" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all configured Server Groups for the specified customer." }, "response": [] }, { "name": "Add a new Server Group.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serverGroup", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serverGroup" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Add a new Server Group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Deletes the Server Group for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serverGroup/:groupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serverGroup", ":groupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "groupId", "value": "", "description": "The unique identifier of the Server Group." } ] }, "description": "Deletes the Server Group for the specified ID." }, "response": [] }, { "name": "Gets the Server Group details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serverGroup/:groupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serverGroup", ":groupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "groupId", "value": "", "description": "The unique identifier of the Server Group." } ] }, "description": "Gets the Server Group details for the specified ID." }, "response": [] }, { "name": "Updates the Server Group for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/serverGroup/:groupId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "serverGroup", ":groupId" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "groupId", "value": "", "description": "The unique identifier of the Server Group." } ] }, "description": "Updates the Server Group for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Log Streaming Service (LSS) Configuration", "item": [ { "name": "Gets all LSS log formats for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS log formats for the specified customer." }, "response": [] }, { "name": "Deletes the LSS configuration for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Deletes the LSS configuration for the specified ID." }, "response": [] }, { "name": "Gets the LSS configuration details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Gets the LSS configuration details for the specified ID." }, "response": [] }, { "name": "Updates the LSS configuration for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Updates the LSS configuration for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets all LSS client types. This API will be deprecated in a future release.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "clientTypes" ] }, "description": "Gets all LSS client types. This API will be deprecated in a future release." }, "response": [] }, { "name": "Gets all LSS client types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/customers/:customerId/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "customers", ":customerId", "clientTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS client types for the specified customer." }, "response": [] }, { "name": "Gets all LSS log formats.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ] }, "description": "Gets all LSS log formats." }, "response": [] }, { "name": "Gets a list of LSS status codes.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/statusCodes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "statusCodes" ] }, "description": "Gets a list of LSS status codes." }, "response": [] } ] }, { "name": "Log Streaming Service (LSS) Configuration", "item": [ { "name": "Gets all LSS log formats for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS log formats for the specified customer." }, "response": [] }, { "name": "Deletes the LSS configuration for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Deletes the LSS configuration for the specified ID." }, "response": [] }, { "name": "Gets the LSS configuration details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Gets the LSS configuration details for the specified ID." }, "response": [] }, { "name": "Updates the LSS configuration for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Updates the LSS configuration for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets all LSS client types. This API will be deprecated in a future release.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "clientTypes" ] }, "description": "Gets all LSS client types. This API will be deprecated in a future release." }, "response": [] }, { "name": "Gets all LSS client types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/customers/:customerId/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "customers", ":customerId", "clientTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS client types for the specified customer." }, "response": [] }, { "name": "Gets all LSS log formats.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ] }, "description": "Gets all LSS log formats." }, "response": [] }, { "name": "Gets a list of LSS status codes.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/statusCodes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "statusCodes" ] }, "description": "Gets a list of LSS status codes." }, "response": [] } ] }, { "name": "Log Streaming Service (LSS) Configuration", "item": [ { "name": "Gets all LSS log formats for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS log formats for the specified customer." }, "response": [] }, { "name": "Deletes the LSS configuration for the specified ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Deletes the LSS configuration for the specified ID." }, "response": [] }, { "name": "Gets the LSS configuration details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Gets the LSS configuration details for the specified ID." }, "response": [] }, { "name": "Updates the LSS configuration for the specified ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/lssConfig/:lssId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "lssConfig", ":lssId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "lssId", "value": "", "description": "The unique identifier of the LSS resource." } ] }, "description": "Updates the LSS configuration for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets all LSS client types. This API will be deprecated in a future release.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "clientTypes" ] }, "description": "Gets all LSS client types. This API will be deprecated in a future release." }, "response": [] }, { "name": "Gets all LSS client types for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/customers/:customerId/clientTypes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "customers", ":customerId", "clientTypes" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all LSS client types for the specified customer." }, "response": [] }, { "name": "Gets all LSS log formats.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/logType/formats", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "logType", "formats" ], "query": [ { "key": "logType", "value": "", "description": "Supported Log type values are: zpn_trans_log, zpn_auth_log, zpn_ast_auth_log, zpn_http_trans_log, zpn_audit_log, zpn_sys_auth_log, zpn_ast_comprehensive_stats, zpn_waf_http_exchanges_log, zpn_smb_inspection_log, zpn_ldap_inspection_log, zpn_krb_inspection_log, zpn_pbroker_comprehensive_stats, zpn_sitec_auth_log, zpn_sitec_comprehensive_stats, zms_flow_log", "disabled": true } ] }, "description": "Gets all LSS log formats." }, "response": [] }, { "name": "Gets a list of LSS status codes.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/lssConfig/statusCodes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "lssConfig", "statusCodes" ] }, "description": "Gets a list of LSS status codes." }, "response": [] } ] }, { "name": "Enrollment Certificates", "item": [ { "name": "Gets the enrollment certificate details for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/enrollmentCert/:enrollmentCertId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "enrollmentCert", ":enrollmentCertId" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "enrollmentCertId", "value": "", "description": "The unique identifier of the signing cert." } ] }, "description": "Gets the enrollment certificate details for the specified ID." }, "response": [] } ] }, { "name": "Trusted Networks", "item": [ { "name": "Gets the trusted networks for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/network/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "network", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the trusted network." } ] }, "description": "Gets the trusted networks for the specified ID." }, "response": [] }, { "name": "Gets all trusted networks for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/network", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "network" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all trusted networks for the specified customer." }, "response": [] } ] }, { "name": "Trusted Networks", "item": [ { "name": "Gets the trusted networks for the specified ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/network/:id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "network", ":id" ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "id", "value": "", "description": "The unique identifier of the trusted network." } ] }, "description": "Gets the trusted networks for the specified ID." }, "response": [] }, { "name": "Gets all trusted networks for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v2/admin/customers/:customerId/network", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v2", "admin", "customers", ":customerId", "network" ], "query": [ { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all trusted networks for the specified customer." }, "response": [] } ] }, { "name": "Zscaler Clouds", "item": [ { "name": "Get all alternate cloud for zpath cloud.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/zpathCloud/getAltClouds", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "zpathCloud", "getAltClouds" ] }, "description": "Get all alternate cloud for zpath cloud." }, "response": [] } ] }, { "name": "Isolation Banner Management", "item": [ { "name": "Add the CBI Banner for the specified customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/banner", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "banner" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Add the CBI Banner for the specified customer", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get all CBI Banners for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/banners", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "banners" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Banners for the specified customer" }, "response": [] }, { "name": "Delete the CBI Banners for the customer based on the specified Id", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/banners/:bannerId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "", "description": "bannerId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Delete the CBI Banners for the customer based on the specified Id" }, "response": [] }, { "name": "Get the CBI Banner for the customer based on the specified Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/banners/:bannerId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "", "description": "bannerId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get the CBI Banner for the customer based on the specified Id" }, "response": [] }, { "name": "Update CBI Banner for the customer based on the specified Id", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/banners/:bannerId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "", "description": "bannerId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Update CBI Banner for the customer based on the specified Id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Isolation Certificate Management", "item": [ { "name": "Add a CBI Certificate for the specified customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/certificate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "certificate" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Add a CBI Certificate for the specified customer", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get all CBI Certificates for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/certificates", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "certificates" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Certificates for the specified customer" }, "response": [] }, { "name": "Delete the CBI Certificate for the customer based on the specified Id", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/certificates/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "certificates", ":certificateId" ], "variable": [ { "key": "certificateId", "value": "", "description": "certificateId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Delete the CBI Certificate for the customer based on the specified Id" }, "response": [] }, { "name": "Get the CBI Certificate for the customer based on the specified Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/certificates/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "certificates", ":certificateId" ], "variable": [ { "key": "certificateId", "value": "", "description": "certificateId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get the CBI Certificate for the customer based on the specified Id" }, "response": [] }, { "name": "Update the CBI Certificate for the customer based on the specified Id", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/certificates/:certificateId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "certificates", ":certificateId" ], "variable": [ { "key": "certificateId", "value": "", "description": "certificateId" }, { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Update the CBI Certificate for the customer based on the specified Id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Isolation Profile Management", "item": [ { "name": "Get all CBI Profiles for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Profiles for the specified customer" }, "response": [] }, { "name": "Add a CBI profile for the specified customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Add a CBI profile for the specified customer", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete the CBI profile for the customer based on the specified Id", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Delete the CBI profile for the customer based on the specified Id" }, "response": [] }, { "name": "Get the CBI profile for the customer based on the specified Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Get the CBI profile for the customer based on the specified Id" }, "response": [] }, { "name": "Update the CBI profile for the customer based on the specified Id", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/profiles/:profileId", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "profiles", ":profileId" ], "query": [ { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" }, { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Update the CBI profile for the customer based on the specified Id", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get all Regions for the specified customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/regions", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "regions" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all Regions for the specified customer" }, "response": [] }, { "name": "Get all CBI Profiles in ZPA for the specified customer, can set show Disabled as true to see disabled profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/cbiconfig/cbi/api/customers/:customerId/zpaprofiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "cbiconfig", "cbi", "api", "customers", ":customerId", "zpaprofiles" ], "query": [ { "key": "showDisabled", "value": "", "description": "showDisabled", "disabled": true }, { "key": "scopeId", "value": "", "description": "The unique identifier of the scope of ZPA tenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Get all CBI Profiles in ZPA for the specified customer, can set show Disabled as true to see disabled profiles" }, "response": [] }, { "name": "Gets all isolation profiles for the specified customer.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/admin/customers/:customerId/isolation/profiles", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "admin", "customers", ":customerId", "isolation", "profiles" ], "query": [ { "key": "showDisabled", "value": "", "description": "Indicates whether the disabled isolation profiles are included in the response or not.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets all isolation profiles for the specified customer." }, "response": [] } ] }, { "name": "Federate Applications", "item": [ { "name": "Federates an application with guest customers", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/application/federate", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "application", "federate" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Federates an existing application segment from a host partner with one or more guest partners.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets federated applications with search, sorting, and pagination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/application/host/:host_id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "application", "host", ":host_id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "host_id", "value": "", "description": "The application segment ID from the host partner. This is the partnerGid value returned when getting active federated partners." } ] }, "description": "Gets the federated applications for the specified customer using filters (i.e., application host ID, domain names, and enabled status)." }, "response": [] } ] }, { "name": "Policies for B2B Federation", "item": [ { "name": "Gets policy rules created by partner on federated applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/policySet/rules/policyType/GLOBAL_POLICY/guest/:guest_id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "policySet", "rules", "policyType", "GLOBAL_POLICY", "guest", ":guest_id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the microtenant of ZPA tenant. For Default microtenant 0 should be passed and for Customer data microtenant should be null.", "disabled": true }, { "key": "search", "value": "", "description": "Search string to filter policy rules by name", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "guest_id", "value": "", "description": "Partner Guest ID" } ] }, "description": "Retrieves paginated list of policy rules created by a partner customer on applications that have been federated to them. The response is sanitized to hide sensitive information." }, "response": [] } ] }, { "name": "Partner Federation Provisioning", "item": [ { "name": "Gets provisioning requests for a customer with search, sorting, and pagination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Indicates the parameter to sort by.", "disabled": true }, { "key": "sortDir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the provisioning requests for the specified customer using search, sorting, and pagination." }, "response": [] }, { "name": "Creates federation token for a customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/token", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", "token" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Creates a federation token for the specified customer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Verifies federation token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/token/verify", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", "token", "verify" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Verifies the federation token for the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Requests approval for tenant federation using token", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/approval", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", "approval" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Approves a partner federation for the specified ID using a token.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates tenant federation provisioning state", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/:federation_id/provisioning-state/:status", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", ":federation_id", "provisioning-state", ":status" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "federation_id", "value": "", "description": "The unique identifier of the federation." }, { "key": "status", "value": "", "description": "The provisioning status of the federation." } ] }, "description": "Updates the provisioning status (APPROVED, DENIED, TERMINATED) of the partner federation request." }, "response": [] }, { "name": "Updates tenant federation status", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/:federation_id/federation-state/:status", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", ":federation_id", "federation-state", ":status" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "federation_id", "value": "", "description": "The provisioning status of the federation." }, { "key": "status", "value": "", "description": "The federation status is ACTIVE (i.e., Active) or INACTIVE (i.e., Pause)." } ] }, "description": "Updates the status (ACTIVE or INACTIVE) of an existing federation for the specified ID." }, "response": [] }, { "name": "Gets active federation partners for a customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/partners", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", "partners" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to support search by features and fields for the API.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pagesize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Indicates the parameter to sort by.", "disabled": true }, { "key": "sortDir", "value": "", "description": "Specifies the sort direction (i.e., ascending or descending order).", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." } ] }, "description": "Gets the active federation partners for the specified customer using search, sorting, and pagination." }, "response": [] }, { "name": "Deletes tenant federation by Federation ID", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/:federation_id", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", ":federation_id" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "federation_id", "value": "", "description": "The unique identifier of the federation." } ] }, "description": "Deletes the partner federation for the specified ID." }, "response": [] }, { "name": "Updates notes for tenant federation provisioning", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZPABaseUrl}}/mgmtconfig/v1/customers/:customerId/tenant-federation/:federation_id/notes", "host": [ "{{ZPABaseUrl}}" ], "path": [ "mgmtconfig", "v1", "customers", ":customerId", "tenant-federation", ":federation_id", "notes" ], "query": [ { "key": "microtenantId", "value": "", "description": "The unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained from the API keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations is limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant.", "disabled": true } ], "variable": [ { "key": "customerId", "value": "", "description": "The unique identifier of the ZPA tenant." }, { "key": "federation_id", "value": "", "description": "The unique identifier of the federation you want to update the notes for." } ] }, "description": "Updates the notes for partner federation provisioning. The initiator updates initiatorNotes, and the partner updates partnerNotes.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] } ] }, { "name": "Cellular API", "item": [ { "name": "Anomaly Policies", "item": [ { "name": "List all anomaly policies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy" ], "query": [ { "key": "policyType", "value": "", "description": "", "disabled": true }, { "key": "startDateTime", "value": "", "description": "", "disabled": false }, { "key": "endDateTime", "value": "", "description": "", "disabled": false }, { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: policyName. Sortable fields: id, policyType, policyName, violations.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: ASC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a paginated list of anomaly policies configured for the customer. Supports filtering by policy type and violation time windows." }, "response": [] }, { "name": "Create an anomaly policy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Creates a new cellular anomaly policy associated with specified SIM location groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete an anomaly policy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" } ] }, "description": "Permanently removes an anomaly policy." }, "response": [] }, { "name": "Update an anomaly policy", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" } ] }, "description": "Updates configuration parameters and assigned SIM location groups for an existing anomaly policy.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List anomaly policy status logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId/logs", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId", "logs" ], "query": [ { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "size", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" } ] }, "description": "Retrieves execution and state transition logs for a specific anomaly policy." }, "response": [] }, { "name": "Update anomaly policy status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId/status", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId", "status" ], "query": [ { "key": "enabled", "value": "", "description": "", "disabled": false } ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" } ] }, "description": "Enables or disables an anomaly policy without modifying its underlying rules or group associations." }, "response": [] }, { "name": "List SIMs with policy violations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId/violations", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId", "violations" ], "query": [ { "key": "startDateTime", "value": "", "description": "", "disabled": false }, { "key": "endDateTime", "value": "", "description": "", "disabled": false }, { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Accepted but ignored on this endpoint.", "disabled": true }, { "key": "sortDir", "value": "", "description": "Accepted but ignored on this endpoint.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" } ] }, "description": "Retrieves a paginated list of SIMs that triggered violations under the specified anomaly policy within a given date range." }, "response": [] }, { "name": "Get violation details for a SIM", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/anomaly-policy/:policyId/violations/:iccid", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "anomaly-policy", ":policyId", "violations", ":iccid" ], "query": [ { "key": "startDateTime", "value": "", "description": "", "disabled": false }, { "key": "endDateTime", "value": "", "description": "", "disabled": false }, { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: timestamp. Sortable fields: policyId, policyType, timestamp.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: DESC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "policyId", "value": "", "description": "" }, { "key": "iccid", "value": "", "description": "" } ] }, "description": "Retrieves detailed violation records and device location telemetry for a specific SIM ICCID under the specified anomaly policy." }, "response": [] } ] }, { "name": "Audit Logs", "item": [ { "name": "Search audit logs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/audit/customers/:id/search", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "audit", "customers", ":id", "search" ], "query": [ { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: creationTime. Sortable fields: creationTime, auditOperationType, objectType, objectName, objectId, customerId, visibility.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: DESC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Searches customer audit logs using criteria such as operation type, object type, time ranges, and visibility.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Customer Management", "item": [ { "name": "Get customer details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves profile details and metadata for the specified customer." }, "response": [] }, { "name": "Activate customer", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Activates the customer account and sets up initial service parameters.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Network Events", "item": [ { "name": "Search network events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/network-events/:id/search/startTime/:startTime/endTime/:endTime", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "network-events", ":id", "search", "startTime", ":startTime", "endTime", ":endTime" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "startTime", "value": "", "description": "" }, { "key": "endTime", "value": "", "description": "" } ] }, "description": "Searches cellular network events for a customer within a specified time range, supporting filtering and pagination.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Customer Regions", "item": [ { "name": "Get customer regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/regions", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "regions" ], "query": [ { "key": "skip_sku_check", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves available and configured regions for the customer." }, "response": [] }, { "name": "Configure customer regions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/regions", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "regions" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Deploys and configures infrastructure resources across selected regional locations.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get region operational status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/regions/operational-status", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "regions", "operational-status" ], "query": [ { "key": "bcSize", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves operational health and deployment metrics for all configured regions." }, "response": [] } ] }, { "name": "SIM Management", "item": [ { "name": "Assign tag to SIMs", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/assign/tag", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "assign", "tag" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Associates a management tag with the specified SIM cards.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get SIM details by ICCID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/details", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "details" ], "query": [ { "key": "iccId", "value": "", "description": "", "disabled": false } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves detailed inventory and carrier status for a single SIM identified by ICCID." }, "response": [] }, { "name": "Export SIM inventory as CSV", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/download", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "download" ], "query": [ { "key": "sortBy", "value": "", "description": "Field to sort by. Default: usage. Sortable fields: iccid, imei, imsi, msisdn, status, eid, locationCountry, ipAddress, usage, brandName, marketingName, deviceType, modelName.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: ASC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Streams a CSV file export of customer SIM records matching search criteria.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Lock or unlock SIMs", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/lock", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "lock" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Locks SIMs to specified IMEI to prevent unauthorized network attachment or status changes.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Search SIMs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/search", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "search" ], "query": [ { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: iccid. Sortable fields: iccid, imei, imsi, msisdn, status, eid, locationCountry, ipAddress, usage, brandName, marketingName, deviceType, modelName.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: ASC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Searches customer SIM inventory with multi-field filtering, sorting, and pagination.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update SIM status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/status", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", "status" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Updates administrative status for provided SIM IDs.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Assign eSIM", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/:iccid/assign", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", ":iccid", "assign" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "iccid", "value": "", "description": "" } ] }, "description": "Assigns an eSIM profile to a user email address and generates an activation code.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Refresh eSIM state", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/:iccid/state", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", ":iccid", "state" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "iccid", "value": "", "description": "" } ] }, "description": "Fetches and synchronizes live eSIM profile state from the carrier MVNO provider." }, "response": [] }, { "name": "Get SIM tower location history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sims/:iccid/tower-locations", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sims", ":iccid", "tower-locations" ], "query": [ { "key": "days", "value": "", "description": "Deprecated. Lookback window in days (1-60). Defaults to 30. Ignored if startDate and endDate are provided.", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date in epoch seconds format", "disabled": true }, { "key": "endDate", "value": "", "description": "End date in epoch seconds format", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "iccid", "value": "", "description": "ICCID of the SIM." } ] }, "description": "Retrieves historical cell tower coordinates and connection history for a single SIM over a lookback window." }, "response": [] } ] }, { "name": "SIM Analytics", "item": [ { "name": "Get map coordinate analytics", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim/analytics/map", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim", "analytics", "map" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves geographic coordinates and usage intensity metrics for dashboard mapping.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get SIM status summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim/analytics/summary", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim", "analytics", "summary" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves summary counts of SIM status distributions across the customer fleet." }, "response": [] }, { "name": "Get top countries by data usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim/analytics/usage/countries", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim", "analytics", "usage", "countries" ], "query": [ { "key": "startDate", "value": "", "description": "", "disabled": false }, { "key": "endDate", "value": "", "description": "", "disabled": false }, { "key": "limit", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves cellular data usage aggregated by country." }, "response": [] }, { "name": "Get daily data usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim/analytics/usage/day", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim", "analytics", "usage", "day" ], "query": [ { "key": "startDate", "value": "", "description": "", "disabled": false }, { "key": "endDate", "value": "", "description": "", "disabled": false }, { "key": "iccId", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves daily aggregated cellular data usage over a specified time window." }, "response": [] }, { "name": "Get top SIMs by data usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim/analytics/usage/sims", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim", "analytics", "usage", "sims" ], "query": [ { "key": "startDate", "value": "", "description": "", "disabled": false }, { "key": "endDate", "value": "", "description": "", "disabled": false }, { "key": "limit", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves the highest data-consuming SIM cards in the customer fleet." }, "response": [] } ] }, { "name": "SIM Location Groups", "item": [ { "name": "List SIM location groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim-location-groups", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim-location-groups" ], "query": [ { "key": "name", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: name. Sortable fields: id, name.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: ASC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves a paginated list of SIM location groups defined for the customer." }, "response": [] }, { "name": "Create a SIM location group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim-location-groups", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim-location-groups" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Creates a new SIM location group for geofencing and policy enforcement.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get SIM location group details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim-location-groups/:simLocationGroupId", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim-location-groups", ":simLocationGroupId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "simLocationGroupId", "value": "", "description": "" } ] }, "description": "Retrieves details and group members for a specific SIM location group." }, "response": [] }, { "name": "Update a SIM location group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim-location-groups/:simLocationGroupId", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim-location-groups", ":simLocationGroupId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "simLocationGroupId", "value": "", "description": "" } ] }, "description": "Updates the name, description, or boundaries of an existing SIM location group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete a SIM location group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/sim-location-groups/:simLocationGroupId", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "sim-location-groups", ":simLocationGroupId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "simLocationGroupId", "value": "", "description": "" } ] }, "description": "Deletes a SIM location group after removing active policy references." }, "response": [] } ] }, { "name": "Tag Management", "item": [ { "name": "List customer tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/tag", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "tag" ], "query": [ { "key": "name", "value": "", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number (0-based)", "disabled": true }, { "key": "size", "value": "", "description": "Page size (1-100)", "disabled": true }, { "key": "sortBy", "value": "", "description": "Field to sort by. Default: name. Sortable fields: id, name.", "disabled": true }, { "key": "sortDir", "value": "", "description": "ASC or DESC. Default: ASC.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Retrieves all resource tags defined for a customer account." }, "response": [] }, { "name": "Create a tag", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCellBaseUrl}}/api/v1/customers/:id/tag", "host": [ "{{ZCellBaseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "tag" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Creates a new resource tag for categorizing SIMs and policies.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] } ] }, { "name": "Zscaler Client Connector", "item": [ { "name": "Login Controller", "item": [ { "name": "Authenticates and obtains a JSON Web Token (JWT)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/auth/v1/login", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "auth", "v1", "login" ] }, "description": "Authenticate using the apikey and the secretKey. The response returns a JSON Web Token (JWT), which must be used for authentication against other API calls in subsequent requests.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Public API Controller", "item": [ { "name": "Downloads or exports device information as a CSV file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/downloadDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "downloadDevices" ], "query": [ { "key": "osTypes", "value": "", "description": "

Filter the list of devices by operating systems. The default value is null, which represents ALL OS types. The following values represent different OS types:

  • 1 - iOS
  • 2 - Android
  • 3 - Windows
  • 4 - macOS
  • 5 - Linux

A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadDevices?osTypes=1,2

", "disabled": true }, { "key": "registrationTypes", "value": "", "description": "

Filter the list of devices by registration types or states. The following values represent different device states:

  • 0 - All states except Removed
  • 1 - Registered
  • 3 - Removal pending
  • 4 - Unregistered
  • 5 - Removed
  • 6 - Quarantined

A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadDevices?registrationTypes=1,3

", "disabled": true } ] }, "description": "Downloads or exports device information as a CSV file." }, "response": [] }, { "name": "Downloads or exports a report as a CSV file showing the disable reasons of a device", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/downloadDisableReasons", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "downloadDisableReasons" ], "query": [ { "key": "osTypes", "value": "", "description": "

Filter the list of entries by operating systems. The default value is null, which represents ALL OS types. The following values represent different OS types:\n

  • 1 - iOS
  • 2 - Android
  • 3 - Windows
  • 4 - macOS
  • 5 - Linux

    • ", "disabled": true }, { "key": "startDate", "value": "", "description": "startDate", "disabled": false }, { "key": "endDate", "value": "", "description": "endDate", "disabled": true } ] }, "description": "Downloads or exports a report as a CSV file showing the disable reasons of a device." }, "response": [] }, { "name": "Downloads service status of all devices as a CSV file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/downloadServiceStatus", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "downloadServiceStatus" ], "query": [ { "key": "osTypes", "value": "", "description": "

    Filter the list by operating systems. The default value is null, which represents ALL OS types. The following values represent different OS types:

    • 1 - iOS
    • 2 - Android
    • 3 - Windows
    • 4 - macOS
    • 5 - Linux

    A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadServiceStatus?osTypes=1,2

    ", "disabled": true }, { "key": "registrationTypes", "value": "", "description": "

    Filter the list by registration types or states. The following values represent different device states:

    • 0 - All states except Removed
    • 1 - Registered
    • 3 - Removal pending
    • 4 - Unregistered
    • 5 - Removed
    • 6 - Quarantined

    A sample API call: https://api-mobile.zscalerbeta.net/papi/public/v1/downloadServiceStatus?registrationTypes=1,3

    ", "disabled": true } ] }, "description": "Downloads service status of all devices as a CSV file." }, "response": [] }, { "name": "Updates a specific admin user", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/editAdminUser", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "editAdminUser" ] }, "description": "Updates a specific admin user.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Force removes enrolled devices", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/forceRemoveDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "forceRemoveDevices" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 30.", "disabled": true } ] }, "description": "

    Force removes the enrolled device from the portal. You can only remove devices that are in registered or device removal pending state. At least one criterion (username, Zscaler Client Connector version, OS type, or UDID) must be specified to remove devices.

    The following are the valid values for the osType attribute. The default value is null, which represents ALL OS types.

    • 1 - iOS
    • 2 - Android
    • 3 - Windows
    • 4 - macOS
    • 5 - Linux
    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "List of admin roles in your organization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getAdminRoles", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getAdminRoles" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true } ] }, "description": "List of admin roles in your organization." }, "response": [] }, { "name": "Gets the list of admin users in your organization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getAdminUsers", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getAdminUsers" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "userType", "value": "", "description": "userType", "disabled": true } ] }, "description": "Gets the list of admin users in your organization." }, "response": [] }, { "name": "Synchronizes the local copy of admin users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getAdminUsersSyncInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getAdminUsersSyncInfo" ] }, "description": "Synchronizes the local copy of admin users." }, "response": [] }, { "name": "Gets information about your organization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getCompanyInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getCompanyInfo" ] }, "description": "

    Gets information about your organization such as the name of the business, domains, etc.

    Note: This API is allowed if the caller is a OneAPI customer or if the token has admin or read-only admin privileges.

    " }, "response": [] }, { "name": "Gets the configuration for device cleanup", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getDeviceCleanupInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getDeviceCleanupInfo" ] }, "description": "Gets the configuration for device cleanup." }, "response": [] }, { "name": "Lists device details of enrolled devices of your organization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getDeviceDetails", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getDeviceDetails" ], "query": [ { "key": "username", "value": "", "description": "Filter by enrolled user name for the device.", "disabled": true }, { "key": "udid", "value": "", "description": "Filter by unique device identifier.", "disabled": true } ] }, "description": "Lists device details of enrolled devices of your organization." }, "response": [] }, { "name": "Lists all enrolled devices of your organization and their basic details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getDevices" ], "query": [ { "key": "username", "value": "", "description": "Filter by enrolled user name for the device.", "disabled": true }, { "key": "osType", "value": "", "description": "Filter by device operating system type.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 50. The max page size is 5000.", "disabled": true } ] }, "description": "Lists all enrolled devices of your organization and their basic details." }, "response": [] }, { "name": "Gets the one-time password (OTP) for a specific device", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getOtp", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getOtp" ], "query": [ { "key": "udid", "value": "", "description": "Unique device identifier.", "disabled": true } ] }, "description": "Gets the one-time password (OTP) for a specific device. These single-use passwords are unique and tied to the device Unique Device Identifier (UDID). It is made of 10 random alphanumeric characters and can only be used once." }, "response": [] }, { "name": "Gets the app profile password for a specific device", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getPasswords", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getPasswords" ], "query": [ { "key": "username", "value": "", "description": "Enrolled user for the device.", "disabled": true }, { "key": "osType", "value": "", "description": "Device operating system.", "disabled": true } ] }, "description": "Gets the app profile password for a specific device. You can determine the assigned global passwords by using the username and OS type of a device." }, "response": [] }, { "name": "Updates profile policy rule passwords", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/managePass", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "managePass" ] }, "description": "

    Updates profile policy rule passwords. The JSON Web Token (JWT) passed in as a header must be associated with a user who has Full access to Zscaler Client Connector App Profiles with an API key created with Write access. To learn more, see Adding Roles and Adding an API Key.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the configuration information for end user and device-related PII", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getWebPrivacyInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getWebPrivacyInfo" ] }, "description": "Gets the configuration information for end user and device-related PII." }, "response": [] }, { "name": "Gets the list of ZDX entitlements for user groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getZdxGroupEntitlements", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getZdxGroupEntitlements" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true } ] }, "description": "Gets the list of ZDX entitlements for user groups." }, "response": [] }, { "name": "Gets the list of ZPA entitlements for user groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/getZpaGroupEntitlements", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "getZpaGroupEntitlements" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true } ] }, "description": "Gets the list of ZPA entitlements for user groups." }, "response": [] }, { "name": "Soft removes enrolled devices", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/removeDevices", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "removeDevices" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size. If not provided, the default page size is 30. The max page size is 5000.", "disabled": true } ] }, "description": "

    Soft removes the enrolled device from the portal. The soft removal marks the device state as device removal pending. At least one criterion (username, Zscaler Client Connector version, OS type, or UDID) must be specified to remove devices.

    The following are the valid values for the osType attribute. The default value is null, which represents ALL OS types.

    • 1 - iOS
    • 2 - Android
    • 3 - Windows
    • 4 - macOS
    • 5 - Linux
    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Removes machine tunnel devices", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/removeMachineTunnel", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "removeMachineTunnel" ], "query": [ { "key": "hostName", "value": "", "description": "Comma-separated list of hostnames for the device.", "disabled": true }, { "key": "machineToken", "value": "", "description": "Machine token.", "disabled": true } ] }, "description": "

    Remove machine tunnel devices.

    Note: For the parameters described below, you can specify either hostName or machineToken but not both.

    \n", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Adds or updates the configuration for device cleanup", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/setDeviceCleanupInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "setDeviceCleanupInfo" ] }, "description": "Adds or updates the configuration for device cleanup.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Adds or updates the configuration information for end user and device-related PII", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/setWebPrivacyInfo", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "setWebPrivacyInfo" ] }, "description": "Adds or updates the configuration information for end user and device-related PII.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Synchronizes the local copy of all the ZIA and ZDX admin users", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/syncZiaZdxAdminUsers", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "syncZiaZdxAdminUsers" ] }, "description": "Synchronizes the local copy of all the ZIA and ZDX admin users." }, "response": [] }, { "name": "Synchronizes the local copy of the ZPA admin users", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/syncZpaAdminUsers", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "syncZpaAdminUsers" ] }, "description": "Synchronizes the local copy of the ZPA admin users." }, "response": [] }, { "name": "Updates ZDX entitlement for user groups", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/updateZdxGroupEntitlement", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "updateZdxGroupEntitlement" ] }, "description": "Updates ZDX entitlement for user groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates ZPA entitlement for user groups", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/updateZpaGroupEntitlement", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "updateZpaGroupEntitlement" ] }, "description": "Updates ZPA entitlement for user groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Enables or disables a policy or app profile for the company by platform", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/web/policy/activate", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "web", "policy", "activate" ] }, "description": "Enables or disables a policy or app profile for the company by platform (iOS, Android, Windows, macOS, and Linux).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Adds or updates a policy or app profile for the company by platform", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/web/policy/edit", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "web", "policy", "edit" ] }, "description": "Adds or updates a policy or app profile for the company by platform (iOS, Android, Windows, macOS, and Linux).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the list of policies by company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/web/policy/listByCompany", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "web", "policy", "listByCompany" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true }, { "key": "searchType", "value": "", "description": "searchType", "disabled": true }, { "key": "deviceType", "value": "", "description": "deviceType", "disabled": true } ] }, "description": "

    The following are the valid values for the deviceType attribute:

    • 1 - iOS
    • 2 - Android
    • 3 - Windows
    • 4 - macOS
    • 5 - Linux
    \n" }, "response": [] }, { "name": "Deletes a policy or app profile for the company by platform", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/web/policy/:policyId/delete", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "web", "policy", ":policyId", "delete" ], "variable": [ { "key": "policyId", "value": "", "description": "policyId" } ] }, "description": "Deletes a policy or app profile for the company by platform (iOS, Android, Windows, macOS, and Linux)." }, "response": [] }, { "name": "Gets the list of applications to bypass Zscaler", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webAppService/listByCompany", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webAppService", "listByCompany" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true } ] }, "description": "Gets the list of applications to bypass Zscaler such as Zoom, Microsoft Teams, etc." }, "response": [] }, { "name": "Updates a specific FailOpen policy for the company", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webFailOpenPolicy/edit", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webFailOpenPolicy", "edit" ] }, "description": "Updates a specific FailOpen policy for the company.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the list of FailOpen policies for the company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webFailOpenPolicy/listByCompany", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webFailOpenPolicy", "listByCompany" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true } ] }, "description": "Gets the list of FailOpen policies for the company." }, "response": [] }, { "name": "Updates a forwarding profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webForwardingProfile/edit", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webForwardingProfile", "edit" ] }, "description": "Updates a forwarding profile.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the list of forwarding profiles by company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webForwardingProfile/listByCompany", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webForwardingProfile", "listByCompany" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true } ] }, "description": "Gets the list of forwarding profiles by company." }, "response": [] }, { "name": "Deletes a forwarding profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webForwardingProfile/:profileId/delete", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webForwardingProfile", ":profileId", "delete" ], "variable": [ { "key": "profileId", "value": "", "description": "profileId" } ] }, "description": "Deletes a forwarding profile." }, "response": [] }, { "name": "Adds a new trusted network", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webTrustedNetwork/create", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webTrustedNetwork", "create" ] }, "description": "Adds a new trusted network.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Updates a trusted network", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webTrustedNetwork/edit", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webTrustedNetwork", "edit" ] }, "description": "Updates a trusted network.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Gets the list of trusted networks by company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webTrustedNetwork/listByCompany", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webTrustedNetwork", "listByCompany" ], "query": [ { "key": "page", "value": "", "description": "page", "disabled": true }, { "key": "pageSize", "value": "", "description": "pageSize", "disabled": true }, { "key": "search", "value": "", "description": "search", "disabled": true }, { "key": "searchType", "value": "", "description": "searchType", "disabled": true } ] }, "description": "Gets the list of trusted networks by company." }, "response": [] }, { "name": "Deletes a trusted network", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/webTrustedNetwork/:networkId/delete", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "webTrustedNetwork", ":networkId", "delete" ], "variable": [ { "key": "networkId", "value": "", "description": "networkId" } ] }, "description": "Deletes a trusted network." }, "response": [] }, { "name": "Retrieves the list of application profile policies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/application-profiles", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "application-profiles" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 50.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies.", "disabled": true }, { "key": "searchType", "value": "", "description": "The search string used to match against the search type. This is enabled only for filename, name, policyToken, ruleset, or groups.", "disabled": true }, { "key": "deviceType", "value": "", "description": "The search string used to match against the device type.", "disabled": true } ] }, "description": "Retrieves the list of application profile policies." }, "response": [] }, { "name": "Retrieves the list of policies for application profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/application-profiles/:profileId", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "application-profiles", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "ID of the profile" } ] }, "description": "Retrieves the list of policies for application profiles." }, "response": [] }, { "name": "Update the properties of the application profile using profile ID", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/application-profiles/:profileId", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "application-profiles", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "ID of the profile" } ] }, "description": "

    Update the properties of the application profile using profile ID.

    Note:You can update only the following allowlisted properties. For array or comma-separated strings, ensure to include existing values along with the new values.

      \n
    • packetTunnelExcludeList
      • \n
    • packetTunnelExcludeListForIPv6
      • \n
    • packetTunnelIncludeList
      • \n
    • packetTunnelIncludeListForIPv6
      • \n
    • vpnGateways
      • \n
    • sourcePortBasedBypasses
      • \n
    • disableParallelIpv4AndIPv6
      • \n
    • dnsPriorityOrderingForTrustedDnsCriteria
      • \n
    • useDefaultAdapterForDNS
      • \n
    • updateDnsSearchOrder
      • \n
    • disableDNSRouteExclusion
      • \n
    • enforceSplitDNS
      • \n
    • bypassDNSTrafficUsingUDPProxy
      • \n
    • truncateLargeUDPDNSResponse
      • \n
    • prioritizeDnsExclusions
      • \n
    • packetTunnelDnsExcludeList
      • \n
    • packetTunnelDnsIncludeList
      • \n
    • dnsPriorityOrdering
      • \n
    • customDNS
      • \n
    • appServiceIds
      • \n
    • bypassAppIds
      • \n
    • bypassCustomAppIds
      • \n
    • groups
      • \n
    • groupAll
      • \n
    • userIds
      • \n
    • logoutpassword
      • \n
    • uninstallpassword
      • \n
    • disablepassword
      • \n
    • exitPassword
      • \n
    • zdxDisablePassword
      • \n
    • zdDisablePassword
      • \n
    • zpaDisablePassword
      • \n
    • zdpDisablePassword
      • \n
    • zccRevertPassword
      • \n
    • zccFailCloseSettingsExitUninstallPassword
      • \n
    • deviceType
    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Retrieves the list of custom IP-based applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/custom-ip-based-apps", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "custom-ip-based-apps" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies.", "disabled": true } ] }, "description": "Retrieves the list of custom IP-based applications." }, "response": [] }, { "name": "Retrieves the custom IP-based application using app ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/custom-ip-based-apps/:appId", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "custom-ip-based-apps", ":appId" ], "variable": [ { "key": "appId", "value": "", "description": "ID of the application." } ] }, "description": "Retrieves the custom IP-based application using app ID." }, "response": [] }, { "name": "Retrieves the list of predefined IP-based applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/predefined-ip-based-apps", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "predefined-ip-based-apps" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies.", "disabled": true } ] }, "description": "Retrieves the list of predefined IP-based applications." }, "response": [] }, { "name": "Retrieves the predefined IP-based application using application ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/predefined-ip-based-apps/:appId", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "predefined-ip-based-apps", ":appId" ], "variable": [ { "key": "appId", "value": "", "description": "ID of the application." } ] }, "description": "Retrieves the predefined IP-based application using application ID." }, "response": [] }, { "name": "Retrieves the list of process-based applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/process-based-apps", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "process-based-apps" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies.", "disabled": true } ] }, "description": "Retrieves the list of process-based applications." }, "response": [] }, { "name": "Retrieves the process-based application using appID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZCCBaseUrl}}/papi/public/v1/process-based-apps/:appId", "host": [ "{{ZCCBaseUrl}}" ], "path": [ "papi", "public", "v1", "process-based-apps", ":appId" ], "variable": [ { "key": "appId", "value": "", "description": "ID of the application." } ] }, "description": "Retrieves the process-based application using appID." }, "response": [] } ] } ] }, { "name": "Zscaler Internet Access (ZIA)", "item": [ { "name": "Activation", "item": [ { "name": "Eusa Status Z Resource Get Eusa Status For Latest Eusa Info ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eusaStatus/latest", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eusaStatus", "latest" ] }, "description": "Retrieves the End User Subscription Agreement (EUSA) acceptance status. If the status does not exist, it returns a status object with no ID." }, "response": [] }, { "name": "Eusa Status Z Resource Update Eusa Status", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eusaStatus/:eusaStatusId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eusaStatus", ":eusaStatusId" ], "variable": [ { "key": "eusaStatusId", "value": "", "description": "The EUSA status ID" } ] }, "description": "Updates the EUSA status based on the specified status ID" }, "response": [] }, { "name": "Get Organization Activation Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/status", "host": [ "{{ZIABaseUrl}}" ], "path": [ "status" ] }, "description": "

    Gets the activation status for the saved configuration changes. To learn more about activating configuration changes, see Saving and Activating Changes in the ZIA Admin Portal.

    \n" }, "response": [] }, { "name": "Activate Organizational Changes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/status/activate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "status", "activate" ] }, "description": "

    Activates the saved configuration changes. To learn more, see Saving and Activating Changes in the ZIA Admin Portal.

    \n" }, "response": [] } ] }, { "name": "Adaptive Access Profiles", "item": [ { "name": "Adaptive Access Profile Resource Get Adaptive Access Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adaptiveAccessProfiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adaptiveAccessProfiles" ] }, "description": "Retrieves a list of all Adaptive Access profiles. To learn more, see About Adaptive Access Profiles." }, "response": [] }, { "name": "Adaptive Access Profile Resource Get Rule Names Associated With Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adaptiveAccessProfiles/profiles/rules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adaptiveAccessProfiles", "profiles", "rules" ], "query": [ { "key": "iamAapIds", "value": "", "description": "Filters based on the Adaptive Access profile IDs", "disabled": true }, { "key": "orgId", "value": "", "description": "Filters based on the organization ID", "disabled": true } ] }, "description": "Retrieves the Adaptive Access profile information based on the specified ID" }, "response": [] } ] }, { "name": "Admin Audit Logs", "item": [ { "name": "Get Audit Report Entry CSV Export Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/auditlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "auditlogEntryReport" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /auditlogEntryReport request.", "disabled": false } ] }, "description": "

    Gets the status of a request for an audit log report. After sending a POST request to /auditlogEntryReport to generate a report, you can continue to call GET /auditlogEntryReport to check whether the report has finished generating. Once the status is COMPLETE, you can send another GET request to /auditlogEntryReport/download to download the report as a CSV file.

    \n" }, "response": [] }, { "name": "Start Audit Report Entry CSV Export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/auditlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "auditlogEntryReport" ] }, "description": "

    Creates an audit log report for the specified time period and saves it as a CSV file. The report includes audit information for every call made to the cloud service API during the specified time period. Creating a new audit log report overwrites a previously-generated report.

    \n" }, "response": [] }, { "name": "Cancel Audit Report Entry CSV Export", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/auditlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "auditlogEntryReport" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /auditlogEntryReport request.", "disabled": false } ] }, "description": "

    Cancels the request to create an audit log report.

    \n" }, "response": [] }, { "name": "Get Audit Report Entry CSV Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/auditlogEntryReport/download", "host": [ "{{ZIABaseUrl}}" ], "path": [ "auditlogEntryReport", "download" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /auditlogEntryReport request.", "disabled": false } ] }, "description": "

    Downloads the most recently created audit log report. After a call to GET /auditlogEntryReport indicates that the report (CSV file) was generated, you can send a GET request to /auditlogEntryReport/download to download the file.

    \n" }, "response": [] } ] }, { "name": "Admin & Role Management", "item": [ { "name": "Password Expiry Resource Get Password Expiry Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/passwordExpiry/settings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "passwordExpiry", "settings" ] }, "description": "Retrieves the password expiration information for all the admins" }, "response": [] }, { "name": "Password Expiry Resource Update Password Expiry Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/passwordExpiry/settings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "passwordExpiry", "settings" ] }, "description": "Updates the password expiration information for all the admins" }, "response": [] }, { "name": "Admin Role Resource Get Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles" ], "query": [ { "key": "includeAuditorRole", "value": "", "description": "Includes or excludes the auditor role information in the list", "disabled": true }, { "key": "includePartnerRole", "value": "", "description": "Includes or excludes the partner admin role information in the list", "disabled": true }, { "key": "includeApiRole", "value": "", "description": "Includes or excludes the API role information in the list", "disabled": true }, { "key": "id", "value": "", "description": "Specifies the admin role login ID", "disabled": true } ] }, "description": "

    Retrieves a list of all admin roles. To learn more, see About Role Management.

    \n" }, "response": [] }, { "name": "Admin Role Resource Add Role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles" ] }, "description": "

    Adds an admin role. To learn more, see Adding Admin Roles.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Admin Role Resource Get Role", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles/:roleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "Specifies the role ID" } ] }, "description": "Retrieves the admin role based on the specified ID" }, "response": [] }, { "name": "Admin Role Resource Update Role", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles/:roleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "Specifies the role ID" } ] }, "description": "

    Updates the admin role based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Admin Role Resource Delete Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles/:roleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "Specifies the role ID" } ] }, "description": "

    Deletes the admin role based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Get Role Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminRoles/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminRoles", "lite" ], "query": [ { "key": "includeAuditorRole", "value": "", "description": "

    Includes or excludes the auditor role information in the list

    \n", "disabled": true }, { "key": "includePartnerRole", "value": "", "description": "

    Includes or excludes the partner admin role information in the list

    \n", "disabled": true }, { "key": "includeApiRole", "value": "", "description": "

    Includes or excludes the API role information in the list

    \n", "disabled": true } ] }, "description": "

    Retrieves a name and ID dictionary of all admin roles. The list only includes the name and ID for all admin roles. To learn more, see About Role Management.

    \n" }, "response": [] }, { "name": "Get Admin Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers" ], "query": [ { "key": "includeAuditorUsers", "value": "", "description": "

    Include or exclude auditor user information in the list.

    \n", "disabled": true }, { "key": "includeAdminUsers", "value": "", "description": "

    Include or exclude admin user information in the list.

    \n", "disabled": true }, { "key": "search", "value": "", "description": "

    The search string used to partially match against an admin/auditor user's Login ID or Name.

    ", "disabled": true }, { "key": "page", "value": "", "description": "

    Specifies the page offset.

    ", "disabled": true }, { "key": "pageSize", "value": "", "description": "

    Specifies the page size. The default size is 100, but the maximum size is 1000.

    ", "disabled": true } ] }, "description": "

    Gets a list of admin users. By default, auditor user information is not included. To learn more, see About Administrators and About Auditors.

    \n" }, "response": [] }, { "name": "Add Admin User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers" ], "query": [ { "key": "associateWithExistingAdmin", "value": "", "description": "This field is set to true to update an admin user that already exists in other Zscaler services but does not exist in ZIA. For example, this field must be set to true when creating an admin user in ZIA who's already a user in Zscaler Digital Experience (ZDX). To learn more, see Adding ZIA Admins.", "disabled": true } ] }, "description": "

    Creates an admin or auditor user. To learn more, see Adding Admins and Adding Auditors.

    \n" }, "response": [] }, { "name": "Update Admin User", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers/:userId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "

    The unique identifier for the admin/auditor user.

    \n" } ] }, "description": "

    Updates admin or auditor user for the specified ID. You can only disable/enable the default admin account using this endpoint, all other updates within the request are ignored for this admin account.

    \n" }, "response": [] }, { "name": "Delete Admin User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers/:userId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "

    The unique identifier for the admin/auditor user.

    \n" } ] }, "description": "Deletes an admin or auditor user using the specified ID.\n\n**Note:** This request deletes an admin and removes them as a user from the ZIA Admin Portal. To delete the admin privileges for a user while retaining them as a regular user, use the `POST /adminUsers/{userId}/convertToUser` request.\n\n**Sample Request (Python):**\n\n```python\nimport http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"HOSTNAME\")\n\nheaders = {\n 'content-type': \"application/json\",\n 'cache-control': \"no-cache\",\n 'cookie': \"JSESSIONID=xxxxxxx\"\n}\n\nconn.request(\"DELETE\", \"/api/v1/adminUsers/6794036\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))\n```\n\n**Sample Response:**\n\n```text\n204 No Content\n```\n" }, "response": [] }, { "name": "Admin User Z Resource Get Current User", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers/me", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers", "me" ] }, "description": "Retrieves information about the current administrator or auditor user, or both" }, "response": [] }, { "name": "Admin User Resource Convert Admin To End User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/adminUsers/:userId/convertToUser", "host": [ "{{ZIABaseUrl}}" ], "path": [ "adminUsers", ":userId", "convertToUser" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifier of the admin user" } ] }, "description": "

    Removes admin privileges for a user while retaining them as a regular user of your organization in the ZIA Admin Portal. This can be used as an alternative to the DELETE /adminUsers/{userId} request, which deletes an admin and removes them as a user from the ZIA Admin Portal. To learn more, see Deleting ZIA Admins.

    Before you can delete the admin privileges for a user, you need to obtain the admin user's ID and other information by using the GET /users request and then send the admin user details in the POST /adminUsers/{userId}/convertToUser request.

    " }, "response": [] } ] }, { "name": "Advanced Settings", "item": [ { "name": "Advanced Settings Resource Get Advanced Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/advancedSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "advancedSettings" ] }, "description": "Retrieves information about the advanced settings configured in the ZIA Admin Portal" }, "response": [] }, { "name": "Advanced Settings Resource Update Advanced Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/advancedSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "advancedSettings" ] }, "description": "Updates the advanced settings configuration in the ZIA Admin Portal. To learn more, see Configuring Advanced Settings." }, "response": [] } ] }, { "name": "Alerts", "item": [ { "name": "Alert Subscription Resource Get Alert Subscriptions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertSubscriptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertSubscriptions" ] }, "description": "Retrieves a list of all alert subscriptions. ." }, "response": [] }, { "name": "Alert Subscription Resource Add Alert Subscription", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertSubscriptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertSubscriptions" ] }, "description": "Adds a new alert subscription. ." }, "response": [] }, { "name": "Alert Subscription Resource Get Alert Subscription", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertSubscriptions/:alertSubscriptionId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertSubscriptions", ":alertSubscriptionId" ], "variable": [ { "key": "alertSubscriptionId", "value": "", "description": "The alert subscription ID" } ] }, "description": "Retrieves the alert subscription information based on the specified ID" }, "response": [] }, { "name": "Alert Subscription Resource Update Alert Subscription", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertSubscriptions/:alertSubscriptionId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertSubscriptions", ":alertSubscriptionId" ], "variable": [ { "key": "alertSubscriptionId", "value": "", "description": "The alert subscription ID" } ] }, "description": "Updates an existing alert subscription based on the specified ID" }, "response": [] } ] }, { "name": "Advanced Threat Protection Policy", "item": [ { "name": "Cyber Threat Protection Resource Get Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/advancedThreatSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "advancedThreatSettings" ] }, "description": "Retrieves the advanced threat configuration settings in the ZIA Admin Portal" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/advancedThreatSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "advancedThreatSettings" ] }, "description": "Updates the advanced threat configuration settings. To learn more, see Configuring the Advanced Threat Protection Policy." }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Malicious Urls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/maliciousUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "maliciousUrls" ] }, "description": "Retrieves the malicious URLs added to the denylist in the Advanced Threat Protection (ATP) policy" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Malicious Urls", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/maliciousUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "maliciousUrls" ], "query": [ { "key": "action", "value": "", "description": "Indicates whether to include or exclude the specified URLs from the list", "disabled": true } ] }, "description": "Updates the malicious URLs added to the denylist in ATP policy. To learn more, see Configuring the Advanced Threat Protection Policy." }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Security Exceptions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/securityExceptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "securityExceptions" ] }, "description": "Retrieves information about the security exceptions configured for the ATP policy" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Security Exceptions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/securityExceptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "securityExceptions" ] }, "description": "Updates security exceptions for the ATP policy.To learn more, see Configuring the Advanced Threat Protection Policy." }, "response": [] } ] }, { "name": "API Authentication", "item": [ { "name": "Get Authenticated Session", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authenticatedSession", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authenticatedSession" ] }, "description": "Checks if there is an authentication session." }, "response": [] }, { "name": "Post Authenticated Session Info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authenticatedSession", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authenticatedSession" ] }, "description": "

    Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.

    " }, "response": [] }, { "name": "Set Authenticated Session Info", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authenticatedSession", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authenticatedSession" ] }, "description": "

    Ends an authenticated session.

    " }, "response": [] } ] }, { "name": "Authentication Settings", "item": [ { "name": "Auth Settings Resource Get Auth Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authSettings" ] }, "description": "

    Retrieves the organization's default authentication settings information, including authentication profile and Kerberos authentication information.

    " }, "response": [] }, { "name": "Auth Settings Resource Update Auth Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authSettings" ] }, "description": "

    Updates the organization's default authentication settings information.

    " }, "response": [] }, { "name": "Auth Settings Resource Get Lite Auth Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authSettings/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authSettings", "lite" ] }, "description": "

    Retrieves organization's default authentication settings information.

    \n" }, "response": [] } ] }, { "name": "Azure Integration", "item": [ { "name": "Azure Resource Get Refresh Connection Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/refreshConnectionStatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "refreshConnectionStatus" ] }, "description": "Retrieves the progress summary of the VPN connection refresh process" }, "response": [] }, { "name": "Azure Resource Start Refresh Connection Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/refreshConnectionStatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "refreshConnectionStatus" ] }, "description": "Starts an asynchronous process to refresh the VPN connection status" }, "response": [] }, { "name": "Azure Resource Get Tunnel Configuration Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/tunnelConfiguration", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "tunnelConfiguration" ] }, "description": "Retrieves the tunnel configuration status of the Azure hub. To learn more, see Integrating with Microsoft Azure Virtual WAN." }, "response": [] }, { "name": "Azure Resource Start Tunnel Config", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/tunnelConfiguration", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "tunnelConfiguration" ] }, "description": "Starts the tunnel configuration process for the specified Azure hub. To learn more, see Configuring Azure Virtual WAN Location." }, "response": [] }, { "name": "Azure Resource Unconfigure Tunnel", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/unConfigureTunnel/:hubId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "unConfigureTunnel", ":hubId" ], "variable": [ { "key": "hubId", "value": "", "description": "The Azure hub ID" } ] }, "description": "Removes the tunnel configuration for a specified Azure hub" }, "response": [] }, { "name": "Azure Resource Get Tunnel Un Configuration Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/unConfigureTunnelStatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "unConfigureTunnelStatus" ] }, "description": "Retrieves the status of the tunnel configuration removal process" }, "response": [] }, { "name": "Azure Resource Get Virtual Hubs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/virtualHubs", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "virtualHubs" ], "query": [ { "key": "version", "value": "", "description": "Version of the data to retrieve", "disabled": true } ] }, "description": "Retrieves a list of synced Azure hubs from the database" }, "response": [] }, { "name": "Azure Resource Get Async Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/virtualHubSync", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "virtualHubSync" ] }, "description": "Retrieves the status of the Azure hub sync process" }, "response": [] }, { "name": "Azure Resource Check Async", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/azure/virtualHubSync", "host": [ "{{ZIABaseUrl}}" ], "path": [ "azure", "virtualHubSync" ] }, "description": "Starts an asynchronous process to sync Azure hubs" }, "response": [] } ] }, { "name": "Bandwidth Control & Classes", "item": [ { "name": "Bandwidth Class Resource Get Bandwidth Classes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses" ] }, "description": "Retrieves a list of bandwidth classes for an organization. ." }, "response": [] }, { "name": "Bandwidth Class Resource Add Bandwidth Class", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses" ] }, "description": "Adds a new bandwidth class. ." }, "response": [] }, { "name": "Bandwidth Class Resource Get Bandwidth Classes Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses", "lite" ] }, "description": "Retrieves a list of bandwidth classes for an organization." }, "response": [] }, { "name": "Bandwidth Class Resource Get Bandwidth Class", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses/:bandwidthClassId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses", ":bandwidthClassId" ], "variable": [ { "key": "bandwidthClassId", "value": "", "description": "Bandwidth class ID" } ] }, "description": "Retrieves the bandwidth class based on the specified ID" }, "response": [] }, { "name": "Bandwidth Class Resource Update Bandwidth Class", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses/:bandwidthClassId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses", ":bandwidthClassId" ], "variable": [ { "key": "bandwidthClassId", "value": "", "description": "Bandwidth class ID" } ] }, "description": "Updates a bandwidth class based on the specified ID" }, "response": [] }, { "name": "Bandwidth Class Resource Delete Bandwidth Class", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthClasses/:bandwidthClassId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthClasses", ":bandwidthClassId" ], "variable": [ { "key": "bandwidthClassId", "value": "", "description": "Bandwidth class ID" } ] }, "description": "Deletes a bandwidth class based on the specified ID" }, "response": [] }, { "name": "Bandwidth Control Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules" ] }, "description": "Retrieves all the rules in the Bandwidth Control policy. ." }, "response": [] }, { "name": "Bandwidth Control Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules" ] }, "description": "Adds a new Bandwidth Control policy rule. ." }, "response": [] }, { "name": "Bandwidth Control Rule Resource Get Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules", "lite" ] }, "description": "Retrieves all the rules in the Bandwidth Control policy" }, "response": [] }, { "name": "Bandwidth Control Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Bandwidth Control rule ID" } ] }, "description": "Retrieves the Bandwidth Control policy rule based on the specified ID" }, "response": [] }, { "name": "Bandwidth Control Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Bandwidth Control rule ID" } ] }, "description": "Updates the Bandwidth Control policy rule based on the specified ID" }, "response": [] }, { "name": "Bandwidth Control Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/bandwidthControlRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "bandwidthControlRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Bandwidth Control rule ID" } ] }, "description": "Deletes a Bandwidth Control policy rule based on the specified ID" }, "response": [] } ] }, { "name": "Browser Isolation", "item": [ { "name": "Browser Isolation Resource Get Cloud Browser Isolation Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/browserIsolation/profiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "browserIsolation", "profiles" ] }, "description": "

    Gets a list of all the cloud browser isolation profiles in the Isolation Profile field for URL Filtering Policy and Cloud App Control Policy rules.

    " }, "response": [] } ] }, { "name": "Cloud Applications", "item": [ { "name": "Cloud Application Risk Profile Resource Get Risk Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles" ] }, "description": "Retrieves the cloud application risk profile. ." }, "response": [] }, { "name": "Cloud Application Risk Profile Resource Add Risk Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles" ] }, "description": "Adds a new cloud application risk profile. ." }, "response": [] }, { "name": "Cloud Application Risk Profile Resource Get Risk Profiles Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles", "lite" ] }, "description": "Retrieves the cloud application risk profile" }, "response": [] }, { "name": "Cloud Application Risk Profile Resource Get Risk Profile By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "The risk profile ID" } ] }, "description": "Retrieves the cloud application risk profile based on the specified ID" }, "response": [] }, { "name": "Cloud Application Risk Profile Resource Update Risk Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "The risk profile ID" } ] }, "description": "Updates the cloud application risk profile based on the specified ID" }, "response": [] }, { "name": "Cloud Application Risk Profile Resource Delete Risk Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/riskProfiles/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "riskProfiles", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "The risk profile ID" } ] }, "description": "Deletes the cloud application risk profile based on the specified ID" }, "response": [] }, { "name": "Cloud Applications Resource Get Policy Web Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplications/policy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplications", "policy" ], "query": [ { "key": "search", "value": "", "description": "Filter application by name", "disabled": true }, { "key": "pageSize", "value": "", "description": "Set the size of response", "disabled": true }, { "key": "page", "value": "", "description": "Set the page number of response", "disabled": true }, { "key": "appClass", "value": "", "description": "Filter application by application category", "disabled": true }, { "key": "groupResults", "value": "", "description": "Show count of applications grouped by application category", "disabled": true } ] }, "description": "

    Retrieves a list of Predefined and User Defined Cloud Applications associated with the DLP rules, Cloud App Control rules, Advanced Settings, Bandwidth Classes, and File Type Control rules.

    Retrieves AppInfo when groupResults is set to false and retrieves the application count grouped by application category when groupResults is set to true.

    " }, "response": [] }, { "name": "Cloud Applications Resource Get SSL Policy Web Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplications/sslPolicy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplications", "sslPolicy" ], "query": [ { "key": "search", "value": "", "description": "Filter application by name", "disabled": true }, { "key": "pageSize", "value": "", "description": "Set the size of response", "disabled": true }, { "key": "page", "value": "", "description": "Set the page number of response", "disabled": true }, { "key": "appClass", "value": "", "description": "Filter application by application category", "disabled": true }, { "key": "groupResults", "value": "", "description": "Show count of applications grouped by application category", "disabled": true } ] }, "description": "

    Retrieves a list of Predefined and User Defined Cloud Applications associated with the SSL Inspection rules.

    Retrieves AppInfo when groupResults is set to false and retrieves the application count grouped by application category when groupResults is set to true.

    " }, "response": [] } ] }, { "name": "Cloud App Control Policy", "item": [ { "name": "Cloud Application Instance Resource Get Cloud Application Instances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplicationInstances", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplicationInstances" ], "query": [ { "key": "instanceName", "value": "", "description": "The cloud application instance name", "disabled": true }, { "key": "instanceType", "value": "", "description": "The cloud application instance type", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves the list of cloud application instances configured in the ZIA Admin Portal. ." }, "response": [] }, { "name": "Cloud Application Instance Resource Add Cloud Application Instance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplicationInstances", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplicationInstances" ] }, "description": "Add a new cloud application instance. ." }, "response": [] }, { "name": "Cloud Application Instance Resource Get Cloud Application Instance By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplicationInstances/:instanceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplicationInstances", ":instanceId" ], "variable": [ { "key": "instanceId", "value": "", "description": "The cloud application instance ID" } ] }, "description": "Retrieves information about a cloud application instance based on the specified ID" }, "response": [] }, { "name": "Cloud Application Instance Resource Update Cloud Application Instances", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplicationInstances/:instanceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplicationInstances", ":instanceId" ], "variable": [ { "key": "instanceId", "value": "", "description": "The cloud application instance ID" } ] }, "description": "Updates information about a cloud application instance based on the specified ID" }, "response": [] }, { "name": "Cloud Application Instance Resource Delete Cloud Application Instance", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplicationInstances/:instanceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplicationInstances", ":instanceId" ], "variable": [ { "key": "instanceId", "value": "", "description": "The cloud application instance ID" } ] }, "description": "Deletes a cloud application instance based on the specified ID" }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Get Tenancy Restriction Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile" ] }, "description": "Retrieves all the restricted tenant profiles. ." }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Add Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile" ] }, "description": "Creates restricted tenant profiles. ." }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Get App Item Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile/app-item-count/:appType/:itemType", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile", "app-item-count", ":appType", ":itemType" ], "query": [ { "key": "excludeProfile", "value": "", "description": "Specifies the profile ID that is excluded from the item count calculation", "disabled": true } ], "variable": [ { "key": "appType", "value": "", "description": "Application type" }, { "key": "itemType", "value": "", "description": "Item type" } ] }, "description": "Retrieves the item count of the specified item type for a given application, excluding any specified profile" }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Get Tenancy Restriction By Profile ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Profile ID" } ] }, "description": "Retrieves the restricted tenant profile based on the specified ID" }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Profile ID" } ] }, "description": "Updates the restricted tenant profile based on the specified ID" }, "response": [] }, { "name": "Tenancy Restriction Profile Resource Delete Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/tenancyRestrictionProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "tenancyRestrictionProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Profile ID" } ] }, "description": "Deletes the restricted tenant profile based on the specified ID" }, "response": [] }, { "name": "Web Application Rule Resource Get Rule Type Mapping", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/ruleTypeMapping", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", "ruleTypeMapping" ] }, "description": "

    Gets the backend keys that match the application type string.

    " }, "response": [] }, { "name": "Web Application Rule Resource Get Rules By Type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a rule type option.

    ", "disabled": true } ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " } ] }, "description": "

    Gets the list of cloud application rules by the type of rule.

    " }, "response": [] }, { "name": "Web Application Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type" ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " } ] }, "description": "

    Adds a new cloud application rule.

    " }, "response": [] }, { "name": "Web Application Rule Resource Get Available Actions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type/availableActions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type", "availableActions" ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " } ] }, "description": "

    Fetches the granular actions supported for the applications.

    " }, "response": [] }, { "name": "Web Application Rule Resource Duplicate Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type/duplicate/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type", "duplicate", ":ruleId" ], "query": [ { "key": "name", "value": "", "description": "

    The duplicated Cloud App Control policy rule's name.

    ", "disabled": true } ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " }, { "key": "ruleId", "value": "", "description": "

    The ID of the Cloud App Control policy rule.

    " } ] }, "description": "

    Duplicates a Cloud App Control policy rule.

    " }, "response": [] }, { "name": "Web Application Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type", ":ruleId" ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " }, { "key": "ruleId", "value": "", "description": "

    The ID of the Cloud App Control policy rule.

    " } ] }, "description": "

    Gets a Cloud App Control policy rule by the rule type and ID.

    " }, "response": [] }, { "name": "Web Application Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type", ":ruleId" ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " }, { "key": "ruleId", "value": "", "description": "

    The ID of the Cloud App Control policy rule.

    " } ] }, "description": "

    Updates the Cloud App Control policy rule.

    " }, "response": [] }, { "name": "Web Application Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webApplicationRules/:rule_type/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webApplicationRules", ":rule_type", ":ruleId" ], "variable": [ { "key": "rule_type", "value": "", "description": "

    The rule type selected from the available options.

    " }, { "key": "ruleId", "value": "", "description": "

    The ID of the Cloud App Control policy rule.

    " } ] }, "description": "

    Deletes a Cloud App Control policy rule.

    " }, "response": [] } ] }, { "name": "Cloud Nanolog Streaming Service (NSS)", "item": [ { "name": "NSS Collector Resource Get NSS Collectors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssCollectors", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssCollectors" ] }, "description": "Retrieves a list of all configured NSS Collector servers. To learn more, see About NSS Collector Servers." }, "response": [] }, { "name": "NSS Collector Resource Create NSS Collector", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssCollectors", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssCollectors" ] }, "description": "Adds a new NSS Collector server. To learn more, see Adding NSS Collector Servers." }, "response": [] }, { "name": "NSS Collector Resource Update NSS Collector", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssCollectors/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssCollectors", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID for the NSS Collector server" } ] }, "description": "Updates the NSS Collector server based on the specified ID" }, "response": [] }, { "name": "NSS Collector Resource Delete Rules", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssCollectors/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssCollectors", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID for the NSS Collector server" } ] }, "description": "Deletes the NSS Collector server based on the specified ID" }, "response": [] }, { "name": "NSS Download Resource Download NSS Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssDownload/:nssId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssDownload", ":nssId" ], "variable": [ { "key": "nssId", "value": "", "description": "Specifies the NSS server ID" } ] }, "description": "Downloads the NSS server virtual appliance information based on the specified NSS server ID in a .ova format. ." }, "response": [] }, { "name": "NSS Resource Get NSS Servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssServers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssServers" ], "query": [ { "key": "type", "value": "", "description": "The server type", "disabled": true } ] }, "description": "Retrieves a list of registered NSS servers. ." }, "response": [] }, { "name": "NSS Resource Add NSS Server", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssServers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssServers" ] }, "description": "Adds a new NSS server. ." }, "response": [] }, { "name": "NSS Resource Get NSS Server", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssServers/:nssId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssServers", ":nssId" ], "variable": [ { "key": "nssId", "value": "", "description": "Specifies the NSS ID" } ] }, "description": "Retrieves the registered NSS server based on the specified ID" }, "response": [] }, { "name": "NSS Resource Update NSS Server", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssServers/:nssId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssServers", ":nssId" ], "variable": [ { "key": "nssId", "value": "", "description": "Specifies the NSS ID" } ] }, "description": "Updates an NSS server based on the specified ID" }, "response": [] }, { "name": "NSS Resource Delete NSS Server", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssServers/:nssId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssServers", ":nssId" ], "variable": [ { "key": "nssId", "value": "", "description": "Specifies the NSS ID" } ] }, "description": "Deletes an NSS server based on the specified ID" }, "response": [] }, { "name": "NSS Feeds Resource Get All NSS Feeds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds" ], "query": [ { "key": "feedType", "value": "", "description": "The cloud NSS feed type", "disabled": true }, { "key": "onPremNss", "value": "", "description": "A Boolean value indicating whether the feed is an on-premises NSS feed", "disabled": true } ] }, "description": "Retrieves the cloud NSS feeds configured in the ZIA Admin Portal" }, "response": [] }, { "name": "NSS Feeds Resource Create NSS Feed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds" ], "query": [ { "key": "onPremNss", "value": "", "description": "A Boolean value indicating whether the feed is on-premises NSS feed", "disabled": true } ] }, "description": "Adds a new cloud NSS feed. To learn more, see Adding Cloud NSS Feeds." }, "response": [] }, { "name": "NSS Feeds Resource Get NSS Feed Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/:feedId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", ":feedId" ], "query": [ { "key": "onPremNss", "value": "", "description": "A Boolean value indicating whether the feed is on-premises NSS feed", "disabled": true } ], "variable": [ { "key": "feedId", "value": "", "description": "Unique identifier for the cloud NSS feed" } ] }, "description": "Retrieves information about cloud NSS feed based on the specified ID" }, "response": [] }, { "name": "NSS Feeds Resource Update NSS Feed", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/:feedId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", ":feedId" ], "query": [ { "key": "onPremNss", "value": "", "description": "A Boolean value indicating whether the feed is on-premises NSS feed", "disabled": true } ], "variable": [ { "key": "feedId", "value": "", "description": "Unique identifier for the cloud NSS feed" } ] }, "description": "Updates cloud NSS feed configuration based on the specified ID. To learn more, see Adding Cloud NSS Feeds." }, "response": [] }, { "name": "NSS Feeds Resource Delete NSS Feed", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/:feedId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", ":feedId" ], "query": [ { "key": "onPremNss", "value": "", "description": "A Boolean value indicating whether the feed is on-premises NSS feed", "disabled": true }, { "key": "cloudNss", "value": "", "description": "A Boolean value indicating whether the feed is cloud NSS feed", "disabled": true } ], "variable": [ { "key": "feedId", "value": "", "description": "Unique identifier for the cloud NSS feed" } ] }, "description": "Deletes cloud NSS feed configuration based on the specified ID" }, "response": [] }, { "name": "NSS Feeds Resource Get Feed Out Put Formats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/feedOutputDefaults", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", "feedOutputDefaults" ], "query": [ { "key": "type", "value": "", "description": "The type of logs that you are streaming", "disabled": true }, { "key": "multiFeedType", "value": "", "description": "This field is used to set the multi-feed type to Tunnel", "disabled": true }, { "key": "fieldFormat", "value": "", "description": "The feed output type of your SIEM", "disabled": true } ] }, "description": "Retrieves the default cloud NSS feed output format for different log types" }, "response": [] }, { "name": "NSS Feeds Resource Test Cloud NSS Connectivity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/testConnectivity/:feedId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", "testConnectivity", ":feedId" ], "variable": [ { "key": "feedId", "value": "", "description": "Unique identifier for the cloud NSS feed" } ] }, "description": "Tests the connectivity of cloud NSS feed based on the specified ID" }, "response": [] }, { "name": "NSS Feeds Resource Validate Feed Format", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/nssFeeds/validateFeedFormat", "host": [ "{{ZIABaseUrl}}" ], "path": [ "nssFeeds", "validateFeedFormat" ], "query": [ { "key": "type", "value": "", "description": "The cloud NSS log type", "disabled": true } ] }, "description": "Validates the cloud NSS feed format and returns the validation result" }, "response": [] } ] }, { "name": "Data Loss Prevention", "item": [ { "name": "Web DLP Global Options Resource Get Web DLP Global Exception", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpGlobalOptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpGlobalOptions" ] }, "description": "Retrieves the DLP Advanced Settings information" }, "response": [] }, { "name": "Web DLP Global Options Resource Update Web DLP Global Exception", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpGlobalOptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpGlobalOptions" ] }, "description": "Updates the existing DLP Advanced Settings. To learn more, see Configuring DLP Advanced Settings." }, "response": [] }, { "name": "Domain Profile Resource Get Domain Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles" ] }, "description": "Retrieves the list of configured domain profiles" }, "response": [] }, { "name": "Domain Profile Resource Create Domain Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles" ] }, "description": "Adds a new domain profile. To learn more, see Adding Email Profiles" }, "response": [] }, { "name": "Domain Profile Resource Get Domain Profile By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Domain profile ID" } ] }, "description": "Retrieves information about a domain profile based on the specified ID" }, "response": [] }, { "name": "Domain Profile Resource Update Domain Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Domain profile ID" } ] }, "description": "Updates a domain profile based on the specified ID" }, "response": [] }, { "name": "Domain Profile Resource Delete Domain Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Domain profile ID" } ] }, "description": "Deletes a domain profile based on the specified ID" }, "response": [] }, { "name": "C2C Incident Receiver Resource Get C2cir", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudToCloudIR", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudToCloudIR" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the names of Cloud-to-Cloud Incident Forwarding tenants and their configurations", "disabled": true }, { "key": "excludeDisabledC2CForwarding", "value": "", "description": "A Boolean value that you can set to include or exclude Cloud-to-Cloud tenants that are onboarded only with Workflow Automation. When the value is true, the tenants onboarded with Workflow Automation-only are excluded from the GET request.", "disabled": true } ] }, "description": "

    Retrieves the list of DLP Incident Receivers configured for Cloud-to-Cloud Incident Forwarding. Cloud-to-Cloud Incident Forwarding is configured in DLP policies, including Inline Web DLP, Endpoint DLP, Email DLP, and SaaS Security Data at Rest Scanning DLP policy rules. .

    These Incident Receivers can be associated with Inline Web DLP and SaaS Security Data at Rest Scanning DLP rules via API by using the /webDlpRules and /casbDlpRules endpoints respectively.

    " }, "response": [] }, { "name": "C2C Incident Receiver Resource Validate Config Delete", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudToCloudIR/config/:id/validateDelete", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudToCloudIR", "config", ":id", "validateDelete" ], "variable": [ { "key": "id", "value": "", "description": "

    System-generated unique ID of a Cloud-to-Cloud Incident Receiver's storage configuration that must be validated for deletion.

    Note: The configuration ID can be obtained using the GET /cloudToCloudIR request. This value pertains to the cloud storage configuration ID returned within the smirBucketConfig object and not the tenant ID.

    " } ] }, "description": "Validates the specified cloud storage configuration (e.g., Amazon S3 bucket configuration) of a Cloud-to-Cloud DLP Incident Receiver by verifying the configuration's current association status with policy rules. Configurations cannot be deleted while being associated with policy rules." }, "response": [] }, { "name": "C2C Incident Receiver Resource Get C2cir Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudToCloudIR/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudToCloudIR", "count" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against the names of Cloud-to-Cloud Incident Forwarding tenants and their configurations", "disabled": true }, { "key": "excludeDisabledC2CForwarding", "value": "", "description": "A Boolean value that you can set to include or exclude Cloud-to-Cloud tenants that are onboarded only with Workflow Automation. When the value is true, the tenants onboarded with Workflow Automation-only are excluded from the GET request.", "disabled": true } ] }, "description": "Retrieves the number of DLP Incident Receivers configured for Cloud-to-Cloud Incident Forwarding" }, "response": [] }, { "name": "C2C Incident Receiver Resource Get C2cir Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudToCloudIR/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudToCloudIR", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the names of Cloud-to-Cloud Incident Forwarding tenants and their configurations", "disabled": true }, { "key": "excludeDisabledC2CForwarding", "value": "", "description": "A Boolean value that you can set to include or exclude Cloud-to-Cloud tenants that are onboarded only with Workflow Automation. When the value is true, the tenants onboarded with Workflow Automation-only are excluded from the GET request.", "disabled": true } ] }, "description": "Retrieves the list of DLP Incident Receivers configured for Cloud-to-Cloud DLP Incident Forwarding, with a subset of information for each Incident Receiver. For complete details of each Incident Receiver including the configuration information, use the GET /cloudToCloudIR request." }, "response": [] }, { "name": "C2C Incident Receiver Resource Get Receiver By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudToCloudIR/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudToCloudIR", ":id" ], "variable": [ { "key": "id", "value": "", "description": "

    System-generated unique ID of the Cloud-to-Cloud Incident Receiver.

    Note: The Incident Receiver's ID can be obtained using the GET /cloudToCloudIR/lite request. This value pertains to the top-level ID of the Incident Receiver returned in the API response and not the configuration-level ID.

    " } ] }, "description": "Retrieves information about a DLP Incident Receiver configured for Cloud-to-Cloud DLP Incident Forwarding based on the specified ID" }, "response": [] }, { "name": "DLP Dictionary Resource Get DLP Dictionaries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a DLP dictionary's name or description attributes.

    \n", "disabled": true } ] }, "description": "Gets information on all custom and predefined DLP dictionaries." }, "response": [] }, { "name": "DLP Dictionary Resource Add Custom DLP Dictionary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries" ] }, "description": "Adds a new custom DLP dictionary." }, "response": [] }, { "name": "DLP Dictionary Resource Get DLP Dictionary Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", "lite" ] }, "description": "Gets a name and ID dictionary of all custom and predefined DLP dictionaries." }, "response": [] }, { "name": "DLP Dictionary Resource Get DLP Dictionary By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/:dlpDictId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", ":dlpDictId" ], "variable": [ { "key": "dlpDictId", "value": "", "description": "The unique identifier for the DLP dictionary." } ] }, "description": "Gets DLP dictionary information for the specified ID." }, "response": [] }, { "name": "DLP Dictionary Resource Update DLP Dictionary", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/:dlpDictId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", ":dlpDictId" ], "variable": [ { "key": "dlpDictId", "value": "", "description": "The unique identifier for the DLP dictionary." } ] }, "description": "Updates a custom or predefined DLP dictionary." }, "response": [] }, { "name": "DLP Dictionary Resource Delete Custom DLP Dictionary", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/:dlpDictId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", ":dlpDictId" ], "variable": [ { "key": "dlpDictId", "value": "", "description": "The unique identifier for the DLP dictionary." } ] }, "description": "Deletes a custom DLP dictionary. You cannot delete predefined DLP dictionaries." }, "response": [] }, { "name": "DLP Dictionary Resource Get Predefined Hierarchical Identifiers By Dictionary ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/:dictId/predefinedIdentifiers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", ":dictId", "predefinedIdentifiers" ], "variable": [ { "key": "dictId", "value": "", "description": "The ID of the hierarchical DLP dictionary" } ] }, "description": "

    Retrieves the list of identifiers that are available for selection in the specified hierarchical DLP dictionary. This information can be obtained for predefined hierarchical dictionaries such as the Driver’s License (United States), Passport Number (European Union), and Credentials and Secrets dictionaries and their clones.

    Each identifier represents a sub-dictionary that consists of specific patterns. The Driver’s License (United States) dictionary includes one sub-dictionary for each state in the United States and the District of Columbia. For example, the Driver's License (United States) dictionary includes one sub-dictionary for each state in the United States, and you can customize this dictionary to detect the driver's licenses issued by specific states (e.g., California, New York, and Texas) by selecting the respective sub-dictionary identifier.

    To learn more about hierarchical dictionaries, see Understanding Predefined DLP Dictionaries.

    " }, "response": [] }, { "name": "DLP Dictionary Resource Validate DLP Pattern", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpDictionaries/validateDlpPattern", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpDictionaries", "validateDlpPattern" ] }, "description": "

    Validates the pattern used by a Pattern and Phrases DLP dictionary type, and provides error information if the pattern is invalid. To learn more about how to define valid patterns for custom DLP dictionaries, see Defining Patterns for Custom DLP Dictionaries.

    " }, "response": [] }, { "name": "DLP Engine Resource Get DLP Engines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines" ] }, "description": "Get a list of DLP engines." }, "response": [] }, { "name": "DLP Engine Resource Add Custom DLP Engine", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines" ] }, "description": "

    Adds a new custom DLP engine. A DLP engine is a collection of one or more DLP Dictionaries, combined using logical operators. DLP engines can be used in DLP policies to detect specific content in the users' traffic. The Zscaler service provides predefined DLP engines and supports custom DLP engines. To learn more, see About DLP Engines and Understanding DLP Engines.

    Note: To enable /dlpEngines endpoints that use POST, PUT, and DELETE methods for your organization, contact Zscaler Support.

    " }, "response": [] }, { "name": "DLP Engine Resource Get DLP Engines Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines", "lite" ] }, "description": "Gets a name and ID dictionary for all DLP engines." }, "response": [] }, { "name": "DLP Engine Resource Validate DLP Pattern", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines/validateDlpExpr", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines", "validateDlpExpr" ] }, "description": "

    Validates the logical expression within a DLP engine that is formed by combining DLP dictionaries and provides error information if the expression is invalid. To learn more about DLP engine expressions, see Understanding DLP Engines.

    Note: To enable /dlpEngines endpoints that use POST, PUT, and DELETE methods for your organization, contact Zscaler Support.

    " }, "response": [] }, { "name": "DLP Engine Resource Get DLP Engine By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines/:dlpEngineId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines", ":dlpEngineId" ], "variable": [ { "key": "dlpEngineId", "value": "", "description": "The unique identifier for the DLP engine." } ] }, "description": "Gets DLP engine information for the specified ID." }, "response": [] }, { "name": "DLP Engine Resource Update DLP Engine", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines/:dlpEngineId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines", ":dlpEngineId" ], "variable": [ { "key": "dlpEngineId", "value": "", "description": "The unique identifier for the DLP engine." } ] }, "description": "

    Updates DLP engine information for the specified ID. To learn more, see About DLP Engines and Editing Predefined DLP Engines.

    Note: To enable /dlpEngines endpoints that use POST, PUT, and DELETE methods for your organization, contact Zscaler Support.

    " }, "response": [] }, { "name": "DLP Engine Resource Delete Custom DLP Engine", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEngines/:dlpEngineId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEngines", ":dlpEngineId" ], "variable": [ { "key": "dlpEngineId", "value": "", "description": "The unique identifier for the DLP engine." } ] }, "description": "

    Deletes the custom DLP engine with the specified ID.

    Note: To enable /dlpEngines endpoints that use POST, PUT, and DELETE methods for your organization, contact Zscaler Support.

    " }, "response": [] }, { "name": "Advanced Data Protection Schema Resource Get Schemas", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpExactDataMatchSchemas", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpExactDataMatchSchemas" ] }, "description": "Exact Data Match (EDM) templates (or EDM schemas) allow the Zscaler service to identify a record from a structured data source that matches predefined criteria. Using the Index Tool, you can create an EDM template that allows you to define this criteria (i.e., define the tokens) for your data records by importing a CSV file. After the data is defined and submitted within the tool, you can then apply the EDM template to a custom DLP dictionary or engine. This endpoint gets the EDM templates for all Index Tools used by the organization. To learn more, see About Exact Data Match and About the Index Tool." }, "response": [] }, { "name": "Advanced Data Protection Schema Resource Get Schema Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpExactDataMatchSchemas/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpExactDataMatchSchemas", "lite" ], "query": [ { "key": "schemaName", "value": "", "description": "The EDM schema name.", "disabled": true }, { "key": "activeOnly", "value": "", "description": "If set to true, only active EDM templates (or schemas) are returned in the response.", "disabled": true }, { "key": "fetchTokens", "value": "", "description": "If set to true, the criteria (i.e., token details) for the active templates are returned in the response.", "disabled": true } ] }, "description": "Gets a list of active EDM templates (or EDM schemas) and their criteria (or token details), only." }, "response": [] }, { "name": "DLP Notification Template Resource Gettemplates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpNotificationTemplates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpNotificationTemplates" ] }, "description": "Gets a list of DLP notification templates. To learn more, see About DLP Notification Templates." }, "response": [] }, { "name": "DLP Notification Template Resource Addtemplate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpNotificationTemplates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpNotificationTemplates" ] }, "description": "Adds a new DLP notification template. To learn more, see Configuring DLP Notification Templates." }, "response": [] }, { "name": "DLP Notification Template Resource Get Template By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpNotificationTemplates/:templateId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpNotificationTemplates", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "The unique identifer for the DLP notification template." } ] }, "description": "Gets DLP notification template information for the specified ID." }, "response": [] }, { "name": "DLP Notification Template Resource Updatetemplate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpNotificationTemplates/:templateId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpNotificationTemplates", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "The unique identifer for the DLP notification template." } ] }, "description": "Updates a DLP notification template." }, "response": [] }, { "name": "DLP Notification Template Resource Deletetemplate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpNotificationTemplates/:templateId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpNotificationTemplates", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "The unique identifer for the DLP notification template." } ] }, "description": "Deletes a DLP notification template." }, "response": [] }, { "name": "ICAP Server Resource Get ICAP Servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/icapServers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "icapServers" ] }, "description": "Gets a the list of DLP servers using ICAP. To learn more, see About ICAP Communication Between Zscaler and DLP Servers, Enabling Secure ICAP, and Enabling Unencrypted ICAP." }, "response": [] }, { "name": "ICAP Server Resource Get ICAP Server Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/icapServers/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "icapServers", "lite" ] }, "description": "Gets a name and ID dictionary for all DLP servers using ICAP." }, "response": [] }, { "name": "ICAP Server Resource Get ICAP Server", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/icapServers/:icapServerId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "icapServers", ":icapServerId" ], "variable": [ { "key": "icapServerId", "value": "", "description": "The unique identifier for the DLP server using ICAP." } ] }, "description": "Get DLP server (i.e., for servers using ICAP) information for the specified ID." }, "response": [] }, { "name": "Idm Profile Resource Get Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/idmprofile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "idmprofile" ] }, "description": "Indexed Document Match (IDM) templates (or IDM profiles) allow you to fingerprint your organization’s critical documents that contain sensitive data. By fingerprinting and indexing your documents, you can create a document repository that the Zscaler service can use to identify completely or partially matching documents when evaluating outbound traffic against a DLP policy. Using the Index Tool, you can create an IDM template that allows you to upload and fingerprint your documents. After you create an IDM template, you can then apply it to a custom DLP dictionary. This endpoint gets all of the IDM templates for all Index Tools used by the organization. To learn more, see About Indexed Document Match and About the Index Tool." }, "response": [] }, { "name": "Idm Profile Resource Get Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/idmprofile/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "idmprofile", "lite" ], "query": [ { "key": "activeOnly", "value": "", "description": "If set to true, only active IDM templates (or profiles) are returned in the response.", "disabled": true } ] }, "description": "-> Gets a list of active IDM templates (or IDM profiles) and their criteria, only." }, "response": [] }, { "name": "Idm Profile Resource Get Profile By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/idmprofile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "idmprofile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "The unique identifier for the IDM template (or profile)." } ] }, "description": "Get IDM template information for the specified ID." }, "response": [] }, { "name": "Incident Receiver Resource Get Incident Receiver Servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/incidentReceiverServers", "host": [ "{{ZIABaseUrl}}" ], "path": [ "incidentReceiverServers" ] }, "description": "Gets a list of DLP Incident Receivers. To learn more, see About Zscaler Incident Receiver." }, "response": [] }, { "name": "Incident Receiver Resource Get Incident Receiver Server Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/incidentReceiverServers/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "incidentReceiverServers", "lite" ] }, "description": "Gets a name and ID dictionary for all DLP Incident Receivers." }, "response": [] }, { "name": "Incident Receiver Resource Get Incident Receiver Server", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/incidentReceiverServers/:incidentReceiverServerId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "incidentReceiverServers", ":incidentReceiverServerId" ], "variable": [ { "key": "incidentReceiverServerId", "value": "", "description": "The unique identifier for the Incident Receiver." } ] }, "description": "Gets DLP Incident Receiver information for the specified ID." }, "response": [] }, { "name": "Web DLP Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules" ] }, "description": "Gets a list of DLP policy rules, excluding SaaS Security API DLP policy rules. To learn more, see Configuring DLP Policy Rules with Content Inspection and Configuring DLP Policy Rules without Content Inspection." }, "response": [] }, { "name": "Web DLP Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules" ] }, "description": "Adds a new DLP policy rule. To learn more, see Configuring DLP Policy Rules with Content Inspection and Configuring DLP Policy Rules without Content Inspection." }, "response": [] }, { "name": "Web DLP Rule Resource Get Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules", "lite" ] }, "description": "Gets name and ID dictionary for all DLP policy rules, excluding SaaS Security API DLP policy rules." }, "response": [] }, { "name": "Web DLP Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the DLP policy rule." } ] }, "description": "Gets DLP policy rule information for the specified ID." }, "response": [] }, { "name": "Web DLP Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the DLP policy rule." } ] }, "description": "Updates a DLP policy rule. This endpoint is not applicable to SaaS Security API DLP policy rules." }, "response": [] }, { "name": "Web DLP Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/webDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "webDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the DLP policy rule." } ] }, "description": "Deletes a DLP policy rule. This endpoint is not applicable to SaaS Security API DLP policy rules." }, "response": [] } ] }, { "name": "Devices", "item": [ { "name": "User Devices Resource Get User Devices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/devices", "host": [ "{{ZIABaseUrl}}" ], "path": [ "devices" ], "query": [ { "key": "id", "value": "", "description": "Filters the list based on the device IDs", "disabled": true }, { "key": "search", "value": "", "description": "Search string to filter devices", "disabled": true }, { "key": "valid", "value": "", "description": "Filter the list for valid devices", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "includeCbiDevices", "value": "", "description": "Filter to include CBI devices in the search result", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves a list of all the devices registered with Zscaler. To learn more, see About Devices." }, "response": [] }, { "name": "User Devices Resource Get User Device", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/devices/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "devices", ":id" ], "query": [ { "key": "valid", "value": "", "description": "Filters for a valid device", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "System-generated device ID" } ] }, "description": "Retrieves information about the registered device based on the device ID" }, "response": [] } ] }, { "name": "Device Groups", "item": [ { "name": "Device Group Resource Get Device Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/deviceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "deviceGroups" ], "query": [ { "key": "includeDeviceInfo", "value": "", "description": "Include or exclude device information.", "disabled": true }, { "key": "includePseudoGroups", "value": "", "description": "Include or exclude Zscaler Client Connector and Cloud Browser Isolation-related device groups.", "disabled": true }, { "key": "includeIOTGroups", "value": "", "description": "Include or exclude IoT device groups.", "disabled": true } ] }, "description": "Gets a list of device groups." }, "response": [] }, { "name": "Device Group Resource Get Devices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/deviceGroups/devices", "host": [ "{{ZIABaseUrl}}" ], "path": [ "deviceGroups", "devices" ], "query": [ { "key": "name", "value": "", "description": "The device group name.", "disabled": true }, { "key": "model", "value": "", "description": "The device models.", "disabled": true }, { "key": "owner", "value": "", "description": "The device owners.", "disabled": true }, { "key": "osType", "value": "", "description": "The device's operating system.", "disabled": true }, { "key": "osVersion", "value": "", "description": "The device's operating system version.", "disabled": true }, { "key": "deviceGroupId", "value": "", "description": "The unique identifier for the device group.", "disabled": true }, { "key": "userIds", "value": "", "description": "Used to list devices for specific users.", "disabled": true }, { "key": "search_all", "value": "", "description": "Used to match against all device attribute information.", "disabled": true }, { "key": "includeAll", "value": "", "description": "Used to include or exclude Cloud Browser Isolation devices.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets a list of devices. Any given search parameters are applied during device search. Search parameters are based on device name, model, owner, OS type, and OS version. The devices listed can also be restricted to return information only for ones belonging to specific users." }, "response": [] }, { "name": "Device Group Resource Get Devices Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/deviceGroups/devices/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "deviceGroups", "devices", "lite" ], "query": [ { "key": "name", "value": "", "description": "The device group name.", "disabled": true }, { "key": "userIds", "value": "", "description": "Used to list devices for specific users.", "disabled": true }, { "key": "includeAll", "value": "", "description": "Used to include or exclude Cloud Browser Isolation devices.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets a list of devices that includes device ID, name, and owner name. Any given search parameters are applied during device search. Search parameters are based on device or user name and owner. The devices listed can also be restricted to return information only for ones belonging to specific users." }, "response": [] } ] }, { "name": "DNS Control Policy", "item": [ { "name": "Firewall DNS Rules Resource Get Firewall DNS Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallDnsRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallDnsRules" ] }, "description": "Retrieves the list of DNS Control policy rules configured in the ZIA Admin Portal" }, "response": [] }, { "name": "Firewall DNS Rules Resource Create Firewall DNS Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallDnsRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallDnsRules" ] }, "description": "Adds a new DNS Control policy rule. To learn more, see Configuring the DNS Control Policy." }, "response": [] }, { "name": "Firewall DNS Rules Resource Get Firewall DNS Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallDnsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallDnsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Retrieves the DNS Control policy rule information based on the specified ID" }, "response": [] }, { "name": "Firewall DNS Rules Resource Update Firewall DNS Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallDnsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallDnsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Updates the DNS Control policy rule information based on the specified ID. To learn more about the rule configuration, see Configuring the DNS Control Policy." }, "response": [] }, { "name": "Firewall DNS Rules Resource Delete Firewall DNS Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallDnsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallDnsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Deletes the DNS Control policy rule information based on the specified ID" }, "response": [] } ] }, { "name": "Email Profiles", "item": [ { "name": "Email Recipient Profile Resource Get Email Recipient Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile" ], "query": [ { "key": "name", "value": "", "description": "Filters the profiles based on the recipient profile name", "disabled": true }, { "key": "emailRecipient", "value": "", "description": "Filters based on the recipient email included in each profile", "disabled": true }, { "key": "description", "value": "", "description": "Filters the profiles based on the description field", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves a list of all recipient email profiles in an organization. To learn more, see About Email Profiles." }, "response": [] }, { "name": "Email Recipient Profile Resource Create Email Recipient Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile" ] }, "description": "Adds a new recipient profile. To learn more, see Adding Email Profiles." }, "response": [] }, { "name": "Email Recipient Profile Resource Get Email Recipient Profile By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Specifies the recipient profile ID" } ] }, "description": "Retrieves the recipient email profile based on the specified ID" }, "response": [] }, { "name": "Email Recipient Profile Resource Update Email Recipient Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Specifies the recipient profile ID" } ] }, "description": "Updates the recipient email profile based on the specified ID" }, "response": [] }, { "name": "Email Recipient Profile Resource Delete Email Recipient Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile/:profileId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile", ":profileId" ], "variable": [ { "key": "profileId", "value": "", "description": "Specifies the recipient profile ID" } ] }, "description": "Deletes the recipient email profile based on the specified ID" }, "response": [] }, { "name": "Email Recipient Profile Resource Get Email Recipient Profiles Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile", "lite" ], "query": [ { "key": "name", "value": "", "description": "Filters the profiles based on the recipient profile name", "disabled": true }, { "key": "description", "value": "", "description": "Filters the profiles based on the description field", "disabled": true }, { "key": "consumer", "value": "", "description": "Filters the profiles based on the type of consumer", "disabled": true }, { "key": "tenantIds", "value": "", "description": "Filters the profiles based on the tenant ID", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves a list of all recipient email profiles in an organization" }, "response": [] }, { "name": "Email Recipient Profile Resource Get Email Recipient Profiles Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailRecipientProfile/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailRecipientProfile", "count" ], "query": [ { "key": "name", "value": "", "description": "Specifies the recipient profile name", "disabled": true }, { "key": "emailRecipient", "value": "", "description": "Specifies the recipient email included in each profile", "disabled": true }, { "key": "description", "value": "", "description": "Additional information about the recipient profile", "disabled": true } ] }, "description": "Retrieves the count of recipient email profiles" }, "response": [] } ] }, { "name": "End User Notifications", "item": [ { "name": "End User Notification Resource Get Eun Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eun", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eun" ] }, "description": "Retrieves browser-based end user notification (EUN) configuration details. To learn more, see Understanding Browser-Based End User Notifications." }, "response": [] }, { "name": "End User Notification Resource Update Eun Details", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eun", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eun" ] }, "description": "Updates browser-based end user notification (EUN) configuration details. To learn more, see Understanding Browser-Based End User Notifications." }, "response": [] }, { "name": "Eun Template Resource Get Eun Templates By Product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eunTemplate/:templateType/product/:product", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eunTemplate", ":templateType", "product", ":product" ], "variable": [ { "key": "templateType", "value": "", "description": "Specifies the type of notification template as Zscaler Client Connector-based or browser-based notification" }, { "key": "product", "value": "", "description": "The policy type associated with the notification template" } ] }, "description": "Retrieves the list of notification templates for browser-based and Zscaler Client Connector-based notifications by policy type. To learn more, see About Browser EUN Template and About Zscaler Client Connector-Based End User Notifications." }, "response": [] }, { "name": "Eun Template Resource Get Feature Enablement Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eunTemplate/:templateType/featureEnablementStatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eunTemplate", ":templateType", "featureEnablementStatus" ], "query": [ { "key": "productType", "value": "", "description": "The policy type associated with the notification template", "disabled": true } ], "variable": [ { "key": "templateType", "value": "", "description": "Specifies the type of notification template as Zscaler Client Connector-based or browser-based notification" } ] }, "description": "Retrieves the EUN enablement status for the specified notification type" }, "response": [] }, { "name": "User Confirmation Resource Get User Confirmation By Product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/userConfirmation/product/:product", "host": [ "{{ZIABaseUrl}}" ], "path": [ "userConfirmation", "product", ":product" ], "variable": [ { "key": "product", "value": "", "description": "The policy type associated with the notification template. User confirmation notifications are supported for Inline Web DLP and Endpoint DLP policies, so only these policy types are valid selections for this field." } ] }, "description": "Retrieves the list of user confirmation notification templates by policy type. To learn more, see About User Confirmation Notification Templates." }, "response": [] }, { "name": "User Confirmation Resource Get Global Default Templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/userConfirmation/globalDefaultTemplates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "userConfirmation", "globalDefaultTemplates" ] }, "description": "Retrieves the global default user confirmation templates for all policy types and policy channels where applicable (e.g., Printing and Network Share channels for Endpoint DLP policy)" }, "response": [] }, { "name": "User Confirmation Resource Get Feature Enablement Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/userConfirmation/:templateType/featureEnablementStatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "userConfirmation", ":templateType", "featureEnablementStatus" ], "query": [ { "key": "productType", "value": "", "description": "The policy type associated with the notification template. User confirmation notifications are supported for Inline Web DLP and Endpoint DLP policies, so only these policy types are valid selections for this field.", "disabled": true } ], "variable": [ { "key": "templateType", "value": "", "description": "Specifies the type of notification template. User confirmation notifications are supported using Zscaler Client Connector only, so the type is always Zscaler Client Connector for this request." } ] }, "description": "Retrieves the notification enablement status for user confirmation notification" }, "response": [] } ] }, { "name": "Endpoint Data Loss Prevention", "item": [ { "name": "Endpoint DLP Rules Resource Get Endpoint DLP Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules" ] }, "description": "Retrieves the list of all Endpoint Data Loss Prevention (DLP) policy rules and any exception rules added to the parent rules" }, "response": [] }, { "name": "Endpoint DLP Rules Resource Add Endpoint DLP Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules" ] }, "description": "Creates a new Endpoint DLP policy rule. To learn more, see Configuring Endpoint DLP Policy Rules." }, "response": [] }, { "name": "Endpoint DLP Rules Resource Fetch File Type Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/fileTypeCategories", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", "fileTypeCategories" ], "query": [ { "key": "external", "value": "", "description": "The file types available to select in an Endpoint DLP policy rule vary depending on whether Content Matching is enabled and DLP engines are used. Setting true for this field retrieves the list of file types available when DLP engines are used with Content Matching enabled. Setting false retrieves a different set of file types available when DLP engines are not used.", "disabled": true } ] }, "description": "Retrieves the list of file types that are available in the Endpoint DLP policy rule criteria. You can create Endpoint DLP rules that apply only to content being sent via specific file types." }, "response": [] }, { "name": "Endpoint DLP Rules Resource Fetch File Types For Endpoint DLP", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/fileTypes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", "fileTypes" ], "query": [ { "key": "external", "value": "", "description": "", "disabled": true } ] }, "description": "This endpoint is deprecated and is no longer supported for usage. It is replaced by the GET /endPointDlpRules/fileTypeCategories endpoint that retrieves the list of file types available in Endpoint DLP policy rule criteria." }, "response": [] }, { "name": "Endpoint DLP Rules Resource Get Endpoint DLP Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Endpoint DLP policy rule ID" } ] }, "description": "Retrieves information about the Endpoint DLP policy rule with the specified ID and any exception rule added to the parent rule" }, "response": [] }, { "name": "Endpoint DLP Rules Resource Modify Endpoint DLP Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID of the policy rule" } ] }, "description": "Updates information for the Endpoint DLP policy rule with the specified ID" }, "response": [] }, { "name": "Endpoint DLP Rules Resource Delete Endpoint DLP Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID of the policy rule" } ] }, "description": "Deletes the Endpoint DLP policy rule with the specified ID" }, "response": [] }, { "name": "Endpoint DLP Rules Resource Add Sub Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id/subRule", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id", "subRule" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID of the policy rule" } ] }, "description": "Adds an exception rule to an existing Endpoint DLP rule. Exception rules allow you to exclude specific users or groups in your organization that need to perform tasks as part of a necessary workflow that might otherwise violate Endpoint rules. To learn more, Configuring Endpoint DLP Policy Rules." }, "response": [] }, { "name": "Endpoint DLP Rules Resource Modify Sub Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id/subRule/:subRuleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id", "subRule", ":subRuleId" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID of the parent Endpoint DLP rule" }, { "key": "subRuleId", "value": "", "description": "System-generated ID of the exception rule that's being modified" } ] }, "description": "Updates information for an exception rule with the specified ID. You must include both the exception rule ID and its parent rule ID in this request." }, "response": [] }, { "name": "Endpoint DLP Rules Resource Delete Sub Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpRules/:id/subRule/:subRuleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpRules", ":id", "subRule", ":subRuleId" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID of the parent Endpoint DLP rule" }, { "key": "subRuleId", "value": "", "description": "System-generated ID of the exception rule that's being deleted" } ] }, "description": "Deletes an exception rule with the specified ID. You must include both the exception rule ID and its parent rule ID in this request." }, "response": [] }, { "name": "Endpoint Resource Get DLP Endpoint Resources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource/:channel", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource", ":channel" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Specifies the sorting order for the list by ascending or descending order of the DLP resource names", "disabled": true }, { "key": "name", "value": "", "description": "The search string used to filter the list by DLP resource name and other fields", "disabled": true } ], "variable": [ { "key": "channel", "value": "", "description": "The channel for which DLP resources must be retrieved" } ] }, "description": "

    Retrieves the list of DLP resources configured for the specified channel.

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint Resource Get Endpoint By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource/:channel/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource", ":channel", ":id" ], "variable": [ { "key": "channel", "value": "", "description": "The channel to which the DLP resource belongs" }, { "key": "id", "value": "", "description": "System-generated ID for the DLP resource" } ] }, "description": "

    Retrieves information about the DLP resource with the specified ID

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint Resource Get Group Ids By Resource", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource/:id/groups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource", ":id", "groups" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "

    Retrieves the list of tags in name-ID pairs to which the specified DLP resource is associated. Tags are channel-specific. To learn more, see Adding Resource Tags.

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint Resource Add DLP Endpoint Resource", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource" ] }, "description": "

    Adds a new DLP resource for one of the supported channels. To learn more, see Adding DLP and Endpoint Resources.

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint Resource Update DLP Endpoint Resource", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "

    Updates the DLP resource with the specified ID for supported channels. To learn more, see Adding DLP and Endpoint Resources.

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint Resource Delete DLP Endpoint Resource", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dlpEndpointResource/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dlpEndpointResource", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "

    Deletes an Endpoint DLP resource by ID

    Note: The /dlpEndpointResource endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplications endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Get Resource Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups/:channel", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups", ":channel" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "name", "value": "", "description": "The search string used to filter the list by DLP resource name or other fields", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Specifies the sorting order for the list by ascending or descending order of the DLP resource tag names", "disabled": true }, { "key": "searchResources", "value": "", "description": "A true value must be set for this field to include search strings via the name parameter", "disabled": true } ], "variable": [ { "key": "channel", "value": "", "description": "Specifies the channel for which the configured DLP resource tags must be retrieved" } ] }, "description": "

    Retrieves the list of DLP resource tags added for the specified channel

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Create Resource Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups" ] }, "description": "

    Adds a new DLP resource tag. To learn more, see Adding Resource Tags.

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Modify Resource Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated ID for the DLP resource tag" } ] }, "description": "

    Updates information about the DLP resource tag with the specified ID. However, DLP resources association with the tag cannot be modified with this request. To modify DLP resource association, use PUT /endPointDlpResourceGroups/{groupId}/resources.

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Delete Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated ID for the DLP resource tag" } ] }, "description": "

    Deletes the DLP resource tag with the specified ID

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Get Resources In Group Public", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups/:groupId/resources", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups", ":groupId", "resources" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true } ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated ID for the DLP resource tag" } ] }, "description": "

    Retrieves the list of DLP resources linked to the specified tag (by ID)

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "Endpoint DLP Resource Groups Resource Modify Group Resource Association Public", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointDlpResourceGroups/:groupId/resources", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointDlpResourceGroups", ":groupId", "resources" ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated ID for the DLP resource tag" } ] }, "description": "

    Updates DLP resources association for the tag group with the specified ID

    Note: The /endPointDlpResourceGroups endpoints support API operations related to Printing, Removable Storage, Network Share, and Personal Cloud Storage channels. For operations related to Application File Access and Clipboard, use the /endPointApplicationGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Custom Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApps", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApps" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the list of custom applications. You can use the applications in Endpoint DLP and other policies (e.g., SSL/TLS Inspection, Firewall Filtering, and DNS Control). To learn more, see Adding DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Applications Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "count" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "applicationType", "value": "", "description": "Filters the results by application type (e.g., Custom, Discovered, and Well-Known)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the count of all endpoint applications

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Cloud Applications Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/cloudApps/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "cloudApps", "count" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names.", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "applicationType", "value": "", "description": "Filters the results by application type (e.g., Discovered and Well-Known)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the count of well-known and discovered endpoint applications as determined by the Zscaler service.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Policies Associated With Apps", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/policies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "policies" ], "query": [ { "key": "resourceId", "value": "", "description": "Resource identifier for the endpoint application. This value corresponds to the resourceId field returned by GET /endPointApplications.", "disabled": true } ] }, "description": "

    Retrieves the list of policy rules currently associated with the endpoint application with the specified ID. To learn more, see About DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Custom Applications By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApps/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApps", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique identifier of the custom endpoint application" } ] }, "description": "

    Retrieves information about the custom endpoint application with the specified ID

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Custom Applications Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApps/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApps", "lite" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against custom application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "page", "value": "", "description": "Page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Page size. Default is 100 if not specified.", "disabled": true } ] }, "description": "

    Retrieves name-ID pairs of custom endpoint applications. To learn more, see Adding DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Categories With Non Empty Apps", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/getCategoriesWithNonEmptyApps", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "getCategoriesWithNonEmptyApps" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "Retrieves the categories that currently have endpoint applications grouped within them" }, "response": [] }, { "name": "End Point Application Resource Get Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against endpoint application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "applicationType", "value": "", "description": "Filters the results by application type (e.g., Custom, Discovered, and Well-Known)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the list of endpoint applications. You can use the endpoint applications in Endpoint DLP and other policies (e.g., SSL/TLS Inspection, Firewall Filtering, and DNS Control). To learn more, see About DLP & Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Applications Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "lite" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "applicationType", "value": "", "description": "Filters the results by application type (e.g., Custom, Discovered, and Well-Known)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves name-ID pairs of endpoint applications. You can use the endpoint applications in Endpoint DLP and other policies (e.g., SSL/TLS Inspection, Firewall Filtering, and DNS Control). To learn more, see About DLP & Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Update Application", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The application's unique identifier" } ] }, "description": "

    Updates information for the endpoint application with the specified ID. To learn more, see Editing DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Get Zdp Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/cloudApps", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "cloudApps" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against application names.", "disabled": true }, { "key": "osType", "value": "", "description": "Filters the results by operating system (e.g., Windows OS and Mac OS)", "disabled": true }, { "key": "applicationType", "value": "", "description": "Filters the results by application type (e.g., Discovered and Well-Known)", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 100 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the list of well-known and discovered endpoint applications. Well-known is a dynamic classification of applications that are frequently seen within the Zero Trust Exchange (ZTE) security cloud. Applications that are discovered on endpoints by the Zscaler service are classified as discovered applications. To learn more, see About DLP and Endpoint Resources and About Endpoint Context.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Add DLP Endpoint Resource", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApp", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApp" ] }, "description": "

    Adds a new custom endpoint application. To learn more, see Adding DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Update DLP Endpoint Resource", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApp/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique identifier of the custom application resource." } ] }, "description": "

    Update information for the custom endpoint application with the specified ID. To learn more, see Editing DLP and Endpoint Resources.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Resource Delete DLP Endpoint Resource", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplications/customApp/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplications", "customApp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique resource identifier of the custom application resource." } ] }, "description": "

    Deletes a custom endpoint application. Applications identified as discovered or well-known by the Zscaler service cannot be deleted.

    Note: The /endPointApplications endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /dlpEndpointResource endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Get Policies Associated With Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups/policies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups", "policies" ], "query": [ { "key": "resourceId", "value": "", "description": "Identifier for the endpoint application group. This value corresponds to the groupId field returned by GET /endPointApplicationGroups", "disabled": true } ] }, "description": "

    Retrieves the policy rules currently associated with the specified application tag group. To learn more, see Adding Resource Tags.

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Get Endpoint Application Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. A default size of 5,000 applies if value is not specified.", "disabled": true } ] }, "description": "

    Retrieves the list of application tag groups. To learn more, see Adding Resource Tags.

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Create Resource Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups" ] }, "description": "

    Adds a new endpoint application tag group. To learn more, see Adding Resource Tags.

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Delete DLP Endpoint Resource", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated ID for the endpoint application tag" } ] }, "description": "

    Deletes the endpoint application tag with the specified ID

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Modify Resource Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated identifier of the endpoint application tag" } ] }, "description": "

    Updates information for the endpoint application tag with the specified ID. However, endpoint applications associated with the tag cannot be modified with this request. To modify application association, use PUT /endPointApplicationGroups/resources/{groupId}.

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] }, { "name": "End Point Application Group Resource Modify Group Association", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/endPointApplicationGroups/resources/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "endPointApplicationGroups", "resources", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "System-generated identifier of the endpoint application tag" } ] }, "description": "

    Updates endpoint applications association for the specified tag group.

    Note: The /endPointApplicationGroups endpoints are exclusive to API operations related to Application File Access and Clipboard channels. For operations related to other channels, use the /endPointDlpResourceGroups endpoints with appropriate resources.

    " }, "response": [] } ] }, { "name": "Event Logs", "item": [ { "name": "Event Log Entry Report Resource Get Event Report Entry CSV Export Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eventlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eventlogEntryReport" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /eventlogEntryReport request.", "disabled": false } ] }, "description": "

    Gets the status of the request to generate an event log report. Following a request to generate a report via the POST /eventlogEntryReport endpoint, you can call GET /eventlogEntryReport to check the current status of report generation. If the status is COMPLETE, you can send a GET request to /eventlogEntryReport/download to download the report as a CSV file.

    " }, "response": [] }, { "name": "Event Log Entry Report Resource Start Event Report Entry CSV Export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eventlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eventlogEntryReport" ] }, "description": "

    Creates an event log report for the specified time period and saves it as a CSV file. The report includes event log information for every call made to the ZIA API during the specified time period. Creating a new event log report overwrites the previously-generated report.

    " }, "response": [] }, { "name": "Event Log Entry Report Resource Cancel Event Report Entry CSV Export", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eventlogEntryReport", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eventlogEntryReport" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /eventlogEntryReport request.", "disabled": false } ] }, "description": "

    Cancels the request to generate an event log report.

    " }, "response": [] }, { "name": "Event Log Entry Report Resource Get Event Report Entry CSV Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/eventlogEntryReport/download", "host": [ "{{ZIABaseUrl}}" ], "path": [ "eventlogEntryReport", "download" ], "query": [ { "key": "statusId", "value": "", "description": "The unique identifier for the report generation task, returned in the response of the POST /eventlogEntryReport request.", "disabled": false } ] }, "description": "

    Downloads the most recently generated event log report. Calling this endpoint downloads the file only if the report generation status is COMPLETE. Use the GET /eventlogEntryReport endpoint to verify the status before calling this endpoint for downloading the file.

    " }, "response": [] } ] }, { "name": "File Type Control Policy", "item": [ { "name": "File Type Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules" ] }, "description": "

    Retrieves all the rules in the File Type Control policy

    " }, "response": [] }, { "name": "File Type Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules" ] }, "description": "

    Adds a new File Type Control policy rule

    " }, "response": [] }, { "name": "File Type Rule Resource Get Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules", "lite" ] }, "description": "

    Retrieves all the rules in the File Type Control policy

    " }, "response": [] }, { "name": "File Type Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "

    Retrieves the File Type Control policy rule information for the specified ID

    " }, "response": [] }, { "name": "File Type Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "

    Updates the File Type Control policy rule information for the specified ID

    " }, "response": [] }, { "name": "File Type Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "

    Deletes a File Type Control policy rule information for the specified ID

    " }, "response": [] }, { "name": "File Type Category Resource Get File Type Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/fileTypeCategories", "host": [ "{{ZIABaseUrl}}" ], "path": [ "fileTypeCategories" ], "query": [ { "key": "enums", "value": "", "description": "

    Specifies the file type category for specific policies to retrieve the corresponding list of predefined file types supported for the policy category. The following values are supported:

    • ZSCALERDLP: DLP rules with content inspection
    • EXTERNALDLP: DLP rules without content inspection
    • FILETYPECATEGORYFORFILETYPECONTROL: File Type Control policy
    ", "disabled": true }, { "key": "excludeCustomFileTypes", "value": "", "description": "A Boolean value specifying whether custom file types must be excluded from the list or not", "disabled": true } ] }, "description": "

    Retrieves the list of all file types, including predefined and custom file types, available for configuring rule conditions in different ZIA policies. You can retrieve predefined file types for specific file categories of policies by using the enum request parameter and by specifying one of the following values:

    • ZSCALERDLP: Web DLP rules with content inspection
    • EXTERNALDLP: Web DLP rules without content inspection
    • FILETYPECATEGORYFORFILETYPECONTROL: File Type Control policy
    " }, "response": [] }, { "name": "Custom File Type Resource Get All Custom File Types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves the list of . Custom file types can be configured as rule conditions in different ZIA policies." }, "response": [] }, { "name": "Custom File Type Resource Create Custom File Type", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes" ] }, "description": "Adds a new custom file type. ." }, "response": [] }, { "name": "Custom File Type Resource Update Custom File Type", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes" ] }, "description": "Updates information for a custom file type based on the specified ID" }, "response": [] }, { "name": "Custom File Type Resource Get Custom File Type Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes", "count" ] }, "description": "Retrieves the count of custom file types available" }, "response": [] }, { "name": "Custom File Type Resource Get Custom File Type By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Custom file type ID" } ] }, "description": "Retrieves information about a custom file type based on the specified ID" }, "response": [] }, { "name": "Custom File Type Resource Delete Custom File Type", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customFileTypes/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customFileTypes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Custom file type ID" } ] }, "description": "Deletes a custom file type based on the specified ID" }, "response": [] } ] }, { "name": "Firewall Policies", "item": [ { "name": "Firewall Filtering Rules Resource Get Firewall Filtering Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules" ], "query": [ { "key": "ruleName", "value": "", "description": "Filters rules based on rule names using the specified keywords", "disabled": true }, { "key": "ruleLabel", "value": "", "description": "Filters rules based on rule labels using the specified keywords", "disabled": true }, { "key": "ruleLabelId", "value": "", "description": "Filters rules based on rule label IDs using specified keywords", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "Filters rules based on rule order using the specified keywords", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "Filters rules based on rule description using the specified keywords", "disabled": true }, { "key": "ruleAction", "value": "", "description": "Filters rules based on rule actions using the specified keywords", "disabled": true }, { "key": "location", "value": "", "description": "Filters rules based on locations using the specified keywords", "disabled": true }, { "key": "department", "value": "", "description": "Filters rules based on user departments using the specified keywords", "disabled": true }, { "key": "group", "value": "", "description": "Filters rules based on user groups using the specified keywords", "disabled": true }, { "key": "user", "value": "", "description": "Filters rules based on users using the specified keywords", "disabled": true }, { "key": "device", "value": "", "description": "Filters rules based on devices using the specified keywords", "disabled": true }, { "key": "deviceGroup", "value": "", "description": "Filters rules based on device groups using the specified keywords", "disabled": true }, { "key": "deviceTrustLevel", "value": "", "description": "Filters rules based on device trust levels using the specified keywords", "disabled": true }, { "key": "srcIps", "value": "", "description": "Filters rules based on source IP addresses using the specified keywords", "disabled": true }, { "key": "destAddresses", "value": "", "description": "Filters rules based on destination IP addresses using the specified keywords", "disabled": true }, { "key": "srcIpGroups", "value": "", "description": "Filters rules based on source IP groups using the specified keywords", "disabled": true }, { "key": "destIpGroups", "value": "", "description": "Filters rules based on destination IP groups using the specified keywords", "disabled": true }, { "key": "nwApplication", "value": "", "description": "Filters rules based on network applications using the specified keywords", "disabled": true }, { "key": "nwServices", "value": "", "description": "Filters rules based on network services using the specified keywords", "disabled": true }, { "key": "destIpCategories", "value": "", "description": "Filters rules based on destination URL categories using the specified keywords", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is set to 5,000, if not specified.", "disabled": true } ] }, "description": "

    Retrieves all rules in the Firewall Filtering policy

    Note: The API response captures all updates made to the Firewall Filtering rules directly (i.e., action performed directly on the rule by admin or API client) or incidentally as a result of other rule modifications (e.g., a higher-order rule creation automatically modifies the rule order for existing rules with lower order). The lastModifiedBy and lastModifiedTime fields of a rule correspond strictly to the latest change to the rule or the rule set. For example, when a new rule of order 1 is added, an existing rule with order 1 shifts down to order 2 and this change applies to the remaining rules. In this case, the lastModifiedBy and lastModifiedTime fields for all rules correspond to the admin or API client who created the new rule and the time it was created.

    However, when you use audit logs to view the change records logged for admins and API clients, the incidental rule changes are excluded from the audit logs. To learn more, see About Audit Logs.

    " }, "response": [] }, { "name": "Firewall Filtering Rules Resource Create Firewall Filtering Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules" ] }, "description": "Adds a new Firewall Filtering policy rule" }, "response": [] }, { "name": "Firewall Filtering Rules Resource Get Firewall Filtering Rules Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules", "count" ], "query": [ { "key": "ruleName", "value": "", "description": "Filters rules based on rule names using the specified keywords", "disabled": true }, { "key": "ruleLabel", "value": "", "description": "Filters rules based on rule labels using the specified keywords", "disabled": true }, { "key": "ruleLabelId", "value": "", "description": "Filters rules based on rule label ID using the specific keywords", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "Filters rules based on rule order using the specified keywords", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "Filters rules based on rule description using the specified keywords", "disabled": true }, { "key": "ruleAction", "value": "", "description": "Filters rules based on rule actions using the specified keywords", "disabled": true }, { "key": "location", "value": "", "description": "Filters rules based on locations using the specified keywords", "disabled": true }, { "key": "department", "value": "", "description": "Filters rules based on user departments using the specified keywords", "disabled": true }, { "key": "group", "value": "", "description": "Filters rules based on user groups using the specified keywords", "disabled": true }, { "key": "user", "value": "", "description": "Filters rules based on users using the specified keywords", "disabled": true }, { "key": "device", "value": "", "description": "Filters rules based on devices using the specified keywords", "disabled": true }, { "key": "deviceGroup", "value": "", "description": "Filters rules based on device groups using the specified keywords", "disabled": true }, { "key": "deviceTrustLevel", "value": "", "description": "Filters rules based on device trust levels using the specified keywords", "disabled": true }, { "key": "srcIps", "value": "", "description": "Filters rules based on source IP addresses using the specified keywords", "disabled": true }, { "key": "destAddresses", "value": "", "description": "Filters rules based on destination IP addresses using the specified keywords", "disabled": true }, { "key": "srcIpGroups", "value": "", "description": "Filters rules based on source IP groups using the specified keywords", "disabled": true }, { "key": "destIpGroups", "value": "", "description": "Filters rules based on destination IP groups using the specified keywords", "disabled": true }, { "key": "nwApplication", "value": "", "description": "Filters rules based on network applications using the specified keywords", "disabled": true }, { "key": "nwServices", "value": "", "description": "Filters rules based on network services using the specified keywords", "disabled": true }, { "key": "destIpCategories", "value": "", "description": "Filters rules based on destination URL categories using the specified keywords", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is set to 5,000, if not specified.", "disabled": true } ] }, "description": "Retrieves the rule count for Firewall Filtering policy based on search criteria. If no search criteria is specified for filtering rules, the total number of Firewall Filtering rules is retrieved by default." }, "response": [] }, { "name": "Firewall Filtering Rules Resource Get Firewall Filtering Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the policy rule" } ] }, "description": "

    Gets the Firewall Filtering policy rule information for the specified ID

    \n" }, "response": [] }, { "name": "Firewall Filtering Rules Resource Update Firewall Filtering Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the policy rule" } ] }, "description": "Updates Firewall Filtering policy rule information for the specified ID" }, "response": [] }, { "name": "Firewall Filtering Rules Resource Delete Firewall Filtering Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the policy rule" } ] }, "description": "Deletes a Firewall Filtering policy rule for the specified ID" }, "response": [] }, { "name": "Custom App Service Config Resource Get All App Service Config For Org", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/apps-services", "host": [ "{{ZIABaseUrl}}" ], "path": [ "apps-services" ] }, "description": "Retrieves the list of predefined and custom application service groups for the organization. To learn more, see About Application Service Groups." }, "response": [] }, { "name": "Custom App Service Config Resource Add App Service Configs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/apps-services", "host": [ "{{ZIABaseUrl}}" ], "path": [ "apps-services" ] }, "description": "Creates one or more custom groups that categorize application services defined by IP addresses and ports. To learn more, see Configuring Application Service Groups. You can add multiple custom application service groups in a single request." }, "response": [] }, { "name": "Custom App Service Config Resource Get App Service Config For Org", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/apps-services/:appServiceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "apps-services", ":appServiceId" ], "variable": [ { "key": "appServiceId", "value": "", "description": "Application service group ID" } ] }, "description": "Retrieves configurations for an application service group with the specified ID" }, "response": [] }, { "name": "Custom App Service Config Resource Update App Service Configs", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/apps-services/:appServiceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "apps-services", ":appServiceId" ], "variable": [ { "key": "appServiceId", "value": "", "description": "Application service group ID" } ] }, "description": "Update configurations for a custom application service group with the specified ID. This request replaces the group's all current configurations with the new definitions specified in the request body. The request payload must contain the complete configurations for the specific group, including those requiring to be updated or preserved." }, "response": [] }, { "name": "Custom App Service Config Resource Delete App Service Config", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/apps-services/:appServiceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "apps-services", ":appServiceId" ], "variable": [ { "key": "appServiceId", "value": "", "description": "Application service group ID" } ] }, "description": "Delete a custom application group based on the specified ID" }, "response": [] }, { "name": "DNS Application Group Resource Get DNS Application Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Unique identifier for the DNS application group" } ] }, "description": "Retrieves information about the DNS application group based on the specified ID" }, "response": [] }, { "name": "DNS Application Group Resource Update DNS Application Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Unique identifier for the DNS application group" } ] }, "description": "Updates the DNS application group based on the specified ID" }, "response": [] }, { "name": "DNS Application Group Resource Delete DNS Application Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Unique identifier for the DNS application group" } ] }, "description": "Deletes a DNS application group based on the specified ID" }, "response": [] }, { "name": "DNS Application Group Resource Get DNS Application Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsApplicationGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsApplicationGroups", "lite" ] }, "description": "Retrieves the name and ID of all DNS application groups" }, "response": [] }, { "name": "DNS Gateway Resource Get DNS Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways" ], "query": [ { "key": "page", "value": "", "description": "Set the page number of the response", "disabled": true }, { "key": "pageSize", "value": "", "description": "Set the size of the response", "disabled": true } ] }, "description": "Retrieves a list of DNS Gateways. ." }, "response": [] }, { "name": "DNS Gateway Resource Add DNS Gateway", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways" ] }, "description": "Adds a new DNS Gateway. ." }, "response": [] }, { "name": "DNS Gateway Resource Get DNS Gateways Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways", "lite" ], "query": [ { "key": "page", "value": "", "description": "Set the size of the response", "disabled": true }, { "key": "pageSize", "value": "", "description": "Set the size of the response", "disabled": true } ] }, "description": "Retrieves a list of DNS Gateways" }, "response": [] }, { "name": "DNS Gateway Resource Get DNS Gateway", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the DNS Gateway" } ] }, "description": "Retrieves the DNS Gateway based on the specified ID" }, "response": [] }, { "name": "DNS Gateway Resource Update DNS Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the DNS Gateway" } ] }, "description": "Updates the DNS Gateway based on the specified ID" }, "response": [] }, { "name": "DNS Gateway Resource Delete DNS Gateway", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnsGateways/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnsGateways", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Deletes a DNS Gateway based on the specified ID" }, "response": [] }, { "name": "IP Destination Group Resource Get Destination IP Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups" ], "query": [ { "key": "excludeType", "value": "", "description": "Filter based on the IP destination group's type.", "disabled": true } ] }, "description": "

    Gets a list of all IP destination groups.

    Note: This endpoint retrieves only IPv4 destination address groups. Organizations that have enabled IPv6 can use GET /ipSourceGroups/ipv6SourceGroups to retrieve IPv6 destination address groups.

    \n" }, "response": [] }, { "name": "IP Destination Group Resource Add Destination IP Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups" ] }, "description": "

    Adds a new IP Destination group.

    Note: This endpoint can only add an IPv4 destination address group. User-defined groups for IPv6 addresses are currently not supported.

    " }, "response": [] }, { "name": "IP Destination Group Resource Get Destination Ipv6 Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/ipv6DestinationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", "ipv6DestinationGroups" ], "query": [ { "key": "excludeType", "value": "", "description": "

    Specifies a destination group type to exclude the corresponding groups from the list.

    ", "disabled": true } ] }, "description": "

    Gets the list of destination IPv6 address groups.

    Note: User-defined groups for IPv6 addresses are currently not supported, so this endpoint retrieves only the predefined group that includes all IPv6 addresses.

    " }, "response": [] }, { "name": "IP Destination Group Resource Get Destination Ipv6 Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/ipv6DestinationGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", "ipv6DestinationGroups", "lite" ], "query": [ { "key": "type", "value": "", "description": "Filters the list based on the destination group type.", "disabled": true }, { "key": "excludeType", "value": "", "description": "

    Specifies a destination group type to exclude the corresponding groups from the list type.

    ", "disabled": true } ] }, "description": "

    Gets a name and ID dictionary for destination IPv6 address groups.

    Note: User-defined groups for IPv6 addresses are currently not supported, so this endpoint retrieves only the predefined group that includes all IPv6 addresses.

    " }, "response": [] }, { "name": "IP Destination Group Resource Get Destination IP Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", "lite" ], "query": [ { "key": "type", "value": "", "description": "Filter based on the IP destination group's type.", "disabled": true }, { "key": "excludeType", "value": "", "description": "Exclude from list based on the IP destination group's type.", "disabled": true } ] }, "description": "

    Gets a name and ID dictionary of all IP destination groups.

    Note: This endpoint retrieves only IPv4 destination address groups. Organizations that have enabled IPv6 can use GET /ipDestinationGroups/ipv6DestinationGroups/lite to retrieve IPv6 destination address groups.

    \n" }, "response": [] }, { "name": "IP Destination Group Resource Get Destination IP Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The unique identifier for the IP destination group." } ] }, "description": "

    Gets the IP destination group information for the specified ID.

    " }, "response": [] }, { "name": "IP Destination Group Resource Edit Destination IP Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "query": [ { "key": "override", "value": "", "description": "Indicates whether the IPs must be overridden. When set to false, the IPs are appended; else the existing IPs are overridden. The default value is true.", "disabled": true } ], "variable": [ { "key": "ipGroupId", "value": "", "description": "Unique identifier for the IP destination group" } ] }, "description": "

    Updates the IP destination group information for the specified ID.

    Note: Only user-defined IP groups can be updated.

    " }, "response": [] }, { "name": "IP Destination Group Resource Delete Destination IP Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "" } ] }, "description": "

    Deletes the IP destination group for the specified ID.

    Note: Only user-defined IP groups can be deleted.

    " }, "response": [] }, { "name": "IP Source Group Resource Get Source IP Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a group's name or description attributes.", "disabled": true } ] }, "description": "

    Gets a list of all IP source groups. The search parameters find matching values within the name or description attributes.

    Note: This endpoint retrieves only IPv4 source address groups. Organizations that have enabled IPv6 can use GET /ipSourceGroups/ipv6SourceGroups to retrieve IPv6 source address groups.

    " }, "response": [] }, { "name": "IP Source Group Resource Add Source IP Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups" ] }, "description": "

    Adds a new IP source group.

    Note: This endpoint can only add an IPv4 source address group. User-defined groups for IPv6 addresses are currently not supported.

    " }, "response": [] }, { "name": "IP Source Group Resource Get Source Ipv6 Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/ipv6SourceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", "ipv6SourceGroups" ] }, "description": "

    Gets the list of source IPv6 address groups.

    Note: User-defined groups for IPv6 addresses are currently not supported, so this endpoint retrieves only the predefined group that includes all IPv6 addresses.

    " }, "response": [] }, { "name": "IP Source Group Resource Get Source Ipv6 Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/ipv6SourceGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", "ipv6SourceGroups", "lite" ] }, "description": "

    Gets a name and ID dictionary for source IPv6 address groups.

    Note: User-defined groups for IPv6 addresses are currently not supported, so this endpoint retrieves only the predefined group that includes all IPv6 addresses.

    " }, "response": [] }, { "name": "IP Source Group Resource Get Source IP Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", "lite" ] }, "description": "

    Gets a name and ID dictionary of all IP source groups.

    Note: This endpoint retrieves only IPv4 source address groups. Organizations that have enabled IPv6 can use GET /ipSourceGroups/ipv6SourceGroups/lite to retrieve IPv6 source address groups.

    \n" }, "response": [] }, { "name": "IP Source Group Resource Get Source IP Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The unique identifier for the IP source group." } ] }, "description": "

    Gets the IP source group information for the specified ID.

    \n" }, "response": [] }, { "name": "IP Source Group Resource Edit Source IP Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The unique identifier for the IP source group." } ] }, "description": "

    Updates the IP source group information for the specified ID.

    Note: Only user-defined IP groups can be updated.

    " }, "response": [] }, { "name": "IP Source Group Resource Delete Source IP Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The unique identifier for the IP source group." } ] }, "description": "

    Deletes the IP source group for the specified ID.

    Note: Only user-defined IP groups can be deleted.

    " }, "response": [] }, { "name": "Network Application Group Resource Get Netowrk Application Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a group's name or description attributes.

    \n", "disabled": true } ] }, "description": "

    Gets a list of all network application groups. The search parameters find matching values within the name or description attributes.

    \n" }, "response": [] }, { "name": "Network Application Group Resource Create Network Application Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups" ] }, "description": "Creates a new custom network application group." }, "response": [] }, { "name": "Network Application Group Resource Get Netowrk Application Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups", "lite" ] }, "description": "

    Gets a name and ID dictionary of all network application groups.

    \n" }, "response": [] }, { "name": "Network Application Group Resource Get Network Application Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "The unique identifier for the network application group." } ] }, "description": "

    Gets the network application group information for the specified ID.

    \n" }, "response": [] }, { "name": "Network Application Group Resource Update Network Application Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "The unique identifier for the network application group." } ] }, "description": "Updates the customer network application group for the specified ID." }, "response": [] }, { "name": "Network Application Group Resource Delete Network Application Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplicationGroups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplicationGroups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "The unique identifier for the network application group." } ] }, "description": "Deletes the custom network application group for the specified ID." }, "response": [] }, { "name": "Get Network Applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplications", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplications" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a network application's description attribute.

    \n", "disabled": true }, { "key": "locale", "value": "", "description": "

    When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN), the network application's description is localized into the requested language.

    ", "disabled": true } ] }, "description": "

    Gets a list of all predefined network applications. The search parameters find matching values within the description attribute.

    \n" }, "response": [] }, { "name": "Get Network Application By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkApplications/:appId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkApplications", ":appId" ], "query": [ { "key": "locale", "value": "", "description": "

    When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN), the network application's description is localized into the requested language.

    ", "disabled": true } ], "variable": [ { "key": "appId", "value": "", "description": "The unique identifier for the network application." } ] }, "description": "

    Gets the network application information for the specified ID.

    \n" }, "response": [] }, { "name": "Network Service Group Resource Get Network Service Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a group's name or description attributes.

    \n", "disabled": true } ] }, "description": "

    Gets a list of all network service groups. The search parameters find matching values within the name or description attributes.

    \n" }, "response": [] }, { "name": "Network Service Group Resource Add Custom Network Service Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups" ] }, "description": "Adds a new network service group." }, "response": [] }, { "name": "Network Service Group Resource Get Network Service Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups", "lite" ] }, "description": "

    Gets a name and ID dictionary of all network service groups.

    \n" }, "response": [] }, { "name": "Network Service Group Resource Get Network Service Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The unique identifier for the network service group." } ] }, "description": "

    Gets the network service group information for the specified ID.

    \n" }, "response": [] }, { "name": "Network Service Group Resource Edit Network Service Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The unique identifier for the network service group." } ] }, "description": "Updates the network service group information for the specified ID." }, "response": [] }, { "name": "Network Service Group Resource Delete Custom Netowrk Service Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The unique identifier for the network service group." } ] }, "description": "Deletes the network service group for the specified ID." }, "response": [] }, { "name": "Network Service Resource Get Network Services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a service's name or description attributes.

    \n", "disabled": true }, { "key": "protocol", "value": "", "description": "Filter based on the network service protocol.", "disabled": true }, { "key": "locale", "value": "", "description": "

    When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN), the network service's description is localized into the requested language.

    ", "disabled": true } ] }, "description": "

    Gets a list of all network services. The search parameters find matching values within the name or description attributes.

    \n" }, "response": [] }, { "name": "Network Service Resource Add Custom Network Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices" ] }, "description": "Adds a new network service." }, "response": [] }, { "name": "Network Service Resource Get Network Services Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices", "lite" ], "query": [ { "key": "locale", "value": "", "description": "", "disabled": true } ] }, "description": "

    Gets a name and ID dictionary of all network services.

    \n" }, "response": [] }, { "name": "Network Service Resource Get Network Service By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices/:serviceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices", ":serviceId" ], "query": [ { "key": "locale", "value": "", "description": "

    When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN), the network service's description is localized into the requested language.

    ", "disabled": true } ], "variable": [ { "key": "serviceId", "value": "", "description": "The unique identifier for the network service." } ] }, "description": "

    Gets the network service for the specified ID.

    \n" }, "response": [] }, { "name": "Network Service Resource Edit Network Service", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices/:serviceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices", ":serviceId" ], "variable": [ { "key": "serviceId", "value": "", "description": "The unique identifier for the network service." } ] }, "description": "Updates the network service information for the specified ID." }, "response": [] }, { "name": "Network Service Resource Delete Custom Network Service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/networkServices/:serviceId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "networkServices", ":serviceId" ], "variable": [ { "key": "serviceId", "value": "", "description": "The unique identifier for the network service." } ] }, "description": "Deletes the network service for the specified ID." }, "response": [] }, { "name": "Time Window Resource Get Time Windows", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeWindows", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeWindows" ] }, "description": "

    Gets a list of time intervals used for by the Firewall policy or the URL Filtering policy.

    \n" }, "response": [] }, { "name": "Time Window Resource Get Time Window Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeWindows/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeWindows", "lite" ] }, "description": "

    Gets a name and ID dictionary of time intervals used by the Firewall policy or the URL Filtering policy.

    \n" }, "response": [] } ] }, { "name": "Forwarding Control Policy", "item": [ { "name": "Dedicated IP Gateway Resource Get Dedicated IP Gateways Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dedicatedIPGateways/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dedicatedIPGateways", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves a list of dedicated IP gateways. ." }, "response": [] }, { "name": "Proxy Resource Get Proxies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies" ] }, "description": "Retrieves a list of all proxies configured for third-party proxy services. ." }, "response": [] }, { "name": "Proxy Resource Add Proxy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies" ] }, "description": "Adds a new proxy for a third-party proxy service. ." }, "response": [] }, { "name": "Proxy Resource Get Proxies Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies", "lite" ] }, "description": "Retrieves a list of all proxies configured for third-party proxy services" }, "response": [] }, { "name": "Proxy Resource Get Proxy By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies/:proxyId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies", ":proxyId" ], "variable": [ { "key": "proxyId", "value": "", "description": "Unique identifier for the proxy" } ] }, "description": "Retrieves the proxy information based on the specified ID" }, "response": [] }, { "name": "Proxy Resource Edit Proxy", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies/:proxyId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies", ":proxyId" ], "variable": [ { "key": "proxyId", "value": "", "description": "Unique identifier for the proxy" } ] }, "description": "Updates an existing proxy based on the specified ID" }, "response": [] }, { "name": "Proxy Resource Delete Proxy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxies/:proxyId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxies", ":proxyId" ], "variable": [ { "key": "proxyId", "value": "", "description": "Unique identifier for the proxy" } ] }, "description": "Deletes an existing proxy based on the specified ID" }, "response": [] }, { "name": "Proxy Gateway Resource Get Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxyGateways", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxyGateways" ] }, "description": "

    Retrieves the proxy gateway information. To learn more, see About Gateways for Proxies.

    " }, "response": [] }, { "name": "Proxy Gateway Resource Get Gateways Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/proxyGateways/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "proxyGateways", "lite" ] }, "description": "

    Retrieves the name and ID of the proxy. To learn more, see About Gateways for Proxies.

    " }, "response": [] }, { "name": "Forwarding Rules Resource Get Forwarding Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/forwardingRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "forwardingRules" ] }, "description": "Gets the list of forwarding rules configured in the ZIA Admin Portal. To learn about forwarding control, see About Forwarding Control." }, "response": [] }, { "name": "Forwarding Rules Resource Create Forwarding Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/forwardingRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "forwardingRules" ] }, "description": "Adds a new forwarding rule. To learn more, see Configuring Forwarding Policy." }, "response": [] }, { "name": "Forwarding Rules Resource Get Forwarding Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/forwardingRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "forwardingRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The ID of the forwarding rule" } ] }, "description": "Gets information for a forwarding rule using the specified ID" }, "response": [] }, { "name": "Forwarding Rules Resource Update Forwarding Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/forwardingRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "forwardingRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The ID of the forwarding rule" } ] }, "description": "Updates information for a forwarding rule using the specified ID" }, "response": [] }, { "name": "Forwarding Rules Resource Delete Forwarding Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/forwardingRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "forwardingRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The ID of the forwarding rule" } ] }, "description": "Deletes a forwarding rule using the specified ID" }, "response": [] }, { "name": "ZPA Gateway Resource Get ZPA Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/zpaGateways", "host": [ "{{ZIABaseUrl}}" ], "path": [ "zpaGateways" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a ZPA gateway name or an associated Server Group name", "disabled": true }, { "key": "appSegment", "value": "", "description": "Filters the list by Application Segment", "disabled": true } ] }, "description": "Gets the list of Zscaler Private Access (ZPA) gateways configured in the ZIA Admin Portal. To learn about ZPA gateways, see About Zscaler Private Access Gateway." }, "response": [] }, { "name": "ZPA Gateway Resource Add ZPA Gateway", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/zpaGateways", "host": [ "{{ZIABaseUrl}}" ], "path": [ "zpaGateways" ] }, "description": "Adds a new custom ZPA gateway. The ZPA gateway can be used in a forwarding control policy to forward traffic to ZPA for Source IP Anchoring. To learn more, see Configuring ZPA Gateway." }, "response": [] }, { "name": "ZPA Gateway Resource Get ZPA Gateway By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/zpaGateways/:gatewayId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "zpaGateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the ZPA gateway" } ] }, "description": "Gets information for a ZPA gateway using the specified ID" }, "response": [] }, { "name": "ZPA Gateway Resource Edit ZPA Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/zpaGateways/:gatewayId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "zpaGateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the ZPA gateway" } ] }, "description": "Updates information for a ZPA gateway using the specified ID" }, "response": [] }, { "name": "ZPA Gateway Resource Delete ZPA Gateway", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/zpaGateways/:gatewayId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "zpaGateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the ZPA gateway" } ] }, "description": "Deletes a ZPA gateway using the specified ID" }, "response": [] } ] }, { "name": "FTP Control Policy", "item": [ { "name": "Ftp Settings Resource Get Ftp Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ftpSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ftpSettings" ] }, "description": "Retrieves the FTP Control status and the list of URL categories for which FTP is allowed. ." }, "response": [] }, { "name": "Ftp Settings Resource Update Ftp Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ftpSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ftpSettings" ] }, "description": "Updates the FTP Control settings. ." }, "response": [] } ] }, { "name": "HTTP Header Control", "item": [ { "name": "HTTP Header Profile Resource Get HTTP Header Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderProfile" ] }, "description": "Retrieves a list of HTTP header profiles. To learn more, see About HTTP Header Profile." }, "response": [] }, { "name": "HTTP Header Profile Resource Create HTTP Header Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderProfile" ] }, "description": "Adds a new HTTP header profile. To learn more, see Adding an HTTP Header Profile." }, "response": [] }, { "name": "HTTP Header Profile Resource Update HTTP Header Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderProfile/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderProfile", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the HTTP header profile" } ] }, "description": "Updates the HTTP header profile based on the specified ID" }, "response": [] }, { "name": "HTTP Header Profile Resource Delete HTTP Header Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderProfile/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderProfile", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the HTTP header profile" } ] }, "description": "Deletes the HTTP header profile based on the specified ID" }, "response": [] }, { "name": "HTTP Header Action Profile Resource Get HTTP Header Action Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderActionProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderActionProfile" ] }, "description": "Retrieves a list of HTTP header insertion profiles. To learn more, see About HTTP Header Insertion Profile." }, "response": [] }, { "name": "HTTP Header Action Profile Resource Create HTTP Header Action Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderActionProfile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderActionProfile" ] }, "description": "Adds a new HTTP header insertion profile. To learn more, see Adding an HTTP Header Insertion Profile." }, "response": [] }, { "name": "HTTP Header Action Profile Resource Update HTTP Header Action Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderActionProfile/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderActionProfile", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the HTTP header insertion profile" } ] }, "description": "Updates the HTTP header insertion profile based on the specified ID" }, "response": [] }, { "name": "HTTP Header Action Profile Resource Delete HTTP Header Action Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/httpHeaderActionProfile/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "httpHeaderActionProfile", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the HTTP header insertion profile" } ] }, "description": "Deletes the HTTP header insertion profile based on the specified ID" }, "response": [] } ] }, { "name": "Intermediate CA Certificates", "item": [ { "name": "SSL Cert Resource Get Certs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslCertificates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslCertificates" ] }, "description": "Retrieves a list of all intermediate Certificate Authority (CA) certificates for SSL Inspection. To learn more, see About Intermediate CA Certificates." }, "response": [] }, { "name": "SSL Cert Resource Show Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslCertificates/certDetail/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslCertificates", "certDetail", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "Unique identifier for the intermediate CA certificate" } ] }, "description": "Retrieves the intermediate Certificate Authority (CA) certificate for SSL Inspection based on the specified certificate ID" }, "response": [] }, { "name": "SSL Cert Resource Delete Cert", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslCertificates/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslCertificates", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "Unique identifier for the intermediate CA certificate" } ] }, "description": "Deletes the intermediate Certificate Authority (CA) certificate based on the specified certificate ID" }, "response": [] }, { "name": "SSL Cert Resource Download SSL Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslCertificates/download/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslCertificates", "download", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "Unique identifier for the intermediate CA certificate" } ] }, "description": "Downloads the intermediate Certificate Authority (CA) certificate based on the specified certificate ID" }, "response": [] }, { "name": "Intermediate Cert Resource Get Intermediate Ca Certificates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ] }, "description": "

    Gets the list of intermediate CA certificates added for SSL inspection.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Add Intermediate Ca Certificate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate" ] }, "description": "

    Adds a custom intermediate CA certificate that can be used for SSL inspection. Custom intermediate certificates can be added with software protection or cloud HSM based on your subscriptions. In cloud HSM protection, your certificate private keys are stored in a cloud hardware security module (HSM) located in a region of your choice.

    With cloud HSM protection subscription, you can add up to eight custom intermediate certificates using either cloud HSM or software protection and only four certificates can be active at a time. With software protection subscription, you can add up to 2 intermediate certificates and only one certificate can be active at a time.

    To learn more, see Configuring Cloud HSM Protection Intermediate CA Certificate and Configuring Software Protection Intermediate CA Certificate.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Download Attestation Stmt", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/downloadAttestation/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "downloadAttestation", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Downloads the attestation bundle produced by the HSM solution for the specified intermediate CA certificate ID. The attestation bundle can be used to verify the HSM key attributes and the validity of the certificate.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Download Csr", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/downloadCsr/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "downloadCsr", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Downloads a Certificate Signing Request (CSR) for the specified ID. To perform this operation, a CSR must have already been generated.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Download Hsm Public Key", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/downloadPublicKey/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "downloadPublicKey", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Downloads the public key in the HSM key pair for the intermediate CA certificate with the specified ID. To perform this operation, a HSM key pair must have already been generated.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Finalize Cert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/finalizeCert/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "finalizeCert", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Finalizes the intermediate CA certificate with the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Generate Csr", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/generateCsr/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "generateCsr", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Generates a Certificate Signing Request (CSR) for the custom intermediate CA certificate with the specified ID. You can send the generated CSR to your Certificate Authority (CA) to sign as a subordinate CA certificate or intermediate CA certificate. The subordinate CA can be an intermediate or an issuing CA.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Generate Hsm Key Pair", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/keyPair/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "keyPair", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Generates a HSM key pair for the custom intermediate CA certificate with the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Get Intermediate Ca Certificates Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ] }, "description": "

    Gets the list of intermediate CA certificates added for SSL inspection.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Get Intermediate Ca Certificate Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/lite/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "lite", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Gets information about the intermediate CA certificate with the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Make Default Certificate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/makeDefault/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "makeDefault", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Updates the intermediate CA certificate information for the specified ID to mark it as the default intermediate certificate. Only one intermediate certificate can be marked as the default certificate at a time.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Get Certificates In Ready To Use State", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/readyToUse", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "readyToUse" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ] }, "description": "

    Gets the list of intermediate CA certificates that are ready to use for SSL inspection.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Show Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/showCert/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "showCert", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Shows information about the signed intermediate CA certificate with the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Show Csr", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/showCsr/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "showCsr", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Shows information about the Certificate Signing Request (CSR) for the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Upload Cert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/uploadCert/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "uploadCert", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Uploads a custom intermediate CA certificate signed by your Certificate Authority (CA) for SSL inspection. To enable users' browsers to trust this new intermediate certificate and any certificate signed by it, install this certificate on users' browsers. If you also want to upload a certificate chain, upload the signed intermediate certificate before uploading the certificate chain.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Upload Cert Chain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/uploadCertChain/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "uploadCertChain", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Uploads the intermediate certificate chain (PEM file). Upload the certificate chain that includes any other intermediate certificates that complete the chain to the intermediate root certificate you want to upload.

    When you upload a certificate chain, the Zscaler service sends the intermediate certificate along with this key chain and the signed server certificate to your users’ machines during SSL inspection. If you do not upload the certificate chain, the Zscaler service sends only your organization’s intermediate root certificate and its signed server certificate to your users' machines.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Verify Key Attestation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/verifyKeyAttestation/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", "verifyKeyAttestation", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Verifies the attestation for the HSM keys generated for the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Get Intermediate Ca Certificate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Gets intermediate CA certificate information for the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Update Intermediate Ca Certificate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Updates intermediate CA certificate information for the specified ID.

    " }, "response": [] }, { "name": "Intermediate Cert Resource Delete Intermediate Ca Certificate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/intermediateCaCertificate/:certId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "intermediateCaCertificate", ":certId" ], "variable": [ { "key": "certId", "value": "", "description": "The unique identifier for the intermediate CA certificate." } ] }, "description": "

    Deletes the intermediate CA certificate with the specified ID. The default intermediate certificate cannot be deleted.

    " }, "response": [] }, { "name": "Download Csr Csr", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/downloadcsr", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "downloadcsr" ] }, "description": "

    Downloads a Certificate Signing Request (CSR). Before you can download the CSR, you must send a POST request to /sslSettings/generatecsr to create it.

    \n" }, "response": [] }, { "name": "Generate Csr", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/generatecsr", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "generatecsr" ] }, "description": "

    Generates a Certificate Signing Request (CSR). If your organization uses a custom intermediate root certificate for SSL inspection, send a GET request to /sslSettings/generatecsr to generate a new CSR, then send the generated CSR to your Certificate Authority (CA) to sign as a subordinate CA certificate. The subordinate CA can be an intermediate or an issuing CA.

    \n" }, "response": [] }, { "name": "Show Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/showcert", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "showcert" ] }, "description": "

    Shows information about the signed intermediate root certificate.

    " }, "response": [] }, { "name": "Upload Cert Return Text", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/uploadcert/text", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "uploadcert", "text" ] }, "description": "

    Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain. To enable users' browsers to trust this intermediate root certificate and any certificate signed by it, install this root certificate on users' browsers. If you also want to upload a certificate chain, upload the signed intermediate root certificate before uploading the certificate chain.

    \n" }, "response": [] }, { "name": "Upload Cert Chain Return Text", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/uploadcertchain/text", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "uploadcertchain", "text" ] }, "description": "

    Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain. Upload the certificate chain that includes any other intermediate certificates that complete the chain to the intermediate root certificate you want to upload.

    When you upload a certificate chain, the Zscaler service sends the intermediate root certificate along with this key chain and the signed server certificate to your users' machines during SSL inspection. If you do not upload the certificate chain, the Zscaler service sends only your organization's intermediate root certificate and its signed server certificate to your users' machines.

    \n" }, "response": [] }, { "name": "Delete Cert Chain", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/certchain", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "certchain" ] }, "description": "

    Deletes the intermediate certificate chain.

    \n" }, "response": [] }, { "name": "Get SSL Exempted Urls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/exemptedUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "exemptedUrls" ] }, "description": "

    Gets a list of URLs that were exempted from SSL Inpection and policy evaluation.

    " }, "response": [] }, { "name": "Update SSL Exempted Urls", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslSettings/exemptedUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslSettings", "exemptedUrls" ], "query": [ { "key": "action", "value": "", "description": "The action applied to the exempted URLs list (i.e., adding a URL or removing a URL).", "disabled": false } ] }, "description": "

    Adds URLs to the exempted from SSL Inspection and policy evaluation list or removes URLs from the list. To add a URL to the list, set the action parameter to ADD_TO_LIST. To remove a URL, set action to REMOVE_FROM_LIST.

    " }, "response": [] } ] }, { "name": "IoT Report", "item": [ { "name": "Iot Discovery Resource Get Device Types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/iotDiscovery/deviceTypes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "iotDiscovery", "deviceTypes" ] }, "description": "

    Retrieve the mapping between device type universally unique identifier (UUID) values and the device type names for all the device types supported by the Zscaler AI/ML.

    " }, "response": [] }, { "name": "Iot Discovery Resource Get Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/iotDiscovery/categories", "host": [ "{{ZIABaseUrl}}" ], "path": [ "iotDiscovery", "categories" ] }, "description": "

    Retrieve the mapping between the device category universally unique identifier (UUID) values and the category names for all the device categories supported by the Zscaler AI/ML. The parent of device category is device type.

    " }, "response": [] }, { "name": "Iot Discovery Resource Get Classifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/iotDiscovery/classifications", "host": [ "{{ZIABaseUrl}}" ], "path": [ "iotDiscovery", "classifications" ] }, "description": "

    Retrieve the mapping between the device classification universally unique identifier (UUID) values and the classification names for all the device classifications supported by Zscaler AI/ML. The parent of device classification is device category.

    " }, "response": [] }, { "name": "Iot Discovery Resource Get Device List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/iotDiscovery/deviceList", "host": [ "{{ZIABaseUrl}}" ], "path": [ "iotDiscovery", "deviceList" ] }, "description": "

    Retrieve a list of discovered devices with the following key contexts, IP address, location, ML auto-label, classification, category, and type.

    " }, "response": [] } ] }, { "name": "IPS Control Policy", "item": [ { "name": "IPS Signature Rule Resource Get IPS Signature Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves a list of custom IPS signature rules. To learn more, see About Custom IPS Signature Rules." }, "response": [] }, { "name": "IPS Signature Rule Resource Add IPS Signature Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules" ] }, "description": "Adds a new custom IPS signature rule. To learn more, see Configuring Custom IPS Signature Rules." }, "response": [] }, { "name": "IPS Signature Rule Resource Get IPS Signature Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", ":id" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "System-generated identifier for the custom signature rule" } ] }, "description": "Retrieves the custom IPS signature rules based on the specified ID" }, "response": [] }, { "name": "IPS Signature Rule Resource Update IPS Signature Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated identifier for the custom signature rule" } ] }, "description": "Updates the custom IPS signature rules based on the specified ID" }, "response": [] }, { "name": "IPS Signature Rule Resource Delete IPS Signature Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "System-generated identifier for the custom signature rule" } ] }, "description": "Deletes the custom IPS signature rules based on the specified ID" }, "response": [] }, { "name": "IPS Signature Rule Resource Export IPS Sig CSV", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/export", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", "export" ] }, "description": "Exports the custom IPS signature rules to a CSV file. To learn more, see Importing and Exporting Custom IPS Signature Rules." }, "response": [] }, { "name": "IPS Signature Rule Resource Import IPS Sig Rule Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/import", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", "import" ] }, "description": "Imports the custom IPS signature rules from a CSV file. To learn more, see Importing and Exporting Custom IPS Signature Rules." }, "response": [] }, { "name": "IPS Signature Rule Resource Import IPS Sig Rules", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/import", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", "import" ] }, "description": "

    Adds a new CSV file with your custom IPS signature rules.

    Note: To import custom IPS signature rules, use the same format as the Sample Import CSV file provided by Zscaler.

    " }, "response": [] }, { "name": "IPS Signature Rule Resource Validate Rule Text", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipsSignatureRules/validateRuleText", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipsSignatureRules", "validateRuleText" ] }, "description": "Validates a new custom signature rule based on specific predefined conditions, such as syntax errors, duplicate signatures, and more. To learn more, see Configuring Custom IPS Signature Rules." }, "response": [] }, { "name": "Firewall IPS Rules Resource Get Firewall IPS Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallIpsRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallIpsRules" ] }, "description": "Retrieves the list of IPS Control policy rules configured in the ZIA Admin Portal" }, "response": [] }, { "name": "Firewall IPS Rules Resource Create Firewall IPS Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallIpsRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallIpsRules" ] }, "description": "Adds a new IPS Control policy rule. To learn more, see Configuring the IPS Control Policy." }, "response": [] }, { "name": "Firewall IPS Rules Resource Get Firewall IPS Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallIpsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallIpsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Retrieves the IPS Control policy rule information based on the specified ID" }, "response": [] }, { "name": "Firewall IPS Rules Resource Update Firewall IPS Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallIpsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallIpsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Updates the IPS Control policy rule information based on the specified ID" }, "response": [] }, { "name": "Firewall IPS Rules Resource Delete Firewall IPS Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/firewallIpsRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "firewallIpsRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Deletes the IPS Control policy rule information based on the specified ID" }, "response": [] } ] }, { "name": "Location Management", "item": [ { "name": "Get Top Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to partially match against a location's name and port attributes.

    \n", "disabled": true }, { "key": "sslScanEnabled", "value": "", "description": "

    This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.

    Filter based on whether the Enable SSL Scanning setting is enabled or disabled for a location.

    \n", "disabled": true }, { "key": "xffEnabled", "value": "", "description": "

    Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a location.

    \n", "disabled": true }, { "key": "authRequired", "value": "", "description": "

    Filter based on whether the Enforce Authentication setting is enabled or disabled for a location.

    \n", "disabled": true }, { "key": "bwEnforced", "value": "", "description": "

    Filter based on whether Bandwith Control is being enforced for a location.

    \n", "disabled": true }, { "key": "enableIOT", "value": "", "description": "

    If set to true, the city field (containing IoT-enabled location IDs, names, latitudes, and longitudes) and the iotDiscoveryEnabled filter are included in the response. Otherwise, they are not included.

    ", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "

    Gets locations only, not sub-locations. When a location matches the given search parameter criteria only its parent location is included in the result set, not its sub-locations. To learn more, see About Locations.

    \n" }, "response": [] }, { "name": "Add Location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations" ] }, "description": "

    Adds new locations and sub-locations. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key.

    \n" }, "response": [] }, { "name": "Bulk Delete Locations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/bulkDelete", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "bulkDelete" ] }, "description": "

    Bulk delete locations up to a maximum of 100 users per request. The response returns the location IDs that were successfully deleted.

    \n" }, "response": [] }, { "name": "Location Resource Get Countries For Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/supportedCountries", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "supportedCountries" ] }, "description": "

    Retrieves the list of countries supported in location configuration

    Note: The response shows the current list of supported values in an Enum list. However, this list might vary if new entries are added or existing values are modified and the request always returns the latest information available about the countries.

    " }, "response": [] }, { "name": "Get Lite Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "lite" ], "query": [ { "key": "includeSubLocations", "value": "", "description": "If set to true sub-locations are included in the response otherwise they are excluded", "disabled": true }, { "key": "includeParentLocations", "value": "", "description": "If set to true locations with sub locations are included in the response, otherwise only locations without sub-locations are included", "disabled": true }, { "key": "sslScanEnabled", "value": "", "description": "

    This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.

    Filter based on whether the Enable SSL Scanning setting is enabled or disabled for a location.

    \n", "disabled": true }, { "key": "search", "value": "", "description": "

    The search string used to partially match against a location's name and port attributes.

    \n", "disabled": true }, { "key": "enableIOT", "value": "", "description": "

    If set to true, the city field (containing IoT-enabled location IDs, names, latitudes, and longitudes) and the iotDiscoveryEnabled filter are included in the response. Otherwise, they are not included.

    ", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "

    Gets a name and ID dictionary of locations.

    \n" }, "response": [] }, { "name": "Get Location", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/:locationId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", ":locationId" ], "variable": [ { "key": "locationId", "value": "", "description": "The unique identifier for the location." } ] }, "description": "

    Gets the location information for the specified ID.

    \n" }, "response": [] }, { "name": "Update Location", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/:locationId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", ":locationId" ], "variable": [ { "key": "locationId", "value": "", "description": "The unique identifier for the location." } ] }, "description": "

    Updates the location and sub-location information for the specified ID.

    \n" }, "response": [] }, { "name": "Delete Location", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/:locationId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", ":locationId" ], "variable": [ { "key": "locationId", "value": "", "description": "The unique identifier for the location." } ] }, "description": "

    Deletes the location or sub-location for the specified ID.

    \n" }, "response": [] }, { "name": "Get Sub Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/:locationId/sublocations", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", ":locationId", "sublocations" ], "query": [ { "key": "search", "value": "", "description": "The search string used to partially match against a sub-location's name and port attributes.", "disabled": true }, { "key": "sslScanEnabled", "value": "", "description": "

    This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.

    Filter based on whether the Enable SSL Scanning setting is enabled or disabled for a sub-location.

    ", "disabled": true }, { "key": "xffEnabled", "value": "", "description": "Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a sub-location.", "disabled": true }, { "key": "authRequired", "value": "", "description": "Filter based on whether the Enforce Authentication setting is enabled or disabled for a sub-location.", "disabled": true }, { "key": "bwEnforced", "value": "", "description": "Filter based on whether Bandwith Control is being enforced for a sub-location.", "disabled": true }, { "key": "enforceAup", "value": "", "description": "Filter based on whether Enforce AUP setting is enabled or disabled for a sub-location.", "disabled": true }, { "key": "enableFirewall", "value": "", "description": "Filter based on whether Enable Firewall setting is enabled or disabled for a sub-location.", "disabled": true }, { "key": "enableIOT", "value": "", "description": "

    If set to true, the city field (containing IoT-enabled location IDs, names, latitudes, and longitudes) and the iotDiscoveryEnabled filter are included in the response. Otherwise, they are not included.

    ", "disabled": true } ], "variable": [ { "key": "locationId", "value": "", "description": "The unique identifier for the location. The sub-location information given is based on the parent location's ID." } ] }, "description": "

    Gets the sub-location information for the location with the specified ID. These are the sub-locations associated to the parent location.

    " }, "response": [] }, { "name": "Locations Group Resource Get Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/groups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "groups" ], "query": [ { "key": "version", "value": "", "description": "The version parameter is for Zscaler internal use only. The version is used by the service for backup operations.", "disabled": true }, { "key": "name", "value": "", "description": "The location group's name", "disabled": true }, { "key": "groupType", "value": "", "description": "The location group's type (i.e., Static or Dynamic)", "disabled": true }, { "key": "comments", "value": "", "description": "Additional comments or information about the location group", "disabled": true }, { "key": "locationId", "value": "", "description": "The unique identifier for a location within a location group", "disabled": true }, { "key": "lastModUser", "value": "", "description": "The admin that last modified the group", "disabled": true }, { "key": "fetchLocations", "value": "", "description": "Fetches locations associated with the group. Set the value to 'false' to avoid fetching associated locations, thereby optimizing the GET location groups endpoint.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "

    Gets information on location groups. To learn more, see About Location Groups.

    " }, "response": [] }, { "name": "Locations Group Resource Get Groups Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/groups/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "groups", "count" ], "query": [ { "key": "lastModUser", "value": "", "description": "The admin who modified the location group last.", "disabled": true }, { "key": "version", "value": "", "description": "The version parameter is for Zscaler internal use only. The version is used by the service for backup operations.", "disabled": true }, { "key": "name", "value": "", "description": "The location group's name.", "disabled": true }, { "key": "groupType", "value": "", "description": "The location group's type (i.e., Static or Dynamic).", "disabled": true }, { "key": "comments", "value": "", "description": "Additional comments or information about the location group.", "disabled": true }, { "key": "locationId", "value": "", "description": "The unique identifier for a location within a location group.", "disabled": true } ] }, "description": "Gets the list of location groups for your organization." }, "response": [] }, { "name": "Locations Group Resource Get Groups Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/groups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "groups", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets the name and ID dictionary of location groups." }, "response": [] }, { "name": "Locations Group Resource Get Group Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/groups/lite/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "groups", "lite", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique identifier for the location group." } ] }, "description": "Gets the name and ID dictionary for the specified location group ID. The response only provides id, name, and deleted information. " }, "response": [] }, { "name": "Locations Group Resource Get Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/locations/groups/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "locations", "groups", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique identifier for the location group." } ] }, "description": "Gets the location group for the specified ID." }, "response": [] } ] }, { "name": "Malware Protection Policy", "item": [ { "name": "Malware Policy Resource Get Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/malwarePolicy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "malwarePolicy" ] }, "description": "Retrieves the Malware Protection policy configured for an organization" }, "response": [] }, { "name": "Malware Policy Resource Update Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/malwarePolicy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "malwarePolicy" ] }, "description": "Updates the Malware Protection policy for an organization" }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Atp Malware Inspection Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/atpMalwareInspection", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "atpMalwareInspection" ] }, "description": "Retrieves the traffic inspection configurations of Malware Protection policy" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Atp Malware Inspection Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/atpMalwareInspection", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "atpMalwareInspection" ] }, "description": "Updates the traffic inspection configurations of Malware Protection policy. To learn more, see Configuring the Malware Protection Policy." }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Atp Malware Protocols Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/atpMalwareProtocols", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "atpMalwareProtocols" ] }, "description": "Retrieves the protocol inspection configurations of Malware Protection policy" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Atp Malware Protocols Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/atpMalwareProtocols", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "atpMalwareProtocols" ] }, "description": "Updates the protocol inspection configurations of Malware Protection policy. To learn more, see Configuring the Malware Protection Policy." }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Malware Settings Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/malwareSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "malwareSettings" ] }, "description": "Retrieves the malware protection policy configuration details " }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/malwareSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "malwareSettings" ] }, "description": "Updates the malware protection policy configuration details. To learn more, see Configuring the Malware Protection Policy." }, "response": [] }, { "name": "Cyber Threat Protection Resource Get Malware Policy Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/malwarePolicy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "malwarePolicy" ] }, "description": "Retrieves information about the security exceptions configured for the Malware Protection policy" }, "response": [] }, { "name": "Cyber Threat Protection Resource Update Malware Policy Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cyberThreatProtection/malwarePolicy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cyberThreatProtection", "malwarePolicy" ] }, "description": "Updates security exceptions for the Malware Protection policy. To learn more, see Configuring the Malware Protection Policy." }, "response": [] } ] }, { "name": "Mobile Malware Protection Policy", "item": [ { "name": "Mobile Malware Protection Resource Get Mobile Malware Protection Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/mobileAdvanceThreatSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "mobileAdvanceThreatSettings" ] }, "description": "Retrieves all the rules in the Mobile Malware Protection policy. ." }, "response": [] }, { "name": "Mobile Malware Protection Resource Update Mobile Malware Protection Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/mobileAdvanceThreatSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "mobileAdvanceThreatSettings" ] }, "description": "Updates the Mobile Malware Protection rule information. ." }, "response": [] } ] }, { "name": "NAT Control Policy", "item": [ { "name": "Dnat Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnatRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnatRules" ] }, "description": "Retrieves a list of all configured and predefined DNAT Control policies. ." }, "response": [] }, { "name": "Dnat Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnatRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnatRules" ] }, "description": "Adds a new DNAT Control policy rule. ." }, "response": [] }, { "name": "Dnat Rule Resource Update Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnatRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnatRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "Retrieves the DNAT Control policy rule information based on the specified ID" }, "response": [] }, { "name": "Dnat Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnatRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnatRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "Updates the DNAT Control policy rule information based on the specified ID" }, "response": [] }, { "name": "Dnat Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dnatRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dnatRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the policy rule" } ] }, "description": "Deletes the DNAT Control policy rule information based on the specified ID" }, "response": [] } ] }, { "name": "Organization Details", "item": [ { "name": "Organization Information Resource Get Organization Information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/orgInformation", "host": [ "{{ZIABaseUrl}}" ], "path": [ "orgInformation" ] }, "description": "

    Retrieves detailed organization information, including headquarter location, geolocation, address, and contact details.

    " }, "response": [] }, { "name": "Organization Information Resource Get Organization Information Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/orgInformation/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "orgInformation", "lite" ] }, "description": "

    Retrieves minimal organization information.

    " }, "response": [] }, { "name": "Subscriptions Resource Get Org Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/subscriptions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "subscriptions" ] }, "description": "Retrieves information about the list of subscriptions enabled for your tenant. Subscriptions define the various features and levels of functionality that are available to your organization. " }, "response": [] } ] }, { "name": "Outbound Email DLP Policy", "item": [ { "name": "Email DLP Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules" ], "query": [ { "key": "orgId", "value": "", "description": "The unique identifier for the organization.", "disabled": true } ] }, "description": "Retrieves the list of all Outbound Email DLP rules. You can filter the results based on rule attributes." }, "response": [] }, { "name": "Email DLP Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules" ] }, "description": "Creates a new Outbound Email DLP rule. To learn more, see Configuring Outbound Email DLP Policy Rules." }, "response": [] }, { "name": "Email DLP Rule Resource Get Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules", "lite" ] }, "description": "Gets the list of all Outbound Email DLP rules with limited information about each rule. To get complete rule details, use the GET /emailDlpRules request." }, "response": [] }, { "name": "Email DLP Rule Resource Get Email DLP Policy Actions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules/actions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules", "actions" ], "query": [ { "key": "tenantIds", "value": "", "description": "A set of unique identifiers for the email tenant applications", "disabled": false } ] }, "description": "Retrieves a mapping of supported Outbound Email DLP rule actions for the specified email tenant applications in a CSV file" }, "response": [] }, { "name": "Email DLP Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Retrieves information about an Outbound Email DLP rule based on the specified rule ID" }, "response": [] }, { "name": "Email DLP Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Updates information for an existing Outbound Email DLP rule. To learn more, see Configuring Outbound Email DLP Policy Rules" }, "response": [] }, { "name": "Email DLP Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/emailDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "emailDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the rule" } ] }, "description": "Deletes an Outbound Email DLP rule based on the specified rule ID" }, "response": [] } ] }, { "name": "PAC Files", "item": [ { "name": "Pac Resource Get Pacs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles" ], "query": [ { "key": "search", "value": "", "description": "Returns PAC files with the names that match the search criteria", "disabled": true }, { "key": "filter", "value": "", "description": "Retrieves the list of PAC files without the PAC file content in the response", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100.", "disabled": true } ] }, "description": "

    Retrieves the list of all PAC files which are in deployed state. This list includes default and custom PAC files. To learn more, see About Hosted PAC Files.

    " }, "response": [] }, { "name": "Pac Resource Add Pac", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles" ] }, "description": "

    Adds a new custom PAC file. To learn more about PAC file configuration, see Using Custom PAC Files to Forward Traffic to ZIA and Writing a PAC File.

    Note: Before adding a new PAC file, you can validate the content of the PAC file by sending a POST request to /pacFiles/validate. This request only adds a PAC file. The PAC file needs to be transitioned to the Deploy state in order for the file to be deployed.

    " }, "response": [] }, { "name": "Pac Resource Validate Pac", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/validate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", "validate" ] }, "description": "Sends the PAC file content for validation and returns the validation result. To learn more, see Using Custom PAC Files to Forward Traffic to ZIA. " }, "response": [] }, { "name": "Pac Resource Delete Pac", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/:pacId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", ":pacId" ], "variable": [ { "key": "pacId", "value": "", "description": "Specifies the ID of the PAC file" } ] }, "description": "Deletes an existing PAC file including all of its versions based on the specified ID" }, "response": [] }, { "name": "Pac Resource Get Pac By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/:pacId/version", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", ":pacId", "version" ], "query": [ { "key": "filter", "value": "", "description": "Excludes specific information about the PAC file from the response such as the PAC file content", "disabled": true } ], "variable": [ { "key": "pacId", "value": "", "description": "Specifies the ID of the PAC file" } ] }, "description": "Retrieves all versions of a PAC file based on the specified ID" }, "response": [] }, { "name": "Pac Resource Add Pac Version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/:pacId/version/:clonedPacVersion", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", ":pacId", "version", ":clonedPacVersion" ], "query": [ { "key": "deleteVersion", "value": "", "description": "Currently, only 10 versions of a PAC file are supported. If this limit is reached and if you are adding a new version using the POST /pacFiles/{pacId}/version/{clonedPacVersion} endpoint, the deleteVersion parameter can be used to specify the PAC file version that must be replaced with the new version created using this request. However, if the limit is reached and if a version is not specified using this parameter, the version with the least number is automatically replaced. If the limit is not reached, this parameter is ignored.", "disabled": true } ], "variable": [ { "key": "pacId", "value": "", "description": "Specifies the ID of the PAC file for which a new version needs to be created" }, { "key": "clonedPacVersion", "value": "", "description": "Specifies the PAC file version that needs to be branched" } ] }, "description": "Adds a new PAC file version by branching an existing version based on the specified ID. To learn more, see Using Custom PAC Files to Forward Traffic to ZIA." }, "response": [] }, { "name": "Pac Resource Get Pac Version", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/:pacId/version/:pacVersion", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", ":pacId", "version", ":pacVersion" ], "query": [ { "key": "filter", "value": "", "description": "Excludes specific information about the PAC file from the response such as the PAC file content", "disabled": true } ], "variable": [ { "key": "pacId", "value": "", "description": "Specifies the ID of the PAC file" }, { "key": "pacVersion", "value": "", "description": "Specifies the version of the PAC file" } ] }, "description": "Retrieves a specific version of a PAC file based on the specified ID" }, "response": [] }, { "name": "Pac Resource Update Pac Version Flag", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/pacFiles/:pacId/version/:pacVersion/action/:pacVersionAction", "host": [ "{{ZIABaseUrl}}" ], "path": [ "pacFiles", ":pacId", "version", ":pacVersion", "action", ":pacVersionAction" ], "query": [ { "key": "newLKGVer", "value": "", "description": "If you are removing a PAC file version as the last known good version using this request, you need to specify a different version that can be marked as the last known good version.", "disabled": true } ], "variable": [ { "key": "pacId", "value": "", "description": "Specifies the ID of the PAC file" }, { "key": "pacVersion", "value": "", "description": "Specifies the version of the PAC file" }, { "key": "pacVersionAction", "value": "", "description": "Specifies the action that must be performed on the PAC file version" } ] }, "description": "Performs the specified action on the PAC file version and updates the file status. Supported actions include deploying, staging, unstaging, and marking or unmarking the file as last known good version can be performed on PAC file versions." }, "response": [] } ] }, { "name": "Partner Integrations", "item": [ { "name": "Integration Partner Resource Get Partners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners" ], "query": [ { "key": "apiKeyProvisioned", "value": "", "description": "Filters the partners list based on the provisioned API key", "disabled": true }, { "key": "partnerType", "value": "", "description": "Filters the partners list based on the partner type", "disabled": true } ] }, "description": "Retrieves a list of partners and services integrated with the Zscaler service. To learn more, see About Partner Integrations." }, "response": [] }, { "name": "Integration Partner Resource Get Ioc Observed Devices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners/crowdStrike/endpoints", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners", "crowdStrike", "endpoints" ], "query": [ { "key": "type", "value": "", "description": "Filters based on the IOC type", "disabled": true }, { "key": "value", "value": "", "description": "Filters based on the IOC value", "disabled": true }, { "key": "limit", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "offset", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "partnerJsonType", "value": "", "description": "Filters based on the partner JSON type", "disabled": true } ] }, "description": "Retrieves the list of CrowdStrike endpoints based on the indicator of compromise (IOC) query, with pagination support. To learn more, see Viewing the CrowdStrike Endpoint Hits Report." }, "response": [] }, { "name": "Integration Partner Resource Crowd Strike End Points", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners/crowdStrike/endpoints", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners", "crowdStrike", "endpoints" ], "query": [ { "key": "partnerJsonType", "value": "", "description": "Filters based on the partner JSON type", "disabled": true } ] }, "description": "Accepts a list of CrowdStrike endpoint or device IDs in the request body and fetches detailed endpoint or device data for those IDs. To learn more, see Integrating with CrowdStrike." }, "response": [] }, { "name": "Integration Partner Resource Get Crowd Strike Whietlisted Domains", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners/crowdStrike/whitelistedBaseUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners", "crowdStrike", "whitelistedBaseUrls" ], "query": [ { "key": "partnerJsonType", "value": "", "description": "Filters based on the partner JSON type", "disabled": true } ] }, "description": "Retrieves a list of CrowdStrike configured whitelisted base URLs (allowist URLs)." }, "response": [] }, { "name": "Integration Partner Resource Get Microsoft Defender Transactions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners/microsoftDefender/endpoints", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners", "microsoftDefender", "endpoints" ] }, "description": "Configures the integration of Microsoft Defender for Endpoint APIs with Zscaler. To learn more, see Integrating with Microsoft Defender for Endpoint." }, "response": [] }, { "name": "Integration Partner Resource Get Md5detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/integrationPartners/sandbox/report/:md5", "host": [ "{{ZIABaseUrl}}" ], "path": [ "integrationPartners", "sandbox", "report", ":md5" ], "variable": [ { "key": "md5", "value": "", "description": "Filters the Sandbox report based on the MD5 hash of the file" } ] }, "description": "Retrieves the MD5 hash of the file required to view the Sandbox Detail Report. To learn more, see Viewing Sandbox Reports and Data." }, "response": [] } ] }, { "name": "Policy Export", "item": [ { "name": "Export Policy Resource Get Policies", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/exportPolicies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "exportPolicies" ] }, "description": "

    Exports the specified policies to a ZIP file. This API request supports exporting a wide range of policy types, and you can view the list of supported policy types in the Enum list included in the request's body parameter.

    The API response is one ZIP file containing JSON representation of the exported policies. One JSON file is created for each policy type specified in the request input. For example, if the request body specifies three policy types, such as FIREWALL, BA, and URL_FILTERING, the API response is exported as one ZIP file containing three JSON files, one for each policy type, named firewall.json, ba.json, and url_filtering.json.

    " }, "response": [] } ] }, { "name": "Remote Assistance Support", "item": [ { "name": "Remote Assistance Resource Get Remote Assistance Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/remoteAssistance", "host": [ "{{ZIABaseUrl}}" ], "path": [ "remoteAssistance" ] }, "description": "

    Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal. Using this option, you can allow Zscaler Support to access your organization’s ZIA Admin Portal for a specified time period to troubleshoot issues. To learn more, see Enabling Remote Assistance.

    " }, "response": [] }, { "name": "Remote Assistance Resource Set Remote Assistance Info", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/remoteAssistance", "host": [ "{{ZIABaseUrl}}" ], "path": [ "remoteAssistance" ] }, "description": "

    Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal. Using this option, you can allow Zscaler Support to access your organization’s ZIA Admin Portal for a specified time period to troubleshoot issues. To learn more, see Enabling Remote Assistance.

    " }, "response": [] } ] }, { "name": "Root Certificates", "item": [ { "name": "Root Certificate Resource Get Certs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/rootCertificates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "rootCertificates" ], "query": [ { "key": "certTypes", "value": "", "description": "The type of root certificate", "disabled": true } ] }, "description": "Retrieves a list of all configured root certificates for third-party proxy-chaining services and isolation profiles. To learn more, see About Root Certificates." }, "response": [] }, { "name": "Root Certificate Resource Create Root Certificate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/rootCertificates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "rootCertificates" ] }, "description": "Adds a custom root certificate for a third-party proxy-chaining service or isolation profile. To learn more, see Adding Root Certificates." }, "response": [] }, { "name": "Root Certificate Resource Show Cert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/rootCertificates/certDetail/:rootCertId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "rootCertificates", "certDetail", ":rootCertId" ], "query": [ { "key": "certTypes", "value": "", "description": "The type of root certificate", "disabled": true } ], "variable": [ { "key": "rootCertId", "value": "", "description": "Unique identifier for the root certificate" } ] }, "description": "Retrieves the root certificate for third-party proxy-chaining services or isolation profiles based on the specified root certificate ID" }, "response": [] }, { "name": "Root Certificate Resource Update Root Certificate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/rootCertificates/:rootCertId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "rootCertificates", ":rootCertId" ], "variable": [ { "key": "rootCertId", "value": "", "description": "Unique identifier for the root certificate" } ] }, "description": "Updates the root certificate based on the specified root certificate ID" }, "response": [] }, { "name": "Root Certificate Resource Delete Cert", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/rootCertificates/:rootCertId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "rootCertificates", ":rootCertId" ], "query": [ { "key": "certTypes", "value": "", "description": "The type of root certificate", "disabled": true } ], "variable": [ { "key": "rootCertId", "value": "", "description": "Unique identifier for the root certificate" } ] }, "description": "Deletes the root certificate based on the specified root certificate ID" }, "response": [] } ] }, { "name": "Rule Labels", "item": [ { "name": "Rule Label Resource Get Rule Labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets a list of rule labels. To learn more, see About Rule Labels." }, "response": [] }, { "name": "Rule Label Resource Add Rule Label", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels" ] }, "description": "Adds a rule label." }, "response": [] }, { "name": "Rule Label Resource Get Rule Label Via Rule Type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels/ruleType/:ruleType", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels", "ruleType", ":ruleType" ], "variable": [ { "key": "ruleType", "value": "", "description": "Specifies the rule type" } ] }, "description": "Retrieves a list of rule labels based on the specified rule type" }, "response": [] }, { "name": "Rule Label Resource Get Rule Label By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels/:ruleLabelId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels", ":ruleLabelId" ], "variable": [ { "key": "ruleLabelId", "value": "", "description": "The unique identifier for the rule label." } ] }, "description": "Gets rule label information for the specified ID." }, "response": [] }, { "name": "Rule Label Resource Update Rule Label", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels/:ruleLabelId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels", ":ruleLabelId" ], "variable": [ { "key": "ruleLabelId", "value": "", "description": "The unique identifier for the rule label." } ] }, "description": "Updates rule label information for the specified ID." }, "response": [] }, { "name": "Rule Label Resource Delete Rule Label", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ruleLabels/:ruleLabelId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ruleLabels", ":ruleLabelId" ], "variable": [ { "key": "ruleLabelId", "value": "", "description": "The unique identifier for the rule label." } ] }, "description": "Deletes the rule label for the specified ID." }, "response": [] } ] }, { "name": "SaaS Security API", "item": [ { "name": "CASB DLP Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules" ], "query": [ { "key": "ruleType", "value": "", "description": "Specifies the DLP rule type", "disabled": true } ] }, "description": "Retrieves the SaaS Security Data at Rest Scanning Data Loss Prevention (DLP) rules based on the specified rule type. ." }, "response": [] }, { "name": "CASB DLP Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules" ] }, "description": "Adds a new SaaS Security Data at Rest Scanning DLP rule. ." }, "response": [] }, { "name": "CASB DLP Rule Resource Get All DLP Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules/all", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules", "all" ] }, "description": "Retrieves all the SaaS Security Data at Rest Scanning DLP rules" }, "response": [] }, { "name": "CASB DLP Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules", ":ruleId" ], "query": [ { "key": "ruleType", "value": "", "description": "Rule type", "disabled": true } ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Retrieves the SaaS Security Data at Rest Scanning DLP rule based on the specified ID" }, "response": [] }, { "name": "CASB DLP Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Updates the SaaS Security Data at Rest Scanning DLP rule based on the specified ID" }, "response": [] }, { "name": "CASB DLP Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbDlpRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbDlpRules", ":ruleId" ], "query": [ { "key": "ruleType", "value": "", "description": "Rule type", "disabled": true } ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Deletes the SaaS Security Data at Rest Scanning DLP rule based on the specified ID" }, "response": [] }, { "name": "CASB Malware Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules" ], "query": [ { "key": "ruleType", "value": "", "description": "Rule type", "disabled": true } ] }, "description": "Retrieves the SaaS Security Data at Rest Scanning Malware Detection rules based on the specified rule type. ." }, "response": [] }, { "name": "CASB Malware Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules" ] }, "description": "Adds a new SaaS Security Data at Rest Scanning Malware Detection rule. ." }, "response": [] }, { "name": "CASB Malware Rule Resource Get All Malware Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules/all", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules", "all" ] }, "description": "Retrieves all the SaaS Security Data at Rest Scanning Malware Detection rules" }, "response": [] }, { "name": "CASB Malware Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules", ":ruleId" ], "query": [ { "key": "ruleType", "value": "", "description": "Rule type", "disabled": true } ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Retrieves the SaaS Security Data at Rest Scanning Malware Detection rule based on the specified ID" }, "response": [] }, { "name": "CASB Malware Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Updates the SaaS Security Data at Rest Scanning Malware Detection rule based on the specified ID" }, "response": [] }, { "name": "CASB Malware Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbMalwareRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbMalwareRules", ":ruleId" ], "query": [ { "key": "ruleType", "value": "", "description": "Rule type", "disabled": true } ], "variable": [ { "key": "ruleId", "value": "", "description": "Rule ID" } ] }, "description": "Deletes the SaaS Security Data at Rest Scanning Malware Detection rule based on the specified ID" }, "response": [] }, { "name": "Domain Profile Resource Get Domain Profiles Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/domainProfiles/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "domainProfiles", "lite" ] }, "description": "Retrieves the domain profile summary. To learn more about domain profiles, navigate to the 'Domain Profiles' section from ." }, "response": [] }, { "name": "Quarantine Tombstone File Template Resource Get Qtn Tombstone File Templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/quarantineTombstoneTemplate/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "quarantineTombstoneTemplate", "lite" ] }, "description": "Retrieves the templates for the tombstone file created when a file is quarantined. ." }, "response": [] }, { "name": "CASB Email Label Resource Get CASB Email Labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbEmailLabel/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbEmailLabel", "lite" ] }, "description": "Retrieves the email labels generated for the SaaS Security API policies in a user's email account. ." }, "response": [] }, { "name": "Cloud Application Tenant Resource Get Tags For Rule Association", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbTenant/:tenantId/tags/policy", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbTenant", ":tenantId", "tags", "policy" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ], "variable": [ { "key": "tenantId", "value": "", "description": "SaaS application tenant ID" } ] }, "description": "Retrieves the tags used in the policy rules associated with a tenant, based on the tenant ID." }, "response": [] }, { "name": "Cloud Application Tenant Resource Get Org Cloud App Tenants Without Policy Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbTenant/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbTenant", "lite" ], "query": [ { "key": "activeOnly", "value": "", "description": "Indicates that the tenant is in use. Policies are enforced for this SaaS application.", "disabled": true }, { "key": "includeDeleted", "value": "", "description": "", "disabled": true }, { "key": "appType", "value": "", "description": "Specifies the SaaS application type", "disabled": true }, { "key": "app", "value": "", "description": "Specifies the sanctioned SaaS application", "disabled": true }, { "key": "scanConfigTenantsOnly", "value": "", "description": "Specifies the tenant for which the scan is already configured", "disabled": true }, { "key": "includeBucketReadyS3Tenants", "value": "", "description": "For the AWS S3 SaaS application, this parameter indicates that the buckets have been read and are ready for use in policies and scan configurations.", "disabled": true }, { "key": "filterByFeature", "value": "", "description": "Filters the SaaS application tenant by feature", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves information about the SaaS application tenant. ." }, "response": [] }, { "name": "Cloud Application Tenant Resource Get Scan Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbTenant/scanInfo", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbTenant", "scanInfo" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves the SaaS Security Scan Configuration information. ." }, "response": [] }, { "name": "Cloud Application Tenant Resource Validate Tenant Cred Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/casbTenant/validate/status/:tenantId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "casbTenant", "validate", "status", ":tenantId" ], "variable": [ { "key": "tenantId", "value": "", "description": "SaaS application tenant ID" } ] }, "description": "Retrieves the validation status of the SaaS application tenant based on the tenant ID" }, "response": [] } ] }, { "name": "Sandbox Policy & Settings", "item": [ { "name": "Ba Rule Resource Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandboxRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandboxRules" ] }, "description": "Retrieves the list of all Sandbox policy rules configured in the ZIA Admin Portal. To learn more, see About Sandbox." }, "response": [] }, { "name": "Ba Rule Resource Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandboxRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandboxRules" ] }, "description": "Adds a Sandbox policy rule. To learn more, see Configuring the Sandbox Policy." }, "response": [] }, { "name": "Ba Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandboxRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandboxRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier of the Sandbox policy rule" } ] }, "description": "Retrieves the Sandbox policy rule information based on the specified ID" }, "response": [] }, { "name": "Ba Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandboxRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandboxRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier of the Sandbox policy rule" } ] }, "description": "Updates the Sandbox policy rule configuration for the specified ID" }, "response": [] }, { "name": "Ba Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandboxRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandboxRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier of the Sandbox policy rule" } ] }, "description": "Deletes the Sandbox policy rule based on the specified ID" }, "response": [] }, { "name": "Ba Advanced Settings Resource Get Custom File Hash", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/behavioralAnalysisAdvancedSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "behavioralAnalysisAdvancedSettings" ] }, "description": "

    Gets the custom list of MD5 file hashes that are blocked by Sandbox

    " }, "response": [] }, { "name": "Ba Advanced Settings Resource Update Custom File Hash", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/behavioralAnalysisAdvancedSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "behavioralAnalysisAdvancedSettings" ] }, "description": "

    Updates the custom list of MD5 file hashes that are blocked by Sandbox. This overwrites a previously generated blocklist. If you need to completely erase the blocklist, submit an empty list.

    Note: Only the file types that are supported by Sandbox analysis can be blocked using MD5 hashes.

    " }, "response": [] }, { "name": "Ba Advanced Settings Resource Get Custom File Hash Quota", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/behavioralAnalysisAdvancedSettings/fileHashCount", "host": [ "{{ZIABaseUrl}}" ], "path": [ "behavioralAnalysisAdvancedSettings", "fileHashCount" ] }, "description": "

    Gets the used and unused quota for blocking MD5 file hashes with Sandbox

    " }, "response": [] } ] }, { "name": "Sandbox Report", "item": [ { "name": "Get Verdict Report Quota Usage Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandbox/report/quota", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandbox", "report", "quota" ] }, "description": "

    The resource access quota for retrieving Sandbox Detail Reports is restricted to 3,000 requests per day, with a rate limit of 2/sec and 1,000/hour. Use GET /sandbox/report/quota to retrieve details regarding your organization's daily Sandbox API resource usage (i.e., used quota, unused quota).

    \n" }, "response": [] }, { "name": "Get Verdict Report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sandbox/report/:md5Hash", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sandbox", "report", ":md5Hash" ], "query": [ { "key": "details", "value": "", "description": "Type of report, full or summary.", "disabled": true } ], "variable": [ { "key": "md5Hash", "value": "", "description": "MD5 hash of the file that was analyzed by Sandbox." } ] }, "description": "

    Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox. To view a full summary report response example, as well as possible enum values for various Sandbox Report attributes, see Sandbox Report Use Cases.

    \n" }, "response": [] } ] }, { "name": "Secure Browsing", "item": [ { "name": "Browser Control Settings Resource Get Supported Browser Versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/browserControlSettings/supportedBrowserVersions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "browserControlSettings", "supportedBrowserVersions" ] }, "description": "Retrieves a list of all supported browsers and their versions. To learn more, see Configuring the Browser Control Policy." }, "response": [] }, { "name": "Browser Control Settings Resource Update Smart Isolation", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/browserControlSettings/smartIsolation", "host": [ "{{ZIABaseUrl}}" ], "path": [ "browserControlSettings", "smartIsolation" ] }, "description": "Updates the Smart Browser Isolation policy settings. To learn more, see Configuring Smart Browser Isolation Policy." }, "response": [] }, { "name": "Browser Control Settings Resource Get Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/browserControlSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "browserControlSettings" ] }, "description": "Retrieves the Browser Control status and the list of configured browsers in the Browser Control policy" }, "response": [] }, { "name": "Browser Control Settings Resource Update Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/browserControlSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "browserControlSettings" ] }, "description": "Updates the Browser Control settings. ." }, "response": [] } ] }, { "name": "Security & UEBA Alerts", "item": [ { "name": "Alert Definition Resource Get Alert Definitions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertDefinitions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertDefinitions" ] }, "description": "Retrieves a list of all configured alert definitions for the organization" }, "response": [] }, { "name": "Alert Definition Resource Add Alert Definition", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertDefinitions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertDefinitions" ] }, "description": "Adds an alert definition. To learn more, see Configuring an Alert Rule." }, "response": [] }, { "name": "Alert Definition Resource Get Alert Definition", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertDefinitions/:alertDefinitionId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertDefinitions", ":alertDefinitionId" ], "variable": [ { "key": "alertDefinitionId", "value": "", "description": "The alert definition ID" } ] }, "description": "Retrieves the alert definition information based on the specified ID" }, "response": [] }, { "name": "Alert Definition Resource Update Alert Definition", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertDefinitions/:alertDefinitionId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertDefinitions", ":alertDefinitionId" ], "variable": [ { "key": "alertDefinitionId", "value": "", "description": "The alert definition ID" } ] }, "description": "Updates an existing alert definition based on the specified ID" }, "response": [] }, { "name": "Alert Definition Resource Delete Alert Definition", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertDefinitions/:alertDefinitionId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertDefinitions", ":alertDefinitionId" ], "variable": [ { "key": "alertDefinitionId", "value": "", "description": "The alert definition ID" } ] }, "description": "Deletes an alert definition based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Get All Security Alert Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules" ] }, "description": "Retrieves a list of all configured Security alert rules for the organization. To learn more, see About Security & UEBA Alerts." }, "response": [] }, { "name": "Alert Rule Configuration Resource Create Alert Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules" ] }, "description": "Adds a new Security alert rule. To learn more, go to For Security Alerts from Configuring an Alert Rule." }, "response": [] }, { "name": "Alert Rule Configuration Resource Get Alert Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Alert rule ID" } ] }, "description": "Retrieves the Security alert rule information based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the Security alert rule" } ] }, "description": "Updates an existing Security alert rule based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Delete Rules", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the Security alert rule" } ] }, "description": "Deletes a Security alert rule based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Get Rule Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/rules/rulestatus", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "rules", "rulestatus" ] }, "description": "Retrieves the statuses of all alert rules for an organization" }, "response": [] }, { "name": "Alert Rule Configuration Resource Get All Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/uebaRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "uebaRules" ] }, "description": "Retrieves a list of all configured User and Entity Behavior Analytics (UEBA) alert rules. To learn more, go to UEBA Alerts from About Security & UEBA Alerts." }, "response": [] }, { "name": "Alert Rule Configuration Resource Create Ueba Alert Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/uebaRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "uebaRules" ] }, "description": "Adds a new UEBA alert rule. To learn more, go to For UEBA Alerts from Configuring an Alert Rule" }, "response": [] }, { "name": "Alert Rule Configuration Resource Get Ueba Alert Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/uebaRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "uebaRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Alert rule ID" } ] }, "description": "Retrieves information about UEBA alert rule based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Update Ueba Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/uebaRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "uebaRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the UEBA alert rule" } ] }, "description": "Updates an existing UEBA alert rule based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Delete Ueba Rules", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/uebaRules/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "uebaRules", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the UEBA alert rule" } ] }, "description": "Deletes a UEBA alert rule based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Get All Webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/webhooks", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "webhooks" ] }, "description": "Retrieves a list of all configured webhooks for an organization. To learn more, see About Webhooks." }, "response": [] }, { "name": "Alert Rule Configuration Resource Create Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/webhooks", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "webhooks" ] }, "description": "Adds a new webhook for alert notifications. To learn more, see Adding a Webhook." }, "response": [] }, { "name": "Alert Rule Configuration Resource Update Webhook", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/webhooks/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Webhook ID" } ] }, "description": "Updates an existing webhook based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Delete Webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/webhooks/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Webhook ID" } ] }, "description": "Deletes a webhook based on the specified ID" }, "response": [] }, { "name": "Alert Rule Configuration Resource Test Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/alertRuleConfiguration/webhooks/test", "host": [ "{{ZIABaseUrl}}" ], "path": [ "alertRuleConfiguration", "webhooks", "test" ] }, "description": "Tests a webhook configuration by sending a sample notification. Any non-2xx HTTP response from this webhook endpoint is treated as a failure, and redirects are not followed." }, "response": [] } ] }, { "name": "Security Policy Settings", "item": [ { "name": "Get Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/security", "host": [ "{{ZIABaseUrl}}" ], "path": [ "security" ] }, "description": "

    Gets a list of URLs that are on the allowlist.

    \n" }, "response": [] }, { "name": "Create Whitelist", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/security", "host": [ "{{ZIABaseUrl}}" ], "path": [ "security" ] }, "description": "

    Updates the list of URLs on the allowlist. This overwrites a previously-generated allowlist. If you need to completely erase the allowlist, submit an empty list.

    \n" }, "response": [] }, { "name": "Get Advanced Policy", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/security/advanced", "host": [ "{{ZIABaseUrl}}" ], "path": [ "security", "advanced" ] }, "description": "

    Gets a list of URLs that are on the denylist.

    \n" }, "response": [] }, { "name": "Manage Blacklist", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/security/advanced", "host": [ "{{ZIABaseUrl}}" ], "path": [ "security", "advanced" ] }, "description": "

    Updates the list of URLs that are on the denylist. This overwrites a previously-generated denylist. If you need to completely erase the denylist, submit an empty list.

    \n" }, "response": [] }, { "name": "Update Blacklist Ur Ls", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/security/advanced/blacklistUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "security", "advanced", "blacklistUrls" ], "query": [ { "key": "action", "value": "", "description": "The action applied to the Advanced Threat Protection policy’s denylist (i.e., adding a URL or removing a URL).", "disabled": false } ] }, "description": "

    Adds a URL to or removes a URL from the denylist. To add a URL to the denylist, set the action parameter to ADD_TO_LIST. To remove a URL, set action to REMOVE_FROM_LIST.

    \n" }, "response": [] } ] }, { "name": "Service Edges", "item": [ { "name": "Virtual Zen Node Resource Get Virtual Zen Nodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenNodes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenNodes" ], "query": [ { "key": "search", "value": "", "description": "Search for a configured Virtual Service Edge", "disabled": true } ] }, "description": "Retrieves the ZIA Virtual Service Edge for an organization. ." }, "response": [] }, { "name": "Virtual Zen Node Resource Add Virtual Zen Node", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenNodes", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenNodes" ] }, "description": "Adds a ZIA Virtual Service Edge for an organization. ." }, "response": [] }, { "name": "Virtual Zen Node Resource Get Virtual Zen Node", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenNodes/:virtualZenNodeId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenNodes", ":virtualZenNodeId" ], "variable": [ { "key": "virtualZenNodeId", "value": "", "description": "The Virtual Service Edge ID" } ] }, "description": "Retrieves the ZIA Virtual Service Edge for an organization based on the specified ID" }, "response": [] }, { "name": "Virtual Zen Node Resource Update Virtual Zen Node", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenNodes/:virtualZenNodeId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenNodes", ":virtualZenNodeId" ], "variable": [ { "key": "virtualZenNodeId", "value": "", "description": "The Virtual Service Edge ID" } ] }, "description": "Updates the ZIA Virtual Service Edge for an organization based on the specified ID" }, "response": [] }, { "name": "Virtual Zen Node Resource Delete Virtual Zen Node", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenNodes/:virtualZenNodeId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenNodes", ":virtualZenNodeId" ], "variable": [ { "key": "virtualZenNodeId", "value": "", "description": "The Virtual Service Edge ID" } ] }, "description": "Deletes the ZIA Virtual Service Edge for an organization based on the specified ID" }, "response": [] }, { "name": "Virtual Zen Cluster Resource Get Virtual Zen Clusters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenClusters", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenClusters" ], "query": [ { "key": "search", "value": "", "description": "Search for a configured Virtual Service Edge cluster", "disabled": true } ] }, "description": "Retrieves a list of ZIA Virtual Service Edge clusters. ." }, "response": [] }, { "name": "Virtual Zen Cluster Resource Add Virtual Zen Cluster", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenClusters", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenClusters" ] }, "description": "Adds a new Virtual Service Edge cluster. ." }, "response": [] }, { "name": "Virtual Zen Cluster Resource Get Virtual Zen Cluster", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenClusters/:virtualZenClusterId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenClusters", ":virtualZenClusterId" ], "variable": [ { "key": "virtualZenClusterId", "value": "", "description": "The Virtual Service Edge cluster ID" } ] }, "description": "Retrieves the Virtual Service Edge cluster based on the specified ID" }, "response": [] }, { "name": "Virtual Zen Cluster Resource Update Virtual Zen Cluster", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenClusters/:virtualZenClusterId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenClusters", ":virtualZenClusterId" ], "variable": [ { "key": "virtualZenClusterId", "value": "", "description": "The Virtual Service Edge cluster ID" } ] }, "description": "Updates the Virtual Service Edge cluster based on the specified ID" }, "response": [] }, { "name": "Virtual Zen Cluster Resource Delete Virtual Zen Cluster", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/virtualZenClusters/:virtualZenClusterId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "virtualZenClusters", ":virtualZenClusterId" ], "variable": [ { "key": "virtualZenClusterId", "value": "", "description": "The Virtual Service Edge cluster ID" } ] }, "description": "Deletes the Virtual Service Edge cluster based on the specified ID" }, "response": [] } ] }, { "name": "Shadow IT Report", "item": [ { "name": "Cloud Applications Resource Bulk Update Cloud Application", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplications/bulkUpdate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplications", "bulkUpdate" ] }, "description": "Updates application status and tag information for predefined or custom cloud applications based on the IDs specified" }, "response": [] }, { "name": "Cloud Applications Resource Get Cloud Applications Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/cloudApplications/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "cloudApplications", "lite" ], "query": [ { "key": "pageNumber", "value": "", "description": "Specifies the page number. The numbering starts at 0.", "disabled": true }, { "key": "limit", "value": "", "description": "Specifies the maximum number of cloud applications that must be retrieved in a page", "disabled": true } ] }, "description": "Gets the list of predefined and custom cloud applications" }, "response": [] }, { "name": "Custom Tag Resource Get All Custom Tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/customTags", "host": [ "{{ZIABaseUrl}}" ], "path": [ "customTags" ] }, "description": "Gets the list of custom tags available to assign to cloud applications" }, "response": [] }, { "name": "Shadow It Report Resource Get Report Data Applications Export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/shadowIT/applications/export", "host": [ "{{ZIABaseUrl}}" ], "path": [ "shadowIT", "applications", "export" ] }, "description": "

    Export the Shadow IT Report (in CSV format) for the cloud applications recognized by Zscaler based on their usage in your organization. This report lists cloud applications along with a number of parameters including the sanction status for each application, the risk index assigned for the application, application usage details, application hosting information, and application security-related information, such as SSL certificate validity, data encryption (in transit), security certifications, published CVE, involvement in data breaches, etc.

    You can generate this report for specific applications by using the application parameter. If no value is specified for this parameter, the report is generated for all cloud applications. You can customize the report by using various filters to show only the cloud applications that match specific parameters. To learn more, see About Shadow IT Report.

    " }, "response": [] }, { "name": "Shadow It Report Resource Get Report Transactions Export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/shadowIT/applications/:entity/exportCsv", "host": [ "{{ZIABaseUrl}}" ], "path": [ "shadowIT", "applications", ":entity", "exportCsv" ], "variable": [ { "key": "entity", "value": "", "description": "

    Indicates whether the Shadow IT Report must be generated to retrieve the list of users who have interacted with a cloud application or the known locations where the cloud application is accessed

    " } ] }, "description": "

    Export the Shadow IT Report (in CSV format) for the list of users or known locations identified with using the cloud applications specified in the request. This report includes information about each user who has interacted with the application or the known location from where the application is accessed, application category, application usage details, the number of transactions made, last accessed time, etc.

    You can customize the report per your requirements by using various filters. To learn more, see About Application Information.

    " }, "response": [] } ] }, { "name": "SMPC Instance", "item": [ { "name": "Smpc Instance Resource Get Smpc Instance Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/smpcInstance", "host": [ "{{ZIABaseUrl}}" ], "path": [ "smpcInstance" ] }, "description": "Retrieves the status of all Secure Message Processing Center (SMPC) instances grouped by data center" }, "response": [] }, { "name": "Smpc Instance Resource Update Data Center Details", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/smpcInstance/dc", "host": [ "{{ZIABaseUrl}}" ], "path": [ "smpcInstance", "dc" ], "query": [ { "key": "isEnabled", "value": "", "description": "Set this field to true to enable DC isolation or false to disable it", "disabled": false } ] }, "description": "Updates the data center and instance details based on the specified data center ID" }, "response": [] } ] }, { "name": "SSL Inspection Policy", "item": [ { "name": "SSL Inspection Rule Resource Get SSL Inspection Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslInspectionRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslInspectionRules" ] }, "description": "Retrieves all SSL inspection rules" }, "response": [] }, { "name": "SSL Inspection Rule Resource Add SSL Inspection Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslInspectionRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslInspectionRules" ] }, "description": "Creates a new SSL inspection rule" }, "response": [] }, { "name": "SSL Inspection Rule Resource Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslInspectionRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslInspectionRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the SSL inspection rule" } ] }, "description": "Retrieves the SSL inspection rule based on the specified ID" }, "response": [] }, { "name": "SSL Inspection Rule Resource Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslInspectionRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslInspectionRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the SSL inspection rule" } ] }, "description": "Updates the SSL inspection rule based on the specified ID" }, "response": [] }, { "name": "SSL Inspection Rule Resource Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/sslInspectionRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "sslInspectionRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Unique identifier for the SSL inspection rule" } ] }, "description": "Deletes an existing SSL inspection rule based on the specified ID" }, "response": [] } ] }, { "name": "System Audit Report", "item": [ { "name": "Config Audit Resource Get Config Report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/configAudit", "host": [ "{{ZIABaseUrl}}" ], "path": [ "configAudit" ] }, "description": "

    Retrieves the System Audit Report. To learn more, see About the System Audit Report.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Config Audit Resource Get IP Visibility", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/configAudit/ipVisibility", "host": [ "{{ZIABaseUrl}}" ], "path": [ "configAudit", "ipVisibility" ] }, "description": "

    Retrieves the IP visibility audit report.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Config Audit Resource Get Pac File", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/configAudit/pacFile", "host": [ "{{ZIABaseUrl}}" ], "path": [ "configAudit", "pacFile" ] }, "description": "

    Retrieves the PAC file audit report.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] } ] }, { "name": "Time Intervals", "item": [ { "name": "Time Interval Resource Get Time Interval", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeIntervals", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeIntervals" ], "query": [ { "key": "search", "value": "", "description": "Search for a configured time interval", "disabled": true }, { "key": "page", "value": "", "description": "Set the page number of the response", "disabled": true }, { "key": "pageSize", "value": "", "description": "Set the size of the response", "disabled": true } ] }, "description": "Retrieves a list of all configured time intervals. ." }, "response": [] }, { "name": "Time Interval Resource Add Time Interval", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeIntervals", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeIntervals" ] }, "description": "Adds a new time interval. ." }, "response": [] }, { "name": "Time Interval Resource Get Time Interval By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeIntervals/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeIntervals", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "Unique identifier for the time interval" } ] }, "description": "Retrieves the configured time interval based on the specified ID" }, "response": [] }, { "name": "Time Interval Resource Update Time Interval", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeIntervals/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeIntervals", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "Unique identifier for the time interval" } ] }, "description": "Updates the time interval based on the specified ID" }, "response": [] } ] }, { "name": "Traffic Capture Policy", "item": [ { "name": "Traffic Capture Rules Resource Get Packet Capture Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules" ], "query": [ { "key": "ruleName", "value": "", "description": "Filter based on the rule name", "disabled": true }, { "key": "ruleLabel", "value": "", "description": "Filter based on the rule label", "disabled": true }, { "key": "ruleLabelId", "value": "", "description": "Filter based on the rule label ID", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "Filter based on the rule order", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "Filter based on the rule description", "disabled": true }, { "key": "ruleAction", "value": "", "description": "Filter based on the rule action", "disabled": true }, { "key": "location", "value": "", "description": "Filter based on the location criteria used in the rules", "disabled": true }, { "key": "department", "value": "", "description": "Filter based on the department criteria used in the rules", "disabled": true }, { "key": "group", "value": "", "description": "Filter based on the group criteria used in the rules", "disabled": true }, { "key": "user", "value": "", "description": "Filter based on the user criteria used in the rules", "disabled": true }, { "key": "device", "value": "", "description": "Filter based on the device criteria used in the rules", "disabled": true }, { "key": "deviceGroup", "value": "", "description": "Filter based on the device group criteria used in the rules", "disabled": true }, { "key": "deviceTrustLevel", "value": "", "description": "Filter based on the device trust level criteria used in the rules", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. Default size is 5,000.", "disabled": true } ] }, "description": "Retrieves the list of Traffic Capture policy rules configured in the ZIA Admin Portal. To learn more, see About Traffic Capture Policy." }, "response": [] }, { "name": "Traffic Capture Rules Resource Create Pcap Traffic Capture Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules" ] }, "description": "Creates a new Traffic Capture policy rule. To learn more about rule configuration, see Configuring the Traffic Capture Policy." }, "response": [] }, { "name": "Retrieves the rule count for Traffic Capture policy based on the specified search criteria", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", "count" ], "query": [ { "key": "ruleName", "value": "", "description": "Filter based on the rule name", "disabled": true }, { "key": "ruleLabel", "value": "", "description": "Filter based on the rule label", "disabled": true }, { "key": "ruleLabelId", "value": "", "description": "Filter based on the rule label ID", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "Filter based on the rule order", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "Filter based on the rule description", "disabled": true }, { "key": "ruleAction", "value": "", "description": "Filter based on the rule action", "disabled": true }, { "key": "location", "value": "", "description": "Filter based on the location criteria used in the rules", "disabled": true }, { "key": "department", "value": "", "description": "Filter based on the department criteria used in the rules", "disabled": true }, { "key": "group", "value": "", "description": "Filter based on the group criteria used in the rules", "disabled": true }, { "key": "user", "value": "", "description": "Filter based on the user criteria used in the rules", "disabled": true }, { "key": "device", "value": "", "description": "Filter based on the device criteria used in the rules", "disabled": true }, { "key": "deviceGroup", "value": "", "description": "Filter based on the device group criteria used in the rules", "disabled": true }, { "key": "deviceTrustLevel", "value": "", "description": "Filter based on the device trust level criteria used in the rules", "disabled": true } ] }, "description": "Retrieves the rule count for Traffic Capture policy based on the specified search criteria" }, "response": [] }, { "name": "Traffic Capture Rules Resource Get Rule Order Info Forget Traffic Capture Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/order", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", "order" ] }, "description": "Retrieves the rule order information for the Traffic Capture policy, including the admin rank and rule order mappings and the maximum configured rule order." }, "response": [] }, { "name": "Traffic Capture Rules Resource Get Rule Label Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/ruleLabels", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", "ruleLabels" ], "query": [ { "key": "searchByField", "value": "", "description": "Search option based on specific rule fields", "disabled": true }, { "key": "searchByValue", "value": "", "description": "Search option based on specified values for rule fields", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. Default size is 1024.", "disabled": true } ] }, "description": "Retrieves the list of rule labels associated with the Traffic Capture policy rules" }, "response": [] }, { "name": "Traffic Capture Rules Resource Get Traffic Capture Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Specifies the rule ID. This value can be obtained using the GET /trafficCaptureRules request." } ] }, "description": "Retrieves the Traffic Capture policy rule based on the specified rule ID" }, "response": [] }, { "name": "Traffic Capture Rules Resource Update Traffic Capture Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Specifies the rule ID. This value can be obtained using the GET /trafficCaptureRules request." } ] }, "description": "Updates information for the Traffic Capture policy rule based on the specified rule ID. To learn more about rule configuration, see Configuring the Traffic Capture Policy." }, "response": [] }, { "name": "Traffic Capture Rules Resource Delete Traffic Capture Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/trafficCaptureRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "trafficCaptureRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "Specifies the rule ID. This value can be obtained using the GET /trafficCaptureRules request." } ] }, "description": "Deletes the Traffic Capture policy rule based on the specified rule ID" }, "response": [] } ] }, { "name": "Traffic Forwarding", "item": [ { "name": "Data Center Resource Get Datacenters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/datacenters", "host": [ "{{ZIABaseUrl}}" ], "path": [ "datacenters" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Retrieves the list of Zscaler data centers (DCs) that can be excluded from service to your organization" }, "response": [] }, { "name": "Tenant Dc Exclusion Resource Get Datacenter Exclusions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dcExclusions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dcExclusions" ] }, "description": "Retrieves the list of Zscaler data centers (DCs) that are currently excluded from service to your organization based on configured exclusions in the ZIA Admin Portal" }, "response": [] }, { "name": "Tenant Dc Exclusion Resource Create Datacenter Exclusions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dcExclusions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dcExclusions" ] }, "description": "

    Adds a data center (DC) exclusion to disable the tunnels terminating at a virtual IP address of a Zscaler DC, triggering a failover from primary to secondary tunnels in the event of service disruptions, incidents, disasters, etc. You can configure to exclude a specific DC based on the traffic forwarding method for a designated time period.

    Note: Currently, only the IPSec VPN tunnel forwarding method is supported for DC exclusion. .

    " }, "response": [] }, { "name": "Tenant Dc Exclusion Resource Update Data Center Exclusions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dcExclusions", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dcExclusions" ] }, "description": "Updates a Zscaler data center (DC) exclusion configuration based on the specified ID. ." }, "response": [] }, { "name": "Tenant Dc Exclusion Resource Delete Data Centre Exclusion", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/dcExclusions/:dcId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "dcExclusions", ":dcId" ], "variable": [ { "key": "dcId", "value": "", "description": "The unique identifier for the DC exclusion configuration" } ] }, "description": "Deletes a Zscaler data center (DC) exclusion configuration based on the specified ID. The DC exclusion configuration ID can be obtained by sending a GET request to /dcExclusions." }, "response": [] }, { "name": "Tenant Sub Cloud Resource Get All Sub Clouds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/subclouds", "host": [ "{{ZIABaseUrl}}" ], "path": [ "subclouds" ], "query": [ { "key": "page", "value": "", "description": "Page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Page size", "disabled": true } ] }, "description": "Retrieves all the subclouds and the excluded data centers that are associated with the subcloud" }, "response": [] }, { "name": "Tenant Sub Cloud Resource Get Country Dc Exclusion Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/subclouds/isLastDcInCountry/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "subclouds", "isLastDcInCountry", ":id" ], "query": [ { "key": "dcId", "value": "", "description": "Data center ID", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the country" } ] }, "description": "Retrieves the list of all the excluded data centers in a country" }, "response": [] }, { "name": "Tenant Sub Cloud Resource Update Tenant Sub Cloud Exclusions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/subclouds/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "subclouds", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the excluded data center" } ] }, "description": "Updates the subcloud and excluded data centers based on the specified ID" }, "response": [] }, { "name": "Extranet Resource Get All Extranet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet" ], "query": [ { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 200.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "orderBy", "value": "", "description": "The field used to sort the list in a specific order", "disabled": true }, { "key": "order", "value": "", "description": "The arrangement of the list in ascending or descending order", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against specific extranets", "disabled": true } ] }, "description": "

    Retrieves the list of extranets configured for the organization. Extranets are configured as part of Zscaler Extranet Application Support which allows an organization to connect its internal network with another organization’s network (e.g., partners, third-party vendors, etc.) that does not use the Zscaler service. Extranet Application Support enables Zscaler-managed organization users to securely access extranet resources through an IPSec VPN tunnel established between the Zscaler data center and the external organization’s data center, without requiring additional hardware or software installations.

    To learn more, see Understanding Extranet Application Support and About Extranet.

    " }, "response": [] }, { "name": "Extranet Resource Add Extranet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet" ] }, "description": "

    Adds a new extranet for the organization. Extranets are configured as part of Zscaler Extranet Application Support which allows an organization to connect its internal network with another organization’s network (e.g., partners, third-party vendors, etc.) that does not use the Zscaler service. Extranet Application Support enables Zscaler-managed organization users to securely access extranet resources through an IPSec VPN tunnel established between the Zscaler data center and the external organization’s data center, without requiring additional hardware or software installations.

    To learn more, see Understanding Extranet Application Support and Configuring an Extranet.

    " }, "response": [] }, { "name": "Extranet Resource Update Extranet", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet" ] }, "description": "Updates an extranet based on the specified ID" }, "response": [] }, { "name": "Extranet Resource Get All Extranets Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet", "lite" ] }, "description": "Retrieves the name-ID pairs of all extranets configured for an organization" }, "response": [] }, { "name": "Extranet Resource Get Extranet With ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the extranet that can be obtained by sending a GET request to /extranet/lite or /extranet" } ] }, "description": "Retrieves information about an extranet based on the specified ID" }, "response": [] }, { "name": "Extranet Resource Delete Extranet", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/extranet/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "extranet", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the extranet that can be obtained by sending a GET request to /extranet/lite or /extranet" } ] }, "description": "Deletes an extranet based on the specified ID" }, "response": [] }, { "name": "GRE Tunnel Resource Get All GRE Tunnels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets all provisioned GRE tunnel information." }, "response": [] }, { "name": "GRE Tunnel Resource Add GRE Tunnel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels" ] }, "description": "

    Adds a GRE tunnel configuration.

    Note: Specifying withinCountryOnly or subcloud parameter is mandatory if this endpoint uses a virtual IP address (VIP) retrieved by passing either of these parameters in GET /vips/recommendedList.

    " }, "response": [] }, { "name": "GRE Tunnel Resource Validate And Get Available Internal IP Ranges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels/availableInternalIpRanges", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels", "availableInternalIpRanges" ], "query": [ { "key": "internalIpRange", "value": "", "description": "Internal IP range information.", "disabled": true }, { "key": "staticIp", "value": "", "description": "Static IP information.", "disabled": true }, { "key": "limit", "value": "", "description": "The maximum number of GRE tunnel IP ranges that can be added.", "disabled": true } ] }, "description": "Gets the next available GRE tunnel internal IP address ranges." }, "response": [] }, { "name": "GRE Tunnel Resource Get GRE Tunel By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the GRE tunnel." } ] }, "description": "Gets the GRE tunnel information for the specified ID." }, "response": [] }, { "name": "GRE Tunnel Resource Update GRE Tunnel", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the GRE tunnel." } ] }, "description": "Updates the GRE tunnel information for the specified ID." }, "response": [] }, { "name": "GRE Tunnel Resource Delete GRE Tunnel", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/greTunnels/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "greTunnels", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the GRE tunnel." } ] }, "description": "Deletes the GRE tunnel information for the specified ID." }, "response": [] }, { "name": "Ipv6 Config Resource Get Ipv6 Configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipv6config", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipv6config" ] }, "description": "

    Gets the IPv6 configuration details for the organization. For information about IPv6 support, see Understanding IPv6 Support.

    " }, "response": [] }, { "name": "Ipv6 Config Resource Get DNS64 Prefixes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipv6config/dns64prefix", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipv6config", "dns64prefix" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a DNS64 prefix’s name, description, or prefixMask attributes.", "disabled": true } ] }, "description": "

    Gets the list of NAT64 prefixes configured as the DNS64 prefix for the organization. To learn more, see About the DNS64 Prefix

    ." }, "response": [] }, { "name": "Ipv6 Config Resource Get NAT64 Prefixes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/ipv6config/nat64prefix", "host": [ "{{ZIABaseUrl}}" ], "path": [ "ipv6config", "nat64prefix" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a NAT64 prefix’s name, description, or prefixMask attributes.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100 and the maximum size is 1000.", "disabled": true } ] }, "description": "

    Gets the list of NAT64 prefixes configured for the organization. The prefix which has the dnsPrefix field set to true is identified as the DNS64 prefix. To learn more, see About NAT64 Prefixes.

    " }, "response": [] }, { "name": "Get Ipgw Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/orgProvisioning/ipGreTunnelInfo", "host": [ "{{ZIABaseUrl}}" ], "path": [ "orgProvisioning", "ipGreTunnelInfo" ], "query": [ { "key": "ipAddresses", "value": "", "description": "Filter based on an IP address range.", "disabled": true } ] }, "description": "

    Gets a list of IP addresses with GRE tunnel details.

    " }, "response": [] }, { "name": "Region Info Resource Get Region By Geo Coordinates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/region/byGeoCoordinates", "host": [ "{{ZIABaseUrl}}" ], "path": [ "region", "byGeoCoordinates" ], "query": [ { "key": "latitude", "value": "", "description": "The latitude coordinate of the city or region", "disabled": false }, { "key": "longitude", "value": "", "description": "The longitude coordinate of the city or region", "disabled": false } ] }, "description": "

    Retrieves the geographical data of the region or city that is located in the specified latitude and longitude coordinates. The geographical data includes the city name, state, country, geographical ID of the city and state, etc.

    " }, "response": [] }, { "name": "Region Info Resource Get Region By Src IP Address", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/region/byIPAddress/:ip", "host": [ "{{ZIABaseUrl}}" ], "path": [ "region", "byIPAddress", ":ip" ], "variable": [ { "key": "ip", "value": "", "description": "The IP address for which you want to retrieve the geo-location and other geographical data." } ] }, "description": "

    Retrieves information about the geo-location of the specified IP address, including the city, state, and country of location, geographical ID of the city and state, postal code, etc.

    " }, "response": [] }, { "name": "Region Info Resource Get Regions By Prefix", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/region/search", "host": [ "{{ZIABaseUrl}}" ], "path": [ "region", "search" ], "query": [ { "key": "prefix", "value": "", "description": "

    The string used in the prefix search of the city or region. The prefix can contain names of city, state, country in the following format: city name, state name, country name. A phrase for city name is mandatory, whereas the state and country names can be optionally provided to narrow down the search results.

    ", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100 and the maximum size is 1,000.", "disabled": true } ] }, "description": "

    Retrieves the list of cities (along with their geographical data) that match the prefix search. The geographical data includes the latitude and longitude coordinates of the city, geographical ID of the city and state, country, postal code, etc.

    " }, "response": [] }, { "name": "Static IP Resource Get All Static I Ps", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP" ], "query": [ { "key": "availableForGreTunnel", "value": "", "description": "Set to true to get only the static IP addresses that are not yet associated to a GRE tunnel.", "disabled": true }, { "key": "ipAddress", "value": "", "description": "Filter based on IP address", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Gets all provisioned static IP addresses." }, "response": [] }, { "name": "Static IP Resource Add Static IP", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP" ] }, "description": "Adds a static IP address." }, "response": [] }, { "name": "Static IP Resource Validate IP Address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP/validate", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP", "validate" ] }, "description": "Validates the static IP address." }, "response": [] }, { "name": "Static IP Resource Get Static IP By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the provisioned static IP address." } ] }, "description": "Gets static IP address for the specified ID" }, "response": [] }, { "name": "Static IP Resource Update Static IP", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the provisioned static IP address." } ] }, "description": "Updates the static IP address for the specified ID." }, "response": [] }, { "name": "Static IP Resource Delete Static IP", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/staticIP/:Id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "staticIP", ":Id" ], "variable": [ { "key": "Id", "value": "", "description": "The unique identifier for the provisioned static IP address." } ] }, "description": "Deletes the static IP address for the specified ID." }, "response": [] }, { "name": "Get Zscaler Nodes Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vips", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vips" ], "query": [ { "key": "dc", "value": "", "description": "Filter based on data center.", "disabled": true }, { "key": "region", "value": "", "description": "Filter based on region.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true }, { "key": "include", "value": "", "description": "Include all, private, or public VIPs in the list.", "disabled": true }, { "key": "subcloud", "value": "", "description": "Filter based on the subcloud for the VIP. To learn more see, About Subcloud.", "disabled": true } ] }, "description": "

    Gets a paginated list of the virtual IP addresses (VIPs) available in the Zscaler cloud, including region and data center information. By default, the request gets all public VIPs in the cloud, but you can also include private or all VIPs in the request, if necessary.

    \n" }, "response": [] }, { "name": "Cloud Vips Resource Get Recommended Vips Grouped By Dc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vips/groupByDatacenter", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vips", "groupByDatacenter" ], "query": [ { "key": "routableIP", "value": "", "description": "The routable IP address.", "disabled": true }, { "key": "withinCountryOnly", "value": "", "description": "Search within country only.", "disabled": true }, { "key": "includePrivateServiceEdge", "value": "", "description": "Include ZIA Private Service Edge VIPs.", "disabled": true }, { "key": "includeCurrentVips", "value": "", "description": "Include currently assigned VIPs.", "disabled": true }, { "key": "sourceIp", "value": "", "description": "The source IP address.", "disabled": true }, { "key": "latitude", "value": "", "description": "The latitude coordinate of the GRE tunnel source.", "disabled": true }, { "key": "longitude", "value": "", "description": "The longitude coordinate of the GRE tunnel source.", "disabled": true }, { "key": "subcloud", "value": "", "description": "The subcloud for the VIP. To learn more see, About Subcloud.", "disabled": true } ] }, "description": "Gets a list of recommended GRE tunnel virtual IP addresses (VIPs), grouped by data center, based on source IP address or latitude/longitude coordinates." }, "response": [] }, { "name": "Cloud Vips Resource Get Recommended GRE Vips", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vips/recommendedList", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vips", "recommendedList" ], "query": [ { "key": "routableIP", "value": "", "description": "The routable IP address.", "disabled": true }, { "key": "withinCountryOnly", "value": "", "description": "Search within country only.", "disabled": true }, { "key": "includePrivateServiceEdge", "value": "", "description": "Include ZIA Private Service Edge VIPs.", "disabled": true }, { "key": "includeCurrentVips", "value": "", "description": "Include currently assigned VIPs.", "disabled": true }, { "key": "sourceIp", "value": "", "description": "The source IP address.", "disabled": true }, { "key": "latitude", "value": "", "description": "The latitude coordinate of the GRE tunnel source.", "disabled": true }, { "key": "longitude", "value": "", "description": "The longitude coordinate of the GRE tunnel source.", "disabled": true }, { "key": "subcloud", "value": "", "description": "The subcloud for the VIP. To learn more see, About Subcloud.", "disabled": true } ] }, "description": "Gets a list of recommended GRE tunnel virtual IP addresses (VIPs), based on source IP address or latitude/longitude coordinates." }, "response": [] }, { "name": "Get VPN Credentials", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials" ], "query": [ { "key": "search", "value": "", "description": "

    The search string used to match against a VPN credential's commonName, fqdn, ipAddress, comments, or locationName attributes.

    \n", "disabled": true }, { "key": "type", "value": "", "description": "

    Only gets VPN credentials for the specified type. This parameter is not supported for partner API keys.

    \n", "disabled": true }, { "key": "includeOnlyWithoutLocation", "value": "", "description": "Include VPN credential only if not associated to any location.", "disabled": true }, { "key": "locationId", "value": "", "description": "Gets the VPN credentials for the specified location ID.", "disabled": true }, { "key": "managedBy", "value": "", "description": "

    Gets the VPN credentials that are managed by the given partner. This filter is automatically applied when called with a partner API key, and it cannot be overridden.

    ", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "

    Gets VPN credentials that can be associated to locations. To learn more, see About VPN Credentials.

    \n" }, "response": [] }, { "name": "Add VPN Credential", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials" ] }, "description": "

    Adds VPN credentials that can be associated to locations. When invoked with a partner API key, it automatically sets the managedBy attribute to the partner associated with the key. To learn more, see Adding VPN Credentials.

    \n" }, "response": [] }, { "name": "Bulk Delete VPN Credentials", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials/bulkDelete", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials", "bulkDelete" ] }, "description": "

    Bulk delete VPN credentials up to a maximum of 100 credentials per request. The response returns the VPN IDs that were successfully deleted.

    \n" }, "response": [] }, { "name": "Get VPN Credential", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials/:vpnId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials", ":vpnId" ], "variable": [ { "key": "vpnId", "value": "", "description": "The unique identifier for the VPN credential." } ] }, "description": "

    Gets the VPN credentials for the specified ID.

    \n" }, "response": [] }, { "name": "Update VPN Credential", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials/:vpnId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials", ":vpnId" ], "variable": [ { "key": "vpnId", "value": "", "description": "The unique identifier for the VPN credential." } ] }, "description": "

    Updates the VPN credentials for the specified ID.

    \n" }, "response": [] }, { "name": "Delete VPN Credential", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/vpnCredentials/:vpnId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "vpnCredentials", ":vpnId" ], "variable": [ { "key": "vpnId", "value": "", "description": "The unique identifier for the VPN credential." } ] }, "description": "

    Deletes the VPN credentials for the specified ID.

    \n" }, "response": [] } ] }, { "name": "URL Categories", "item": [ { "name": "Get URL Category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories" ], "query": [ { "key": "customOnly", "value": "", "description": "If set to true, gets information on custom URL categories only.", "disabled": true }, { "key": "includeOnlyUrlKeywordCounts", "value": "", "description": "By default this parameter is set to false, so the response includes URLs and keywords for custom URL categories only. If set to true, the response only includes URL and keyword counts.", "disabled": true } ] }, "description": "

    Gets information about all or custom URL categories. By default, the response includes keywords.

    \n" }, "response": [] }, { "name": "Add Custom Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories" ] }, "description": "

    Adds a new custom URL category. If keywords are included within the request, they are added to the new category.

    \n" }, "response": [] }, { "name": "Get Lite URL Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", "lite" ] }, "description": "

    Gets a lightweight key-value list of all or custom URL categories.

    \n" }, "response": [] }, { "name": "URL Category Resource Get Categories With Matching Domains", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/review/domains", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", "review", "domains" ] }, "description": "

    For the specified list of URLs, finds matching entries present in existing custom URL categories. This endpoint allows you to review URLs for potential matches in existing categories to group-related entries in a single category.

    The URLs specified are matched against the entries present in urls (referred as Custom URLs in the UI) and dbCategorizedUrls (referred as URLs Retaining Parent Category in the UI) fields of custom URL categories. The matches are returned only for URLs of Subdomain type that match with existing wildcard entries and not vice versa. The only exception is when a wildcard URL is matched against another wildcard entry, but the former is identified as a subdomain in relation to the wildcard match. For example, if a URL such as .teams.microsoft.com matches with .microsoft.com, the .teams.microsoft.com entry in this case is regarded as a subdomain in relation to the match found and is returned as part of the API response. However, if .teams.microsoft.com matches with teams.microsoft.com, this becomes a wildcard match against a subdomain and is discarded in the response.

    Note: A maximum of 100 URLs can be sent in a request.

    The matches found through this request can be added to the required custom URL categories using the PUT /urlCategories/review/domains request.

    " }, "response": [] }, { "name": "URL Category Resource Update Categories With Matching Domains", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/review/domains", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", "review", "domains" ] }, "description": "

    Adds the list of matching URLs fetched by POST /urlCategories/review/domains to the specified custom URL categories. The URL specified is added to either urls (referred to as Custom URLs in the UI) or dbCategorizedUrls (referred to as URLs Retaining Parent Category in the UI) fields of the custom category based on the following condition: If the matching URL is present in the dbCategorizedUrls field, the new entry is added to this field. Otherwise, it is added to the urls field.

    Note:

    • A maximum of 100 URL categories can be updated at once using this request.
    • Only URLs that are of Subdomain type can be added to custom categories via this request. Wildcard matches cannot be added. To learn more, see the description for POST /urlCategories/review/domains.
    \n" }, "response": [] }, { "name": "Get URL Quota", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/urlQuota", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", "urlQuota" ] }, "description": "

    Gets information on the number of unique URLs that are currently provisioned for your organization as well as how many URLs you can add before reaching that number.

    \n" }, "response": [] }, { "name": "Get URL Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/:categoryId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", ":categoryId" ], "variable": [ { "key": "categoryId", "value": "", "description": "The unique identifier for the URL category." } ] }, "description": "

    Gets the URL category information for the specified ID.

    \n" }, "response": [] }, { "name": "Update Category", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/:categoryId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", ":categoryId" ], "query": [ { "key": "action", "value": "", "description": "

    The action applied to the URL category (i.e., add or remove from category list). When no action is specified, all the URLs sent in the request will replace the existing ones. It is recommended that you specify the add or remove action to update the URL categories. This ensures that update is performed only on the added or removed URLs, and is useful when the URL category list is large. To learn more, see URL Categories Use Cases.

    \n", "disabled": true } ], "variable": [ { "key": "categoryId", "value": "", "description": "The unique identifer for the URL category." } ] }, "description": "

    Updates the URL category for the specified ID. If keywords are included within the request, then they replace existing ones for the specified URL category . If the keywords attribute is not included the request, the existing keywords are retained.

    You can perform a full update for the specified URL category. However, if attributes are omitted within the update request, the values for those attributes are cleared.

    You can also perform an incremental update, to add or remove URLs, for the specified URL category using the action parameter. To learn more, see URL Categories Use Cases.

    \n" }, "response": [] }, { "name": "Delete Custom Category", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlCategories/:categoryId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlCategories", ":categoryId" ], "variable": [ { "key": "categoryId", "value": "", "description": "The unique identifer for the custom URL category." } ] }, "description": "

    Deletes the custom URL category for the specified ID. You cannot delete a custom category while it is being used by a URL policy or NSS feed. Also, predefined categories cannot be deleted.

    \n" }, "response": [] }, { "name": "Search Ur Ls Classification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlLookup", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlLookup" ] }, "description": "

    Retrieve Zscaler's default classification for a given set of URLs (e.g., ['abc.com', 'xyz.com']).

    Note:

    • Custom URL classification is not returned by this request. Any URLs that are not categorized under a predefined URL category return a value of MISCELLANEOUS_OR_UNKNOWN.
    • Up to 100 URLs can be looked up per request, and a URL cannot exceed 1,024 characters.

    \n" }, "response": [] } ] }, { "name": "URL Filtering Policy", "item": [ { "name": "Get Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "

    Gets a list of all of URL Filtering Policy rules.

    " }, "response": [] }, { "name": "Add Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules" ] }, "description": "

    Adds a URL Filtering Policy rule.

    If you are using the Admin Rank feature, refer to About Admin Rank to determine which value to provide for rank when adding a policy rule. If you are not using Admin Rank, the rank value must be 7.

    " }, "response": [] }, { "name": "URL Filtering Rule Resource Get Rules Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules/count", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules", "count" ] }, "description": "Retrieves the count of URL Filtering rules based on the specified search criteria" }, "response": [] }, { "name": "Get Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the URL Filtering Policy rule." } ] }, "description": "

    Gets the URL Filtering Policy rule for the specified ID.

    " }, "response": [] }, { "name": "Update Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the URL Filtering Policy rule." } ] }, "description": "

    Updates the URL Filtering Policy rule for the specified ID.

    If you are using the Admin Rank feature, refer to About Admin Rank to determine which value to provide for rank when adding a policy rule. If you are not using Admin Rank, the rank value must be 7.

    " }, "response": [] }, { "name": "Delete Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/urlFilteringRules/:ruleId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "urlFilteringRules", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The unique identifier for the URL Filtering Policy rule." } ] }, "description": "Deletes the URL Filtering Policy rule for the specified ID." }, "response": [] }, { "name": "Time Window Resource Get Time Windows", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeWindows", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeWindows" ] }, "description": "

    Gets a list of time intervals used for by the Firewall policy or the URL Filtering policy.

    \n" }, "response": [] }, { "name": "Time Window Resource Get Time Window Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/timeWindows/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "timeWindows", "lite" ] }, "description": "

    Gets a name and ID dictionary of time intervals used by the Firewall policy or the URL Filtering policy.

    \n" }, "response": [] } ] }, { "name": "URL & Cloud App Control Policy Settings", "item": [ { "name": "Advanced URL Filtering Cloud App Resource Get Advanced URL Filt Options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/advancedUrlFilterAndCloudAppSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "advancedUrlFilterAndCloudAppSettings" ] }, "description": "Retrieves information about URL and Cloud App Control advanced policy settings" }, "response": [] }, { "name": "Advanced URL Filtering Cloud App Resource Update Advanced URL Filt Options", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/advancedUrlFilterAndCloudAppSettings", "host": [ "{{ZIABaseUrl}}" ], "path": [ "advancedUrlFilterAndCloudAppSettings" ] }, "description": "Updates the URL and Cloud App Control advanced policy settings" }, "response": [] } ] }, { "name": "User Authentication Settings", "item": [ { "name": "Get Auth Exempted Urls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authSettings/exemptedUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authSettings", "exemptedUrls" ] }, "description": "

    Gets a list of URLs that were exempted from cookie authentication. To learn more, see URL Format Guidelines.

    " }, "response": [] }, { "name": "Update Auth Exempted Urls", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/authSettings/exemptedUrls", "host": [ "{{ZIABaseUrl}}" ], "path": [ "authSettings", "exemptedUrls" ], "query": [ { "key": "action", "value": "", "description": "The action applied to the exempted URLs list (i.e., adding a URL or removing a URL).", "disabled": false } ] }, "description": "

    Adds a URL to or removes a URL from the cookie authentication exempt list. To add a URL to the list, set the action parameter to ADD_TO_LIST. To remove a URL, set action to REMOVE_FROM_LIST.

    " }, "response": [] } ] }, { "name": "User Management", "item": [ { "name": "Get Departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a department's name or comments attributes", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "limitSearch", "value": "", "description": "Limits the search to match only against the department name", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sorts the departments based on available values", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sorts the order of departments based on available values", "disabled": true } ] }, "description": "

    Retrieves a list of departments. The search parameters find matching values within the name or comments fields.

    \n" }, "response": [] }, { "name": "Department Resource Add Department", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments" ] }, "description": "

    Adds a department for an organization. To learn more, see Adding Departments.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Department Resource Get Departments Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments", "lite" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a department's name or comments attributes", "disabled": true }, { "key": "id", "value": "", "description": "Department ID", "disabled": true }, { "key": "includeDefaultDept", "value": "", "description": "Specifies whether to include the default department for a user", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sorts the departments based on available values", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sorts the order of departments based on available values", "disabled": true } ] }, "description": "

    Retrieves a list of departments. The search parameters find matching values within the name or comments fields.

    " }, "response": [] }, { "name": "Get Department", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the department" } ] }, "description": "

    Retrieves the department based on the specified ID

    " }, "response": [] }, { "name": "Department Resource Get Department Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments/lite/:id", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments", "lite", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier for the department" } ] }, "description": "

    Retrieves the department based on the specified ID

    " }, "response": [] }, { "name": "Department Resource Update Department", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments/:departmentId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments", ":departmentId" ], "variable": [ { "key": "departmentId", "value": "", "description": "Department ID" } ] }, "description": "

    Updates the department for an organization based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Department Resource Delete Department", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/departments/:departmentId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "departments", ":departmentId" ], "variable": [ { "key": "departmentId", "value": "", "description": "Department ID" } ] }, "description": "

    Deletes a department for an organization based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Get Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a group's name or comments attributes", "disabled": true }, { "key": "adminScopeSupport", "value": "", "description": "A Boolean value that indicates whether the group is part of the admin scope. When you set the value to true, the group is included in the admin scope.", "disabled": true }, { "key": "definedBy", "value": "", "description": "The string value defined by the group name or other applicable attributes", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sorts the groups based on available values", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sorts the order of groups based on available values", "disabled": true } ] }, "description": "

    Retrieves a list of groups. The search parameters find matching values in the name or comments attributes.

    \n" }, "response": [] }, { "name": "Group Resource Add Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups" ] }, "description": "

    Adds a new group. To learn more, see Adding Groups.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Group Resource Get Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups/lite", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups", "lite" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against a group's name or comments attributes", "disabled": true }, { "key": "adminScopeSupport", "value": "", "description": "A Boolean value that indicates whether the group is part of the admin scope. When you set the value to true, the group is included in the admin scope.", "disabled": true }, { "key": "definedBy", "value": "", "description": "The string value defined by the group name", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sorts the group names based on available values", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Sorts the order of group names based on available values", "disabled": true } ] }, "description": "

    Retrieves a list of group names. The search parameters find matching values in the name or comments attributes.

    " }, "response": [] }, { "name": "Group Resource Get Group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Group ID" } ] }, "description": "

    Retrieves the group based on the specified ID

    " }, "response": [] }, { "name": "Group Resource Update Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Group ID" } ] }, "description": "

    Updates an existing group based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Group Resource Delete Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Group ID" } ] }, "description": "

    Deletes the group based on the specified ID.

    Note: This endpoint is accessible via Zscaler OneAPI only.

    " }, "response": [] }, { "name": "Group Resource Get Group Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/groups/lite/:groupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "groups", "lite", ":groupId" ], "variable": [ { "key": "groupId", "value": "", "description": "Group ID" } ] }, "description": "

    Retrieves the group based on the specified ID

    " }, "response": [] }, { "name": "Get Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users" ], "query": [ { "key": "name", "value": "", "description": "Filters by user name.", "disabled": true }, { "key": "dept", "value": "", "description": "Filters by department name.", "disabled": true }, { "key": "group", "value": "", "description": "Filters by group name.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100 and the maximum size is 10,000.", "disabled": true } ] }, "description": "

    Gets a list of all users and allows user filtering by name, department, or group. The name search parameter performs a partial match. The dept and group parameters perform a 'starts with' match.

    \n" }, "response": [] }, { "name": "Add User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users" ] }, "description": "

    Adds a new user. A user can belong to multiple groups, but can only belong to one department.

    \n" }, "response": [] }, { "name": "Bulk Delete Users", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/bulkDelete", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", "bulkDelete" ] }, "description": "

    Bulk delete users up to a maximum of 500 users per request. The response returns the user IDs that were successfully deleted.

    \n" }, "response": [] }, { "name": "User Z Resource Get User References", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/references", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", "references" ], "query": [ { "key": "name", "value": "", "description": "Filters by user name", "disabled": true }, { "key": "includeAdminUsers", "value": "", "description": "Specifies whether to include the administrator users when retrieving the list", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 1 and the maximum size is 100.", "disabled": true } ] }, "description": "Gets the list of Name-ID pairs for all users in the ZIA Admin Portal that can be referenced in user criteria within policies. Users can be filtered by name and the name search parameter performs a partial match. Administrators can be optionally included in the list by using the includeAdminUsers parameter." }, "response": [] }, { "name": "Get User", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/:userId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifer for the user." } ] }, "description": "

    Gets the user information for the specified ID.

    \n" }, "response": [] }, { "name": "Update User", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/:userId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifer for the user." } ] }, "description": "

    Updates the user information for the specified ID. However, the email attribute is read-only.

    \n" }, "response": [] }, { "name": "Delete User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/:userId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifer for the user." } ] }, "description": "

    Deletes the user for the specified ID.

    \n" }, "response": [] }, { "name": "User Resource Get Auditors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/users/auditors", "host": [ "{{ZIABaseUrl}}" ], "path": [ "users", "auditors" ] }, "description": "Gets a list of auditors. To learn more, see About Auditors." }, "response": [] } ] }, { "name": "Votiro CDR", "item": [ { "name": "Retrieves Votiro CDR policies configured for a tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/isolationVotiroCdr/policies", "host": [ "{{ZIABaseUrl}}" ], "path": [ "isolationVotiroCdr", "policies" ] }, "description": "Retrieves Votiro CDR policies configured for a tenant" }, "response": [] }, { "name": "Isolation Votiro Cdr Resource Get Votiro Token Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/isolationVotiroCdr/tokenConfig", "host": [ "{{ZIABaseUrl}}" ], "path": [ "isolationVotiroCdr", "tokenConfig" ] }, "description": "Retrieves the Votiro CDR authentication credentials. To learn more, see Understanding Votiro Integration for Zero Trust Browser." }, "response": [] }, { "name": "Isolation Votiro Cdr Resource Update Votiro Token Config", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/isolationVotiroCdr/tokenConfig", "host": [ "{{ZIABaseUrl}}" ], "path": [ "isolationVotiroCdr", "tokenConfig" ], "query": [ { "key": "action", "value": "", "description": "Updates either the token or hostname. When you set the token or hostname, only the respective field in the VotiroCdrTokenConfig is updated.", "disabled": true } ] }, "description": "Configures or updates the Votiro CDR authentication credentials. To learn more, see Votiro CDR Integration on Creating Isolation Profiles for ZIA." }, "response": [] }, { "name": "Isolation Votiro Cdr Resource Delete Votiro Token Config", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/isolationVotiroCdr/tokenConfig", "host": [ "{{ZIABaseUrl}}" ], "path": [ "isolationVotiroCdr", "tokenConfig" ] }, "description": "Deletes the Votiro CDR authentication credentials" }, "response": [] } ] }, { "name": "Workload Groups", "item": [ { "name": "Workload Group Resource Get Workload Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/workloadGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "workloadGroups" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250 and the maximum size is 1,000.", "disabled": true } ] }, "description": "Gets the list of workload groups configured in the ZIA Admin Portal. You can configure the workload groups as criteria in various policies including Data Loss Prevention, URL Filtering, SSL Inspection, and Firewall Filtering rules. To learn more, see About Workload Groups and Configuring Workload Groups." }, "response": [] }, { "name": "Workload Group Resource Add Workload Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/workloadGroups", "host": [ "{{ZIABaseUrl}}" ], "path": [ "workloadGroups" ] }, "description": "Adds a workload group for an organization. ." }, "response": [] }, { "name": "Workload Group Resource Get Workload Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/workloadGroups/:workloadGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "workloadGroups", ":workloadGroupId" ], "variable": [ { "key": "workloadGroupId", "value": "", "description": "The workload group ID" } ] }, "description": "Retrieves the workload group based on the specified ID" }, "response": [] }, { "name": "Workload Group Resource Update Workload Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/workloadGroups/:workloadGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "workloadGroups", ":workloadGroupId" ], "variable": [ { "key": "workloadGroupId", "value": "", "description": "The workload group ID" } ] }, "description": "Updates the workload group for an organization based on the specified ID" }, "response": [] }, { "name": "Workload Group Resource Delete Workload Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZIABaseUrl}}/workloadGroups/:workloadGroupId", "host": [ "{{ZIABaseUrl}}" ], "path": [ "workloadGroups", ":workloadGroupId" ], "variable": [ { "key": "workloadGroupId", "value": "", "description": "The workload group ID" } ] }, "description": "Updates the workload group based on the specified ID" }, "response": [] } ] } ] }, { "name": "Zscaler Cloud & Branch Connector", "item": [ { "name": "Authentication", "item": [ { "name": "Get Authenticated Session", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/auth", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "auth" ] }, "description": "Checks if there is an authenticated session." }, "response": [] }, { "name": "Add Authenticated Session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/auth", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "auth" ], "query": [ { "key": "includeDisplayPreferences", "value": "", "description": "Indicates whether to include localization info from organization settings.", "disabled": true } ] }, "description": "Creates an authenticated session. The response returns a cookie in the header called JSESSIONID that must be used in subsequent requests.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Authenticated Session", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/auth", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "auth" ] }, "description": "Log out of authenticated session." }, "response": [] } ] }, { "name": "Activation", "item": [ { "name": "Activate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus/activate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus", "activate" ] }, "description": "Activates configuration changes." }, "response": [] }, { "name": "Force Activate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus/forcedActivate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus", "forcedActivate" ] }, "description": "Force activates configuration changes." }, "response": [] }, { "name": "Get Org Edit Activate Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecAdminActivateStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecAdminActivateStatus" ] }, "description": "Gets activation status." }, "response": [] } ] }, { "name": "Admin and Role Management", "item": [ { "name": "Get Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminRoles", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles" ], "query": [ { "key": "includeAuditorRole", "value": "", "description": "Include or exclude auditor role information in the list.", "disabled": true }, { "key": "includePartnerRole", "value": "", "description": "Include or exclude partner admin role information in the list.", "disabled": true }, { "key": "includeApiRole", "value": "", "description": "Include or exclude API role information in the list.", "disabled": true }, { "key": "id", "value": "", "description": "Include or exclude role ID information in the list.", "disabled": true } ] }, "description": "Lists existing admin roles." }, "response": [] }, { "name": "Add Role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminRoles", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles" ] }, "description": "Creates an admin role.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update Role", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminRoles/:roleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "The unique identifier for the admin role." } ] }, "description": "Updates the admin role specified by the role ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminRoles/:roleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminRoles", ":roleId" ], "variable": [ { "key": "roleId", "value": "", "description": "The unique identifier for the admin role." } ] }, "description": "Deletes the admin role specified by the role ID." }, "response": [] }, { "name": "Update Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/passwordChange", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "passwordChange" ] }, "description": "Changes current password.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Admin Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers" ], "query": [ { "key": "includeAuditorUsers", "value": "", "description": "Include or exclude auditor user information in the list.", "disabled": true }, { "key": "includeAdminUsers", "value": "", "description": "Include or exclude admin user information in the list.", "disabled": true }, { "key": "partnerType", "value": "", "description": "Include or exclude partner type information in the list.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to partially match against an admin user's Login ID or Name.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100; the maximum size is 1000.", "disabled": true }, { "key": "version", "value": "", "description": "Specifies backed up admins from backup version.", "disabled": true } ] }, "description": "Lists admin users." }, "response": [] }, { "name": "Add Admin User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers" ], "query": [ { "key": "associateWithExistingAdmin", "value": "", "description": "Indicates whether to associate this admin with an existing admin.", "disabled": true } ] }, "description": "Creates an admin user.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Admin User By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/:userId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifier for the admin user." } ] }, "description": "Gets the admin user specified by the user ID." }, "response": [] }, { "name": "Update Admin User", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/:userId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifier for the admin user." } ] }, "description": "Updates admin user for the specified user ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Admin User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/adminUsers/:userId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "adminUsers", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "The unique identifier for the admin user." } ] }, "description": "Deletes an admin user for the specified user ID." }, "response": [] } ] }, { "name": "Cloud & Branch Connector Groups", "item": [ { "name": "Get Ec Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Lists Cloud & Branch Connector groups." }, "response": [] }, { "name": "Get Ec Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 20.", "disabled": true } ] }, "description": "Lists a subset of Cloud & Branch Connector group information." }, "response": [] }, { "name": "Get Ec Vm", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "VM ID." } ] }, "description": "Gets a VM by specified Cloud or Branch Connector group ID and VM ID" }, "response": [] }, { "name": "Delete Ec Vm", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "VM ID." } ] }, "description": "Deletes a VM specified by Cloud or Branch Connector group ID and VM ID." }, "response": [] }, { "name": "Get Ec Group By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":id" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "ID of Cloud or Branch Connector group." } ] }, "description": "Gets Cloud or Branch Connector group by ID." }, "response": [] }, { "name": "Get Ec Interfaces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/intf", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "intf" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." } ] }, "description": "Retrieves the list of interfaces associated with a specific VM in a Cloud or Branch Connector group." }, "response": [] }, { "name": "Create Interface", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/intf", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "intf" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." } ] }, "description": "Creates an interface for a specific VM in a Cloud or Branch Connector group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Ec Interface By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/intf/:intfId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "intf", ":intfId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "intfId", "value": "", "description": "The interface ID." } ] }, "description": "Retrieves the Cloud or Branch Connector interface within a specific VM based on the provided interface ID." }, "response": [] }, { "name": "Update Ec VM Interface", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/intf/:intfId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "intf", ":intfId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "intfId", "value": "", "description": "The interface ID" } ] }, "description": "Updates the Cloud or Branch Connector interface within a specific VM based on the provided interface ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Ec VM Interface", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/intf/:intfId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "intf", ":intfId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "intfId", "value": "", "description": "The interface ID" } ] }, "description": "Deletes a Cloud or Branch Connector interface within a specific VM based on the provided interface ID." }, "response": [] }, { "name": "Get Ec Route", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." } ] }, "description": "Retrieves the list of Cloud or Branch Connector routes for the specified VM in the group." }, "response": [] }, { "name": "Create Ec Route", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." } ] }, "description": "Creates a Cloud or Branch Connector route within a specific VM in the group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Ec Route By Vm", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." } ] }, "description": "Deletes a specific Cloud or Branch Connector route associated with a VM in the group." }, "response": [] }, { "name": "Get Ec Route By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route/:ecRouteId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route", ":ecRouteId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "ecRouteId", "value": "", "description": "The Cloud or Branch Connector route ID." } ] }, "description": "Retrieves the details of the Cloud or Branch Connector route within a specific VM based on the provided route ID." }, "response": [] }, { "name": "Update Ec Route", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route/:ecRouteId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route", ":ecRouteId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "ecRouteId", "value": "", "description": "The Cloud or Branch Connector route ID." } ] }, "description": "Updates the Cloud or Branch Connector route details within a specific VM based on the provided route ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Ec Route", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/:ecgroupId/vm/:vmId/route/:ecRouteId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", ":ecgroupId", "vm", ":vmId", "route", ":ecRouteId" ], "variable": [ { "key": "ecgroupId", "value": "", "description": "The Cloud or Branch Connector group ID." }, { "key": "vmId", "value": "", "description": "The ID of the VM." }, { "key": "ecRouteId", "value": "", "description": "The Cloud or Branch Connector route ID." } ] }, "description": "Deletes a Cloud or Branch Connector route within a specific VM based on the provided route ID." }, "response": [] }, { "name": "Get Ec Vm List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecInstance/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecInstance", "lite" ] }, "description": "Lists a subset of Cloud & Branch Connector instance information." }, "response": [] }, { "name": "Get Ec VM By Instance Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecVm/uuid/:vmInstanceId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecVm", "uuid", ":vmInstanceId" ], "variable": [ { "key": "vmInstanceId", "value": "", "description": "The ID of the VM native public cloud instance." } ] }, "description": "Retrieves details about a VM based on the provided Cloud or Branch Connector native public cloud instance ID." }, "response": [] }, { "name": "Delete Ec Vm By Instance ID", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecVm/uuid/:vmInstanceId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecVm", "uuid", ":vmInstanceId" ], "variable": [ { "key": "vmInstanceId", "value": "", "description": "The ID of the VM native public cloud instance." } ] }, "description": "Deletes a VM based on the provided Cloud or Branch Connector native public cloud instance ID." }, "response": [] }, { "name": "Update VM Status in Bulk", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/vmStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "vmStatus" ] }, "description": "Updates the status of Cloud Connector virtual machines (VMs) in bulk.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update VM Release Channels in Bulk", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/releaseChannel", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "releaseChannel" ] }, "description": "Updates the release channels for Cloud Connector VMs in bulk.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get VM Upgrade Metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecgroup/vmUpgradeMetrics", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecgroup", "vmUpgradeMetrics" ], "query": [ { "key": "deployType", "value": "", "description": "Deployment type of the Cloud Connector group.", "disabled": true }, { "key": "autoScale", "value": "", "description": "Indicates whether auto scaling is enabled for the Cloud Connector group.", "disabled": true }, { "key": "zeroTrustGroup", "value": "", "description": "Indicates whether the Cloud Connector group is configured as a Zero Trust Gateway.", "disabled": true }, { "key": "platform", "value": "", "description": "Platform of the Cloud Connector group.", "disabled": true }, { "key": "releaseChannel", "value": "", "description": "The release channel type. ", "disabled": true }, { "key": "locationId", "value": "", "description": "The location ID of the Cloud Connector group.", "disabled": true }, { "key": "name", "value": "", "description": "Name of Cloud Connector group.", "disabled": true }, { "key": "upgradeStatus", "value": "", "description": "The status of the scheduled upgrade.", "disabled": true } ] }, "description": "Retrieves the Cloud Connector VMs release channel and scheduled upgrade metrics." }, "response": [] } ] }, { "name": "DNS Gateway", "item": [ { "name": "Ec DNS Gateway Z Resource Get DNS Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 255.", "disabled": true } ] }, "description": "

    Retrieves the list of DNS Gateways.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec DNS Gateway Z Resource Add DNS Gateway", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways" ] }, "description": "

    Creates a new DNS gateway based on the specified parameters.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec DNS Gateway Z Resource Get DNS Gateways Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 255.", "disabled": true } ] }, "description": "

    Retrieves the list of DNS gateways.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec DNS Gateway Z Resource Get Gateway By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways/:gatewayId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the DNS gateway." } ] }, "description": "

    Retrieves the DNS gateway based on the specified DNS gateway ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec DNS Gateway Z Resource Update DNS Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the DNS gateway." } ] }, "description": "Updates the DNS gateway based on the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec DNS Gateway Z Resource Delete DNS Gateway", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/dnsGateways/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "dnsGateways", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the DNS gateway." } ] }, "description": "Deletes the DNS gateway based on the specified ID." }, "response": [] } ] }, { "name": "DNS Control Forwarding Rule", "item": [ { "name": "Ec Rule Z Resource Get Ec DNS Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecDns", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecDns" ], "query": [ { "key": "ruleName", "value": "", "description": "The search string used to match against the rule name.", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "The search string used to match against the rule order.", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "The search string used to match against the rule description.", "disabled": true }, { "key": "ruleAction", "value": "", "description": "Specifies the rule action.", "disabled": true }, { "key": "location", "value": "", "description": "The search string used to match against the locations or sublocations used in rule configurations.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 50.", "disabled": true }, { "key": "sortBy", "value": "", "description": "The rule parameter by which the list must be sorted.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Specifies whether the list must be sorted by ascending or descending rule order or by rule processing order.", "disabled": true } ] }, "description": "

    Retrieves the list of DNS forwarding rules.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec Rule Z Resource Create Ec DNS Forwarding Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecDns", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecDns" ] }, "description": "

    Creates a DNS forwarding rule.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Get Ec DNS By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecDns/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecDns", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Retrieves a DNS forwarding rule configuration based on the specified ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec Rule Z Resource Update Ec DNS Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecDns/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecDns", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Updates DNS forwarding rule configuration based on the specified ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Delete Ec DNS Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecDns/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecDns", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Deletes a DNS forwarding rule based on the specified ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] } ] }, { "name": "Forwarding Gateways", "item": [ { "name": "Get Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways" ] }, "description": "Retrieves the list of ZIA gateways and Log and Control gateways. To learn more, see ZIA gateways and Log and Control gateways." }, "response": [] }, { "name": "Add Gateway", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways" ] }, "description": "Adds a new ZIA gateway or Log and Control gateway based on the specified parameters. To learn more, see Configuring a ZIA Gateway and Configuring a Log and Control Gateway.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Ec Gateway Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", "lite" ] }, "description": "Retrieves the list of ZIA gateways and Log and Control gateways. This request retrieves basic information about gateways. For extensive details, use the GET /gateways request." }, "response": [] }, { "name": "Ec Gateway Z Resource Get Gateway By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways/:gatewayId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the gateway." } ] }, "description": "Retrieves a ZIA gateway or log and control gateway based on the specified gateway ID." }, "response": [] }, { "name": "Ec Gateway Z Resource Edit Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways/:gatewayId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "The ID of the gateway." } ] }, "description": "Updates the ZIA gateway or log and control gateway based on the specified gateway ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Gateway", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/gateways/:gatewayId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "gateways", ":gatewayId" ], "variable": [ { "key": "gatewayId", "value": "", "description": "ID of the gateway." } ] }, "description": "Deletes a ZIA gateway or Log and Control gateway based on the specified ID." }, "response": [] } ] }, { "name": "Location Management", "item": [ { "name": "Get Top Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/location", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location" ], "query": [ { "key": "groupId", "value": "", "description": "Filter based on location group ID for a location.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to partially match against a location's name and port attributes.", "disabled": true }, { "key": "state", "value": "", "description": "Filter based on geographical state for a location.", "disabled": true }, { "key": "sslScanEnabled", "value": "", "description": "

    This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in the future.

    Filter based on whether Enable SSL Scanning is enabled for a location.

    \n", "disabled": true }, { "key": "xffEnabled", "value": "", "description": "Filter based on whether Enforce XFF Forwarding is enabled for a location.", "disabled": true }, { "key": "authRequired", "value": "", "description": "Filter based on whether Enforce Authentication is enabled for a location.", "disabled": true }, { "key": "bwEnforced", "value": "", "description": "Filter based on whether Bandwith Control is enforced for a location.", "disabled": true }, { "key": "partnerId", "value": "", "description": "Not applicable to Cloud & Branch Connector.", "disabled": true }, { "key": "enforceAup", "value": "", "description": "Filter based on whether Acceptable Use Policy (AUP) is enforced for a location.", "disabled": true }, { "key": "enableFirewall", "value": "", "description": "Filter based on whether firewall is enabled for a location.", "disabled": true }, { "key": "locationType", "value": "", "description": "Filter based on type of location.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Lists locations only, not sub-locations. When a location matches the given search parameter criteria only its parent location is included in the result set, not its sub-locations. To learn more, see About Locations.\n" }, "response": [] }, { "name": "Get All Location By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/location/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location", ":id" ], "variable": [ { "key": "id", "value": "", "description": "ID of location." } ] }, "description": "Gets location by ID." }, "response": [] }, { "name": "Get Lite Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/location/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "location", "lite" ], "query": [ { "key": "includeSubLocations", "value": "", "description": "If set to true, sub-locations are included in the response.", "disabled": true }, { "key": "includeParentLocations", "value": "", "description": "If set to true, parent locations (i.e., locations with sub-locations) are included in the response.", "disabled": true }, { "key": "includeDefaultLocation", "value": "", "description": "If set to true, default location is included in response.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to partially match against the location name and port attributes.", "disabled": true }, { "key": "groupId", "value": "", "description": "Filter based on location group ID for a location.", "disabled": true }, { "key": "partnerId", "value": "", "description": "Not applicable to Cloud & Branch Connector.", "disabled": true }, { "key": "version", "value": "", "description": "Not applicable to Cloud & Branch Connector.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100, but the maximum size is 1000.", "disabled": true } ] }, "description": "Lists a subset of location information." }, "response": [] }, { "name": "Get All Location Templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Lists location templates." }, "response": [] }, { "name": "Create Location Template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate" ] }, "description": "Creates a location template.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update Location Template", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/:templateId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "ID of the location template." } ] }, "description": "Updates the location template specified by the location template ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Location Template", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/:templateId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "ID of the location template." } ] }, "description": "Deletes the location template specified by the location template ID." }, "response": [] }, { "name": "Get Location Template", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Location template ID." } ] }, "description": "Gets location template specified by location template ID." }, "response": [] }, { "name": "Get Location Templates Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/locationTemplate/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "locationTemplate", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100.", "disabled": true } ] }, "description": "Lists a subset of location template information." }, "response": [] } ] }, { "name": "Log and Control Forwarding", "item": [ { "name": "Ec Rule Z Resource Get Self Ec Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/self", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "self" ], "query": [ { "key": "ruleName", "value": "", "description": "The search string used to match against the rule name.", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "The search string used to match against the rule order.", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "The search string used to match against the rule description.", "disabled": true }, { "key": "location", "value": "", "description": "The location to which the rule applies.", "disabled": true }, { "key": "ruleForwardMethod", "value": "", "description": "The search string used to match against the rule forwarding method.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size if 50.", "disabled": true }, { "key": "sortBy", "value": "", "description": "The rule parameter by which the list must be sorted.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Specifies whether the list must be sorted by ascending or descending rule order or by the rule processing order.", "disabled": true } ] }, "description": "

    Retrieves the list of log and control forwarding rules.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec Rule Z Resource Create Self Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/self", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "self" ] }, "description": "

    Creates a log and control forwarding rule.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Get Ec Self Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/self/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "self", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Retrieves log and control forwarding rule configuration based on the specified rule ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Ec Rule Z Resource Update Self Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/self/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "self", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Updates the log and control forwarding rule configuration.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Delete Self Forwarding Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/self/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "self", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "

    Deletes a log and control forwarding rule based on the rule ID.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] } ] }, { "name": "Partner Integrations", "item": [ { "name": "Get Aws Account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo" ], "query": [ { "key": "page", "value": "", "description": " Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ] }, "description": " Retrieves the list of AWS accounts with metadata. To learn more, see About Amazon Web Services Accounts." }, "response": [] }, { "name": "Create Aws Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo" ] }, "description": "Creates a new AWS account with the provided account and region details. You can create a maximum of 512 accounts in each organization. To learn more, see Adding an Amazon Web Services Account.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Cloud Formation Template Url", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/cloudFormationTemplate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "cloudFormationTemplate" ], "query": [ { "key": "awsAccountId", "value": "", "description": "(Optional) The AWS account ID to customize the CloudFormation template URL. If an awsAccountId is provided, the URL is customized with account-specific values, or a generic template URL is returned.", "disabled": true } ] }, "description": "Retrieves the CloudFormation template URL. To learn more, see Adding an Amazon Web Services Account." }, "response": [] }, { "name": "Get Aws Account Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "count" ] }, "description": "Retrieves the total number of AWS accounts." }, "response": [] }, { "name": "Generate External Id", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/generateExternalId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "generateExternalId" ] }, "description": "Creates an external ID for an AWS account.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Aws Account Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "lite" ], "query": [ { "key": "cloudType", "value": "", "description": "The cloud type. The default and mandatory value is AWS.", "disabled": true }, { "key": "search", "value": "", "description": "The search string.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. ", "disabled": true } ] }, "description": "Retrieves basic information about the AWS cloud accounts. For additional details, use the GET /publicCloudInfo method." }, "response": [] }, { "name": "Get Aws Supported Regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/supportedRegions", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", "supportedRegions" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. ", "disabled": true } ] }, "description": "Retrieves a list of AWS regions supported for workload discovery settings (WDS)." }, "response": [] }, { "name": "Get Aws Account By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", ":id" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account." } ] }, "description": "Retrieves the existing AWS account details based on the provided ID." }, "response": [] }, { "name": "Update Aws Account", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account." } ] }, "description": "Updates the existing AWS account details based on the provided ID. ", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Aws Account", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account." } ] }, "description": "Removes a specific AWS account based on the provided ID." }, "response": [] }, { "name": "Disable Aws Account", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudInfo/:id/changeState", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudInfo", ":id", "changeState" ], "query": [ { "key": "enable", "value": "", "description": " Set true to enable the AWS account, and false to disable it.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account." } ] }, "description": "Enables or disables a specific AWS account in all regions based on the provided ID." }, "response": [] }, { "name": "Get Workload Discovery Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/discoveryService/workloadDiscoverySettings", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "discoveryService", "workloadDiscoverySettings" ] }, "description": "Retrieves the workload discovery service settings." }, "response": [] }, { "name": "Get Permissions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/discoveryService/:id/permissions", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "discoveryService", ":id", "permissions" ], "variable": [ { "key": "id", "value": "", "description": "The unique identifier for the AWS account." } ] }, "description": "Verifies the specified AWS account permissions using the discovery role and external ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Account Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ] }, "description": "Retrieves the details of AWS account groups with metadata. To learn more, see About Amazon Web Services Account Groups." }, "response": [] }, { "name": "Create Account Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups" ] }, "description": "Creates an AWS account group. You can create a maximum of 128 groups in each organization. To learn more, see Adding an Amazon Web Services Account Group.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Account Groups Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "count" ] }, "description": "Retrieves the total number of AWS account groups." }, "response": [] }, { "name": "Get Account Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", "lite" ] }, "description": "Retrieves the ID and name of all the AWS account groups. For additional details, use the GET /accountGroups method." }, "response": [] }, { "name": "Get Account Group By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", ":id" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The ID of the AWS account group." } ] }, "description": "Retrieves the specific AWS account group details based on the provided group ID." }, "response": [] }, { "name": "Update Account Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account group." } ] }, "description": "Updates the existing AWS account group details based on the provided ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Account Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/accountGroups/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "accountGroups", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The unique ID of the AWS account group." } ] }, "description": "Removes a specific AWS account group based on the provided ID." }, "response": [] } ] }, { "name": "Policy Management", "item": [ { "name": "Get Forwarding Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr" ], "query": [ { "key": "ruleName", "value": "", "description": "The search string used to match against the rule name.", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "The search string used to match against the rule order.", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "The search string used to match against the rule description.", "disabled": true }, { "key": "ruleForwardMethod", "value": "", "description": "The search string used to match against the rule forwarding method. Supported forwarding methods are ZIA, ZPA, DIRECT, and DROP.", "disabled": true }, { "key": "location", "value": "", "description": "The search string used to match against the locations or sublocations used in rule configurations.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 50.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Rule parameter by which the list must be sorted.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Specifies whether the list must be sorted by ascending or descending rule order or by rule execution order.", "disabled": true } ] }, "description": "Retrieves the list of traffic forwarding rules. To learn more, see About Traffic Forwarding." }, "response": [] }, { "name": "Create Rdr Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr" ] }, "description": "Creates a new traffic forwarding rule. To learn more, see Configuring Traffic Forwarding Rules.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Get Forwarding Rule By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The ID of the forwarding rule." } ] }, "description": "Retrieves the traffic forwarding rule configuration based on the specified forwarding rule ID." }, "response": [] }, { "name": "Update Ec Rdr Rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "ID of the rule." } ] }, "description": "Updates a traffic forwarding rule configuration based on the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Ec Rule Z Resource Delete Rdr Forwarding Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/:ruleId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", ":ruleId" ], "variable": [ { "key": "ruleId", "value": "", "description": "The ID of the forwarding rule." } ] }, "description": "Deletes the traffic forwarding rule configuration based on the specified ID." }, "response": [] }, { "name": "Get Forwarding Rules Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ecRules/ecRdr/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ecRules", "ecRdr", "count" ], "query": [ { "key": "predefinedRuleCount", "value": "", "description": "Indicates whether the count of predefined rules is retrieved (true) or the count all rules is retrieved (false).", "disabled": true }, { "key": "ruleName", "value": "", "description": "The search string used to match against the rule name.", "disabled": true }, { "key": "ruleOrder", "value": "", "description": "The search string used to match against the rule order.", "disabled": true }, { "key": "ruleDescription", "value": "", "description": "The search string used to match against the rule description.", "disabled": true }, { "key": "ruleForwardMethod", "value": "", "description": "The search string used to match against the rule forwarding method. Supported values are ZIA, ZPA, DIRECT, and DROP.", "disabled": true }, { "key": "location", "value": "", "description": "The search string used to match against the locations or sublocations used in rule configurations.", "disabled": true } ] }, "description": "Retrieves the count of traffic forwarding rules available in the Cloud & Branch Connector Admin Portal." }, "response": [] } ] }, { "name": "Policy Resources", "item": [ { "name": "Get Source Ip Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against the source IP group parameters, such as name and IP addresses.", "disabled": true } ] }, "description": "Retrieves the list of source IP groups. To learn more, see About Source IP Groups." }, "response": [] }, { "name": "Add Source Ip Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups" ] }, "description": "Adds a new custom source IP group. To learn more, see Configuring Source IP Groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Source Ip Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", "lite" ] }, "description": "Retrieves the list of source IP groups. This request retrieves basic information about the source IP groups, such as name and ID. For extensive details, use the GET /ipSourceGroups request." }, "response": [] }, { "name": "IP Source Group Z Resource Get Source IP Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The ID of the source IP group." } ] }, "description": "Retrieves the source IP group based on the specified source IP group ID." }, "response": [] }, { "name": "IP Source Group Z Resource Edit Source IP Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the source IP group." } ] }, "description": "Updates the source IP group based on the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Source Ip Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipSourceGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipSourceGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the source IP group." } ] }, "description": "Deletes a source IP group based on the specified ID." }, "response": [] }, { "name": "Get Destination Ip Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups" ], "query": [ { "key": "excludeType", "value": "", "description": "Specifies the destination IP group type that must be excluded from the list.", "disabled": true } ] }, "description": "Retrieves the list of destination IP groups. To learn more, see About Destination IP Groups." }, "response": [] }, { "name": "Add Destination Ip Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups" ] }, "description": "Adds a new custom destination IP group. To learn more, see Configuring Destination IP Groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Destination Ip Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", "lite" ], "query": [ { "key": "type", "value": "", "description": "List of destination IP group types that must be included in the response.", "disabled": true }, { "key": "excludeType", "value": "", "description": "Specifies the destination IP group type that must be excluded from the response.", "disabled": true }, { "key": "includeURLCategory", "value": "", "description": "Not applicable to Cloud & Branch Connector.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the destination IP group parameters.", "disabled": true }, { "key": "includeZscalerDomains", "value": "", "description": "A Boolean field indicating whether or not to include the automatically generated Zscaler Domains group in the response.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 100.", "disabled": true } ] }, "description": "Retrieves the list of destination IP groups. This request retrieves basic information about the destination IP groups, ID, name, and type. For extensive details, use the GET /ipDestinationGroups request." }, "response": [] }, { "name": "IP Destination Group Z Resource Get Destination IP Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the destination IP group." } ] }, "description": "Retrieves the destination IP group based on the specified source IP group ID." }, "response": [] }, { "name": "IP Destination Group Z Resource Edit Destination IP Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the destination IP group." } ] }, "description": "Updates the destination IP group based on the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Destination Ip Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipDestinationGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipDestinationGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the group." } ] }, "description": "Deletes the destination IP group based on the specified ID. Default destination groups that are automatically created cannot be deleted." }, "response": [] }, { "name": "Get Ip Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against the IP pool parameters.", "disabled": true } ] }, "description": "Retrieves the list of IP pools. To learn more, see About IP Pool." }, "response": [] }, { "name": "Add Ip Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups" ] }, "description": "Adds a new custom IP pool. To learn more, see Configuring IP Pool.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Get Ip Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", "lite" ] }, "description": "Retrieves the list of IP pools. This request retrieves basic information about the IP pools, such as name and ID. For extensive details, use the GET /ipGroups request." }, "response": [] }, { "name": "IP Group Z Resource Get IP Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The IP group ID." } ] }, "description": "Retrieves an IP pool based on the specified ID." }, "response": [] }, { "name": "IP Group Z Resource Edit IP Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "The IP group ID. " } ] }, "description": "Updates the IP pool based on the specified ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Ip Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ipGroups/:ipGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ipGroups", ":ipGroupId" ], "variable": [ { "key": "ipGroupId", "value": "", "description": "ID of the IP pool." } ] }, "description": "Deletes an IP pool based on the specified ID." }, "response": [] }, { "name": "Get Network Services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices" ], "query": [ { "key": "locale", "value": "", "description": "When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN), the network service's description is localized into the requested language.", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against a service's name or description attributes.", "disabled": true }, { "key": "protocol", "value": "", "description": "Filter based on the network service protocol.", "disabled": true } ] }, "description": "Retrieves the list of all network services. The search parameters find matching values within the name or description attributes.\n" }, "response": [] }, { "name": "Add Custom Network Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices" ] }, "description": "Creates a new network service.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Network Service Z Resource Get Network Service By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices/:serviceid", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices", ":serviceid" ], "variable": [ { "key": "serviceid", "value": "", "description": "ID of the network service." } ] }, "description": "Retrieves the network service information for the specified service ID." }, "response": [] }, { "name": "Edit Network Service", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices/:serviceid", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices", ":serviceid" ], "variable": [ { "key": "serviceid", "value": "", "description": "ID of the network service." } ] }, "description": "Updates the network service information for the specified service ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Custom Network Service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServices/:serviceid", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServices", ":serviceid" ], "variable": [ { "key": "serviceid", "value": "", "description": "ID of the network service." } ] }, "description": "Deletes the network service for the specified ID." }, "response": [] }, { "name": "Get Network Service Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against the network service group parameters.", "disabled": true } ] }, "description": "Retrieves the list of network service groups. To learn more, see About Network Service Groups." }, "response": [] }, { "name": "Network Service Group Z Resource Add Custom Network Service Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups" ] }, "description": "Updates the list of network service groups.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Network Service Group Z Resource Get Network Service Group By ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The ID of the network service group." } ] }, "description": "Retrieves the network service group based on the service group ID." }, "response": [] }, { "name": "Network Service Group Z Resource Edit Network Service Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The ID of the network service group." } ] }, "description": "Creates a network service group based on the service group ID.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Network Service Group Z Resource Delete Custom Network Service Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/networkServiceGroups/:serviceGroupId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "networkServiceGroups", ":serviceGroupId" ], "variable": [ { "key": "serviceGroupId", "value": "", "description": "The ID of the network service group." } ] }, "description": "Deletes the network service group based on the service group ID." }, "response": [] }, { "name": "Get Zpa Application Segments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/zpaResources/applicationSegments", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "zpaResources", "applicationSegments" ], "query": [ { "key": "search", "value": "", "description": "The search string used to match against the ZPA application segment name.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 50.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Specifies the application segment parameter by which the list must be sorted. By default, it is sorted by name.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "The order in which the list must be sorted, such as ascending or descending order of the specified parameter or rule execution order.", "disabled": true } ] }, "description": "Retrieves the list of ZPA application segments that be configured in traffic forwarding rule criteria. To learn more, see Configuring Traffic Forwarding Rules." }, "response": [] } ] }, { "name": "Provisioning", "item": [ { "name": "Get Api Keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/apiKeys", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "apiKeys" ], "query": [ { "key": "includePartnerKey", "value": "", "description": "Include or exclude partner keys from the list.", "disabled": true } ] }, "description": "Lists available API keys." }, "response": [] }, { "name": "Regenerate Api Key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/apiKeys/:keyId/regenerate", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "apiKeys", ":keyId", "regenerate" ], "variable": [ { "key": "keyId", "value": "", "description": "The API key ID of the API key you want to regenerate." } ] }, "description": "Regenerates an API key." }, "response": [] }, { "name": "Get Prov Urls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/provUrl", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "provUrl" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Lists provisioning templates." }, "response": [] }, { "name": "Get Prov Url By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/provUrl/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "provUrl", ":id" ], "variable": [ { "key": "id", "value": "", "description": "ID of provisioning template." } ] }, "description": "Gets a provisioning template by ID." }, "response": [] }, { "name": "Get Public Account Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Lists public cloud account information." }, "response": [] }, { "name": "Get Public Account Details By Id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails", ":id" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "ID of the public cloud account." } ] }, "description": "Gets the public (Cloud Connector) cloud account information for the specified ID." }, "response": [] }, { "name": "Get Public Account Details Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountDetails/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountDetails", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "Lists a subset of public (Cloud Connector) cloud account information." }, "response": [] }, { "name": "Get Public Cloud Id Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountIdStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountIdStatus" ] }, "description": "Lists public (Cloud Connector) cloud account status information (enabled/disabled)." }, "response": [] }, { "name": "Update Public Cloud Id Info", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/publicCloudAccountIdStatus", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "publicCloudAccountIdStatus" ] }, "description": "Enables/disables public (Cloud Connector) cloud account status.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] }, { "name": "Workload Groups", "item": [ { "name": "Workload Group Z Resource Get Workload Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/workloadGroups", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "workloadGroups" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 250.", "disabled": true } ] }, "description": "

    Retrieves the list of workload groups.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] }, { "name": "Workload Group Z Resource Get Workload Groups Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/workloadGroups/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "workloadGroups", "lite" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page offset.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size. The default size is 20.", "disabled": true } ] }, "description": "

    Retrieves the list of workload groups.

    \n

    ⚠ This API endpoint is accessible only via OneAPI.

    " }, "response": [] } ] }, { "name": "Zero Trust Gateway", "item": [ { "name": "Get Zero Trust Gateways", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway" ], "query": [ { "key": "platform", "value": "", "description": "Platform of Cloud or Branch Connector group", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies", "disabled": true }, { "key": "region", "value": "", "description": "The region where the ZT gateway is deployed", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieve list of Zero Trust Gateways" }, "response": [] }, { "name": "Create Zero Trust Gateway", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway" ] }, "description": "Creates a Zero Trust Gateway based on the specified parameters", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Update Zero Trust Gateway Metrics", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/analytic/metrics/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "analytic", "metrics", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier of the Zero Trust Gateway" } ] }, "description": "Updates the Zero Trust Gateway based on the specified ID", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Compare Zero Trust Gateway Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/config/compare/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "config", "compare", ":id" ], "query": [ { "key": "action", "value": "", "description": "", "disabled": true }, { "key": "version1", "value": "", "description": "The first version of the configuration selected for comparison", "disabled": true }, { "key": "version2", "value": "", "description": "The second version of the configuration selected for comparison", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier of the gateway" } ] }, "description": "Retrieves the list of Zero Trust Gateways with Internet & SaaS configuration versions that have been activated" }, "response": [] }, { "name": "Get Zero Trust Gateway Config Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/config/status/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "config", "status", ":id" ], "query": [ { "key": "action", "value": "", "description": "The actions available for ZT gateway (Status and compare)", "disabled": true }, { "key": "size", "value": "", "description": "The number of configurations returned per page", "disabled": true }, { "key": "token", "value": "", "description": "Pagination cursor passed in the subsequent request when additional configs are available", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Unique identifier of the Zero Trust gateway" } ] }, "description": "Retrieves the Zero Trust gateway configuration status based on the gateway ID" }, "response": [] }, { "name": "Get Zero Trust Gateways Count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/count", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "count" ], "query": [ { "key": "platform", "value": "", "description": "The cloud service provider used to deploy the gateway", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies", "disabled": true }, { "key": "region", "value": "", "description": "The region where the ZT gateway is deployed", "disabled": true } ] }, "description": "Retrieves the total number of existing Zero Trust Gateways per organization" }, "response": [] }, { "name": "Get Zero Trust Gateway Events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/events/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "events", ":id" ], "query": [ { "key": "size", "value": "", "description": "The number of events returned per page. The default is 25", "disabled": true }, { "key": "ntoken", "value": "", "description": "The default is 25", "disabled": true }, { "key": "begin", "value": "", "description": "Timestamp when the event started", "disabled": true }, { "key": "end", "value": "", "description": "Timestamp when the event ended", "disabled": true }, { "key": "category", "value": "", "description": "The category of the event", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway resource ID" } ] }, "description": "Retrieves the list of events that occurred based on the ZT gateway resource ID" }, "response": [] }, { "name": "Get Zero Trust Gateway License Info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/licenseInfo", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "licenseInfo" ], "query": [ { "key": "platform", "value": "", "description": "The cloud service provider used to deploy the gateway", "disabled": true } ] }, "description": "Retrieves license details of ZT Gateway" }, "response": [] }, { "name": "Get Zero Trust Gateways Lite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/lite", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "lite" ], "query": [ { "key": "platform", "value": "", "description": "The cloud service provider used to deploy the gateway", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies", "disabled": true }, { "key": "region", "value": "", "description": "The region where the ZT gateway is deployed", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves the list of ID and name of existing Zero Trust Gateways" }, "response": [] }, { "name": "Get Zero Trust Gateway Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/status/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "status", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway resource ID" } ] }, "description": "Retrieves the status of the ZT gateway based on the ID" }, "response": [] }, { "name": "Get Zero Trust Gateway Supported Regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/supportedRegions", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "supportedRegions" ], "query": [ { "key": "platform", "value": "", "description": "The platform of Cloud or Branch Connector group", "disabled": true }, { "key": "search", "value": "", "description": "The search string used to match against the policies", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page offset", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the page size", "disabled": true } ] }, "description": "Retrieves the list of ZT gateway supported regions" }, "response": [] }, { "name": "Get Traffic Tests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest" ] }, "description": "Retrieves the list of traffic tests created" }, "response": [] }, { "name": "Create Traffic Test", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest" ] }, "description": "Create a traffic test environment", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Traffic Test Environment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/env/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", "env", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the traffic test" } ] }, "description": "Delete the traffic test based on the ID" }, "response": [] }, { "name": "Get Traffic Test Environment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/env/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", "env", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway resource ID" } ] }, "description": "Retrieve traffic test environment details based on the ZT gateway resource ID" }, "response": [] }, { "name": "Create Traffic Test Environment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/env/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", "env", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway resource ID" } ] }, "description": "Create a traffic test environment" }, "response": [] }, { "name": "Delete Traffic Test", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/:testId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", ":testId" ], "variable": [ { "key": "testId", "value": "", "description": "The traffic test ID" } ] }, "description": "Delete the traffic test based on the traffic test ID" }, "response": [] }, { "name": "Get Traffic Test by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/:testId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", ":testId" ], "variable": [ { "key": "testId", "value": "", "description": "The traffic test ID" } ] }, "description": "Retrieve the traffic test details based on test ID" }, "response": [] }, { "name": "Update Traffic Test", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/trafficTest/:testId", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", "trafficTest", ":testId" ], "variable": [ { "key": "testId", "value": "", "description": "The traffic test ID" } ] }, "description": "Update the traffic test based on the test ID", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Run Traffic Test", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/:gwId/trafficTest/run", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", ":gwId", "trafficTest", "run" ], "variable": [ { "key": "gwId", "value": "", "description": "The ZT gateway resource ID" } ] }, "description": "Run a traffic test based on the gateway ID", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] }, { "name": "Delete Zero Trust Gateway", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway ID" } ] }, "description": "Delete a ZT gateway based on the ZT gateway ID" }, "response": [] }, { "name": "Get Zero Trust Gateway by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway ID" } ] }, "description": "Retrieves the ZT gateway details based on the gateway ID" }, "response": [] }, { "name": "Update Zero Trust Gateway", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{ZTWBaseUrl}}/ztGateway/:id", "host": [ "{{ZTWBaseUrl}}" ], "path": [ "ztGateway", ":id" ], "variable": [ { "key": "id", "value": "", "description": "The ZT gateway ID" } ] }, "description": "Update ZT gateway based on the ZT gateway ID", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [] } ] } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "refreshRequestParams", "value": [ { "key": "audience", "value": "https://api.zscaler.com", "enabled": true, "send_as": "request_body" } ], "type": "any" }, { "key": "tokenRequestParams", "value": [ { "key": "audience", "value": "https://api.zscaler.com", "enabled": true, "send_as": "request_body" } ], "type": "any" }, { "key": "clientSecret", "value": "{{clientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{clientID}}", "type": "string" }, { "key": "refreshTokenUrl", "value": "", "type": "string" }, { "key": "tokenName", "value": "Authentication Service Token", "type": "string" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "accessTokenUrl", "value": "{{authServiceBaseUrl}}/oauth2/v1/token", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "authServiceBaseUrl", "value": "" }, { "key": "clientID", "value": "" }, { "key": "clientSecret", "value": "" }, { "key": "customerId", "value": "" }, { "key": "oneAPIBaseUrl", "value": "https://api.zsapi.net" }, { "key": "ZDXBaseUrl", "value": "{{oneAPIBaseUrl}}/zdx/v1" }, { "key": "ZIAMBaseUrl", "value": "{{oneAPIBaseUrl}}/ziam/admin/api/v1" }, { "key": "ZBIBaseUrl", "value": "{{oneAPIBaseUrl}}/bi" }, { "key": "EASMBaseUrl", "value": "{{oneAPIBaseUrl}}/easm/easm-ui/v1" }, { "key": "AIRedTeamingBaseUrl", "value": "{{oneAPIBaseUrl}}/aisecurity/airt" }, { "key": "UrbacBaseUrl", "value": "{{oneAPIBaseUrl}}/urbac/urbac" }, { "key": "ZPABaseUrl", "value": "{{oneAPIBaseUrl}}/zpa" }, { "key": "ZCellBaseUrl", "value": "{{oneAPIBaseUrl}}/zcell/config" }, { "key": "ZCCBaseUrl", "value": "{{oneAPIBaseUrl}}/zcc/papi/public" }, { "key": "ZIABaseUrl", "value": "{{oneAPIBaseUrl}}/zia/api/v1" }, { "key": "AIInfrastructureBaseUrl", "value": "{{oneAPIBaseUrl}}/aisecurity/aispm" }, { "key": "ZTWBaseUrl", "value": "{{oneAPIBaseUrl}}/ztw/api/v1" } ] }