Services API - GET a service
We have a new version of this API—Entity API v2. Check it out!
Gets the parameters of a specified service.
The request produces an application/json
payload.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/services/{meIdentifier} | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/services/{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
meIdentifier | string | The Dynatrace entity ID of the required service. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Service | Success |
Response body objects
The Service
object
Element | Type | Description |
---|---|---|
entityId | string | The Dynatrace entity ID of the required entity. Can be |
displayName | string | The name of the Dynatrace entity as displayed in the UI. Can be |
customizedName | string | The customized name of the entity Can be |
discoveredName | string | The discovered name of the entity Can be |
firstSeenTimestamp | integer | The timestamp of when the entity was first detected, in UTC milliseconds Can be |
lastSeenTimestamp | integer | The timestamp of when the entity was last detected, in UTC milliseconds Can be |
tags | Tag | The list of entity tags. Can be |
fromRelationships | object | - Can be |
toRelationships | object | - Can be |
agentTechnologyType | string | - Can be |
path | string | - Can be |
databaseHostNames | string[] | - Can be |
serviceType | string | - Can be |
ibmCtgGatewayUrl | string | The IBM CTG gateway URL. Can be |
webServiceNamespace | string | - Can be |
remoteEndpoint | string | The endpoint of the remote service. Can be |
webServerName | string | - Can be |
port | integer | - Can be |
ibmCtgServerName | string | The IBM CICS Transaction Gateway name. Can be |
contextRoot | string | - Can be |
databaseName | string | - Can be |
managementZones | Entity | The management zones that the entity is part of. Can be |
serviceTechnologyTypes | string[] | - Can be |
databaseVendor | string | - Can be |
esbApplicationName | string | The ESB application name. Can be |
webServiceName | string | - Can be |
className | string | - Can be |
remoteServiceName | string | The name of the remote service. Can be |
akkaActorSystem | string | The services of the akka actor system. Can be |
softwareTechnologies | Technology | - Can be |
iibApplicationName | string | The IIB application name. Can be |
webApplicationId | string | - Can be |
ipAddresses | string[] | - Can be |
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. Can be |
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. Can be |
description | string | A short description of the Dynatrace entity. Can be |
The TechnologyInfo
object
Element | Type | Description |
---|---|---|
type | string | - Can be |
edition | string | - Can be |
version | string | - Can be |
Response body JSON model
{
"entityId": "string",
"displayName": "string",
"customizedName": "string",
"discoveredName": "string",
"firstSeenTimestamp": 1,
"lastSeenTimestamp": 1,
"tags": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"fromRelationships": {
"runsOnProcessGroupInstance": [
"string"
],
"calls": [
"string"
],
"runsOn": [
"string"
]
},
"toRelationships": {
"calls": [
"string"
]
},
"agentTechnologyType": "APACHE",
"path": "string",
"databaseHostNames": [
"string"
],
"serviceType": "AMP",
"ibmCtgGatewayUrl": "string",
"webServiceNamespace": "string",
"remoteEndpoint": "string",
"webServerName": "string",
"port": 1,
"ibmCtgServerName": "string",
"contextRoot": "string",
"databaseName": "string",
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}
],
"serviceTechnologyTypes": [
"string"
],
"databaseVendor": "string",
"esbApplicationName": "string",
"webServiceName": "string",
"className": "string",
"remoteServiceName": "string",
"akkaActorSystem": "string",
"softwareTechnologies": [
{
"type": "string",
"edition": "string",
"version": "string"
}
],
"iibApplicationName": "string",
"webApplicationId": "string",
"ipAddresses": [
"string"
]
}
Example
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
curl -X GET \
'https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066
Response body
{
"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
}
]
}
Response code
200