Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get an Access Point Tunnel details

This API retrieves detailed information about tunnels associated with a specific access point. It provides tunnel related details such as name, status, encapsulation type, source and destination information based on the access point's serial number.

get/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

tunnel-idstring const required

Tunnel ID of an access point tunnel

Example:gw-ipsecmap.11.22.33.44~Primary

Tunnel ID of the tunnel

Response

Object containing information about the access point tunnel, such as name, status, encapsulation type, source and destination information based on the access point's serial number.

tunnelNamestring const required

The name of the tunnel.

indexstring const required

The index of the tunnel

destinationNamestring

The serial number or Host Name of the audit.

destinationMacAddressstring const

The MAC address of the destination endpoint.

destinationIpAddressstring const

The IP address of the destination endpoint.

statusstring const required

The current status of the tunnel.

encapsulationTypestring const

The encapsulation type used for the tunnel.

cryptoType'TUNNEL_CRYPTO_TYPE_UNSPECIFIED' | 'TUNNEL_CRYPTO_TYPE_CERTIFICATE' | 'TUNNEL_CRYPTO_TYPE_PSK'

The cryptographic key exchange type used by the tunnel.

sourceIpAddressstring const

The source IP address of the tunnel.

lastChangeReasonstring const

The reason for the last status change of the tunnel.

uptimeInMillisinteger

The uptime of the tunnel in milliseconds.

activeboolean required

Indicates whether the tunnel is active.

peerTypestring const

The type of the peer endpoint.

authenticationstring const

The authentication method used for the tunnel.

encryptionstring const

The encryption method used for the tunnel.

inSpinumber double

The inbound Security Parameter Index (SPI) for the tunnel.

outSpinumber double

The outbound Security Parameter Index (SPI) for the tunnel.

tunnelIdstring const required

Tunnel ID of an access point tunnel

idstring const required

Identifier for the resource.

typestring const required

The type of the resource.

Example response

{
  "tunnelName": "c2c_tunnel_01",
  "index": "Primary",
  "destinationName": "GW2",
  "destinationMacAddress": "00:01:02:03:04:05",
  "destinationIpAddress": "11.0.0.1",
  "status": "Up",
  "encapsulationType": "IPSec",
  "cryptoType": "TUNNEL_CRYPTO_TYPE_CERTIFICATE",
  "sourceIpAddress": "10.0.0.1",
  "lastChangeReason": "Uplink Deleted",
  "uptimeInMillis": 3600000,
  "active": true,
  "peerType": "Gateway",
  "authentication": "SHA-256",
  "encryption": "AES",
  "inSpi": 10933320,
  "outSpi": 11196835,
  "tunnelId": "c2c_tunnel_01~Primary",
  "id": "AP00000001/tunnels/c2c_tunnel_01~Primary",
  "type": "network-monitoring/access-point-monitoring"
}