@itentialopensource/adapter-zscaler

{ "openapi": "3.0.2", "info": { "title": "adapter-zscaler", "version": "1.0.0" }, "paths": { "/authenticatedSession": { "get": { "operationId": "getAuthenticatedSession", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "post": { "operationId": "postAuthenticatedSession", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "credentials", "in": "query", "required": true, "schema": { "title": "credentials", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteAuthenticatedSession", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/auditReport": { "get": { "operationId": "getAuditReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "post": { "operationId": "postAuditReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "delete": { "operationId": "deleteAuditReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/auditReport/download": { "get": { "operationId": "getAuditReportdownload", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/auditlogEntryReport": { "get": { "operationId": "getAuditlogEntryReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "post": { "operationId": "postAuditlogEntryReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "request", "in": "query", "required": false, "schema": { "title": "request", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteAuditlogEntryReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/auditlogEntryReport/download": { "get": { "operationId": "getAuditlogEntryReportdownload", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/departments": { "get": { "operationId": "getDepartments", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/departments/{id}": { "get": { "operationId": "getDepartmentsid", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/groups": { "get": { "operationId": "getGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "title": "search", "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "title": "pageSize", "type": "number" } } ] } }, "/groups/{groupId}": { "get": { "operationId": "getGroupsgroupId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "title": "groupId", "type": "number" } } ] } }, "/users": { "get": { "operationId": "getUsers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "dept", "in": "query", "required": false, "schema": { "title": "dept", "type": "string" } }, { "name": "group", "in": "query", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "title": "pageSize", "type": "number" } } ] }, "post": { "operationId": "postUsers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "user", "in": "query", "required": false, "schema": { "title": "user", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/users/bulkDelete": { "post": { "operationId": "postUsersbulkDelete", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userIds", "in": "query", "required": false, "schema": { "title": "userIds", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/users/{userId}": { "get": { "operationId": "getUsersuserId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ] }, "put": { "operationId": "putUsersuserId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } }, { "name": "user", "in": "query", "required": false, "schema": { "title": "user", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteUsersuserId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ] } }, "/security": { "get": { "operationId": "getSecurity", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "put": { "operationId": "putSecurity", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policy", "in": "query", "required": false, "schema": { "title": "policy", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/security/advanced": { "get": { "operationId": "getSecurityadvanced", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } }, "put": { "operationId": "putSecurityadvanced", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "advSettings", "in": "query", "required": false, "schema": { "title": "advSettings", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/security/advanced/blacklistUrls": { "post": { "operationId": "postSecurityadvancedblacklistUrls", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "title": "action", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/sslSettings/certchain": { "delete": { "operationId": "deleteSslSettingscertchain", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/sslSettings/downloadcsr": { "get": { "operationId": "getSslSettingsdownloadcsr", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/sslSettings/generatecsr": { "post": { "operationId": "postSslSettingsgeneratecsr", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cert", "in": "query", "required": true, "schema": { "title": "cert", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/sslSettings/showcert": { "get": { "operationId": "getSslSettingsshowcert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/sslSettings/uploadcert/text": { "post": { "operationId": "postSslSettingsuploadcerttext", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "fileInputStream", "in": "query", "required": false, "schema": { "title": "fileInputStream", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/sslSettings/uploadcertchain/text": { "post": { "operationId": "postSslSettingsuploadcertchaintext", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "fileInputStream", "in": "query", "required": false, "schema": { "title": "fileInputStream", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/urlCategories": { "get": { "operationId": "getUrlCategories", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "customOnly", "in": "query", "required": false, "schema": { "title": "customOnly", "type": "boolean" } } ] }, "post": { "operationId": "postUrlCategories", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "customCategory", "in": "query", "required": false, "schema": { "title": "customCategory", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/urlCategories/lite": { "get": { "operationId": "getUrlCategorieslite", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/urlCategories/urlQuota": { "get": { "operationId": "getUrlCategoriesurlQuota", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/urlCategories/{categoryId}": { "get": { "operationId": "getUrlCategoriescategoryId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "title": "categoryId", "type": "string" } } ] }, "put": { "operationId": "putUrlCategoriescategoryId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "title": "categoryId", "type": "string" } }, { "name": "action", "in": "query", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "customCategory", "in": "query", "required": false, "schema": { "title": "customCategory", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteUrlCategoriescategoryId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "title": "categoryId", "type": "string" } } ] } }, "/urlLookup": { "post": { "operationId": "postUrlLookup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "urls", "in": "query", "required": false, "schema": { "title": "urls", "type": "array" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vpnCredentials": { "get": { "operationId": "getVpnCredentials", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "title": "search", "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "includeOnlyWithoutLocation", "in": "query", "required": false, "schema": { "title": "includeOnlyWithoutLocation", "type": "boolean" } }, { "name": "locationId", "in": "query", "required": false, "schema": { "title": "locationId", "type": "number" } }, { "name": "managedBy", "in": "query", "required": false, "schema": { "title": "managedBy", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "title": "pageSize", "type": "number" } } ] }, "post": { "operationId": "postVpnCredentials", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnCred", "in": "query", "required": false, "schema": { "title": "vpnCred", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vpnCredentials/bulkDelete": { "post": { "operationId": "postVpnCredentialsbulkDelete", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "title": "ids", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vpnCredentials/{vpnId}": { "get": { "operationId": "getVpnCredentialsvpnId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "number" } } ] }, "put": { "operationId": "putVpnCredentialsvpnId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "number" } }, { "name": "vpnCred", "in": "query", "required": false, "schema": { "title": "vpnCred", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteVpnCredentialsvpnId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vpnId", "in": "path", "required": true, "schema": { "title": "vpnId", "type": "number" } } ] } }, "/locations": { "get": { "operationId": "getLocations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "title": "search", "type": "string" } }, { "name": "sslScanEnabled", "in": "query", "required": false, "schema": { "title": "sslScanEnabled", "type": "boolean" } }, { "name": "xffEnabled", "in": "query", "required": false, "schema": { "title": "xffEnabled", "type": "boolean" } }, { "name": "authRequired", "in": "query", "required": false, "schema": { "title": "authRequired", "type": "boolean" } }, { "name": "bwEnforced", "in": "query", "required": false, "schema": { "title": "bwEnforced", "type": "boolean" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "title": "pageSize", "type": "number" } } ] }, "post": { "operationId": "postLocations", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "location", "in": "query", "required": false, "schema": { "title": "location", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/locations/bulkDelete": { "post": { "operationId": "postLocationsbulkDelete", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "LocationIds", "in": "query", "required": false, "schema": { "title": "LocationIds", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/locations/lite": { "get": { "operationId": "getLocationslite", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "sslScanEnabled", "in": "query", "required": false, "schema": { "title": "sslScanEnabled", "type": "boolean" } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "search", "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "title": "pageSize", "type": "number" } } ] } }, "/locations/{locationId}": { "get": { "operationId": "getLocationslocationId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "title": "locationId", "type": "number" } } ] }, "put": { "operationId": "putLocationslocationId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "title": "locationId", "type": "number" } }, { "name": "location", "in": "query", "required": false, "schema": { "title": "location", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteLocationslocationId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "title": "locationId", "type": "number" } } ] } }, "/sandbox/report/quota": { "get": { "operationId": "getSandboxreportquota", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/sandbox/report/{md5Hash}": { "get": { "operationId": "getSandboxreportmd5Hash", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "md5Hash", "in": "path", "required": true, "schema": { "title": "md5Hash", "type": "string" } }, { "name": "details", "in": "query", "required": false, "schema": { "title": "details", "type": "string" } } ] } }, "/status": { "get": { "operationId": "getStatus", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/status/activate": { "post": { "operationId": "postStatusactivate", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/zscsb/submit": { "post": { "tags": [ "Sandbox Submission API" ], "summary": "submitFile", "description": "Submits raw or archive files (e.g., ZIP) to Sandbox for analysis. You can submit up to 100 files per day and it supports all file types that are currently supported by Sandbox. To learn more, see <a href=\"/zia/about-sandbox\" target=\"_blank\">About Sandbox</a>. By default, files are scanned by Zscaler antivirus (AV) and submitted directly to the sandbox in order to obtain a verdict. However, if a verdict already exists for the file, you can use the 'force' parameter to make the sandbox to reanalyze it. You must have a Sandbox policy rule configured within the ZIA Admin Portal in order to analyze files that aren't present in the default policy rule. Ensure that you have explicitly added Sandbox policy rules that include the appropriate file types within your request. If not, an 'Unknown' message is shown in the response. To learn more, see <a href=\"/zia/configuring-sandbox-policy\" target=\"_blank\">Configuring the Sandbox Policy</a> and <a href=\"/zia/configuring-default-sandbox-rule\" target=\"_blank\">Configuring the Default Sandbox Rule</a>.After files are sent for analysis, you must use GET /sandbox/report/{md5Hash} in order to retrieve the verdict. You can get the Sandbox report 10 minutes after a file is sent for analysis.\n", "operationId": "submitFile", "parameters": [ { "name": "api_token", "in": "query", "description": "The Sandbox API token obtained from the ZIA Admin Portal to be used for authenticating the Sandbox Submission API. To learn more, see <a href=\"/zia/about-sandbox-api-token\" target=\"_blank\">Managing Sandbox API Token</a>.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "Submit file to sandbox even if found malicious during AV scan and a verdict already exists.", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/force" }, { "description": "Submit file to sandbox even if found malicious during AV scan and a verdict already exists." } ] } } ], "responses": { "200": { "description": "Successful Operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSubmissionResponse" } } } } }, "deprecated": false } }, "/zscsb/discan": { "post": { "tags": [ "Sandbox Submission API" ], "summary": "submitFileForScan", "description": "Submits raw or archive files (e.g., ZIP) to the Zscaler service for out-of-band file inspection to generate real-time verdicts for known and unknown files. It leverages capabilities such as Malware Prevention, Advanced Threat Prevention, Sandbox cloud effect, AI/ML-driven file analysis, and integrated third-party threat intelligence feeds to inspect files and classify them as benign or malicious instantaneously.All file types that are currently supported by the <a href=\"/zia/configuring-malware-protection-policy\" target=\"_blank\">Malware Protection policy</a> and <a href=\"/zia/configuring-advanced-threat-protection-policy\" target=\"_blank\">Advanced Threat Protection</a> policy are supported for inspection, and each file is limited to a size of 400 MB.Note: Dynamic file analysis is not included in out-of-band file inspection.", "operationId": "submitFileForScan", "parameters": [ { "name": "api_token", "in": "query", "description": "The Sandbox API token obtained from the ZIA Admin Portal to be used for authenticating the Sandbox Submission API. To learn more, see <a href=\"/zia/about-sandbox-api-token\" target=\"_blank\">Managing Sandbox API Token</a>.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DIScanSubmissionResponse" } } } } }, "deprecated": false } }, "/apps/app": { "get": { "tags": [ "Applications" ], "summary": "getApp", "description": "https://api.apptotal.zscaler.com/v1/apps/app Constraints:<ul><li> For query parameters, ensure that the provided characters adhere to the specifications outlined in RFC 7230 and RFC 3986. <li> Special characters and encoding must follow the standards defined in RFC 3986.</ul> Searches the AppTotal App Catalog by either app ID or URL (i.e., a valid consent or marketplace link). You must use one of the required parameters—<code>app_id </code> or <code>url</code>—for your search. If you use both an app ID and a URL for your search, an error is returned. <ul><li>If the app is found in the catalog, a <code>200</code> response is received and the app's information is returned. </li><li>If the app is not initially found in the catalog, a <code>202</code> response is received and the app is submitted for analysis in the AppTotal Sandbox. </li> Note: After analysis is complete, a subsequent <code>GET</code> request is required to fetch the app's information. As a best practice, allow 24 hours for analysis and then resubmit the required <code>GET</code> request. </ul><ul><li>If the app is not found in the catalog, a <code>404</code> response is received.</li><li>If the URL is not valid, a <code>400</code> response is received.</li> Note: If you cannot find the app via the API, you can troubleshoot by <a target=_blank href=\"https://help.zscaler.com/zia/searching-apps\\\">manually searching for the app</a> in the AppTotal Admin Portal. If you cannot find the app through manual search, contact Zscaler Support. </ul>To learn more, see the Responses in the right-side panel.\n", "operationId": "getApp", "parameters": [ { "name": "app_id", "in": "query", "description": "The app identifier (e.g., OAuth client ID)", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Valid consent link or marketplace link", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "verbose", "in": "query", "description": "Return a verbose report including potentially heavy artifacts (e.g., extracted URLs and a list of vulnerabilities)", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful Operation", "headers": { "X-Rate-Limit-Remaining": { "description": "The requests remaining until the quota limit is reached", "content": { "text/plain": { "schema": { "type": "integer", "description": "The requests remaining until the quota limit is reached", "format": "int32" } } } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "202": { "description": "Application Analysis Underway", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleMessageResponse" } } } }, "400": { "description": "Bad Input Parameter", "headers": {}, "content": {} }, "401": { "description": "Not Authenticated", "headers": {}, "content": {} }, "403": { "description": "Access Forbidden", "headers": {}, "content": {} }, "404": { "description": "Application Not Found", "headers": {}, "content": {} }, "409": { "description": "Rate Limit Exceeded", "headers": { "Retry-After": { "description": "The seconds remaining until the rate limit resets", "content": { "text/plain": { "schema": { "type": "integer", "description": "The seconds remaining until the rate limit resets", "format": "int32" } } } } }, "content": {} }, "500": { "description": "Internal Server Error Occurred", "headers": {}, "content": {} } }, "deprecated": false }, "post": { "tags": [ "Applications" ], "summary": "postApp", "description": "https://api.apptotal.zscaler.com/v1/apps/app Submits an app for analysis in the AppTotal Sandbox. After analysis is complete, a subsequent <code>GET</code> request is required to fetch the app's information.\n", "operationId": "postApp", "parameters": [], "requestBody": { "description": "The app identifier (e.g., OAuth client ID)", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SimpleAppIdRequest" }, { "description": "The app identifier (e.g., OAuth client ID)" } ] } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "headers": { "X-Rate-Limit-Remaining": { "description": "The requests remaining until the quota limit is reached", "content": { "text/plain": { "schema": { "type": "integer", "description": "The requests remaining until the quota limit is reached", "format": "int32" } } } } }, "content": {} }, "400": { "description": "Invalid Request Body", "headers": {}, "content": {} }, "401": { "description": "Not Authenticated", "headers": {}, "content": {} }, "403": { "description": "Access Forbidden", "headers": {}, "content": {} }, "409": { "description": "Rate Limit Exceeded", "headers": { "Retry-After": { "description": "The seconds remaining until the rate limit resets", "content": { "text/plain": { "schema": { "type": "integer", "description": "The seconds remaining until the rate limit resets", "format": "int32" } } } } }, "content": {} }, "500": { "description": "Internal Server Error Occurred", "headers": {}, "content": {} } }, "deprecated": false } }, "/apps/search": { "get": { "tags": [ "Applications" ], "summary": "AppsSearch_GET", "description": "https://api.apptotal.zscaler.com/v1/apps/search Constraints:<ul><li> For query parameters, ensure that the provided characters adhere to the specifications outlined in RFC 7230 and RFC 3986. <li> Special characters and encoding must follow the standards defined in RFC 3986.</ul> Searches for an app by name. Any app whose name contains the search term (<code>appName</code>) is returned. Note: The maximum number of results that are returned is 200.\n", "operationId": "AppsSearch_GET", "parameters": [ { "name": "appName", "in": "query", "description": "The app name", "required": true, "style": "form", "explode": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit the number of results", "style": "form", "explode": true, "schema": { "maximum": 200.0, "minimum": 1.0, "type": "integer", "format": "int32", "default": 50 } }, { "name": "page", "in": "query", "description": "Page number", "style": "form", "explode": true, "schema": { "minimum": 1.0, "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Successful Operation", "headers": { "X-Rate-Limit-Remaining": { "description": "The remaining requests until the quota limit is reached", "content": { "text/plain": { "schema": { "type": "integer", "description": "The remaining requests until the quota limit is reached", "format": "int32" } } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaginationResponse" }, "description": "" } } } }, "400": { "description": "Invalid Request Body", "headers": {}, "content": {} }, "401": { "description": "Not Authenticated", "headers": {}, "content": {} }, "403": { "description": "Access Forbidden", "headers": {}, "content": {} }, "409": { "description": "Rate Limit Exceeded", "headers": { "Retry-After": { "description": "The seconds remaining until the rate limit resets", "content": { "text/plain": { "schema": { "type": "integer", "description": "The seconds remaining until the rate limit resets", "format": "int32" } } } } }, "content": {} }, "500": { "description": "Internal Server Error Occurred", "headers": {}, "content": {} } }, "deprecated": false } }, "/app_views/list": { "get": { "tags": [ "App Views" ], "summary": "getViews", "description": "https://api.apptotal.zscaler.com/v1/app_views/list Retrieves the list of <a target=_blank href=\"https://help.zscaler.com/zia/custom-views\\\">custom views</a> that you have configured in the AppTotal Admin Portal and includes all configurations that define the custom view.", "operationId": "getViews", "parameters": [], "responses": { "200": { "description": "Successful Operation", "headers": { "X-Rate-Limit-Remaining": { "description": "The requests remaining until the quota limit is reached", "content": { "text/plain": { "schema": { "type": "integer", "description": "The requests remaining until the quota limit is reached", "format": "int32" } } } } },