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 a specified service.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/services/{meIdentifier} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/services/{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 service. | path | required |
| Code | Type | Description |
|---|---|---|
| 200 | Service | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
Service object| Element | Type | Description |
|---|---|---|
| agentTechnologyType | string | -
|
| akkaActorSystem | string | The services of the akka actor system. |
| className | string | - |
| contextRoot | string | - |
| customizedName | string | The customized name of the entity |
| databaseHostNames | string[] | - |
| databaseName | string | - |
| databaseVendor | string | - |
| 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. |
| esbApplicationName | string | The ESB application name. |
| firstSeenTimestamp | integer | The timestamp of when the entity was first detected, in UTC milliseconds |
| fromRelationships | object | - |
| ibmCtgGatewayUrl | string | The IBM CTG gateway URL. |
| ibmCtgServerName | string | The IBM CICS Transaction Gateway name. |
| iibApplicationName | string | The IIB application name. |
| ipAddresses | string[] | - |
| isExternalService | boolean | - |
| lastSeenTimestamp | integer | The timestamp of when the entity was last detected, in UTC milliseconds |
| managementZones | Entity | The management zones that the entity is part of. |
| path | string | - |
| port | integer | - |
| publicDomainName | object | Public domain name. |
| remoteEndpoint | string | The endpoint of the remote service. |
| remoteServiceName | string | The name of the remote service. |
| serviceDetectionAttributes | object | Attributes that contributed to the service id. |
| serviceTechnologyTypes | string[] | - |
| serviceType | string | -
|
| softwareTechnologies | Technology | - |
| tags | Tag | The list of entity tags. |
| toRelationships | object | - |
| webApplicationId | string | - |
| webServerName | string | - |
| webServiceName | string | - |
| webServiceNamespace | string | - |
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 object| Element | 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. |
{"agentTechnologyType": "APACHE","akkaActorSystem": "string","className": "string","contextRoot": "string","customizedName": "string","databaseHostNames": ["string"],"databaseName": "string","databaseVendor": "string","discoveredName": "string","displayName": "string","entityId": "string","esbApplicationName": "string","firstSeenTimestamp": 1,"fromRelationships": {"calls": ["string"],"runsOn": ["string"],"runsOnProcessGroupInstance": ["string"]},"ibmCtgGatewayUrl": "string","ibmCtgServerName": "string","iibApplicationName": "string","ipAddresses": ["string"],"isExternalService": true,"lastSeenTimestamp": 1,"managementZones": [{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}],"path": "string","port": 1,"publicDomainName": {},"remoteEndpoint": "string","remoteServiceName": "string","serviceDetectionAttributes": {},"serviceTechnologyTypes": ["string"],"serviceType": "AMP","softwareTechnologies": [{"edition": "string","type": "string","version": "string"}],"tags": [{"context": "AWS","key": "string","value": "string"}],"toRelationships": {"calls": ["string"]},"webApplicationId": "string","webServerName": "string","webServiceName": "string","webServiceNamespace": "string"}
In this example, the request gets the details of the PHP-FPM via domain socket /run/php7-fpm.sock service, which has the ID of SERVICE-72503CBDD2AEF066.
The API token is passed in the Authorization header.
curl -X GET \'https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066' \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066
{"entityId": "SERVICE-72503CBDD2AEF066","displayName": "PHP-FPM via domain socket /run/php7-fpm.sock","discoveredName": "PHP-FPM via domain socket /run/php7-fpm.sock","firstSeenTimestamp": 1505902015554,"lastSeenTimestamp": 1546010106998,"tags": [],"fromRelationships": {"runsOnProcessGroupInstance": ["PROCESS_GROUP_INSTANCE-9BA70456D770536E","PROCESS_GROUP_INSTANCE-7E988C3503AE8803"],"runsOn": ["PROCESS_GROUP-E5C3CC7EC1F80B5B"]},"toRelationships": {"calls": ["SERVICE-5304CCF4AFBFF35E"]},"agentTechnologyType": "N/A","serviceType": "WebRequest","softwareTechnologies": [{"type": "SQLITE","edition": null,"version": null},{"type": "PHP","edition": "FPM","version": "7.0.32"},{"type": "PHP_FPM","edition": null,"version": null}]}
200