Sites API - GET sites

Applies to NAM 2019

This documentation is a work in progress. Please see the NAM REST API Explorer in your NAM Console for a 'Swaggerized' exploration of the NAM Console Public REST API.

Fetches a list of sites currently configured on a specified 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.