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

Response codes

Code Description
200

Success

Response body

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

The IBM CTG gateway URL.

port integer
webServiceName string
softwareTechnologies TechnologyInfo[]
ipAddresses string[]
ibmCtgServerName string

The IBM CICS Transaction Gateway name.

contextRoot string
className string
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.

esbApplicationName string

The ESB application name.

webServiceNamespace string
serviceType string
iibApplicationName string

The IIB application name.

databaseVendor string
serviceTechnologyTypes string[]
agentTechnologyType string
path string
databaseHostNames string[]
webApplicationId string
webServerName string
remoteEndpoint string

The endpoint of the remote service.

remoteServiceName string

The name of the remote service.

akkaActorSystem string

The services of the akka actor system.

databaseName string
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.

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.

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