• Home
  • Dynatrace API
  • Environment
  • Topology and Smartscape v1
  • Processes
  • GET a process

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/processes/{meIdentifier}
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
meIdentifierstring

The Dynatrace entity ID of the required process.

pathrequired

Response

Response codes

CodeTypeDescription
200ProcessGroupInstance

Success

Response body objects

The ProcessGroupInstance object

Parameters of a process.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the required entity.

displayNamestring

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

customizedNamestring

The customized name of the entity

discoveredNamestring

The discovered name of the entity

firstSeenTimestampinteger

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

lastSeenTimestampinteger

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

tagsTagInfo[]

The list of entity tags.

fromRelationshipsobject-
toRelationshipsobject-
metadataobject-
azureSiteNamestring-
modulesstring[]-
bitnessstring-
The element can hold these values
  • 32bit
  • 64bit
versionedModulesProcessGroupInstanceModule[]-
managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

azureHostNamestring-
monitoringStateMonitoringState

Defines the current monitoring state of an entity.

listenPortsinteger[]-
softwareTechnologiesTechnologyInfo[]-
agentVersionsAgentVersion[]

Versions of OneAgents currently running on the entity.

The TagInfo object

Tag of a Dynatrace entity.

ElementTypeDescription
contextstring

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

Custom tags use the CONTEXTLESS value.

The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

The ProcessGroupInstanceModule object

ElementTypeDescription
namestring-
versionstring-

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

The MonitoringState object

Defines the current monitoring state of an entity.

ElementTypeDescription
actualMonitoringStatestring

The current actual monitoring state on the entity.

The element can hold these values
  • OFF
  • ON
expectedMonitoringStatestring

The monitoring state that is expected from the configuration

The element can hold these values
  • OFF
  • ON
restartRequiredboolean

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

The TechnologyInfo object

ElementTypeDescription
typestring-
editionstring-
versionstring-

The AgentVersion object

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

ElementTypeDescription
majorinteger

The major version number.

minorinteger

The minor version number.

revisioninteger

The revision number.

timestampstring

A timestamp string: format "yyyymmdd-hhmmss

sourceRevisionstring

A string representation of the SVN revision number.

Response body JSON model

