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

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.

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

Authentication

To execute this request, you need an access token with Access problem and event feed, metrics, and topology (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.

Can be null.

displayNamestring

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

Can be null.

customizedNamestring

The customized name of the entity

Can be null.

discoveredNamestring

The discovered name of the entity

Can be null.

firstSeenTimestampinteger

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

Can be null.

lastSeenTimestampinteger

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

Can be null.

tagsTagInfo[]

The list of entity tags.

Can be null.

fromRelationshipsobject-

Can be null.

toRelationshipsobject-

Can be null.

metadataobject-

Can be null.

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

Can be null.

listenPortsinteger[]-

Can be null.

modulesstring[]-

Can be null.

softwareTechnologiesTechnologyInfo[]-

Can be null.

azureSiteNamestring-

Can be null.

monitoringStateMonitoringState

Defines the current monitoring state of an entity.

Can be null.

bitnessstring-
The element can hold these values
  • 32bit
  • 64bit

Can be null.

azureHostNamestring-

Can be null.

versionedModulesProcessGroupInstanceModule[]-

Can be null.

agentVersionsAgentVersion[]

Versions of OneAgents currently running on the entity.

Can be null.

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.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

The TechnologyInfo object

ElementTypeDescription
typestring-

Can be null.

editionstring-

Can be null.

versionstring-

Can be null.

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

Can be null.

expectedMonitoringStatestring

The monitoring state that is expected from the configuration

The element can hold these values
  • OFF
  • ON

Can be null.

restartRequiredboolean

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

Can be null.

The ProcessGroupInstanceModule object

ElementTypeDescription
namestring-

Can be null.

versionstring-

Can be null.

The AgentVersion object

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

ElementTypeDescription
majorinteger

The major version number.

Can be null.

minorinteger

The minor version number.

Can be null.

revisioninteger

The revision number.

Can be null.

timestampstring

A timestamp string: format "yyyymmdd-hhmmss

Can be null.

sourceRevisionstring

A string representation of the SVN revision number.

Can be null.

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" ], "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" ], "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" ], "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" ], "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" ] }, "managementZones": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" } ], "listenPorts": [ 1 ], "modules": [ "string" ], "softwareTechnologies": [ { "type": "string", "edition": "string", "version": "string" } ], "azureSiteName": "string", "monitoringState": { "actualMonitoringState": "OFF", "expectedMonitoringState": "OFF", "restartRequired": true }, "bitness": "32bit", "azureHostName": "string", "versionedModules": [ { "name": "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

shell
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.