Services API - GET a service

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.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/services/{meIdentifier}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/services/{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

ParameterTypeDescriptionInRequired
meIdentifierstring

The Dynatrace entity ID of the required service.

pathrequired

Response

Response codes

CodeTypeDescription
200Service

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The Service object

ElementTypeDescription
agentTechnologyTypestring-
  • APACHE
  • DOTNET
  • DUMPPROC
  • GO
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • N/A
  • NET
  • NETTRACER
  • NGINX
  • NODEJS
  • OPENTRACINGNATIVE
  • OS
  • PHP
  • PLUGIN
  • PROCESS
  • PYTHON
  • REMOTE_PLUGIN
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • WSMB
  • Z
akkaActorSystemstring

The services of the akka actor system.

classNamestring-
contextRootstring-
customizedNamestring

The customized name of the entity

databaseHostNamesstring[]-
databaseNamestring-
databaseVendorstring-
discoveredNamestring

The discovered name of the entity

displayNamestring

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

entityIdstring

The Dynatrace entity ID of the required entity.

esbApplicationNamestring

The ESB application name.

firstSeenTimestampinteger

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

fromRelationshipsobject-
ibmCtgGatewayUrlstring

The IBM CTG gateway URL.

ibmCtgServerNamestring

The IBM CICS Transaction Gateway name.

iibApplicationNamestring

The IIB application name.

ipAddressesstring[]-
isExternalServiceboolean-
lastSeenTimestampinteger

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

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

pathstring-
portinteger-
publicDomainNameobject

Public domain name.

remoteEndpointstring

The endpoint of the remote service.

remoteServiceNamestring

The name of the remote service.

serviceDetectionAttributesobject

Attributes that contributed to the service id.

serviceTechnologyTypesstring[]-
serviceTypestring-
  • AMP
  • Cics
  • CicsInteraction
  • CustomApplication
  • Database
  • EnterpriseServiceBus
  • External
  • Ims
  • ImsInteraction
  • Messaging
  • Method
  • Mobile
  • Process
  • QueueInteraction
  • QueueListener
  • RemoteCall
  • Rmi
  • SaasVendor
  • Span
  • Unified
  • Unknown
  • WebRequest
  • WebService
  • WebSite
  • ZosConnect
softwareTechnologiesTechnologyInfo[]-
tagsTagInfo[]

The list of entity tags.

toRelationshipsobject-
webApplicationIdstring-
webServerNamestring-
webServiceNamestring-
webServiceNamespacestring-

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

The TechnologyInfo object

ElementTypeDescription
editionstring-
typestring-
versionstring-

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.

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

Response body JSON model

{
"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"
}

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