Processes API - GET a process

This API is deprecated. Use the Monitored entities API instead. You can find more information about switching to the new API in the migration guide.

Gets the parameters of the specified process.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/processes/{meIdentifier}`
GET	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}`

Authentication

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

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

Parameters

Parameter	Type	Description	In	Required
meIdentifier	string	The Dynatrace entity ID of the required process.	path	required

Response

Response codes

Code	Type	Description
200	ProcessGroupInstance	Success
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ProcessGroupInstance` object

Parameters of a process.

Element	Type	Description
agentVersions	AgentVersion[]	Versions of OneAgents currently running on the entity.
azureHostName	string	-
azureSiteName	string	-
bitness	string	- `32bit` `64bit`
customizedName	string	The customized name of the entity
discoveredName	string	The discovered name of the entity
displayName	string	The name of the Dynatrace entity as displayed in the UI.
entityId	string	The Dynatrace entity ID of the required entity.
firstSeenTimestamp	integer	The timestamp of when the entity was first detected, in UTC milliseconds
fromRelationships	object	-
lastSeenTimestamp	integer	The timestamp of when the entity was last detected, in UTC milliseconds
listenPorts	integer[]	-
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.
metadata	object	-
modules	string[]	-
monitoringState	MonitoringState	Defines the current monitoring state of an entity.
softwareTechnologies	TechnologyInfo[]	-
tags	TagInfo[]	The list of entity tags.
toRelationships	object	-
versionedModules	ProcessGroupInstanceModule[]	-

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.
sourceRevision	string	A string representation of the SVN revision number.
timestamp	string	A timestamp string: format "yyyymmdd-hhmmss

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description
description	string	A short description of the Dynatrace entity.
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.

The `MonitoringState` object

Defines the current monitoring state of an entity.

Element	Type	Description
actualMonitoringState	string	The current actual monitoring state on the entity. `OFF` `ON`
expectedMonitoringState	string	The monitoring state that is expected from the configuration `OFF` `ON`
restartRequired	boolean	Defines whether or not the process has to restarted to enable monitoring

The `TechnologyInfo` object

Element	Type	Description
edition	string	-
type	string	-
version	string	-

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description

context

string

Element	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`
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.

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

Custom tags use the CONTEXTLESS value.

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

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.

The `ProcessGroupInstanceModule` object

Element	Type	Description
name	string	-
version	string	-

Response body JSON model

