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

NAM Console Public REST API - Devices

Applies to NAM 2019+

GET list of devices

Gets a list of devices connected to the console.

GET
  • url https://{console-host}:{console-port}/cxf/api/v1/cxf/api/v1/devices

Parameters

Parameter Type Description In Required
type string

Device type.

The type element can hold these values.
query optional

Possible values

Possible values for the type element:

  • OTHER
  • AMD
  • PRIVATE_ENTERPRISE_AGENT_MANAGER
  • CAS
  • PLATFORM

Response format

The DevicePublicREST object

Element Type Description
id integer
connectionKey string
type string The type element can hold these values.
description string
version string
isHttps boolean
serverRole string The serverRole element can hold these values.
isPrimaryServer boolean

Possible values

Possible values for the serverRole element in the DevicePublicREST object:

  • PRIMARY
  • NODE
  • FAILOVER
  • NONE
  • STANDALONE

Possible values for the type element in the DevicePublicREST object:

  • OTHER
  • AMD
  • PRIVATE_ENTERPRISE_AGENT_MANAGER
  • CAS
  • PLATFORM

Response codes

Code Description
default

Gets a list of devices connected to the NAM Console.

Example

In this example, we list all devices of type CAS (NAM Server) in your environment. It returns two devices.

The API token is passed in the Authorization header.

Curl

curl -X GET "https://mySampleEnv.dynatrace.org:4183/cxf/api/v1/devices?type=CAS" -H "accept: application/json"

Request URL

https://mySampleEnv.dynatrace.org:4183/cxf/api/v1/devices?type=CAS

Response body

[
  {
    "id": 1,
    "connectionKey": "mySampleEnv.dynatrace.org:443",
    "type": "CAS",
    "description": "machinename1;  1.2.3.1",
    "version": "19.0.0.515",
    "isHttps": true,
    "serverRole": "NODE",
    "isPrimaryServer": false
  },
  {
    "id": 2,
    "connectionKey": "mySampleEnv.dynatrace.org:443",
    "type": "CAS",
    "description": "machinename2; 1.2.3.2",
    "version": "19.0.0.515",
    "isHttps": true,
    "serverRole": "PRIMARY",
    "isPrimaryServer": true
  }
]

Response code

200