• Home
  • Dynatrace API
  • Environment
  • Monitored entities
  • GET entity type

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/entityTypes/{type}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}

Authentication

To execute this request, you need an access token with entities.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
typestring

The required entity type.

pathrequired

Response

Response codes

CodeTypeDescription
200EntityType

Success

400

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

Response body objects

The EntityType object

A list of properties of the monitored entity type.

ElementTypeDescription
fromRelationshipsToPosition[]

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

toRelationshipsFromPosition[]

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

entityLimitExceededboolean

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

dimensionKeystring

The dimension key used within metrics for this monitored entity.

tagsstring

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

managementZonesstring

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

displayNamestring

The display name of the monitored entity.

propertiesEntityTypePropertyDto[]

A list of additional properties of the monitored entity type.

typestring

The type of the monitored entity.

The ToPosition object

The TO position of a relationship.

ElementTypeDescription
toTypesstring[]

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

idstring

The ID of the relationship.

The FromPosition object

The FROM position of a relationship.

ElementTypeDescription
fromTypesstring[]

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

idstring

The ID of the relationship.

The EntityTypePropertyDto object

The property of a monitored entity.

ElementTypeDescription
displayNamestring

The display-name of the property.

idstring

The ID of the property.

typestring

The type of the property.

Response body JSON model

json
{ "type": "HOST", "entityLimitExceeded": "false", "properties": [ { "id": "BITNESS", "type": "Enum" }, { "id": "CPU_CORES", "type": "Number" } ], "tags": "placeholder for tags", "managementZones": "placeholder for management zones", "fromRelationships": [ { "id": "RUNS_ON_RESOURCE", "toTypes": [ "CUSTOM_DEVICE" ] }, { "id": "IS_NETWORK_CLIENT_OF_HOST", "toTypes": [ "HOST", "CUSTOM_DEVICE" ] } ], "toRelationships": [ { "id": "IS_DISK_OF", "fromTypes": [ "DISK" ] }, { "id": "IS_SITE_OF", "fromTypes": [ "VMWARE_DATACENTER", "GEOLOC_SITE" ] } ] }

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

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

Request URL

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

Response body

json
{ "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

Related topics
  • Custom tags API

    Manage custom tags of the monitored entities via the Dynatrace API.