Network Get Network Gateways
Gets all gateways associated with the specified network.
Privileges required:
READ GATEWAY
Request
URI
POST
https://{api_host}/portal/rest/network/getNetworkGateways
COPY
Request Body
{
"networkId": 0,
"logicalIds": [
"string"
],
"gatewayIds": [
"string"
],
"with": [
"string"
]
}
integer
networkId
Optional
networkId
array of
string
logicalIds
Optional
logicalIds
array of
string
gatewayIds
Optional
gatewayIds
array of
string
with
Optional
with
Possible values are :
site,
pools,
enterprises,
enterpriseAssociations,
enterpriseAssociationCounts,
dataCenters,
certificates,
handOffEdges,
roles,
syslog,
wss,
Responses
200
Request was successfully processed
Returns
Array of
network_get_network_gateways_result_item
of type(s)
application/json
[
{
"activationKey": "string",
"activationState": "string",
"activationTime": "string",
"bastionState": "string",
"buildNumber": "string",
"certificates": [
{
"id": 0,
"created": "string",
"csrId": 0,
"gatewayId": 0,
"networkId": 0,
"certificate": "string",
"serialNumber": "string",
"subjectKeyId": "string",
"authorityKeyId": "string",
"fingerPrint": "string",
"fingerPrint256": "string",
"validFrom": "string",
"validTo": "string"
}
],
"certificatesCount": 0,
"connectedEdges": 0,
"created": "string",
"dataCenters": [
{}
],
"description": "string",
"deviceId": "string",
"dnsName": "string",
"endpointPkiMode": "string",
"enterpriseAssociations": [
{
"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",
"enterpriseId": 0,
"enterpriseObjectId": 0,
"edgeId": 0,
"gatewayType": "string",
"pinned": 0,
"enterpriseObjectName": "string",
"enterpriseObjectType": "string",
"edgeName": "string",
"edgeLogicalId": "string"
}
],
"enterpriseAssociationCount": {
"enterpriseAssociationCount": 0
},
"enterprises": [
{
"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,
"gatewayState": "string",
"handOffDetail": {
"type": "string",
"subnets": [
{
"name": "string",
"routeCost": 0,
"cidrIp": "string",
"cidrPrefix": 0,
"encrypt": false,
"handOffType": "string"
}
],
"v6Subnets": [
{
"name": "string",
"routeCost": 0,
"cidrIp": "string",
"cidrPrefix": 0,
"encrypt": false,
"handOffType": "string"
}
],
"icmpProbe": {
"enabled": false,
"probeType": "string",
"cTag": 0,
"sTag": 0,
"destinationIp": "string",
"frequencySeconds": 0,
"threshold": 0
},
"icmpResponder": {
"enabled": false,
"ipAddress": "string",
"mode": "string"
}
},
"handOffEdges": [
{
"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",
"edgeId": 0,
"isPrimary": 0,
"pinned": 0,
"enterpriseName": "string"
}
],
"id": 0,
"ipAddress": "string",
"ipsecGatewayDetail": {
"enabled": false,
"strictHostCheck": false,
"strictHostCheckDN": "string"
},
"isHitlessMigrationSupported": false,
"isLoadBalanced": false,
"lastContact": "string",
"logicalId": "string",
"modified": "string",
"name": "string",
"networkId": 0,
"pools": [
{
"id": 0,
"networkId": 0,
"enterpriseProxyId": 0,
"created": "string",
"name": "string",
"description": "string",
"logicalId": "string",
"isDefault": false,
"ipV4Enabled": false,
"ipV6Enabled": false,
"handOffType": "string",
"modified": "string",
"gatewayPoolAssocId": 0,
"gatewayId": 0
}
],
"poolsCount": 0,
"privateIpAddress": "string",
"roles": [
{
"created": "string",
"gatewayId": 0,
"gatewayRole": "string",
"required": 0
}
],
"serviceState": "string",
"serviceUpSince": "string",
"site": {
"id": 0,
"created": "string",
"name": "string",
"logicalId": "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",
"shippingSameAsLocation": 0,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"siteId": 0,
"softwareVersion": "string",
"systemUpSince": "string",
"utilization": "number",
"utilizationDetail": {
"load": "number",
"overall": "number",
"cpu": "number",
"memory": "number"
},
"syslog": {
"tag": "string",
"facilityCode": "string",
"collectors": [
{
"host": "string",
"port": 0,
"protocol": "string",
"severity": "string"
}
]
}
}
]Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/network/getNetworkGateways
Network Operations
POST
Network Remove Operator Config Assoc From All Enterprises
POST
Enterprise Get Default Operator Configuration
POST
Enterprise Get Enterprise Specific Operator Configs
POST
Enterprise Update Edge Image Management
POST
Enterprise Update Edge Image Management Multiple
POST
Network Delete Network Gateway Pool
POST
Network Get Network Gateways
POST
Network Insert Network Gateway Pool
POST
Network Update Network Gateway Pool Attributes