json
{ "entityId": "string", "displayName": "string", "customizedName": "string", "discoveredName": "string", "firstSeenTimestamp": 1, "lastSeenTimestamp": 1, "tags": [ { "context": "AWS", "key": "string", "value": "string" } ], "fromRelationships": { "isProcessOf": [ "string" ], "isInstanceOf": [ "string" ], "isNetworkClientOf": [ "string" ] }, "toRelationships": { "runsOnProcessGroupInstance": [ "string" ], "isNetworkClientOf": [ "string" ] }, "metadata": { "hostGroups": [ "string" ], "cloudFoundryAppIds": [ "string" ], "dynatraceNodeIds": [ "string" ], "executables": [ "string" ], "googleComputeEngineMetadata": {}, "phpScripts": [ "string" ], "awsEcsCluster": [ "string" ], "declarativeId": [ "string" ], "glassfishInstanceNames": [ "string" ], "tibcoBusinessWorksEnginePropertyFiles": [ "string" ], "jbossServerNames": [ "string" ], "catalinaBaseValues": [ "string" ], "mssqlInstanceName": [ "string" ], "ibmIntegrationServerName": [ "string" ], "varnishInstanceNames": [ "string" ], "phpWorkingDirectories": [ "string" ], "websphereLibertyServerName": [ "string" ], "googleCloudProjects": [ "string" ], "dockerContainerImageVersions": [ "string" ], "hybrisConfigDirectories": [ "string" ], "executablePaths": [ "string" ], "awsEcrImageRegions": [ "string" ], "tibcoBusinessWorksAppSpaceName": [ "string" ], "springBootStartupClass": [ "string" ], "weblogicDomainNames": [ "string" ], "elasticSearchNodeNames": [ "string" ], "tibcoBWEnginePropertyFilePaths": [ "string" ], "kubernetesContainerNames": [ "string" ], "rubyAppRootPaths": [ "string" ], "ibmImsMessageProcessingRegions": [ "string" ], "googleCloudInstanceId": [ "string" ], "googleCloudInstanceRegion": [ "string" ], "linkage": [ "string" ], "cloudfoundryMetadata": {}, "oracleSid": [ "string" ], "awsEcsFamily": [ "string" ], "commandLineArgs": [ "string" ], "aspDotNetCoreApplicationPaths": [ "string" ], "awsEcrImageAccountIds": [ "string" ], "springBootAppName": [ "string" ], "websphereClusterNames": [ "string" ], "springBootProfileName": [ "string" ], "kubernetesAnnotations": {}, "websphereServerNames": [ "string" ], "catalinaHomeValues": [ "string" ], "glassfishDomainNames": [ "string" ], "kubernetesBasePodNames": [ "string" ], "weblogicClusterNames": [ "string" ], "javaMainModules": [ "string" ], "ibmJobName": [ "string" ], "kubernetesPodUids": [ "string" ], "awsEcsContainerName": [ "string" ], "coldfusionJvmConfigFiles": [ "string" ], "dotnetCommandPath": [ "string" ], "tibcoBusinessWorksDomainName": [ "string" ], "elasticSearchClusterNames": [ "string" ], "nodejsScriptNames": [ "string" ], "iisRoleNames": [ "string" ], "apacheSparkMasterIpAddresses": [ "string" ], "weblogicNames": [ "string" ], "rubyScriptPaths": [ "string" ], "ibmImsSoapGwName": [ "string" ], "nodejsAppBaseDirectories": [ "string" ], "softwareAgProductPropertyName": [ "string" ], "awsEcsRevision": [ "string" ], "ibmImsControlRegions": [ "string" ], "javaMainClasses": [ "string" ], "cassandraClusterNames": [ "string" ], "softwareAgInstallRoot": [ "string" ], "cloudFoundryAppNames": [ "string" ], "cloudFoundrySpaceNames": [ "string" ], "pluginMetadata": {}, "ibmIntegrationNodeName": [ "string" ], "dockerContainerNames": [ "string" ], "ibmCtgName": [ "string" ], "googleCloudRunService": [ "string" ], "tibcoBusinessWorksCeAppName": [ "string" ], "kubernetesFullPodNames": [ "string" ], "apacheConfigPaths": [ "string" ], "tibcoBusinessWorksAppNodeName": [ "string" ], "tibcoBusinessWorksCeVersion": [ "string" ], "dotNetCommands": [ "string" ], "googleAppEngineServices": [ "string" ], "kubernetesNamespaces": [ "string" ], "hybrisDataDirectories": [ "string" ], "envVariables": {}, "javaJarFiles": [ "string" ], "javaJarPaths": [ "string" ], "dockerContainerIds": [ "string" ], "cloudFoundrySpaceIds": [ "string" ], "ruleResult": [ "string" ], "kubernetesRuleResult": [ "string" ], "jbossModes": [ "string" ], "awsLambdaFunctionNames": [ "string" ], "cloudFoundryInstanceIndexes": [ "string" ], "hybrisBinDirectories": [ "string" ], "weblogicHomeValues": [ "string" ], "jbossHomes": [ "string" ], "ibmApplid": [ "string" ], "dynatraceClusterIds": [ "string" ], "googleAppEngineInstances": [ "string" ], "websphereNodeNames": [ "string" ], "agentValueMetadata": {}, "iisAppPools": [ "string" ], "ibmImsConnectRegions": [ "string" ], "dockerContainerImageNames": [ "string" ], "tibcoBusinessWorksHome": [ "string" ], "ibmCicsRegion": [ "string" ], "serviceNames": [ "string" ], "websphereCellNames": [ "string" ], "nodejsAppNames": [ "string" ], "equinoxConfigPath": [ "string" ], "awsRegions": [ "string" ] }, "azureSiteName": "string", "modules": [ "string" ], "bitness": "32bit", "versionedModules": [ { "name": "string", "version": "string" } ], "managementZones": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" } ], "azureHostName": "string", "monitoringState": { "actualMonitoringState": "OFF", "expectedMonitoringState": "OFF", "restartRequired": true }, "listenPorts": [ 1 ], "softwareTechnologies": [ { "type": "string", "edition": "string", "version": "string" } ], "agentVersions": [ { "major": 1, "minor": 1, "revision": 1, "timestamp": "string", "sourceRevision": "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

bash
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

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

Response body

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

Related topics
  • Process groups

    Analyze process groups and customize process group naming, detection, and monitoring.