• Home
  • Dynatrace API
  • Environment
  • Topology and Smartscape v1
  • Services
  • GET a service

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.

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

Response body objects

The Service object

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the required entity.

displayNamestring

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

customizedNamestring

The customized name of the entity

discoveredNamestring

The discovered name of the entity

firstSeenTimestampinteger

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

lastSeenTimestampinteger

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

tagsTagInfo[]

The list of entity tags.

fromRelationshipsobject-
toRelationshipsobject-
remoteEndpointstring

The endpoint of the remote service.

remoteServiceNamestring

The name of the remote service.

webApplicationIdstring-
serviceTechnologyTypesstring[]-
akkaActorSystemstring

The services of the akka actor system.

agentTechnologyTypestring-
The element can hold these values
  • 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
contextRootstring-
serviceTypestring-
The element can hold these values
  • 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
isExternalServiceboolean-
iibApplicationNamestring

The IIB application name.

databaseVendorstring-
databaseHostNamesstring[]-
ibmCtgGatewayUrlstring

The IBM CTG gateway URL.

portinteger-
webServiceNamespacestring-
softwareTechnologiesTechnologyInfo[]-
webServerNamestring-
pathstring-
ibmCtgServerNamestring

The IBM CICS Transaction Gateway name.

esbApplicationNamestring

The ESB application name.

webServiceNamestring-
classNamestring-
databaseNamestring-
ipAddressesstring[]-
managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

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.

The element can hold these values
  • 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.

The TechnologyInfo object

ElementTypeDescription
typestring-
editionstring-
versionstring-

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "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" ] }, "remoteEndpoint": "string", "remoteServiceName": "string", "webApplicationId": "string", "serviceTechnologyTypes": [ "string" ], "akkaActorSystem": "string", "agentTechnologyType": "APACHE", "contextRoot": "string", "serviceType": "AMP", "isExternalService": true, "iibApplicationName": "string", "databaseVendor": "string", "databaseHostNames": [ "string" ], "ibmCtgGatewayUrl": "string", "port": 1, "webServiceNamespace": "string", "softwareTechnologies": [ { "type": "string", "edition": "string", "version": "string" } ], "webServerName": "string", "path": "string", "ibmCtgServerName": "string", "esbApplicationName": "string", "webServiceName": "string", "className": "string", "databaseName": "string", "ipAddresses": [ "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 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

bash
curl -X GET \ 'https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066' \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/entity/services/SERVICE-72503CBDD2AEF066

Response body

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

Related topics
  • Services

    Learn how to monitor and analyze your services, how to define and use request attributes, and more.