{
"openapi": "3.0.0",
"info": {
"title": "Zscaler Private Access API Portal",
"description": "To access detailed ZPA API documentation, including references and use cases, refer to the [Zscaler Help Portal](/zpa/about-zpa-api).",
"version": "1.0"
},
"extensions": {
"x-original-swagger-version": "2.0"
},
"tags": [
{
"name": "Application Segment Management"
}
],
"paths": {
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/mappings": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the application segment mapping details for the specified customer.",
"operationId": "getApplicationSegmentMappings_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationMappingResource"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/tags": {
"put": {
"tags": [
"Application Segment Management"
],
"description": "Updates tags for the inherited and shared application segment.",
"operationId": "updateTagsForInheritedAndSharedApplication_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the Application Segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationTagsResource"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/getAppsByType": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets all configured application segments by application type (e.g., Browser Access, AppProtection, Privileged Remote Access) for the specified customer.",
"operationId": "getAllBaOrInspectApps_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "The search string used to support search by features and fields for the API.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Specifies the page number.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "1"
},
{
"name": "pagesize",
"in": "query",
"description": "Specifies the page size. If not provided, the default page size is 20. The maximum page size is 500.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "20"
},
{
"name": "expandAll",
"in": "query",
"description": "If set to true, includes additional information related to the applications.",
"required": false,
"explode": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "applicationType",
"in": "query",
"description": "Indicates the type of application. The supported values are:INSPECT: AppProtectionSECURE_REMOTE_ACCESS: Privileged Remote AccessBROWSER_ACCESS: Browser Access
",
"required": true,
"explode": false,
"schema": {
"type": "string"
},
"example": "INSPECT"
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PageListBaseAppDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets all configured application segments for the specified customer.",
"operationId": "getAllApplications_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "The search string used to support search by features and fields for the API.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Specifies the page number.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "1"
},
{
"name": "pagesize",
"in": "query",
"description": "Specifies the page size. If not provided, the default page size is 20. The maximum page size is 500.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "20"
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PageListApplicationResource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
},
"post": {
"tags": [
"Application Segment Management"
],
"description": "Adds a new application segment for the specified customer.",
"operationId": "addApplication_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the application segment details for the specified ID.",
"operationId": "getApplication_3",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
},
"put": {
"tags": [
"Application Segment Management"
],
"description": "Updates the application segment details for the specified ID.",
"operationId": "updateApplicationV2_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
},
"required": "true"
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
},
"delete": {
"tags": [
"Application Segment Management"
],
"description": "Deletes the application segment for the specified ID.",
"operationId": "deleteApplication_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "forceDelete",
"in": "query",
"description": "Set this field to true to delete the mapping between the application segment and segment group.",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "false"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/share": {
"put": {
"tags": [
"Application Segment Management"
],
"description": "Shares the application segment to the Microtenant for the specified ID.",
"operationId": "shareApplicationToScopes_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationShareResource"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/validate": {
"post": {
"tags": [
"Application Segment Management"
],
"description": "Update the domain names with wildcards for the specified customer. If the domain names are updated, the application segment is updated.",
"operationId": "validateWildCardDomainName_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/bulkUpdateMultiMatch": {
"put": {
"tags": [
"Application Segment Management"
],
"description": "Bulk updates application segment Multimatch in multiple applications.",
"operationId": "bulkUpdateMultimatchInApplications_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpdateMultimatchResource"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{appId}/getAppByType": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the application segment details based on application type (e.g., Browser Access, AppProtection, Privileged Remote Access) for the specified customer.",
"operationId": "getBaOrInspectApp_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "appId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationType",
"in": "query",
"description": "The type of application",
"required": true,
"explode": false,
"schema": {
"type": "string"
},
"example": "INSPECT"
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BaseAppDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/configured/count": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the count of application segments for the specified customer based on the requested time range.",
"operationId": "getConfiguredApplicationCount_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfiguredApplicationCount"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/count/currentAndMaxLimit": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the current count and maximum count for application domains for a specified customer.",
"operationId": "getCurrentAndMaxCount_1",
"parameters": [
{
"name": "customerId",
"description": "The unique identifier of the ZPA tenant.",
"in": "path",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApplicationCurrentAndMaxCount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/weightedLbConfig": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the application load balancing configuration of the application segment for the specified ID.",
"operationId": "getWeightedLoadBalancerConfig_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/WeightedLBConfigDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
},
"put": {
"tags": [
"Application Segment Management"
],
"description": "Updates the application load balancing configuration of the application segment for the specified ID.",
"operationId": "updateWeightedLoadBalancerConfig_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WeightedLBConfigDTO"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/summary": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets a summary of application segments for the specified customer.",
"operationId": "getAllApplicationNameIds_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "The search string used to support search by features and fields for the API.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Specifies the page number.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "1"
},
{
"name": "pagesize",
"in": "query",
"description": "Specifies the page size. If not provided, the default page size is 20. The max page size is 500.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": "20"
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PageListNameIdDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/{applicationId}/move": {
"post": {
"tags": [
"Application Segment Management"
],
"description": "Moves an application segment from one Microtenant to another Microtenant for the specified ID.",
"operationId": "moveApplication_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "applicationId",
"in": "path",
"description": "The unique identifier of the application segment.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppMoveDTO"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/multimatchUnsupportedReferences": {
"post": {
"tags": [
"Application Segment Management"
],
"description": "Gets the application segments by domain that are incompatible for application segment Multimatch.",
"operationId": "multimatchUnsupportedReferences_2",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"description": "The list of application domains.",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultimatchUnsupportedReferences"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
},
"/mgmtconfig/v1/admin/customers/{customerId}/application/export": {
"get": {
"tags": [
"Application Segment Management"
],
"description": "Gets the export of the application segment details for the specified customer.",
"operationId": "exportApplication_1",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The unique identifier of the ZPA tenant.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "The search string used to support search by features and fields for the API.",
"required": false,
"allowEmptyValue": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "single",
"in": "query",
"required": false,
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "microtenantId",
"in": "query",
"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.",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ZPathAPIError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ApplicationMappingResource": {
"properties": {
"names": {
"type": "array",
"description": "The list of resources for the application mapping.",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "The type of application mapping."
}
}
},
"ZPathAPIError": {
"properties": {
"reason": {
"type": "string",
"description": "The reason for the cause of the error status code. To learn more, see API Response Codes and Error Messages."
},
"id": {
"type": "string",
"description": "The unique identifier of the error status code."
},
"params": {
"type": "array",
"description": "The parameters that were sent in the request body.",
"items": {
"type": "object"
}
},
"hostname": {
"type": "string",
"description": "The client server address or domain name."
}
}
},
"ApplicationTagsResource": {
"properties": {
"creationTime": {
"type": "integer",
"description": "The time the application tag resource is created. This field is only applicable for GET requests, and is ignored in PUT, POST, or DELETE requests.",
"format": "int32",
"readOnly": true
},
"id": {
"type": "string",
"description": "The unique identifier of the application tag resource. This field is only applicable for GET requests, and is ignored in PUT, POST, or DELETE requests.",
"readOnly": true
},
"modifiedBy": {
"type": "string",
"description": "The unique identifier of the tenant who modified the application tag resource. This field is only applicable for GET requests, and is ignored in PUT, POST, or DELETE requests.",
"readOnly": true
},
"modifiedTime": {
"type": "integer",
"description": "The time the application tag resource is modified. This field is only applicable for GET requests, and is ignored in PUT, POST, or DELETE requests.",
"format": "int32",
"readOnly": true
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"tags": {
"type": "array",
"description": "The list of tags.",
"items": {
"$ref": "#/components/schemas/TagValueSummary"
}
}
}
},
"PageListBaseAppDto": {
"properties": {
"totalPages": {
"type": "integer",
"description": "The total number of pages per the pagination attribute.",
"format": "int32"
},
"currentCount": {
"type": "integer",
"description": "The current count of resources per the search feature.",
"format": "int64"
},
"totalCount": {
"type": "integer",
"description": "The total count of resources per the search feature.",
"format": "int64"
},
"list": {
"type": "array",
"description": "The total list of application resources.",
"items": {
"$ref": "#/components/schemas/BaseAppDto"
}
}
}
},
"PageListApplicationResource": {
"properties": {
"totalPages": {
"type": "integer",
"description": "The total number of pages per the pagination attribute.",
"format": "int32"
},
"currentCount": {
"type": "integer",
"description": "The current count of resources per the search feature.",
"format": "int64"
},
"totalCount": {
"type": "integer",
"description": "The total count of resources per the search feature.",
"format": "int64"
},
"list": {
"type": "array",
"description": "The total list of application resources.",
"items": {
"$ref": "#/components/schemas/ApplicationResource"
}
}
}
},
"ApplicationResource": {
"required": [
"name"
],
"properties": {
"modifiedTime": {
"type": "integer",
"description": "The time the application resource is modified. This field is only applicable for a GET request, and is ignored in PUT, POST, and DELETE requests.",
"format": "int32",
"readOnly": true
},
"creationTime": {
"type": "integer",
"description": "The time the application resource is created. This field is only applicable for a GET request, and is ignored in PUT, POST, and DELETE requests. requests.",
"format": "int32",
"readOnly": true
},
"modifiedBy": {
"type": "string",
"description": "The unique identifier of the tenant who modified the application resource. This field is only applicable for a GET request, and is ignored in PUT, POST, and DELETE requests.",
"readOnly": true
},
"id": {
"type": "string",
"description": "The unique identifier of the application resource. This field is only applicable for a GET request, and is ignored in PUT, POST, and DELETE requests.",
"readOnly": true
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"domainNames": {
"type": "array",
"description": "The list of domains and IP addresses. The maximum limit for domains or IP addresses is 2,000 applications per application segment. The maximum limit for domains or IP addresses for the whole customer is 6,000 applications.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "The name of the application resource."
},
"description": {
"type": "string",
"description": "The description of the application resource."
},
"defaultIdleTimeout": {
"type": "integer",
"description": "The duration of the default idle timeout.",
"format": "int32"
},
"defaultMaxAge": {
"type": "integer",
"description": "The default maximum age of the resource.",
"format": "int32"
},
"serverGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppServerGroup"
}
},
"enabled": {
"type": "boolean",
"description": "Whether or not this application resource is enabled."
},
"passiveHealthEnabled": {
"type": "boolean",
"description": "Indicates if passive health checks are enabled on the application."
},
"tcpPortRanges": {
"type": "array",
"description": "The list of TCP port ranges used to access the application.",
"items": {
"type": "integer",
"format": "int32"
}
},
"udpPortRanges": {
"type": "array",
"description": "The list of UDP port ranges used to access the application.",
"items": {
"type": "integer",
"format": "int32"
}
},
"tcpPortRange": {
"type": "array",
"description": "The list of TCP port ranges used to access the application.",
"items": {
"$ref": "#/components/schemas/AppPortRange"
}
},
"udpPortRange": {
"type": "array",
"description": "The UDP port ranges used to access the application.",
"items": {
"$ref": "#/components/schemas/AppPortRange"
}
},
"doubleEncrypt": {
"type": "boolean",
"description": "Indicates if Double Encryption is enabled (true) or disabled (false) for the application."
},
"segmentGroupId": {
"type": "string",
"description": "The unique identifier of the segment group."
},
"segmentGroupName": {
"type": "string",
"description": "The name of the segment group."
},
"configSpace": {
"type": "string",
"description": "Indicates if the configuration is created as part of the SIEM or application resource.",
"enum": [
"DEFAULT",
"SIEM"
]
},
"bypassType": {
"type": "string",
"description": "Indicates the bypass type when users bypass ZPA to access applications.",
"enum": [
"ALWAYS",
"NEVER",
"ON_NET"
]
},
"healthCheckType": {
"type": "string",
"description": "Whether the health check is enabled (DEFAULT) or disabled (NONE) for the application.",
"enum": [
"DEFAULT",
"NONE"
]
},
"icmpAccessType": {
"type": "string",
"description": "The ICMP access type of the application.",
"enum": [
"PING_TRACEROUTING",
"PING",
"NONE"
]
},
"isCnameEnabled": {
"description": "Indicates if Zscaler Client Connector receives CNAME DNS records from App Connectors.",
"type": "boolean"
},
"clientlessApps": {
"type": "array",
"description": "List of clientless or Browser Access applications. If a list of Browser Access applications are provided, then the field matchStyle must be set to EXCLUSIVE.",
"items": {
"$ref": "#/components/schemas/BAAppDto"
}
},
"inspectionApps": {
"type": "array",
"description": "The list of AppProtection applications.",
"items": {
"$ref": "#/components/schemas/InspectAppDto"
}
},
"praApps": {
"type": "array",
"description": "The list of Privileged Remote Access applications.",
"items": {
"$ref": "#/components/schemas/PraAppDto"
}
},
"commonAppsDto": {
"$ref": "#/components/schemas/CommonApplicationDto",
"description": "The configured application."
},
"ipAnchored": {
"type": "boolean",
"description": "Whether Source IP Anchoring for use with ZIA is enabled (true) or disabled (false) for the application."
},
"bypassOnReauth": {
"type": "boolean",
"description": "Indicates if application access during reauthentication bypasses ZPA (Enabled) or not (Disabled). For example, if your IdP is configured to do multi-factor authentication (MFA) for off-premises users, enabling this option redirects the user to the IdP via the internet where the IdP prompts the user for MFA. For on-premises users, enabling this option redirects the user to the IdP via the internet where the IdP prompts them for MFA. This feature requires versions Zscaler Client Connector 4.3 or later for Windows and macOS."
},
"inspectTrafficWithZia": {
"type": "boolean",
"description": "Enable to leverage single posture for securing internet or SaaS and private applications and apply Data Loss Prevention policies to the application segment you are creating. If Source IP Anchor is enabled, you must disable it prior to enabling Inspect Traffic with ZIA as both features cannot be enabled at the same time."
},
"healthReporting": {
"type": "string",
"description": "Indicates the health reporting of the application.",
"enum": [
"NONE",
"ON_ACCESS",
"CONTINUOUS"
]
},
"useInDrMode": {
"type": "boolean",
"description": "Whether or not the application resource is designated for disaster recovery."
},
"tcpKeepAlive": {
"type": "integer",
"description": "Indicates if TCP Keep Alive is enabled (1) or disabled (0) for the application segment.",
"format": "int32"
},
"appRecommendationId": {
"type": "string",
"description": "The unique identifier of the recommended application."
},
"selectConnectorCloseToApp": {
"type": "boolean",
"description": "Whether the App Connector is closest to the application (true) or closest to the user (false)."
},
"sharedMicrotenantDetails": {
"$ref": "#/components/schemas/SharedMicrotenantDetails",
"description": "The details of the Microtenant."
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails",
"description": "The details of the inconsistent configuration."
},
"matchStyle": {
"type": "string",
"description": "Indicates if Multimatch is enabled for the application segment. If enabled (INCLUSIVE), the request allows traffic to match multiple applications. If disabled (EXCLUSIVE), the request allows traffic to match a single application. A domain can only be INCLUSIVE or EXCLUSIVE, and any application segment can only contain inclusive or exclusive domains.",
"enum": [
"EXCLUSIVE",
"INCLUSIVE"
]
},
"tcpProtocols": {
"type": "array",
"description": "Indicates the AD Protection protocols to be inspected on the specified TCP port ranges. This field is only required if adpEnabled is set to true.",
"items": {
"type": "string",
"enum": [
"NONE",
"KERBEROS",
"LDAP",
"SMB"
]
}
},
"udpProtocols": {
"type": "array",
"description": "Indicates the AD Protection protocols to be inspected on the specified UDP port ranges. This field is only required if adpEnabled is set to true.",
"items": {
"type": "string",
"enum": [
"NONE",
"KERBEROS",
"LDAP",
"SMB"
]
}
},
"isIncompleteDRConfig": {
"type": "boolean",
"description": "Indicates if the disaster recovery configuration is incomplete (true) or not (false)."
},
"adpEnabled": {
"type": "boolean",
"description": "Indicates if Active Directory Inspection is enabled or not for the application. This allows the application segment's traffic to be inspected by Active Directory (AD) Protection. By default, this field is set to false. If adpEnabled is set to true, then the field matchStyle must be set to EXCLUSIVE. If adpEnabled is set to true, then autoAppProtectEnabled cannot be set to true."
},
"autoAppProtectEnabled": {
"type": "boolean",
"description": "If autoAppProtectEnabled is set to true, this field indicates if the application segment\u2019s traffic is inspected by AppProtection. If set to true, a valid AppProtection enrollment certificate must be generated to inspect application segment traffic by AppProtection. If adpEnabled is set to true for Active Directory Inspection, then autoAppProtectEnabled cannot be true."
},
"apiProtectionEnabled": {
"type": "boolean",
"description": "If true, designates the application segment for API traffic inspection."
},
"fqdnDnsCheck": {
"type": "boolean",
"description": "If true, perform a DNS check to find an A or AAAA record for this application."
},
"weightedLoadBalancing": {
"type": "boolean",
"description": "Indicates if the application load balancing configuration for application segments is enabled (true) or disabled (false)."
},
"extranetEnabled": {
"type": "boolean",
"description": "Indicates if the application is designated for Extranet Application Support (true) or not (false). Extranet applications connect to a partner site or offshore development center that is not directly available on your organization\u2019s network."
},
"zpnErId": {
"$ref": "#/components/schemas/ZpnExtranetResource",
"description": "The ID of the Extranet application."
}
}
},
"ApplicationShareResource": {
"properties": {
"shareToMicrotenants": {
"uniqueItems": true,
"description": "The unique identifier of the Microtenant that the application segment is being shared to. This field is required if you want to share an application segment.",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"BulkUpdateMultimatchResource": {
"properties": {
"matchStyle": {
"type": "string",
"description": "Indicates if Multimatch is enabled for the application segment. If enabled (INCLUSIVE), the request allows traffic to match multiple applications. If disabled (EXCLUSIVE), the request allows traffic to match a single application. A domain can only be INCLUSIVE or EXCLUSIVE, and any application segment can only contain inclusive or exclusive domains.",
"enum": [
"EXCLUSIVE",
"INCLUSIVE"
]
},
"applicationIds": {
"uniqueItems": true,
"description": "The IDs of the appication segments.",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"BaseAppDto": {
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the application."
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string",
"description": "The description of the application."
},
"certificateId": {
"type": "integer",
"description": "The unique identifier of the certificate.",
"format": "int64"
},
"certificateName": {
"type": "string",
"description": "The name of the certificate."
},
"applicationPort": {
"type": "integer",
"description": "The application port.",
"format": "int32"
},
"applicationProtocol": {
"type": "string",
"description": "The application protocol.",
"enum": [
"HTTP",
"HTTPS",
"FTP",
"RDP",
"SSH",
"WEBSOCKET",
"VNC",
"REALVNC",
"NONE",
"AUTO",
"DYNAMIC",
"KRB",
"LDAP",
"SMB"
]
},
"domain": {
"type": "string",
"description": "The domain of the application."
},
"appId": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails",
"description": "The details of the inconsistent configuration."
}
}
},
"ConfiguredApplicationCount": {
"type": "object",
"properties": {
"configuredDateInEpochSeconds": {
"type": "integer",
"format": "int64",
"description": "The configured date of the configured application."
},
"appsConfigured": {
"type": "integer",
"format": "int32",
"description": "The count of configured applications."
}
}
},
"ApplicationCurrentAndMaxCount": null,
"WeightedLBConfigDTO": {
"properties": {
"applicationId": {
"type": "integer",
"description": "The unique identifier of the application segment.",
"format": "int64"
},
"weightedLoadBalancing": {
"type": "boolean",
"description": "Indicates if the application load balancing configuration for application segments is enabled (true) or disabled (false)."
},
"applicationToServerGroupMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationToGroupMappingDto"
}
}
}
},
"PageListNameIdDto": {
"properties": {
"currentCount": {
"type": "integer",
"description": "The current count of names for the entity type.",
"format": "int64"
},
"list": {
"type": "array",
"description": "The list of names for the entity type.",
"items": {
"$ref": "#/components/schemas/NameIdDto"
}
},
"message": {
"type": "string",
"description": "The message of the entity type."
},
"totalCount": {
"type": "integer",
"description": "The total count of entity types.",
"format": "int64"
},
"totalPages": {
"type": "integer",
"description": "The total number of pages per the pagination attribute. ",
"format": "int32"
}
}
},
"AppMoveDTO": {
"properties": {
"targetMicrotenantId": {
"type": "integer",
"description": "The unique identifier of the Microtenant that the application segment is being moved to.",
"format": "int64"
},
"targetSegmentGroupId": {
"type": "integer",
"description": "The unique identifier of the target segment group that the application segment is being moved to.",
"format": "int64"
},
"targetServerGroupId": {
"type": "integer",
"description": "The unique identifier of the target server group that the application segment is being moved to.",
"format": "int64"
}
}
},
"MultimatchUnsupportedReferences": {
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the unsupported references."
},
"appSegmentName": {
"type": "string",
"description": "The name of the application segment."
},
"domains": {
"type": "array",
"description": "The list of domains.",
"items": {
"type": "string"
}
},
"tcpPorts": {
"type": "array",
"description": "The list of TCP port ranges.",
"items": {
"type": "integer",
"format": "int32"
}
},
"udpPorts": {
"type": "array",
"description": "The list of UDP port ranges.",
"items": {
"type": "integer",
"format": "int32"
}
},
"unsupportedFeatures": {
"type": "array",
"description": "The list of unsupported features.",
"items": {
"type": "string"
}
},
"matchStyle": {
"type": "string",
"description": "Indicates if Multimatch is enabled for the application segment. If enabled (INCLUSIVE), the request allows traffic to match multiple applications. If disabled (EXCLUSIVE), the request allows traffic to match a single application. A domain can only be INCLUSIVE or EXCLUSIVE, and any application segment can only contain inclusive or exclusive domains.",
"enum": [
"EXCLUSIVE",
"INCLUSIVE"
]
},
"microtenantId": {
"type": "string",
"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."
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
}
}
},
"TagValueSummary": {
"properties": {
"namespace": {
"$ref": "#/components/schemas/TagNamespaceKeyInfo"
},
"origin": {
"type": "string",
"description": "The origin of the namespace. Only ORIGIN is supported when creating a namespace.",
"enum": [
"CUSTOM",
"PREDEFINED",
"SEGMENTATION"
]
},
"tagKey": {
"$ref": "#/components/schemas/TagNamespaceKeyInfo"
},
"tagValue": {
"$ref": "#/components/schemas/TagNameIdDto"
}
}
},
"TagNamespaceKeyInfo": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Specifies if the tag namespace is enabled (true) or disabled (false)."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the namespace, or key."
},
"name": {
"type": "string",
"description": "The name of the tag, namespace, or key."
}
}
},
"TagNameIdDto": {
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the tag."
},
"name": {
"type": "string",
"description": "The name of the tag."
}
}
},
"InconsistentConfigDetails": {
"properties": {
"application": {
"type": "array",
"description": "The inconsistent configuration details for the application.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"sraApplication": {
"type": "array",
"description": "The inconsistent configuration details for the Privileged Remote Access application.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"segmentGroup": {
"type": "array",
"description": "The inconsistent configuration details for the segment group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"serverGroup": {
"type": "array",
"description": "The inconsistent configuration details for the server group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"appConnectorGroup": {
"type": "array",
"description": "The inconsistent configuration details for the App Connector group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"baCertificate": {
"type": "array",
"description": "The inconsistent configuration details for the Browser Access certificate.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"postureProfile": {
"type": "array",
"description": "The inconsistent configuration details for the posture profile.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"trustedNetwork": {
"type": "array",
"description": "The inconsistent configuration details for the trusted network.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"branchConnectorGroup": {
"type": "array",
"description": "The inconsistent configuration details for the Branch Connector group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"cloudConnectorGroup": {
"type": "array",
"description": "The inconsistent configuration details for the Cloud Connector group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"samlAttributes": {
"type": "array",
"description": "The inconsistent configuration details for the SAML attributes.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"scimAttributes": {
"type": "array",
"description": "The inconsistent configuration details for the SCIM attributes.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"machineGroup": {
"type": "array",
"description": "The inconsistent configuration details for the machine group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"idp": {
"type": "array",
"description": "The inconsistent configuration details for the IdP.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"location": {
"type": "array",
"description": "The inconsistent configuration details for the location.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"workloadTagGroup": {
"type": "array",
"description": "The inconsistent configuration details for the workload group.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
},
"userPortal": {
"type": "array",
"description": "The inconsistent configuration details for the user portal.",
"items": {
"$ref": "#/components/schemas/InconsistentConfigNameReasonDto"
}
}
}
},
"InconsistentConfigNameReasonDto": {
"properties": {
"name": {
"type": "string",
"description": "The name of the inconsistent configuration."
},
"reason": {
"type": "string",
"description": "The reason for the inconsistent configuration."
}
}
},
"AppServerGroup": {
"required": [
"configSpace",
"enabled",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the server group.",
"format": "int64"
},
"modifiedTime": {
"type": "integer",
"description": "The time the server group is modified.",
"format": "int32"
},
"creationTime": {
"type": "integer",
"description": "The time the server group is created.",
"format": "int32"
},
"modifiedBy": {
"type": "integer",
"description": "The unique identifier of the tenant who modified the resource.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the server group."
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"enabled": {
"type": "boolean",
"description": "Whether or not the server group is enabled."
},
"dynamicDiscovery": {
"type": "boolean",
"description": "Controls dynamic discovery of the servers."
},
"description": {
"type": "string",
"description": "The description of the server group."
},
"configSpace": {
"type": "string",
"description": "Indicates if the configuration is created as part of the SIEM or application resource.",
"enum": [
"DEFAULT",
"SIEM"
]
},
"weight": {
"type": "integer",
"description": "The weight of the load balancing configuration. Weights with a lower value indicate that a lesser number of requests are served by the App Connectors linked to the server group. Weights with a higher value than other server groups indicate that the App Connectors linked to the server group serve a greater number of requests. Server groups with weights set to 0 do not route requests.",
"format": "int32"
},
"passive": {
"type": "boolean",
"description": "Indicates if the server groups are in an active state and can load balance (false), or if the server groups stay passive (true)."
},
"extranetEnabled": {
"type": "boolean",
"description": "indicates if Extranet Application Support is enabled for the server group. These field is only applicable for server group endpoints, and is not applicable for Policy Set or Policy Rule endpoints."
},
"zpnErId": {
"$ref": "#/components/schemas/ZpnExtranetResource"
}
}
},
"ZpnExtranetResource": {
"required": [
"ziaCloud",
"ziaErId",
"ziaErName",
"ziaOrgId"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the extranet resource.",
"format": "int64"
},
"modifiedTime": {
"type": "integer",
"description": "The time the extranet resource is modified.",
"format": "int32"
},
"creationTime": {
"type": "integer",
"description": "The time the extranet resource is created.",
"format": "int32"
},
"modifiedBy": {
"type": "integer",
"description": "The unique identifier of the tenant who modified the extranet resource.",
"format": "int64"
},
"ziaErId": {
"type": "integer",
"description": "The unique identifier of the extranet resource created in ZIA.",
"format": "int64"
},
"ziaErName": {
"type": "string",
"description": "The name of the extranet resource created in ZIA."
},
"ziaCloud": {
"type": "string",
"description": "The ZIA cloud of the extranet resource."
},
"ziaOrgId": {
"type": "integer",
"description": "The unique identifier of the organization for the extranet resource.",
"format": "int64"
},
"ziaModifiedTime": {
"type": "integer",
"description": "The time the extranet resource was modified in ZIA.",
"format": "int64"
}
}
},
"AppPortRange": {
"properties": {
"from": {
"type": "integer",
"description": "The starting port for a port range.",
"format": "int32"
},
"to": {
"type": "integer",
"description": "The ending port for a port range.",
"format": "int32"
}
}
},
"BAAppDto": {
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the Browser Access application segment.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the Browser Access application segment."
},
"enabled": {
"type": "boolean",
"description": "Indicates whether the Browser Access application segment is enabled (true) or not (false)."
},
"description": {
"type": "string",
"description": "The description of the Browser Access application segment."
},
"certificateId": {
"type": "integer",
"description": "The unique identifier of the certificate.",
"format": "int64"
},
"certificateName": {
"type": "string",
"description": "The name of the certificate."
},
"applicationPort": {
"type": "integer",
"description": "The port for the Browser Access application.",
"format": "int32"
},
"applicationProtocol": {
"type": "string",
"description": "The protocol for the Browser Access application.",
"enum": [
"HTTP",
"HTTPS",
"FTP",
"RDP",
"SSH",
"WEBSOCKET",
"VNC",
"REALVNC",
"NONE",
"AUTO",
"DYNAMIC",
"KRB",
"LDAP",
"SMB"
]
},
"domain": {
"type": "string",
"description": "The domain of the Browser Access application."
},
"appId": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails"
},
"path": {
"type": "string",
"description": "The path of the Browser Access application."
},
"hidden": {
"type": "boolean",
"description": "Indicates whether the Browser Access application is hidden or not."
},
"portal": {
"type": "boolean",
"description": "Indicates whether the portal is enabled or not."
},
"trustUntrustedCert": {
"type": "boolean",
"description": "Whether the use of untrusted certificates is enabled (true) or disabled (false) for the Browser Access application."
},
"allowOptions": {
"type": "boolean"
},
"localDomain": {
"type": "string",
"description": "The local domain of the Browser Access application."
},
"cname": {
"type": "string",
"description": "The canonical name (CNAME DNS records) of the Browser Access application."
},
"appResource": {
"$ref": "#/components/schemas/ApplicationDetails"
},
"extDomain": {
"type": "string",
"description": "The external domain name prefix of the Browser Access application that is used for Zscaler-managed certificates when creating a privileged portal. This field is returned when making GET requests to get privileged portal details or when retreiving application segment details. The supported value must be a string, but doesn't support special characters (e.g., periods) as the FQDN wouldn't match the CNAME entry."
},
"extLabel": {
"type": "string",
"description": "The domain prefix for the privileged portal URL. The supported string can include numbers, lowercase characters, and only supports a hyphen (-)."
},
"extDomainName": {
"type": "string",
"description": "The domain suffix for the privileged portal URL. This field must be one of the customer's authentication domains."
}
}
},
"ApplicationDetails": {
"required": [
"name"
],
"properties": {
"modifiedTime": {
"type": "integer",
"description": "The time the application resource is modified. This field is only applicable for GET requests, and is ignored in PUT, POST, and DELETE requests.",
"format": "int32",
"readOnly": true
},
"creationTime": {
"type": "integer",
"description": "The time the application resource is created. This field is only applicable for GET requests, and is ignored in PUT, POST, and DELETE requests.",
"format": "int32",
"readOnly": true
},
"modifiedBy": {
"type": "string",
"description": "The unique identifier of the tenant who modified the resource. This field is only applicable for GET requests, and is ignored in PUT, POST, and DELETE requests.",
"readOnly": true
},
"id": {
"type": "string",
"description": "The unique identifier of the application resource. This field is only applicable for GET requests, and is ignored in PUT, POST, and DELETE requests.",
"readOnly": true
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"domainNames": {
"type": "array",
"description": "The list of domains and IP addresses. The maximum limit for domains or IP addresses is 2,000 applications per application segment. The maximum limit for domains or IP addresses for the whole customer is 6,000 applications.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "The name of the application resource."
},
"description": {
"type": "string",
"description": "The description of the application resource."
},
"defaultIdleTimeout": {
"type": "integer",
"description": "The duration of the default idle timeout.",
"format": "int32"
},
"defaultMaxAge": {
"type": "integer",
"description": "The default maximum age of the resource.",
"format": "int32"
},
"serverGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppServerGroup"
}
},
"enabled": {
"type": "boolean",
"description": "Indicates whether or not the application resource is enabled."
},
"passiveHealthEnabled": {
"type": "boolean",
"description": "Indicates if passive health checks are enabled on the application."
},
"tcpPortRanges": {
"type": "array",
"items": {
"type": "integer",
"description": "The list of TCP port ranges used to access the application.",
"format": "int32"
}
},
"udpPortRanges": {
"type": "array",
"items": {
"type": "integer",
"description": "The list of UDP port ranges used to access the application.",
"format": "int32"
}
},
"tcpPortRange": {
"type": "array",
"description": "The list of TCP port ranges used to access the application.",
"items": {
"$ref": "#/components/schemas/AppPortRange"
}
},
"udpPortRange": {
"type": "array",
"description": "The UDP port ranges used to access the application.",
"items": {
"$ref": "#/components/schemas/AppPortRange"
}
},
"doubleEncrypt": {
"type": "boolean",
"description": "Indicates if Double Encryption is enabled (true) or disabled (false) for the application."
},
"segmentGroupId": {
"type": "string",
"description": "The unique identifier of the segment group."
},
"segmentGroupName": {
"type": "string",
"description": "The name of the segment group."
},
"configSpace": {
"type": "string",
"description": "Indicates if the configuration is created as part of the SIEM or application resource.",
"enum": [
"DEFAULT",
"SIEM"
]
},
"bypassType": {
"type": "string",
"description": "Indicates the bypass type when users bypass ZPA to access applications.",
"enum": [
"ALWAYS",
"NEVER",
"ON_NET"
]
},
"healthCheckType": {
"type": "string",
"description": "Whether the health check is enabled (DEFAULT) or disabled (NONE) for the application.",
"enum": [
"DEFAULT",
"NONE"
]
},
"icmpAccessType": {
"type": "string",
"description": "The ICMP access type of the application.",
"enum": [
"PING_TRACEROUTING",
"PING",
"NONE"
]
},
"isCnameEnabled": {
"type": "boolean",
"description": "Indicates if Zscaler Client Connector receives CNAME DNS records from App Connectors."
},
"ipAnchored": {
"type": "boolean",
"description": "Whether Source IP Anchoring for use with ZIA is enabled (true) or disabled (false) for the application."
},
"healthReporting": {
"type": "string",
"description": "Indicates the health reporting of the application.",
"enum": [
"NONE",
"ON_ACCESS",
"CONTINUOUS"
]
},
"tcpKeepAlive": {
"type": "integer",
"description": "Indicates if TCP Keep Alive is enabled (1) or disabled (0) for the application segment.",
"format": "int32"
},
"appRecommendationId": {
"type": "string",
"description": "The unique identifier of the recommended application."
},
"selectConnectorCloseToApp": {
"type": "boolean",
"description": "Whether the App Connector is closest to the application (true) or closest to the user (false)."
},
"sharedMicrotenantDetails": {
"$ref": "#/components/schemas/SharedMicrotenantDetails"
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails"
},
"fqdnDnsCheck": {
"type": "boolean",
"description": "If set to true, performs a DNS check to find an A or AAAA record for this application."
}
}
},
"SharedMicrotenantDetails": {
"properties": {
"sharedToMicrotenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NameIdDto"
}
},
"sharedFromMicrotenant": {
"$ref": "#/components/schemas/NameIdDto"
}
}
},
"NameIdDto": {
"properties": {
"id": {
"type": "integer",
"description": "The list of unique identifiers for the entity type.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The list of names for the entity type."
}
}
},
"InspectAppDto": {
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the AppProtection application.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the AppProtection application."
},
"enabled": {
"type": "boolean",
"description": "Indicates if the AppProtection application is enabled (true) or disabled (false)."
},
"description": {
"type": "string",
"description": "The description of the AppProtection application."
},
"certificateId": {
"type": "integer",
"description": "The unique identifier of the certificate.",
"format": "int64"
},
"certificateName": {
"type": "string",
"description": "The name of the certificate."
},
"applicationPort": {
"type": "integer",
"description": "The port of the AppProtection application.",
"format": "int32"
},
"applicationProtocol": {
"type": "string",
"description": "The protocol of the AppProtection application.",
"enum": [
"HTTP",
"HTTPS",
"FTP",
"RDP",
"SSH",
"WEBSOCKET",
"VNC",
"REALVNC",
"NONE",
"AUTO",
"DYNAMIC",
"KRB",
"LDAP",
"SMB"
]
},
"domain": {
"type": "string",
"description": "The domain of the AppProtection application."
},
"appId": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails"
},
"trustUntrustedCert": {
"type": "boolean",
"description": "Whether the use of untrusted certificates is enabled (true) or disabled (false) for the AppProtection application."
},
"appResource": {
"$ref": "#/components/schemas/ApplicationDetails"
},
"protocols": {
"type": "array",
"description": "The protocols of the AppProtection application.",
"items": {
"type": "string",
"enum": [
"NONE",
"KERBEROS",
"LDAP",
"SMB"
]
}
}
}
},
"PraAppDto": {
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the Prilieged Remote Access application.",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the Privileged Remote Access application."
},
"enabled": {
"type": "boolean",
"description": "Indicates if the Privileged Remote Access application is enabled (true) or not (false)."
},
"description": {
"type": "string",
"description": "The description of the Privileged Remote Access application."
},
"certificateId": {
"type": "integer",
"description": "The unique identifier of the certificate.",
"format": "int64"
},
"certificateName": {
"type": "string",
"description": "The name of the certificate."
},
"applicationPort": {
"type": "integer",
"description": "The port for the Privileged Remote Access application.",
"format": "int32"
},
"applicationProtocol": {
"type": "string",
"description": "The protocol for the Privileged Remote Access application.",
"enum": [
"HTTP",
"HTTPS",
"FTP",
"RDP",
"SSH",
"WEBSOCKET",
"VNC",
"REALVNC",
"NONE",
"AUTO",
"DYNAMIC",
"KRB",
"LDAP",
"SMB"
]
},
"domain": {
"type": "string",
"description": "The domain of the Privileged Remote Access application."
},
"appId": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"microtenantId": {
"type": "integer",
"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.",
"format": "int64"
},
"microtenantName": {
"type": "string",
"description": "The name of the Microtenant."
},
"inconsistentConfigDetails": {
"$ref": "#/components/schemas/InconsistentConfigDetails",
"description": "The details of the inconsistent configuration."
},
"hidden": {
"type": "boolean"
},
"connectionSecurity": {
"type": "string",
"description": "The Connection Security field of the Privileged Remote Access application. If you select RDP, you need to enter the Connection Security. You can select TLS, RDP, or NLA. If the application server you select has network-level authentication enabled, select Any to provide access to the server.",
"enum": [
"ANY",
"NLA",
"NLA_EXT",
"TLS",
"VM_CONNECT",
"RDP"
]
},
"appResource": {
"$ref": "#/components/schemas/ApplicationDetails",
"description": "The details of the application."
}
}
},
"CommonApplicationDto": {
"properties": {
"appsConfig": {
"type": "array",
"description": "The configured applications.",
"items": {
"$ref": "#/components/schemas/CommonAppConfigDto"
}
},
"deletedBaApps": {
"type": "array",
"description": "The deleted Browser Access applications.",
"items": {
"type": "integer",
"format": "int64"
}
},
"deletedInspectApps": {
"type": "array",
"description": "The deleted AppProtection applications.",
"items": {
"type": "integer",
"format": "int64"
}
},
"deletedPraApps": {
"type": "array",
"description": "The deleted Privileged Remote Access applications.",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"CommonAppConfigDto": {
"properties": {
"name": {
"type": "string",
"description": "The name of the application."
},
"baAppId": {
"type": "integer",
"description": "The unique identifier of the Browser Access application.",
"format": "int64"
},
"inspectAppId": {
"type": "integer",
"description": "The unique identifier of the AppProtection application.",
"format": "int64"
},
"praAppId": {
"type": "integer",
"description": "The unique identifier of the Privileged Remote Access application.",
"format": "int64"
},
"enabled": {
"type": "boolean",
"description": "Indicates whether the application is enabled (true) or not (false)."
},
"description": {
"type": "string",
"description": "The description of the application."
},
"certificateId": {
"type": "integer",
"description": "The unique identifier of the certificate.",
"format": "int64"
},
"certificateName": {
"type": "string",
"description": "The name of the certificate."
},
"applicationPort": {
"type": "integer",
"description": "The port of the application.",
"format": "int32"
},
"applicationProtocol": {
"type": "string",
"description": "The protocol of the application.",
"enum": [
"HTTP",
"HTTPS",
"FTP",
"RDP",
"SSH",
"WEBSOCKET",
"VNC",
"REALVNC",
"NONE",
"AUTO",
"DYNAMIC",
"KRB",
"LDAP",
"SMB"
]
},
"connectionSecurity": {
"type": "string",
"description": "The Connection Security field of the application. If you select RDP, you need to enter the Connection Security. You can select TLS, RDP, or NLA. If the application server you select has network-level authentication enabled, select Any to provide access to the server.",
"enum": [
"ANY",
"NLA",
"NLA_EXT",
"TLS",
"VM_CONNECT",
"RDP"
]
},
"domain": {
"type": "string",
"description": "The domain of the application."
},
"path": {
"type": "string",
"description": "The path of the application."
},
"hidden": {
"type": "boolean",
"description": "Indicates whether the application is hidden or not."
},
"portal": {
"type": "boolean",
"description": "Indicates whether the portal is enabled or not."
},
"appId": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"trustUntrustedCert": {
"type": "boolean",
"description": "Whether the use of untrusted certificates is enabled (true) or disabled (false) for the application."
},
"allowOptions": {
"type": "boolean",
"description": "Whether the options are enabled or not for the application."
},
"cname": {
"type": "string",
"description": "The canonical name (CNAME DNS records) of the application."
},
"localDomain": {
"type": "string",
"description": "The local domain of the application."
},
"appTypes": {
"type": "array",
"description": "The types of applications (i.e., Browser Access, Source IP Anchor, AppProtection, and Privileged Remote Access).",
"items": {
"type": "string",
"enum": [
"BROWSER_ACCESS",
"SIPA",
"INSPECT",
"SECURE_REMOTE_ACCESS"
]
}
},
"protocols": {
"type": "array",
"description": "The protocols of the application.",
"items": {
"type": "string",
"enum": [
"NONE",
"KERBEROS",
"LDAP",
"SMB"
]
}
},
"adpEnabled": {
"type": "boolean",
"description": "Indicates if Active Directory Inspection is enabled or not for the application. This allows the application segment's traffic to be inspected by Active Directory (AD) Protection. By default, this field is set to false. If adpEnabled is set to true, then the field matchStyle must be set to EXCLUSIVE. If adpEnabled is set to true, then autoAppProtectEnabled cannot be set to true."
},
"extDomain": {
"type": "string",
"description": "The external domain name prefix of the Browser Access application that is used for Zscaler-managed certificates when creating a privileged portal. This field is returned when making GET requests to get privileged portal details or when retreiving application segment details. The supported value must be a string, but doesn't support special characters (e.g., periods) as the FQDN wouldn't match the CNAME entry."
},
"extLabel": {
"type": "string",
"description": "The domain prefix for the privileged portal URL. The supported string can include numbers, lowercase characters, and only supports a hyphen (-)."
}
}
},
"ApplicationToGroupMappingDto": {
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the application.",
"format": "int64"
},
"weight": {
"type": "integer",
"description": "The weight of the load balancing configuration. Weights with a lower value indicate that a lesser number of requests are served by the App Connectors linked to the server group. Weights with a higher value than other server groups indicate that the App Connectors linked to the server group serve a greater number of requests. Server groups with weights set to 0 do not route requests.",
"format": "int32"
},
"passive": {
"type": "boolean",
"description": "Indicates if the server groups are in an active state and can load balance (false), or if the server groups stay passive (true)."
},
"name": {
"type": "string",
"description": "The name of the application."
}
}
}
}
}
}