Topology & Smartscape API - Custom device

The Topology & Smartscape—Custom device API enables you to create a custom network device and to push metric data to it.

A custom network device is any part of your environment that can't run Dynatrace OneAgent. Examples include Firewalls, DataPower gateways, cloud databases, and any other network appliance such as a proxy or gateway. By using the Dynatrace API, it's possible for your own networked box to send custom metrics into Dynatrace based on the native properties of these devices, or to write your own scripts that pull the metrics from your networked or cloud-networked box.

As Dynatrace AI and intelligent problem detection and correlation depend on topological information, each custom device should announce its position within your network infrastructure. By providing the correct IP address, along with a detailed description of the custom device properties, you enable Dynatrace to automatically map your custom device into your existing Smartscape environment.

This page contains general description of the request, such as parameters and response format. Depending on the payload the usage is different—you can create a custom device or report measurements to an existing custom device.

POST custom device

The request consumes and produces application/json payload.

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

Dynatrace will show the custom device on the host and process level within Smartscape, as the device itself can contain a network IP address as well as listening ports. Once communication is detected between a OneAgent-instrumented host and the custom device, the connection will be automatically shown within Smartscape. Once your custom devices begin to send in metric values, you can use the metrics on the custom charting tile.