{
  "agentVersions": [
    {
      "major": 1,
      "minor": 1,
      "revision": 1,
      "sourceRevision": "string",
      "timestamp": "string"
    }
  ],
  "azureHostName": "string",
  "azureSiteName": "string",
  "bitness": "32bit",
  "customizedName": "string",
  "discoveredName": "string",
  "displayName": "string",
  "entityId": "string",
  "firstSeenTimestamp": 1,
  "fromRelationships": {
    "isInstanceOf": [
      "string"
    ],
    "isNetworkClientOf": [
      "string"
    ],
    "isProcessOf": [
      "string"
    ]
  },
  "lastSeenTimestamp": 1,
  "listenPorts": [
    1
  ],
  "managementZones": [
    {
      "description": "Dynatrace entity for the REST API example",
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity"
    }
  ],
  "metadata": {
    "adobe.em.env_type": [
      "string"
    ],
    "adobe.em.program": [
      "string"
    ],
    "adobe.em.service": [
      "string"
    ],
    "adobe.em.tier": [
      "string"
    ],
    "agentValueMetadata": {},
    "apacheConfigPaths": [
      "string"
    ],
    "apacheSparkMasterIpAddresses": [
      "string"
    ],
    "aspDotNetCoreApplicationPaths": [
      "string"
    ],
    "awsEcrImageAccountIds": [
      "string"
    ],
    "awsEcrImageRegions": [
      "string"
    ],
    "awsEcsCluster": [
      "string"
    ],
    "awsEcsContainerARN": [
      "string"
    ],
    "awsEcsContainerName": [
      "string"
    ],
    "awsEcsDockerID": [
      "string"
    ],
    "awsEcsDockerName": [
      "string"
    ],
    "awsEcsFamily": [
      "string"
    ],
    "awsEcsRevision": [
      "string"
    ],
    "awsEcsTaskARN": [
      "string"
    ],
    "awsLambdaFunctionNames": [
      "string"
    ],
    "awsRegions": [
      "string"
    ],
    "azure.containerapp.hostname": [
      "string"
    ],
    "azure.containerapp.replica.name": [
      "string"
    ],
    "azure.servicefabric.application.id": [
      "string"
    ],
    "azure.servicefabric.application.name": [
      "string"
    ],
    "azure.servicefabric.codepackage.name": [
      "string"
    ],
    "azure.servicefabric.hostedservice.name": [
      "string"
    ],
    "azure.servicefabric.instance.id": [
      "string"
    ],
    "azure.servicefabric.replica.id": [
      "string"
    ],
    "azure.servicefabric.servicepackage.name": [
      "string"
    ],
    "azure.spring.application.name": [
      "string"
    ],
    "azure.spring.cloudconfiguri": [
      "string"
    ],
    "azure.website.instance.id": [
      "string"
    ],
    "azure.website.owner.name": [
      "string"
    ],
    "azure.website.site.name": [
      "string"
    ],
    "cassandraClusterNames": [
      "string"
    ],
    "catalinaBaseValues": [
      "string"
    ],
    "catalinaHomeValues": [
      "string"
    ],
    "cloudFoundryAppIds": [
      "string"
    ],
    "cloudFoundryAppNames": [
      "string"
    ],
    "cloudFoundryInstanceIndexes": [
      "string"
    ],
    "cloudFoundrySpaceIds": [
      "string"
    ],
    "cloudFoundrySpaceNames": [
      "string"
    ],
    "cloudfoundryMetadata": {},
    "coldfusionJvmConfigFiles": [
      "string"
    ],
    "commandLineArgs": [
      "string"
    ],
    "datasourceMonitoringConfigId": [
      "string"
    ],
    "declarativeConfigRuleId": [
      "string"
    ],
    "declarativeId": [
      "string"
    ],
    "dockerContainerIds": [
      "string"
    ],
    "dockerContainerImageNames": [
      "string"
    ],
    "dockerContainerImageVersions": [
      "string"
    ],
    "dockerContainerNames": [
      "string"
    ],
    "dotNetCommands": [
      "string"
    ],
    "dotnetCommandPath": [
      "string"
    ],
    "dynatraceClusterIds": [
      "string"
    ],
    "dynatraceNodeIds": [
      "string"
    ],
    "elasticSearchClusterNames": [
      "string"
    ],
    "elasticSearchNodeNames": [
      "string"
    ],
    "envVariables": {},
    "equinoxConfigPath": [
      "string"
    ],
    "executablePaths": [
      "string"
    ],
    "executables": [
      "string"
    ],
    "glassfishDomainNames": [
      "string"
    ],
    "glassfishInstanceNames": [
      "string"
    ],
    "google.appengine.version": [
      "string"
    ],
    "google.cloudrun.execution": [
      "string"
    ],
    "google.cloudrun.job": [
      "string"
    ],
    "google.cloudrun.revision": [
      "string"
    ],
    "googleAppEngineInstances": [
      "string"
    ],
    "googleAppEngineServices": [
      "string"
    ],
    "googleCloudInstanceId": [
      "string"
    ],
    "googleCloudInstanceRegion": [
      "string"
    ],
    "googleCloudProjects": [
      "string"
    ],
    "googleCloudRunService": [
      "string"
    ],
    "googleComputeEngineMetadata": {},
    "heroku.appdefaultdomainname": [
      "string"
    ],
    "heroku.dyno": [
      "string"
    ],
    "heroku.releaseversion": [
      "string"
    ],
    "hostGroups": [
      "string"
    ],
    "hybrisBinDirectories": [
      "string"
    ],
    "hybrisConfigDirectories": [
      "string"
    ],
    "hybrisDataDirectories": [
      "string"
    ],
    "ibmApplid": [
      "string"
    ],
    "ibmCicsRegion": [
      "string"
    ],
    "ibmCtgName": [
      "string"
    ],
    "ibmImsConnectRegions": [
      "string"
    ],
    "ibmImsControlRegions": [
      "string"
    ],
    "ibmImsMessageProcessingRegions": [
      "string"
    ],
    "ibmImsSoapGwName": [
      "string"
    ],
    "ibmIntegrationNodeName": [
      "string"
    ],
    "ibmIntegrationServerName": [
      "string"
    ],
    "ibmJobName": [
      "string"
    ],
    "iisAppPools": [
      "string"
    ],
    "iisRoleNames": [
      "string"
    ],
    "javaJarFiles": [
      "string"
    ],
    "javaJarPaths": [
      "string"
    ],
    "javaMainClasses": [
      "string"
    ],
    "javaMainModules": [
      "string"
    ],
    "jbossHomes": [
      "string"
    ],
    "jbossModes": [
      "string"
    ],
    "jbossServerNames": [
      "string"
    ],
    "kubernetesAnnotations": {},
    "kubernetesBasePodNames": [
      "string"
    ],
    "kubernetesClusterId": [
      "string"
    ],
    "kubernetesContainerNames": [
      "string"
    ],
    "kubernetesFullPodNames": [
      "string"
    ],
    "kubernetesNamespaces": [
      "string"
    ],
    "kubernetesPodUids": [
      "string"
    ],
    "kubernetesRuleResult": [
      "string"
    ],
    "linkage": [
      "string"
    ],
    "mssqlInstanceName": [
      "string"
    ],
    "nodejsAppBaseDirectories": [
      "string"
    ],
    "nodejsAppNames": [
      "string"
    ],
    "nodejsScriptNames": [
      "string"
    ],
    "oracleSid": [
      "string"
    ],
    "osagent.groupIdName": [
      "string"
    ],
    "osagent.instanceIdName": [
      "string"
    ],
    "phpScripts": [
      "string"
    ],
    "phpWorkingDirectories": [
      "string"
    ],
    "pluginMetadata": {},
    "rke2Type": [
      "string"
    ],
    "rubyAppRootPaths": [
      "string"
    ],
    "rubyScriptPaths": [
      "string"
    ],
    "ruleResult": [
      "string"
    ],
    "serviceNames": [
      "string"
    ],
    "softwareAgInstallRoot": [
      "string"
    ],
    "softwareAgProductPropertyName": [
      "string"
    ],
    "springBootAppName": [
      "string"
    ],
    "springBootProfileName": [
      "string"
    ],
    "springBootStartupClass": [
      "string"
    ],
    "tibcoBWEnginePropertyFilePaths": [
      "string"
    ],
    "tibcoBusinessWorksAppNodeName": [
      "string"
    ],
    "tibcoBusinessWorksAppSpaceName": [
      "string"
    ],
    "tibcoBusinessWorksCeAppName": [
      "string"
    ],
    "tibcoBusinessWorksCeVersion": [
      "string"
    ],
    "tibcoBusinessWorksDomainName": [
      "string"
    ],
    "tibcoBusinessWorksEnginePropertyFiles": [
      "string"
    ],
    "tibcoBusinessWorksHome": [
      "string"
    ],
    "varnishInstanceNames": [
      "string"
    ],
    "weblogicClusterNames": [
      "string"
    ],
    "weblogicDomainNames": [
      "string"
    ],
    "weblogicHomeValues": [
      "string"
    ],
    "weblogicNames": [
      "string"
    ],
    "websphereCellNames": [
      "string"
    ],
    "websphereClusterNames": [
      "string"
    ],
    "websphereLibertyServerName": [
      "string"
    ],
    "websphereNodeNames": [
      "string"
    ],
    "websphereServerNames": [
      "string"
    ],
    "zCodeModuleVersion": [
      "string"
    ]
  },
  "modules": [
    "string"
  ],
  "monitoringState": {
    "actualMonitoringState": "OFF",
    "expectedMonitoringState": "OFF",
    "restartRequired": true
  },
  "softwareTechnologies": [
    {
      "edition": "string",
      "type": "string",
      "version": "string"
    }
  ],
  "tags": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ],
  "toRelationships": {
    "isNetworkClientOf": [
      "string"
    ],
    "runsOnProcessGroupInstance": [
      "string"
    ]
  },
  "versionedModules": [
    {
      "name": "string",
      "version": "string"
    }
  ]
}

