Process groups API - GET a process group
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 group.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/{meIdentifier} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{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 group. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Process | Success |
Response body objects
The ProcessGroup object
Parameters of a process group.
| 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 | Tag | The list of entity tags. |
| fromRelationships | object | - |
| toRelationships | object | - |
| metadata | object | - |
| softwareTechnologies | Technology | - |
| listenPorts | integer[] | - |
| azureHostName | string | - |
| azureSiteName | string | - |
| managementZones | Entity | The management zones that the entity is part of. |
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 |
| 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 TechnologyInfo object
| Element | Type | Description |
|---|---|---|
| type | string | - |
| edition | 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. |
Response body JSON model
{
"entityId": "string",
"displayName": "string",
"customizedName": "string",
"discoveredName": "string",
"firstSeenTimestamp": 1,
"lastSeenTimestamp": 1,
"tags": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"fromRelationships": {
"isNetworkClientOfProcessGroup": [
"string"
],
"runsOn": [
"string"
]
},
"toRelationships": {
"isNetworkClientOfProcessGroup": [
"string"
],
"isInstanceOf": [
"string"
],
"runsOn": [
"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"
]
},
"softwareTechnologies": [
{
"type": "string",
"edition": "string",
"version": "string"
}
],
"listenPorts": [
1
],
"azureHostName": "string",
"azureSiteName": "string",
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}
]
}Example
In this example, the request gets the details of the PHP-FPM process group, which has the ID of PROCESS_GROUP-E5C3CC7EC1F80B5B.
The API token is passed in the Authorization header.
Curl
curl -X GET \
'https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5BResponse body
{
"entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
"displayName": "PHP-FPM",
"discoveredName": "PHP-FPM",
"firstSeenTimestamp": 1503909407206,
"lastSeenTimestamp": 1545150389821,
"tags": [],
"fromRelationships": {
"isNetworkClientOfProcessGroup": [
"PROCESS_GROUP-49C926A7091830E3"
],
"runsOn": [
"HOST-249385B2CEBFE51F",
"HOST-890A0495CB619DDF",
"HOST-3FBF48320E4079EF"
]
},
"toRelationships": {
"isInstanceOf": [
"PROCESS_GROUP_INSTANCE-BBFBABB27B2686F2",
"PROCESS_GROUP_INSTANCE-7E988C3503AE8803"
],
"isNetworkClientOfProcessGroup": [
"PROCESS_GROUP-49C926A7091830E3"
],
"runsOn": [
"SERVICE-72503CBDD2AEF066"
]
},
"metadata": {
"hostGroups": [
"authoring"
],
"commandLineArgs": [
"/usr/sbin/php-fpm7.0 --nodaemonize --fpm-config /etc/php/7.0/fpm/php-fpm.conf"
],
"executables": [
"php-fpm7.0"
],
"executablePaths": [
"/usr/sbin/php-fpm7.0"
]
},
"softwareTechnologies": [
{
"type": "SQLITE",
"edition": null,
"version": null
},
{
"type": "PHP",
"edition": "FPM",
"version": "7.0.32"
},
{
"type": "PHP_FPM",
"edition": null,
"version": null
}
]
}Response code
200