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.dexp.ae/api/v1/entity/services/{meIdentifier}

Parameters

Parameter Type Description In Required
meIdentifier string

The DESK entity ID of the required service.

 path required

Response format

The Service object

Element Type Description
entityId string

The DESK entity ID of the required entity.
displayName string

The name of the DESK 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
softwareTechnologies TechnologyInfo[]
ipAddresses string[]
serviceTechnologyTypes string[]
ibmCtgServerName string

The IBM CICS Transaction Gateway name.
databaseHostNames string[]
remoteEndpoint string

The endpoint of the remote service.
webApplicationId string
databaseVendor string
ibmCtgGatewayUrl string

The IBM CTG gateway URL.
akkaActorSystem string

The services of the akka actor system.
remoteServiceName string

The name of the remote service.
className string
port integer
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.
iibApplicationName string

The IIB application name.
agentTechnologyType string
webServiceName string
webServerName string
serviceType string
databaseName string
webServiceNamespace string
path string
contextRoot string

The EntityShortRepresentation object

The short representation of a DESK entity.

Element Type Description
id string

The ID of the DESK entity.
name string

The name of the DESK entity.
description string

A short description of the DESK entity.

The TechnologyInfo object

Element Type Description
type string
edition string
version string

The TagInfo object

Tag of a DESK 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.dexp.ae/api/v1/entity/services/SERVICE-72503CBDD2AEF066' \
  -H 'Authorization: Api-Token abcdefjhij1234567890' \

Request URL

https://mySampleEnv.live.dexp.ae/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