Monitored entities API - GET entities list

Lists entities observed within the specified timeframe along with their properties.

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/entities
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/entities

Authentication

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

Parameters

Parameter Type Description In Required
nextPageKey string

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify the nextPageKey query parameter.

When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.

query optional
pageSize integer

The desired amount of entities in a single response payload.

The maximal allowed page size is configurable per environment.

If not set, 50 is used.

query optional
entitySelector string

Defines the scope of the query. Only entities matching the specified criteria are included into response.

You can set one or several of the following criteria:

  • Entity type (required): type("value").
  • Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. If a value-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive.
  • Management zone ID: mzId("ID")
  • Management zone name: mzName("value"). Management zone names are case-sensitive.
  • Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY")
  • Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")).
  • Dynatrace entity name: entityName("value"). You can specify several entity names, separated by a comma (entityName("name-1","name-2")). Entity names are case-sensitive.

To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in response.

The length of the string is limited to 10,000 characters.

The field is required when you're querying the first page of results.

query optional
from string

The start of the requested timeframe.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2019-12-21T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. For example, now-1y/w is one year back, aligned by a week. The alignment rounds to the past. Supported time units for the relative timeframe are:
  • m: minutes
  • h: hours
  • d: days
  • w: weeks
  • M: months
  • y: years

If not set, the relative timeframe of three days is used (now-3d).

query optional
to string

The end of the requested timeframe.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2019-12-21T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. For example, now-1y/w is one year back, aligned by a week. The alignment rounds to the past. Supported time units for the relative timeframe are:
  • m: minutes
  • h: hours
  • d: days
  • w: weeks
  • M: months
  • y: years

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 +. You can specify several properties, separated by a comma (for example fields=+lastSeenTms,+properties.BITNESS).

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 properties.FIELD format (for example, properties.BITNESS).

query optional

Response format

The EntitiesList object

A list of monitored entities along with their properties.

Element Type Description
totalCount integer

The total number of entries in the result.

pageSize integer

The number of entries per page.

nextPageKey string

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

entities Entity[]

A list of monitored entities.

The Entity object

The properties of a monitored entity.

Element Type Description
managementZones ManagementZone[]

A list of management zones to which the entity belongs.

fromRelationships object

A list of relationships where the entity occupies the FROM position.

toRelationships object

A list of relationships where the entity occupies the TO position.

entityId string

The ID of the entity.

firstSeenTms integer

The timestamp at which the entity was first seen, in UTC milliseconds.

lastSeenTms integer

The timestamp at which the entity was last seen, in UTC milliseconds.

properties object

A list of additional properties of the entity.

displayName string

The name of the entity, displayed in the UI.

tags METag[]

A list of tags assigned to the entity.

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.

Not applicable to custom tags.

key string

The key of the tag.

Custom tags have the tag value here.

context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

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.

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.

Example

In this example, the request list services that belong to the management zones with the ID of 229130632296508575249. To achieve that, the entitySelector query parameter is set to type("SERVICE"),mzId("9130632296508575249").

Apart from default Dynatrace entity IDs and names of the entities, the request also returns the timestamp of when the service was last seen and the list of technology types that run in the service. To achieve that, the fields query parameter is set to lastSeenTms,properties.serviceTechnologyTypes.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes' \
-H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes

Response body

{
  "totalCount": 52,
  "pageSize": 50,
  "nextPageKey": "AQArdHlwZSgiU0VSVklDRSIpL",
  "entities": [
    {
      "entityId": "SERVICE-1125C375A187D27A",
      "displayName": "dotNetBackend_easyTravel_x64",
      "lastSeenTms": 1590609632865,
      "properties": {
        "serviceTechnologyTypes": [
          "IIS app pool",
          "ASP.NET",
          "DotNet"
        ]
      }
    },
    {
      "entityId": "SERVICE-42C0B06C4DCFD0EF",
      "displayName": "AuthenticationService",
      "lastSeenTms": 1590747000977,
      "properties": {
        "serviceTechnologyTypes": [
          "Java"
        ]
      }
    },
    {
      "entityId": "SERVICE-620517BB99A7ED9E",
      "displayName": "BookingService",
      "lastSeenTms": 1590747028702,
      "properties": {
        "serviceTechnologyTypes": [
          "Java"
        ]
      }
    }
  ]
}

Response code

200