Processes API - GET a process

We have a new version of this API—Entity API v2. Check it out!

Gets the parameters of the specified process.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}
  • SaaS https://{your-environment-id}{meIdentifier}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}


To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
meIdentifier string

The Dynatrace entity ID of the required process.

path required


Response codes

Code Description


Response body

The ProcessGroupInstance object

Parameters of a process.

Element Type Description
entityId string

The Dynatrace entity ID of the required entity.

displayName string

The name of the Dynatrace entity as displayed in the UI.

customizedName string

The customized name of the entity

discoveredName string

The discovered name of the entity

firstSeenTimestamp integer

The timestamp of when the entity was first detected, in UTC milliseconds

lastSeenTimestamp integer

The timestamp of when the entity was last detected, in UTC milliseconds

tags TagInfo[]

The list of entity tags.

toRelationships object
metadata object
listenPorts integer[]
azureHostName string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

versionedModules ProcessGroupInstanceModule[]
bitness string
softwareTechnologies TechnologyInfo[]
azureSiteName string
agentVersions AgentVersion[]

Versions of OneAgents currently running on the entity.

monitoringState MonitoringState
modules string[]
fromRelationships object

The MonitoringState object

Defines the current monitoring state of an entity.

Element Type Description
actualMonitoringState string

The current actual monitoring state on the entity.

expectedMonitoringState string

The monitoring state that is expected from the configuration

restartRequired boolean

Defines whether or not the process has to restarted to enable monitoring

The AgentVersion object

Defines the version of the agent currently running on the entity.

Element Type Description
major integer

The major version number.

minor integer

The minor version number.

revision integer

The revision number.

timestamp string

A timestamp string: format "yyyymmdd-hhmmss

sourceRevision string

A string representation of the SVN revision number.

The TechnologyInfo object

Element Type Description
type string
edition string
version string

The ProcessGroupInstanceModule object

Element Type Description
name string
version string

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description
context string

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

Custom tags use the CONTEXTLESS value.

key string

The key of the tag.

Custom tags have the tag value here.

value string

The value of the tag.

Not applicable to custom tags.


In this example, the request gets the details of the Apache Web Server apache2 process, which has the ID of PROCESS_GROUP_INSTANCE-EC9688429EB24B6B.

The API token is passed in the Authorization header.


curl -X GET \ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

Response body

  "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
  "displayName": "Apache Web Server apache2",
  "discoveredName": "Apache Web Server apache2",
  "firstSeenTimestamp": 1464951001104,
  "lastSeenTimestamp": 1545147232609,
  "tags": [],
  "fromRelationships": {
    "isProcessOf": [
    "isInstanceOf": [
  "toRelationships": {
    "runsOnProcessGroupInstance": [
  "metadata": {
    "commandLineArgs": [
      "/usr/sbin/apache2 -k start"
    "executables": [
    "executablePaths": [
    "apacheConfigPaths": [
  "softwareTechnologies": [
      "type": "PHP",
      "edition": "Apache",
      "version": "5.5.9"
      "type": "APACHE_HTTPD",
      "edition": null,
      "version": "2.4.7"
      "type": "SQLITE",
      "edition": null,
      "version": null
  "listenPorts": [
  "bitness": "64bit",
  "modules": [
  "monitoringState": {
    "actualMonitoringState": "ON",
    "expectedMonitoringState": "ON",
    "restartRequired": false
  "agentVersions": [
      "major": 1,
      "minor": 157,
      "revision": 210,
      "timestamp": "20181213-075558",
      "sourceRevision": ""

Response code