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

Parameter	Type	Description	In	Required
meIdentifier	string	The Dynatrace entity ID of the required service.	path	required

Response

Response codes

Code	Type	Description
200	Service	Success

Response body objects

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.
fromRelationships	object	-
toRelationships	object	-
agentTechnologyType	string	- 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`
isExternalService	boolean	-
databaseVendor	string	-
webServiceName	string	-
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.
path	string	-
ibmCtgServerName	string	The IBM CICS Transaction Gateway name.
serviceType	string	- 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`
databaseName	string	-
ipAddresses	string[]	-
databaseHostNames	string[]	-
remoteServiceName	string	The name of the remote service.
iibApplicationName	string	The IIB application name.
serviceTechnologyTypes	string[]	-
remoteEndpoint	string	The endpoint of the remote service.
className	string	-
port	integer	-
esbApplicationName	string	The ESB application name.
akkaActorSystem	string	The services of the akka actor system.
ibmCtgGatewayUrl	string	The IBM CTG gateway URL.
webServerName	string	-
webApplicationId	string	-
contextRoot	string	-
softwareTechnologies	TechnologyInfo[]	-
webServiceNamespace	string	-

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description

context

string

Element	Type	Description
context	string	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`
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.

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

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.

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	-

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",
  "isExternalService": true,
  "databaseVendor": "string",
  "webServiceName": "string",
  "managementZones": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity",
      "description": "Dynatrace entity for the REST API example"
    }
  ],
  "path": "string",
  "ibmCtgServerName": "string",
  "serviceType": "AMP",
  "databaseName": "string",
  "ipAddresses": [
    "string"
  ],
  "databaseHostNames": [
    "string"
  ],
  "remoteServiceName": "string",
  "iibApplicationName": "string",
  "serviceTechnologyTypes": [
    "string"
  ],
  "remoteEndpoint": "string",
  "className": "string",
  "port": 1,
  "esbApplicationName": "string",
  "akkaActorSystem": "string",
  "ibmCtgGatewayUrl": "string",
  "webServerName": "string",
  "webApplicationId": "string",
  "contextRoot": "string",
  "softwareTechnologies": [
    {
      "type": "string",
      "edition": "string",
      "version": "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

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

Services API - GET a service

Authentication

Parameters

Response

Response codes

Response body objects

The Service object

The TagInfo object

The EntityShortRepresentation object

The TechnologyInfo object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `Service` object

The `TagInfo` object

The `EntityShortRepresentation` object

The `TechnologyInfo` object