Services API - GET a service

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}

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. 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 format

The Service object

Element Type Description
entityId string

The Dynatrace entity ID of the required entity.

displayName string

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

customizedName string

The customized name of the entity

discoveredName string

The discovered name of the entity

firstSeenTimestamp integer

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

lastSeenTimestamp integer

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

tags TagInfo[]

The list of entity tags.

toRelationships object
esbApplicationName string

The ESB application name.

softwareTechnologies TechnologyInfo[]
databaseName string
ipAddresses string[]
remoteServiceName string

The name of the remote service.

webServiceName string
iibApplicationName string

The IIB application name.

webServerName string
databaseVendor string
ibmCtgServerName string

The IBM CICS Transaction Gateway name.

contextRoot string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

path string
akkaActorSystem string

The services of the akka actor system.

remoteEndpoint string

The endpoint of the remote service.

className string
agentTechnologyType string The agentTechnologyType element can hold these values.
port integer
serviceTechnologyTypes string[]
serviceType string The serviceType element can hold these values.
databaseHostNames string[]
webServiceNamespace string
webApplicationId string
ibmCtgGatewayUrl string

The IBM CTG gateway URL.

fromRelationships object

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.

description string

A short description of the Dynatrace entity.

The TechnologyInfo object

Element Type Description
type string
edition string
version string

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 CONTEXTLESS value.

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

Possible values

Possible values for the serviceType element in the Service object:

  • AMP
  • Cics
  • CicsInteraction
  • CustomApplication
  • Database
  • EnterpriseServiceBus
  • External
  • Ims
  • ImsInteraction
  • Messaging
  • Method
  • Mobile
  • Process
  • QueueInteraction
  • QueueListener
  • RemoteCall
  • Rmi
  • SaasVendor
  • Unknown
  • WebRequest
  • WebService
  • WebSite

Possible values for the agentTechnologyType element in the Service object:

  • APACHE
  • DOTNET
  • DUMPPROC
  • GO
  • IIS
  • JAVA
  • LOG_ANALYTICS
  • N/A
  • NET
  • NGINX
  • NODEJS
  • OPENTRACING
  • OS
  • PHP
  • PLUGIN
  • PROCESS
  • PYTHON
  • REMOTE_PLUGIN
  • RUBY
  • SDK
  • UPDATER
  • VARNISH
  • WSMB
  • Z

Possible values for the context element in the TagInfo object:

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES

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