Skip to main content

ServiceEdge Schema

Data structure for Service Edge objects.

Fields​

FieldTypeRequiredDescriptionNotes
idlongNo--
modified_timeintegerNo-API field: modified_time
creation_timeintegerNo-API field: creation_time
modified_bylongNo-API field: modified_by
namestringYes--
microtenant_idlongNo-API field: microtenant_id
microtenant_namestringNo-API field: microtenant_name
restriction_typestringNo-API field: restriction_type
descriptionstringNo--
fingerprintstringNo--
issued_cert_idlongNo-API field: issued_cert_id
enabledbooleanNo--
ip_aclstringCollectionNo-API field: ip_acl
listen_ipsstringCollectionNo-API field: listen_ips
publish_ipsstringCollectionNo-API field: publish_ips
publish_ipv6booleanNo-API field: publish_ipv6
private_broker_versionServiceEdgeVersionNo-API field: private_broker_version
provisioning_key_idlongNo-API field: provisioning_key_id
provisioning_key_namestringNo-API field: provisioning_key_name
service_edge_group_idstringNo-API field: service_edge_group_id
service_edge_group_namestringNo-API field: service_edge_group_name
enrollment_certEmptyModelNo-API field: enrollment_cert
latitudestringNo--
longitudestringNo--
locationstringNo--
expected_versionstringNo-API field: expected_version
current_versionstringNo-API field: current_version
previous_versionstringNo-API field: previous_version
last_upgrade_timelongNo-API field: last_upgrade_time
expected_upgrade_timelongNo-API field: expected_upgrade_time
upgrade_statusstringNo-API field: upgrade_status
control_channel_statusstringNo-API field: control_channel_status
upgrade_attemptintegerNo-API field: upgrade_attempt
ctrl_broker_namestringNo-API field: ctrl_broker_name
last_broker_connect_timelongNo-API field: last_broker_connect_time
last_broker_connect_time_durationstringNo-API field: last_broker_connect_time_duration
last_broker_disconnect_timelongNo-API field: last_broker_disconnect_time
last_broker_disconnect_time_durationstringNo-API field: last_broker_disconnect_time_duration
private_ipstringNo-API field: private_ip
public_ipstringNo-API field: public_ip
platformstringNo--
runtime_OSstringNo-API field: runtime_OS
application_start_timelongNo-API field: application_start_time
sarge_versionstringNo-API field: sarge_version
platform_detailstringNo-API field: platform_detail
expected_sarge_versionstringNo-API field: expected_sarge_version
sarge_upgrade_statusstringNo-API field: sarge_upgrade_status
os_upgrade_statusstringNo-API field: os_upgrade_status
last_sarge_upgrade_timelongNo-API field: last_sarge_upgrade_time
last_OS_upgrade_timelongNo-API field: last_OS_upgrade_time
sarge_upgrade_attemptintegerNo-API field: sarge_upgrade_attempt
platform_versionstringNo-API field: platform_version
os_upgrade_enabledbooleanNo-API field: os_upgrade_enabled
zpn_sub_module_upgrade_listSubModuleUpgradeWrapperCollectionNo-API field: zpn_sub_module_upgrade_list
read_onlybooleanNo-API field: read_only
zscaler_managedbooleanNo-API field: zscaler_managed
name_without_trimstringNo-API field: name_without_trim
versionComponentLevelVersionNo--

Example​

{
"id": 123,
"modified_time": 123,
"creation_time": 123,
"modified_by": 123,
"name": "string",
"microtenant_id": 123,
"microtenant_name": "string",
"restriction_type": "string"
}
// ... more fields