Sites API - GET sites

Applies to NAM 2019

Fetches a list of sites currently configured on a specified NAM Server.

GET
  • url https://{console-host}:{console-port}/cxf/api/v1/config/sites/server/{connectionKey}

Parameters

Parameter Type Description In Required
connectionKey

Device address and port (for example, 1.1.1.1:80).

path required
includeReadOnly

Include read-only sites.

query optional
region

Get sites only from specified region name.

query optional
area

Get sites only from specified area name.

query optional
udl

Get only user-defined links.

query optional
wan

Get only WAN-optimized links.

query optional

Response format

The PublicApiError object

Element Type Description
code string
description string

The RESTSite object

Element Type Description
name string

Site name

region string

Region name

area string

Area name

comment string
type string
isUDL boolean

Indicates if it is a user-defined link.

isWAN boolean

Indicates if it is a WAN-optimized link.

linkSpeedIn integer
linkSpeedOut integer
domains object

Response codes

Code Description
200

The list of sites.

404

The device was not found.

Example

A GET request of the form

https://console-address:console-port/cxf/api/v1/config/sites/server/server-address:server-port

where:

  • console-address can be an IP address (such as 1.2.3.4) or a name (such as my-nam-console.my-company.com) specifying the NAM Console.
  • server-address can be an IP address (such as 1.2.3.4) or a name (such as my-nam-server.my-company.com) specifying the NAM Server.

returns a list (json format) of all sites defined on NAM Server server-address:server-port such as

Each site is described by the following fields:

Field Description
name A free-form site name.
region A free-form region name.
area A free-form area name.
comment A free-form descriptive comment.
type
isUDL Whether the site is a user-defined link.
isWAN Whether the site is a WAN-optimized link.
linkSpeedIn The site's link speed in.
linkSpeedOut The site's link speed out.
domains The section defining the address range for each site, where each range is a pair of first and last addresses.
first The first address of the address range for a site.
last The last address of the address range for a site.