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

Response

Response codes

Code	Type	Description
200	Service	Success

Response body objects

The `Service` object

Element	Type	Description	Required
entityId	string	The Dynatrace entity ID of the required entity.	optional
displayName	string	The name of the Dynatrace entity as displayed in the UI.	optional
customizedName	string	The customized name of the entity	optional
discoveredName	string	The discovered name of the entity	optional
firstSeenTimestamp	integer	The timestamp of when the entity was first detected, in UTC milliseconds	optional
lastSeenTimestamp	integer	The timestamp of when the entity was last detected, in UTC milliseconds	optional
tags	TagInfo[]	The list of entity tags.	optional
fromRelationships	object	-	optional
toRelationships	object	-	optional
databaseName	string	-	optional
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.	optional
ipAddresses	string[]	-	optional
akkaActorSystem	string	The services of the akka actor system.	optional
serviceTechnologyTypes	string[]	-	optional
databaseVendor	string	-	optional
webServerName	string	-	optional
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`	optional
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`	optional
remoteEndpoint	string	The endpoint of the remote service.	optional
softwareTechnologies	TechnologyInfo[]	-	optional
port	integer	-	optional
path	string	-	optional
remoteServiceName	string	The name of the remote service.	optional
databaseHostNames	string[]	-	optional
webServiceNamespace	string	-	optional
iibApplicationName	string	The IIB application name.	optional
esbApplicationName	string	The ESB application name.	optional
webApplicationId	string	-	optional
ibmCtgGatewayUrl	string	The IBM CTG gateway URL.	optional
contextRoot	string	-	optional
ibmCtgServerName	string	The IBM CICS Transaction Gateway name.	optional
webServiceName	string	-	optional
className	string	-	optional

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description Required

context

string

Element	Type	Description	Required
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`	required
key	string	The key of the tag. Custom tags have the tag value here.	required
value	string	The value of the tag. Not applicable to custom tags.	optional

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

required

key

string

The key of the tag.

Custom tags have the tag value here.

required

value

string

The value of the tag.

Not applicable to custom tags.

optional

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
id	string	The ID of the Dynatrace entity.	required
name	string	The name of the Dynatrace entity.	optional
description	string	A short description of the Dynatrace entity.	optional

The `TechnologyInfo` object

Element	Type	Description	Required
type	string	-	optional
edition	string	-	optional
version	string	-	optional

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

http
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