Monitored entities API - GET entity type

Lists possible properties of an entity of the specified type. Note that these are placeholders showing what properties an entity can possibly have, not actual properties. To view actual properties of an entity, use the GET an entity request.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/entityTypes/{type}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}

Authentication

To execute this request, you need the Read entities (entities.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
type string

The required entity type.

path required

Response

Response codes

Code Description
200

Success

400

Failed. The requested monitored entity type is not exportable or doesn't exist.

Response body

The EntityType object

A list of properties of the monitored entity type.

Element Type Description
entityLimitExceeded boolean

Whether the entity creation limit for the given type has been exceeded

dimensionKey string

The dimension key used within metrics for this monitored entity.

fromRelationships ToPosition[]

A list of possible relationships where the monitored entity type occupies the FROM position

toRelationships FromPosition[]

A list of possible relationships where the monitored entity type occupies the TO position.

managementZones string

The placeholder for the list of management zones of an actual entity.

properties EntityTypePropertyDto[]

A list of additional properties of the monitored entity type.

type string

The type of the monitored entity.

displayName string

The display name of the monitored entity.

tags string

The placeholder for the list of tags of an actual entity.

The EntityTypePropertyDto object

The property of a monitored entity.

Element Type Description
id string

The ID of the property.

type string

The type of the property.

displayName string

The display-name of the property.

The FromPosition object

The FROM position of a relationship.

Element Type Description
fromTypes string[]

A list of monitored entity types that can occupy the FROM position.

id string

The ID of the relationship.

The ToPosition object

The TO position of a relationship.

Element Type Description
toTypes string[]

A list of monitored entity types that can occupy the TO position.

id string

The ID of the relationship.

Example

In this example, the request lists all possible properties of entities of the PROCESS_GROUP_INSTANCE type.

The API token is passed in the Authorization header.

Curl

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/entityTypes/PROCESS_GROUP_INSTANCE' \
-H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/entityTypes/PROCESS_GROUP_INSTANCE

Response body

{
  "type": "PROCESS_GROUP_INSTANCE",
  "properties": [
    {
      "id": "appVersion",
      "type": "String"
    },
    {
      "id": "awsNameTag",
      "type": "String"
    },
    {
      "id": "azureHostName",
      "type": "String"
    },
    {
      "id": "azureSiteName",
      "type": "String"
    },
    {
      "id": "bitness",
      "type": "Enum"
    },
    {
      "id": "boshName",
      "type": "String"
    },
    {
      "id": "conditionalName",
      "type": "String"
    },
    {
      "id": "customPgMetadata",
      "type": "Map"
    },
    {
      "id": "customizedName",
      "type": "String"
    },
    {
      "id": "gardenApplicationNames",
      "type": "List"
    },
    {
      "id": "gcpZone",
      "type": "String"
    },
    {
      "id": "internalName",
      "type": "String"
    },
    {
      "id": "isDockerized",
      "type": "Boolean"
    },
    {
      "id": "jvmClrVersion",
      "type": "String"
    },
    {
      "id": "jvmVendor",
      "type": "String"
    },
    {
      "id": "listenPorts",
      "type": "List"
    },
    {
      "id": "metadata",
      "type": "List"
    },
    {
      "id": "modules",
      "type": "List"
    },
    {
      "id": "oneAgentCustomHostName",
      "type": "String"
    },
    {
      "id": "processType",
      "type": "Enum"
    },
    {
      "id": "softwareTechnologies",
      "type": "List"
    },
    {
      "id": "versionedModules",
      "type": "List"
    }
  ],
  "tags": "List",
  "managementZones": "List",
  "fromRelationships": [
    {
      "id": "isProcessOf",
      "toTypes": [
        "HOST"
      ]
    },
    {
      "id": "runsOnResource",
      "toTypes": [
        "CUSTOM_DEVICE"
      ]
    },
    {
      "id": "isInstanceOf",
      "toTypes": [
        "PROCESS_GROUP"
      ]
    },
    {
      "id": "talksWithCandidate",
      "toTypes": [
        "HOST"
      ]
    },
    {
      "id": "isNetworkClientOf",
      "toTypes": [
        "CUSTOM_DEVICE",
        "PROCESS_GROUP_INSTANCE"
      ]
    }
  ],
  "toRelationships": [
    {
      "id": "runsOnProcessGroupInstance",
      "fromTypes": [
        "SERVICE"
      ]
    },
    {
      "id": "isHostGroupOf",
      "fromTypes": [
        "HOST_GROUP"
      ]
    },
    {
      "id": "isNetworkClientOf",
      "fromTypes": [
        "CUSTOM_DEVICE",
        "PROCESS_GROUP_INSTANCE"
      ]
    },
    {
      "id": "candidateTalksWith",
      "fromTypes": [
        "HOST"
      ]
    }
  ]
}

Response code

200