Monitored entities API - GET an entity
Gets the full list of properties of the specified entity. The actual list depends on the entity type.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
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 |
---|---|---|---|---|
entityId | string |
The ID of the required entity. |
path | required |
from | string |
The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of three days is used ( |
query | optional |
to | string |
The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
query | optional |
fields | string |
Defines the list of entity properties included in the response. The ID and the name of an entity are always included to the response. To add properties, list them with leading plus Use the GET /entityTypes/{type} request to fetch the list of properties available for your entity type. Fields from the properties object must be specified in the |
query | optional |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The Entity object
The properties of a monitored entity.
Element | Type | Description |
---|---|---|
toRelationships | object | A list of relationships where the entity occupies the TO position. |
tags | METag[] | A set of tags assigned to the entity. |
managementZones | ManagementZone[] | A set of management zones to which the entity belongs. |
entityId | string | The ID of the entity. |
lastSeenTms | integer | The timestamp at which the entity was last seen, in UTC milliseconds. |
firstSeenTms | integer | The timestamp at which the entity was first seen, in UTC milliseconds. |
fromRelationships | object | A list of relationships where the entity occupies the FROM position. |
properties | object | A list of additional properties of the entity. |
displayName | string | The name of the entity, displayed in the UI. |
The ManagementZone object
A short representation of a management zone.
Element | Type | Description |
---|---|---|
name | string | The name of the management zone. |
id | string | The ID of the management zone. |
The METag object
The tag of a monitored entity.
Element | Type | Description |
---|---|---|
stringRepresentation | string | The string representation of the tag. |
value | string | The value of the tag. |
key | string | The key of the tag. |
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
The EntityId object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
{
"entityId": "HOST-06F288EE2A930951",
"displayName": "my host",
"firstSeenTms": 1574697667547,
"lastSeenTms": 1588242361417,
"properties": {
"bitness": 64,
"monitoringMode": "FULL_STACK",
"osType": "LINUX",
"osArchitecture": "X86",
"networkZoneId": "aws.us.east01",
"cpuCores": 8
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "architecture",
"value": "x86",
"stringRepresentation": "architecture:x86"
},
{
"context": "ENVIRONMENT",
"key": "Infrastructure",
"value": "Linux",
"stringRepresentation": "[ENVIRONMENT]Infrastructure:Linux"
}
],
"managementZones": [
{
"id": "6239538939987181652",
"name": "main app"
}
],
"fromRelationships": {
"isInstanceOf": [
{
"id": "HOST_GROUP-0E489369D663A4BF",
"type": "HOST_GROUP"
}
]
},
"toRelationships": {
"isDiskOf": [
{
"id": "DISK-0393340DCA3853B0",
"type": "DISK"
}
]
}
}
Example
In this example, the request lists the properties of the dotNetBackend_easyTravel_x64 service, which has the ID of SERVICE-1125C375A187D27A.
The API token is passed in the Authorization header.
Curl
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/entities/SERVICE-1125C375A187D27A' \
-H 'Authorization: Api-Token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/entities/SERVICE-1125C375A187D27A
Request body
{
"entityId": "SERVICE-1125C375A187D27A",
"displayName": "dotNetBackend_easyTravel_x64",
"firstSeenTms": 1424310498896,
"lastSeenTms": 1590609632865,
"properties": {
"serviceType": "WEB_REQUEST_SERVICE",
"internalName": "dotNetBackend_easyTravel_x64",
"webServerName": "dotNetBackend_easyTravel_x64",
"softwareTechnologies": [
{
"edition": "FullCLR",
"version": "2.0.50727"
},
{
"type": "DOTNET",
"edition": ".NET Framework",
"version": "3.5.1.0"
},
{
"type": "ADO_NET",
"edition": "System.Data",
"version": "2.0.50727.8751"
},
{
"type": "ASP_DOTNET",
"version": "3.5.1.0"
},
{
"type": "IIS_APP_POOL",
"version": "10.0.14393.0"
},
{
"type": "DOTNET_REMOTING",
"version": "2.0.50727.8771"
}
],
"serviceTechnologyTypes": [
"IIS app pool",
"ASP.NET",
"DotNet"
],
"mainServiceSoftwareTech": {
"type": "ASP_DOTNET"
},
"contextRoot": "/",
"agentTechnologyType": "DOTNET"
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "customService",
"stringRepresentation": "customService"
},
{
"context": "CONTEXTLESS",
"key": "easytravel",
"value": "backend",
"stringRepresentation": "easytravel:backend"
}
],
"mangementZones": [
{
"id": "2827032493241090264",
"name": "allServices"
},
{
"id": "9130632296508575249",
"name": "Easytravel"
}
],
"fromRelationships": {
"calls": [
{
"id": "SERVICE-775060208AAA1058",
"type": "SERVICE"
},
{
"id": "SERVICE-6737CDED8F9BF969",
"type": "SERVICE"
}
],
"runsOn": [
{
"id": "PROCESS_GROUP-0A9A52EA262BC039",
"type": "PROCESS_GROUP"
}
],
"runsOnHost": [
{
"id": "HOST-B64B6B9CB11E2244",
"type": "HOST"
},
{
"id": "HOST-CF61BC45E6282234",
"type": "HOST"
}
],
"runsOnProcessGroupInstance": [
{
"id": "PROCESS_GROUP_INSTANCE-DE765F657721AF59",
"type": "PROCESS_GROUP_INSTANCE"
}
]
},
"toRelationships": {
"calls": [
{
"id": "SERVICE-D20E300A0A6814EF",
"type": "SERVICE"
},
{
"id": "SERVICE-7675DAA7464128F8",
"type": "SERVICE"
}
]
}
}
Response code
200