Example

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

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B

Response body

{
  "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
  "displayName": "Apache Web Server apache2",
  "discoveredName": "Apache Web Server apache2",
  "firstSeenTimestamp": 1464951001104,
  "lastSeenTimestamp": 1545147232609,
  "tags": [],
  "fromRelationships": {
    "isProcessOf": [
      "HOST-5FD609AD6757BE7D"
    ],
    "isInstanceOf": [
      "PROCESS_GROUP-B34081EFF9E5F516"
    ]
  },
  "toRelationships": {
    "runsOnProcessGroupInstance": [
      "SERVICE-C3173FEB08025322",
      "SERVICE-443EACA6DCAEE651",
      "SERVICE-B8C88BAA442098CF"
    ]
  },
  "metadata": {
    "commandLineArgs": [
      "/usr/sbin/apache2 -k start"
    ],
    "executables": [
      "apache2"
    ],
    "executablePaths": [
      "/usr/sbin/apache2"
    ],
    "apacheConfigPaths": [
      "/etc/apache2/apache2.conf"
    ]
  },
  "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": [
    80,
    443
  ],
  "bitness": "64bit",
  "modules": [
    "mod_auth_basic.c",
    "mod_authn_file.c",
    "mod_negotiation.c",
    "mod_dir.c",
    "mod_rewrite.c"
  ],
  "monitoringState": {
    "actualMonitoringState": "ON",
    "expectedMonitoringState": "ON",
    "restartRequired": false
  },
  "agentVersions": [
    {
      "major": 1,
      "minor": 157,
      "revision": 210,
      "timestamp": "20181213-075558",
      "sourceRevision": ""
    }
  ]
}

Response code

200

Processes API - GET a process

Authentication

Parameters

Response

Response codes

Response body objects

The ProcessGroupInstance object

The AgentVersion object

The EntityShortRepresentation object

The MonitoringState object

The TechnologyInfo object

The TagInfo object

The ProcessGroupInstanceModule object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

Related topics

The `ProcessGroupInstance` object

The `AgentVersion` object

The `EntityShortRepresentation` object

The `MonitoringState` object

The `TechnologyInfo` object

The `TagInfo` object

The `ProcessGroupInstanceModule` object