Dynatrace · Schema

Entity

Represents a monitored entity in Dynatrace. Entities are the components of your monitored environment such as services, hosts, processes, and applications. Each entity has a unique ID, a type, properties, tags, and relationships to other entities.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

Name	Type	Description
entityId	string	The unique identifier of the entity in the format TYPE-HEXADECIMALID, e.g., SERVICE-1234567890ABCDEF.
displayName	string	The human-readable display name of the entity.
type	string	The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION, SYNTHETIC_TEST.
firstSeenTms	integer	The Unix timestamp in milliseconds when the entity was first seen.
lastSeenTms	integer	The Unix timestamp in milliseconds when the entity was last seen.
properties	object	A map of entity-type-specific properties. Available properties vary by entity type. For example, a HOST entity may include osType, cpuCores, and memoryTotalBytes.
tags	array	The list of tags applied to the entity, including auto-detected and manually defined tags.
managementZones	array	The management zones that the entity belongs to, used for access control and organizational scoping.
toRelationships	object	Relationships where this entity is the target. Keys are relationship types (e.g., isProcessOf), values are arrays of entity IDs. For example, {"isProcessOf": ["PROCESS_GROUP-123"]}.
fromRelationships	object	Relationships where this entity is the source. Keys are relationship types (e.g., runsOn), values are arrays of entity IDs. For example, {"runsOn": ["HOST-456"]}.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dynatrace/refs/heads/main/json-schema/entities-api-v2-entity-schema.json",
  "title": "Entity",
  "description": "Represents a monitored entity in Dynatrace. Entities are the components of your monitored environment such as services, hosts, processes, and applications. Each entity has a unique ID, a type, properties, tags, and relationships to other entities.",
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "The unique identifier of the entity in the format TYPE-HEXADECIMALID, e.g., SERVICE-1234567890ABCDEF.",
      "example": "abc123"
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable display name of the entity.",
      "example": "Production Service"
    },
    "type": {
      "type": "string",
      "description": "The type of the entity, e.g., SERVICE, HOST, PROCESS_GROUP, APPLICATION, SYNTHETIC_TEST.",
      "example": "STANDARD"
    },
    "firstSeenTms": {
      "type": "integer",
      "format": "int64",
      "description": "The Unix timestamp in milliseconds when the entity was first seen.",
      "example": 500
    },
    "lastSeenTms": {
      "type": "integer",
      "format": "int64",
      "description": "The Unix timestamp in milliseconds when the entity was last seen.",
      "example": 500
    },
    "properties": {
      "type": "object",
      "description": "A map of entity-type-specific properties. Available properties vary by entity type. For example, a HOST entity may include osType, cpuCores, and memoryTotalBytes.",
      "additionalProperties": true,
      "example": {}
    },
    "tags": {
      "type": "array",
      "description": "The list of tags applied to the entity, including auto-detected and manually defined tags.",
      "items": {
        "$ref": "#/components/schemas/EntityTag"
      },
      "example": [
        {
          "context": "example-value",
          "key": "example-value",
          "value": "example-value",
          "stringRepresentation": "example-value"
        }
      ]
    },
    "managementZones": {
      "type": "array",
      "description": "The management zones that the entity belongs to, used for access control and organizational scoping.",
      "items": {
        "$ref": "#/components/schemas/ManagementZone"
      },
      "example": [
        {
          "id": "abc123",
          "name": "Production Service"
        }
      ]
    },
    "toRelationships": {
      "type": "object",
      "description": "Relationships where this entity is the target. Keys are relationship types (e.g., isProcessOf), values are arrays of entity IDs. For example, {\"isProcessOf\": [\"PROCESS_GROUP-123\"]}.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {}
    },
    "fromRelationships": {
      "type": "object",
      "description": "Relationships where this entity is the source. Keys are relationship types (e.g., runsOn), values are arrays of entity IDs. For example, {\"runsOn\": [\"HOST-456\"]}.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {}
    }
  }
}