Monitored entities API - GET all entity types

Lists all types of monitored entities observed in your environment.

Additionally, every entity type lists the possible properties of an entity of that 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.

You can limit the output by using the pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Then use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

The request produces an application/json payload.

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

Response

Response codes

Response body

Example

In this example, the request lists all entity types observed in the mySampleEnv environment.

The API token is passed in the Authorization header.

Because the full result is rather lengthy, it is truncated to three entries. Subsequently, the properties array of each entity is also truncated to three entries.

Curl

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

Request URL

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

Response body

{
  "totalCount": 33,
  "pageSize": 33,
  "types": [
    {
      "type": "APPLICATION",
      "properties": [
        {
          "id": "applicationType",
          "type": "Enum"
        },
        {
          "id": "conditionalName",
          "type": "String"
        },
        {
          "id": "customizedName",
          "type": "String"
        }
      ],
      "tags": "List",
      "managementZones": "List",
      "fromRelationships": [
        {
          "id": "calls",
          "toTypes": [
            "SERVICE"
          ]
        }
      ],
      "toRelationships": []
    },
    {
      "type": "HOST",
      "properties": [
        {
          "id": "ipAddresses",
          "type": "List"
        },
        {
          "id": "osType",
          "type": "Enum"
        },
        {
          "id": "osVersion",
          "type": "String"
        }
      ],
      "tags": "List",
      "managementZones": "List",
      "fromRelationships": [
        {
          "id": "runsOn",
          "toTypes": [
            "EC2_INSTANCE",
            "VIRTUALMACHINE",
            "AZURE_VM",
            "OPENSTACK_VM",
            "GOOGLE_COMPUTE_ENGINE",
            "HYPERVISOR"
          ]
        },
        {
          "id": "runsOnResource",
          "toTypes": [
            "CUSTOM_DEVICE"
          ]
        },
        {
          "id": "isInstanceOf",
          "toTypes": [
            "HOST_GROUP"
          ]
        },
        {
          "id": "isNetworkClientOfHost",
          "toTypes": [
            "HOST",
            "CUSTOM_DEVICE"
          ]
        },
        {
          "id": "candidateTalksWith",
          "toTypes": [
            "CUSTOM_DEVICE",
            "PROCESS_GROUP_INSTANCE"
          ]
        }
      ],
      "toRelationships": [
        {
          "id": "isProcessOf",
          "fromTypes": [
            "PROCESS_GROUP_INSTANCE"
          ]
        },
        {
          "id": "runsOn",
          "fromTypes": [
            "OPENSTACK_VM",
            "PROCESS_GROUP"
          ]
        },
        {
          "id": "isSiteOf",
          "fromTypes": [
            "GEOLOC_SITE",
            "VMWARE_DATACENTER"
          ]
        },
        {
          "id": "talksWithCandidate",
          "fromTypes": [
            "CUSTOM_DEVICE",
            "PROCESS_GROUP_INSTANCE"
          ]
        },
        {
          "id": "isNetworkClientOfHost",
          "fromTypes": [
            "CUSTOM_DEVICE",
            "HOST"
          ]
        },
        {
          "id": "isDiskOf",
          "fromTypes": [
            "DISK"
          ]
        },
        {
          "id": "runsOnHost",
          "fromTypes": [
            "SERVICE"
          ]
        },
        {
          "id": "isContainerGroupInstanceOfHost",
          "fromTypes": [
            "CONTAINER_GROUP_INSTANCE"
          ]
        }
      ]
    },
    {
      "type": "SERVICE",
      "properties": [
        {
          "id": "mainServiceSoftwareTech",
          "type": "Map"
        },
        {
          "id": "port",
          "type": "Number"
        },
        {
          "id": "serviceType",
          "type": "Enum"
        }
      ],
      "tags": "List",
      "managementZones": "List",
      "fromRelationships": [
        {
          "id": "runsOn",
          "toTypes": [
            "CUSTOM_DEVICE_GROUP",
            "PROCESS_GROUP"
          ]
        },
        {
          "id": "runsOnProcessGroupInstance",
          "toTypes": [
            "CUSTOM_DEVICE",
            "PROCESS_GROUP_INSTANCE"
          ]
        },
        {
          "id": "runsOnHost",
          "toTypes": [
            "CUSTOM_DEVICE",
            "HOST"
          ]
        },
        {
          "id": "calls",
          "toTypes": [
            "SERVICE"
          ]
        }
      ],
      "toRelationships": [
        {
          "id": "calls",
          "fromTypes": [
            "MOBILE_APPLICATION",
            "CUSTOM_APPLICATION",
            "HTTP_CHECK",
            "APPLICATION",
            "SERVICE"
          ]
        }
      ]
    }
  ]
}

Response code

200