/mgmtconfig/v1/admin/customers/{customerId}/connector/bulkDelete
Parameters
Name
Description
Responses
Response content type:
Code
200
Description
OK
Code
201
Description
Created
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connector/{connectorId}
Parameters
Name
Description
applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass
microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
< * >: string}upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]zpnSubModuleUpgradeList
creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]upgradeStatus
string
The upgrade status of the supporting file.
[
...
]upgradeTime
integer($int64)
The time the supporting file is upgraded.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
"applicationStartTime": 0,
"appConnectorGroupId": "string",
"appConnectorGroupName": "string",
"controlChannelStatus": "UNKNOWN",
"creationTime": 0,
"ctrlBrokerName": "string",
"currentVersion": "string",
"description": "string",
"enabled": true,
"expectedUpgradeTime": 0,
"expectedVersion": "string",
"fingerprint": "string",
"id": 0,
"ipAcl": [
"string"
],
"issuedCertId": 0,
"lastBrokerConnectTime": 0,
"lastBrokerConnectTimeDuration": "string",
"lastBrokerDisconnectTime": 0,
"lastBrokerDisconnectTimeDuration": "string",
"lastUpgradeTime": 0,
"latitude": 0,
"location": "string",
"longitude": 0,
"modifiedBy": 0,
"modifiedTime": 0,
"name": "string",
"provisioningKeyId": 0,
"provisioningKeyName": "string",
"platform": "string",
"platformDetail": "string",
"previousVersion": "string",
"privateIp": "string",
"publicIp": "string",
"runtimeOS": "string",
"sargeVersion": "string",
"microtenantId": 0,
"microtenantName": "string",
"enrollmentCert": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"upgradeAttempt": 0,
"upgradeStatus": "COMPLETE",
"zpnSubModuleUpgradeList": [
{
"creationTime": 0,
"currentVersion": "string",
"entityGid": 0,
"entityType": "ASSISTANT",
"expectedVersion": "string",
"id": 0,
"modifiedBy": 0,
"modifiedTime": 0,
"previousVersion": "string",
"role": "ASSISTANT",
"upgradeStatus": "COMPLETE",
"upgradeTime": 0
}
]
}Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connector/{connectorId}
Parameters
Name
Description
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connector/{connectorId}
Parameters
Name
Description
Responses
Response content type:
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
/mgmtconfig/v1/admin/customers/{customerId}/connector
Parameters
Name
Description
list
The total list of App Connectors.
applicationStartTime
integer($int64)
The start time of the App Connector.
appConnectorGroupId
string
The unique identifier of the App Connector Group.
appConnectorGroupName
string
The name of the App Connector Group.
controlChannelStatus
string
The status of the control channel. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]creationTime
integer($int32)
The time the App Connector is created.
ctrlBrokerName
string
The name of the Control Public Service Edge. This field has read-only properties and is ignored in PUT and POST requests.
currentVersion
string
The current version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
description
string
The description of the App Connector.
enabled
boolean
Whether this App Connector is enabled or not.
expectedUpgradeTime
integer($int64)
The expected upgrade time for the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
expectedVersion
string
The expected version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
fingerprint
string
The hardware fingerprint associated with the App Connector.
id
integer($int64)
The unique identifier of the App Connector.
ipAcl
array[string]
The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
issuedCertId
integer($int64)
The unique identifier of the issued certificate.
lastBrokerConnectTime
integer($int64)
The time the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerConnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last connected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTime
integer($int64)
The time the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastBrokerDisconnectTimeDuration
string
The duration of time when the ZPA Public Service Edge last disconnected. This field has read-only properties and is ignored in PUT and POST requests.
lastUpgradeTime
integer($int64)
The time the App Connector last upgraded.
latitude
number($double)
The latitude of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
location
string
The location of the App Connector.
longitude
number($double)
The longitude of the App Connector.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the App Connector.
modifiedTime
integer($int32)
The time the App Connector is modified.
name*
string
The name of the App Connector.
provisioningKeyId
integer($int64)
The unique identifier of the provisioning key.
provisioningKeyName
string
The name of the provisioning key.
platform
string
The host OS the App Connector is deployed on.
platformDetail
string
The platform the App Connector is deployed on.
previousVersion
string
The previous version of the App Connector. This field has read-only properties and is ignored in PUT and POST requests.
privateIp
string
The private IP of the App Connector.
publicIp
string
The public IP of the App Connector.
runtimeOS
string
The run time OS on which the App Connector is running.
sargeVersion
string
The manager version of the App Connector.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass
microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.microtenantName
string
The name of the Microtenant.
enrollmentCert
The enrollment certificate for the App Connector.
{
< * >: string}upgradeAttempt
integer($int32)
The number of attempts the App Connector takes to upgrade. This field has read-only properties and is ignored in PUT and POST requests.
upgradeStatus
string
The status of the App Connector upgrade. Only applicable in a GET request. This field has read-only properties and is ignored in PUT and POST requests.
[
...
]zpnSubModuleUpgradeList
creationTime
integer($int32)
The time the supporting file is created.
currentVersion
string
The version of the supporting file.
entityGid
integer($int64)
The group ID of the entity for the supporting file.
entityType
string
The entity type of the supporting file.
[
...
]expectedVersion
string
The expected version of the supporting file.
id
integer($int64)
The unique identifier of the supporting file.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the supporting file.
modifiedTime
integer($int32)
The time the supporting file is modified.
previousVersion
string
The previous version of the supporting file.
role
string
The role of the supporting file.
[
...
]upgradeStatus
string
The upgrade status of the supporting file.
[
...
]upgradeTime
integer($int64)
The time the supporting file is upgraded.
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": [
{
"applicationStartTime": 0,
"appConnectorGroupId": "string",
"appConnectorGroupName": "string",
"controlChannelStatus": "UNKNOWN",
"creationTime": 0,
"ctrlBrokerName": "string",
"currentVersion": "string",
"description": "string",
"enabled": true,
"expectedUpgradeTime": 0,
"expectedVersion": "string",
"fingerprint": "string",
"id": 0,
"ipAcl": [
"string"
],
"issuedCertId": 0,
"lastBrokerConnectTime": 0,
"lastBrokerConnectTimeDuration": "string",
"lastBrokerDisconnectTime": 0,
"lastBrokerDisconnectTimeDuration": "string",
"lastUpgradeTime": 0,
"latitude": 0,
"location": "string",
"longitude": 0,
"modifiedBy": 0,
"modifiedTime": 0,
"name": "string",
"provisioningKeyId": 0,
"provisioningKeyName": "string",
"platform": "string",
"platformDetail": "string",
"previousVersion": "string",
"privateIp": "string",
"publicIp": "string",
"runtimeOS": "string",
"sargeVersion": "string",
"microtenantId": 0,
"microtenantName": "string",
"enrollmentCert": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"upgradeAttempt": 0,
"upgradeStatus": "COMPLETE",
"zpnSubModuleUpgradeList": [
{
"creationTime": 0,
"currentVersion": "string",
"entityGid": 0,
"entityType": "ASSISTANT",
"expectedVersion": "string",
"id": 0,
"modifiedBy": 0,
"modifiedTime": 0,
"previousVersion": "string",
"role": "ASSISTANT",
"upgradeStatus": "COMPLETE",
"upgradeTime": 0
}
]
}
],
"totalCount": 0,
"totalPages": 0
}Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connectorSchedule/{id}
Parameters
Name
Description
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connectorSchedule
Parameters
Name
Description
customerId
integer($int64)
The unqiue identifier of the ZPA tenant.
deleteDisabled
boolean
Indicates if the App Connectors are included for deletion if they are in a disconnected state based on the
frequencyInterval and frequency values.enabled
boolean
Indicates if the setting for deleting App Connectors is enabled or disabled.
frequency
string
The scheduled frequency at which the disconnected App Connectors are deleted.
frequencyInterval
integer($int32)
The interval for the configured frequency value. The minimum supported value is 5.
id
integer($int64)
The unique identifier for the App Connector auto deletion configuration for a customer. This field is only required for the PUT request to update the frequency of the App Connector Settings.
readonly: true
Responses
Response content type:
Code
200
Description
OK
Example Value
{
"customerId": 0,
"deleteDisabled": true,
"enabled": true,
"frequency": "string",
"frequencyInterval": 0,
"id": 0
}Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/connectorSchedule
Parameters
Name
Description
customerId
integer($int64)
The unqiue identifier of the ZPA tenant.
deleteDisabled
boolean
Indicates if the App Connectors are included for deletion if they are in a disconnected state based on the
frequencyInterval and frequency values.enabled
boolean
Indicates if the setting for deleting App Connectors is enabled or disabled.
frequency
string
The scheduled frequency at which the disconnected App Connectors are deleted.
frequencyInterval
integer($int32)
The interval for the configured frequency value. The minimum supported value is 5.
id
integer($int64)
The unique identifier for the App Connector auto deletion configuration for a customer. This field is only required for the PUT request to update the frequency of the App Connector Settings.
readonly: true
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Example Value
{
"customerId": 0,
"deleteDisabled": true,
"enabled": true,
"frequency": "string",
"frequencyInterval": 0,
"id": 0
}Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found