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

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.

GETManaged 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

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.

Can be null.

displayNamestring

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

Can be null.

customizedNamestring

The customized name of the entity

Can be null.

discoveredNamestring

The discovered name of the entity

Can be null.

firstSeenTimestampinteger

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

Can be null.

lastSeenTimestampinteger

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

Can be null.

tagsTagInfo[]

The list of entity tags.

Can be null.

fromRelationshipsobject-

Can be null.

toRelationshipsobject-

Can be null.

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

Can be null.

pathstring-

Can be null.

databaseHostNamesstring[]-

Can be null.

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
  • Unknown
  • WebRequest
  • WebService
  • WebSite
  • ZosConnect

Can be null.

ibmCtgGatewayUrlstring

The IBM CTG gateway URL.

Can be null.

webServiceNamespacestring-

Can be null.

remoteEndpointstring

The endpoint of the remote service.

Can be null.

webServerNamestring-

Can be null.

portinteger-

Can be null.

ibmCtgServerNamestring

The IBM CICS Transaction Gateway name.

Can be null.

contextRootstring-

Can be null.

databaseNamestring-

Can be null.

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

Can be null.

serviceTechnologyTypesstring[]-

Can be null.

databaseVendorstring-

Can be null.

esbApplicationNamestring

The ESB application name.

Can be null.

webServiceNamestring-

Can be null.

classNamestring-

Can be null.

remoteServiceNamestring

The name of the remote service.

Can be null.

akkaActorSystemstring

The services of the akka actor system.

Can be null.

softwareTechnologiesTechnologyInfo[]-

Can be null.

iibApplicationNamestring

The IIB application name.

Can be null.

webApplicationIdstring-

Can be null.

ipAddressesstring[]-

Can be null.

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.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

The TechnologyInfo object

ElementTypeDescription
typestring-

Can be null.

editionstring-

Can be null.

versionstring-

Can be null.

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" ] }, "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

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