/mgmtconfig/v1/admin/customers/{customerId}/visible/versionProfiles

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
page
integer($int32)
(query)
Specifies the page number.
Example : 1
pagesize
integer($int32)
(query)
Specifies the page size. If not provided, the default page size is 20. The max page size is 500.
Example : 20
search
string
(query)
The search string used to support search by features and fields for the API.

list
The total list of version profiles.

creationTime
integer($int32)
The time the version profile is created.
customScopeCustomerIds
The ZPA tenant IDs and names of the customer when the visibilityScope is set to CUSTOM. This field is only applicable for GET requests and is ignored in POST and PUT requests.

customerId
integer($int64)
The unqiue identifier of the ZPA tenant.
excludeConstellation
boolean
isPartner
boolean
Indicates if a customer is an additional tenant and is using a separate tunnel to connect between Zscaler Client Connector and a ZPA Public Service Edge, or between an App Connector and a ZPA Private Service Edge. To learn more, see About Client Connector Support for Multiple Tenants.
name
string
The name of the customer.
customScopeRequestCustomerIds

addCustomerIds
array[integer]
Used to update a version profile for a custom version. Not applicable in a GET request.
deleteCustomerIds
array[integer]
customerId
integer($int64)
The ZPA tenant ID of the customer.
description
string
The description of the version profile.
id
integer($int64)
The unique identifier of the version profile.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the version profile.
modifiedTime
integer($int32)
The time the version profile is modified.
name
string
The name of the version profile.
numberOfAssistants
integer($int64)
The number of App Connectors for the version profile.
numberOfCustomers
integer($int64)
The number of customers for the version profile.
numberOfPrivateBrokers
integer($int64)
The number of ZPA Private Service Edges for the version profile.
numberOfUpdatedAssistants
integer($int64)
The number of updated App Connectors for the version profile.
numberOfUpdatedPrivateBrokers
integer($int64)
The number of updated ZPA Private Service Edges for the version profile.
upgradePriority
string
The priority of the upgrade for the version profile.
[
...
]
4 items
versions
The builds of the version profile.

creationTime
integer($int32)
The time the version is created.
customerId
integer($int64)
The ZPA tenant ID of the customer.
id
integer($int64)
The unique identifier of the version.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the version.
modifiedTime
integer($int32)
The time the version is modified.
platform
string
The platform the App Connector or ZPA Private Service Edge is deployed on.
restartAfterUptimeInDays
integer($int32)
The number of days after uptime that the App Connector or ZPA Private Service Edge restarts.
role
string
Whether or not this version is applicable for an App Connector or ZPA Private Service Edge.
upgradeOrder
integer($int32)
The upgrade order of the version.
upgradeWithoutRestart
boolean
Whether or not the version is upgraded without a restart.
version
string
The version the platform is deployed in.
version_profile_gid
integer($int64)
The group ID of the version profile.
visibilityScope
string
Whether or not the version profile is visible to all of the tenants, none of the tenants, or a custom set of tenants. This field is only applicable for GET requests and is ignored in POST, PUT, and DELETE requests.
[
...
]
3 items
totalCount
integer($int64)
The total count of resources per the search feature.
totalPages
integer($int32)
The total number of pages per the pagination attribute.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "list": [
    {
      "creationTime": 0,
      "customScopeCustomerIds": [
        {
          "customerId": 0,
          "excludeConstellation": true,
          "isPartner": true,
          "name": "string"
        }
      ],
      "customScopeRequestCustomerIds": {
        "addCustomerIds": [
          0
        ],
        "deleteCustomerIds": [
          0
        ]
      },
      "customerId": 0,
      "description": "string",
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "numberOfAssistants": 0,
      "numberOfCustomers": 0,
      "numberOfPrivateBrokers": 0,
      "numberOfUpdatedAssistants": 0,
      "numberOfUpdatedPrivateBrokers": 0,
      "upgradePriority": "WEEK",
      "versions": [
        {
          "creationTime": 0,
          "customerId": 0,
          "id": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "platform": "string",
          "restartAfterUptimeInDays": 0,
          "role": "string",
          "upgradeOrder": 0,
          "upgradeWithoutRestart": true,
          "version": "string",
          "version_profile_gid": 0
        }
      ],
      "visibilityScope": "ALL"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found