v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get a list of Access Point Tunnels

This API endpoint retrieves a list of tunnels associated with a specific access point, based on the query parameters provided. Each tunnel in the returned list includes comprehensive details like tunnel name, status, encapsulation, source and destination IP etc. The query parameters allow you to narrow down the results to tunnel that meet specific criteria, ensuring you receive only the relevant data.

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

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

Query parameters

site-idstring const

The unique identifier of the site to which the access point has been assigned.

Example:24833497

ID of the Site for which access point tunnel information is requested

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
status	eq and in
encapsulationType	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:tunnelName asc,encapsulationType desc,sourceIpAddress asc,destinationName asc,destinationIpAddress asc,uptimeInMillis desc

A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending. By default, the response is sorted in ascending order by tunnel status.

Supported fields are tunnelName, encapsulationType, sourceIpAddress, destinationName, destinationIpAddress, uptimeInMillis.

limitinteger

Example:20

Specifies the maximum number of tunnels returned in the response.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources.

The minimum value: 1

Response

List of access point tunnels, along with their details and associated pagination information.

countinteger required

Number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicate the next page number, null if there are no further pages.

Example response

{
  "items": [
    {
      "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,
      "tunnelId": "c2c_tunnel_01~Primary",
      "id": "AP00000001/tunnels/c2c_tunnel_01~Primary",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 3,
  "total": 3,
  "next": null
}