Network Get Network Enterprises
Gets all enterprises existing on a network, optionally including all Edges or Edge counts. The edgeConfigUpdate "with" option may also be passed to check whether the application of configuration updates to Edges is enabled for each enterprise.
Privileges required:
READ ENTERPRISE
Request
URI
POST
https://{api_host}/portal/rest/network/getNetworkEnterprises
COPY
Request Body
{
"networkId": 0,
"id": 0,
"enterprises": [
0
],
"_count": false,
"with": [
"string"
]
}
integer
networkId
Optional
networkId
integer
id
Optional
Alias for networkId
array of
integer
enterprises
Optional
enterprises
boolean
_count
Optional
_count
array of
string
with
Optional
with
Possible values are :
edges,
edgeCount,
edgeConfigUpdate,
serviceLicenses,
Responses
200
Request was successfully processed
Returns
Array of
network_get_network_enterprises_result_item
of type(s)
application/json
[
{
"id": 0,
"created": "string",
"networkId": 0,
"gatewayPoolId": 0,
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"bastionState": "string",
"enterpriseProxyId": 0,
"enterpriseProxyName": "string",
"edgeCount": 0,
"edges": [
{
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": 0,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"enterpriseId": 0,
"enterpriseLogicalId": "string",
"factorySoftwareVersion": "string",
"factoryBuildNumber": "string",
"platformFirmwareVersion": "string",
"platformBuildNumber": "string",
"modemFirmwareVersion": "string",
"modemBuildNumber": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"haMode": "string",
"id": 0,
"isLive": 0,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": 0,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"siteId": 0,
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string",
"haWifiCapabilityMismatch": false,
"ccVersion": "string",
"ccInstallationStatus": "string",
"ccRunningStatus": "string"
}
],
"edgeConfigUpdate": {
"enabled": false,
"enabledOnUpgrade": false
},
"serviceLicenses": {
"SDWAN": {
"enabled": false
},
"CWS": {
"enabled": false,
"licenseEdition": "string"
},
"ZTNAD": {
"enabled": false,
"maxPops": 0
},
"PICS": {
"enabled": false
},
"MCS": {
"enabled": false
},
"SSE": {
"enabled": false
},
"SYMANTECP2P": {
"enabled": false,
"symantecLicense": "string"
}
}
}
]Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/network/getNetworkEnterprises