Time to upgrade! NAM is scheduled for end of support. It's time to move to Dynatrace our all-in-one software intelligence platform.

Sites API - PUT sites

Applies to NAM 2019+

Replaces the sites configuration on a server.

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

Parameters

Parameter Type Description In Required
connectionKey string

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

path required
body

Created user object

body optional

The RESTSite object

Element Type Description Required
name string

Site name

optional
region string

Region name

optional
area string

Area name

optional
comment string optional
type string The type element can hold these values. optional
isUDL boolean

Indicates if it is a user-defined link.

optional
isWAN boolean

Indicates if it is a WAN-optimized link.

optional
linkSpeedIn integer optional
linkSpeedOut integer optional
domains object optional

Possible values

Possible values for the type element in the RESTSite object:

  • Default
  • Auto
  • External
  • Predefined
  • Manual
  • AS
  • Active
  • Deleted
  • CidrBlock

Request body

The request body (json format) defines sites in the following format. Note that NAM 2019 Service Pack 1 adds the ability to define subnets.

Subnets

Applies to NAM 2019 Service Pack 1+

Starting with NAM 2019 Service Pack 1, you can alternatively specify a subnet in the domains subsection of your site definitions for PUT and POST requests.

The following two examples specify the same site.

However, even if you use subnet to define a site, a subsequent GET request returns the following response with the subnet translated to a first and last address range.

Response format

A successful request doesn't return any content.

Response codes

Code Description
200 The sites configuration has been replaced.
400 The request was invalid.
404 The device was not found.

Example

A GET request of the form

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

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

To update that list to change the first site name, edit the site list from the GET request and issue a PUT request of the form

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

with the entire edited site list in the payload (json format).