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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/{meIdentifier} |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier} |
To execute this request, you need an access token with DataExport
scope.
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 group. | path | required |
Code | Type | Description |
---|---|---|
200 | Process | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
ProcessGroup
objectParameters of a process group.
Element | Type | Description |
---|---|---|
azureHostName | string | - |
azureSiteName | string | - |
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 | Entity | The management zones that the entity is part of. |
metadata | object | - |
softwareTechnologies | Technology | - |
tags | Tag | The list of entity tags. |
toRelationships | object | - |
EntityShortRepresentation
objectThe 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. |
TechnologyInfo
objectElement | Type | Description |
---|---|---|
edition | string | - |
type | string | - |
version | string | - |
TagInfo
objectTag 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. |
{"azureHostName": "string","azureSiteName": "string","customizedName": "string","discoveredName": "string","displayName": "string","entityId": "string","firstSeenTimestamp": 1,"fromRelationships": {"isNetworkClientOfProcessGroup": ["string"],"runsOn": ["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"]},"softwareTechnologies": [{"edition": "string","type": "string","version": "string"}],"tags": [{"context": "AWS","key": "string","value": "string"}],"toRelationships": {"isInstanceOf": ["string"],"isNetworkClientOfProcessGroup": ["string"],"runsOn": ["string"]}}
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 -X GET \'https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B' \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B
{"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}]}
200