Create custom device via Dynatrace API

The Topology & Smartscape—Custom device API enables you to create a custom device with a specified name in your Dynatrace environment.

For this use case, the series element of the request body must be omitted.

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/custom/{customDeviceId}

Parameters

To create a custom device, omit the series element of the body.

Parameter Type Description In Required
customDeviceId string

The ID of the custom device.

If you use the ID of an existing device, the respective parameters will be updated.

path required
body CustomDevicePushMessage

The JSON body of the request. Contains parameters of a custom device.

body optional

The CustomDevicePushMessage object

Configuration of a custom device.

Element Type Description Required
displayName string

The name of the custom device that will appear in the user interface.

optional
group string

User defined group ID of entity.

The group ID helps to keep a consistent picture of device-group relations. One of many cases where a proper group is important is service detection: you can define which custom devices should lead to the same service by defining the same group ID for them.

If you set a group ID, it will be hashed into the Dynatrace entity ID of the custom device. In that case the custom device can only be part of one custom device group.

If you don't set the group ID, Dynatrace will create it based on the ID or type of the custom device. Also, the group will not be hashed into the device ID which means the device may switch groups.

optional
ipAddresses string[]

The list of IP addresses that belong to the custom device.

These addresses are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.

If you send a value (including an empty value), the existing values will be overwritten.

If you send null or omit this field, the existing values will be kept.

optional
listenPorts integer[]

The list of ports the custom devices listens to.

These ports are used to discover the horizontal communication relationship between this component and all other observed components within Smartscape.

Once a connection is discovered, it is automatically mapped and shown within Smartscape.

If ports are specified, you should also add at least one IP address or a host name for the custom device.

If you send a value, the existing values will be overwritten.

If you send null, or an empty value, or omit this field, the existing values will be kept.

optional
type string

The technology type definition of the custom device.

It must be the same technology type of the metric you're reporting.

If you send a value (including an empty value), the existing value will be overwritten.

If you send null or omit this field, the existing value will be kept.

optional
favicon string

The icon to be displayed for your custom component within Smartscape. Provide the full URL of the icon file.

optional
configUrl string

The URL of a configuration web page for the custom device, such as a login page for a firewall or router.

optional
properties object

The list of key-value pair properties that will be shown beneath the infographics of your custom device.

optional
tags string[]

List of custom tags that you want to attach to your custom device.

optional
series EntityTimeseriesData[]

The list of metric values that are reported for the custom device.

Dynatrace aggregates all the values you report for a custom device.

If you send a value (including an empty value), it will be added to the set of existing values.

If you send null or omit this field, the set of existing values won't change.

optional
hostNames string[]

The list of host names related to the custom device.

These names are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.

If you send a value, the existing values will be overwritten.

If you send null or an empty value; or omit this field, the existing values will be kept.

optional

The EntityTimeseriesData object

Information about a metric and its data points.

Element Type Description Required
timeseriesId string

The ID of the metric, where you want to post data points.

required
dimensions object

Dimensions of the data points you're posting.

The key of the metric dimension must be defined earlier in the metric definition.

optional
dataPoints array[]

List of data points.

Each data point is an array, containing the timestamp and the value.

Timestamp is UTC milliseconds reported as a number, for example: 1520523365557.

Values can't be reported more than 2 hours into the past!

A custom metric must be registered before you can report a metric value. Therefore, the timestamp for reporting a value must be after the registration time of the metric.

required

Response format

Element Type Description
entityId string The Dynatrace entity ID of the newly created custom device.
groupId string The Dynatrace entity ID of the custom device group.

Example

In this example, the request creates custom device idOfmyCustomDevice of type F5-Firewall, with IP address 172.16.115.211 and listen port 9999. The request also specifies some additional parameters.

See Report custom device metric via Dynatrace API to learn how to submit data to the newly created custom device.

The API token is passed in the Authorization header.

The request returns the IDs of the custom device (see entityId) and its group (see groupId) as confirmation.

You can download or copy the example request body to try it out on your own.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/custom/idOfmyCustomDevice \
  -H 'Authorization: Api-Token abcdefjhij1234567890'
  -H 'Content-Type: application/json' \  
  -d '{
  "displayName" : "F5 Firewall 24",
  "ipAddresses" : ["172.16.115.211"],
  "listenPorts" : ["9999"],
  "type" : "F5-Firewall",
  "favicon" : "http://assets.dynatrace.com/global/icons/f5.png",
  "configUrl" : "http://192.128.0.1:8080",
  "tags": [
    "REST example"
  ],
  "properties" : {
    "Sample Property 1": "Sample value 1"    
  }  
}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/custom/idOfmyCustomDevice

Request body

api-examples/custom-device/create-custom-device.json
Download
{
  "displayName" : "F5 Firewall 24",
  "ipAddresses" : ["172.16.115.211"],
  "listenPorts" : ["9999"],
  "type" : "F5-Firewall",
  "favicon" : "http://assets.dynatrace.com/global/icons/f5.png",
  "configUrl" : "http://192.128.0.1:8080",
  "tags": [
    "REST example"
  ],
  "properties" : {
    "Sample Property 1": "Sample value 1"
  }
}

Response body

{
  "entityId": "CUSTOM_DEVICE-6A567B33AADC306E",
  "groupId": "CUSTOM_DEVICE_GROUP-FC2E2ABF54F513D8"
}

Response code

200

Result

New custom device in Smartscape

Properties of the custom device