Process groups API - GET a process group

Gets the parameters of the specified process group.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}
  • SaaS https://{your-environment-id}.live.dexp.ae/api/v1/entity/infrastructure/process-groups/{meIdentifier}

Parameters

Parameter Type Description In Required
meIdentifier string

The DESK entity ID of the required process group.

 path required

Response format

The ProcessGroup object

Parameters of a process group.

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[]
azureHostName string
listenPorts integer[]
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.
metadata object
azureSiteName 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 process group, which has the ID of PROCESS_GROUP-E5C3CC7EC1F80B5B.

The API token is passed in the Authorization header.

Curl

curl -X GET \
  'https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B' \
  -H 'Authorization: Api-Token abcdefjhij1234567890' \

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B

Response body

{
  "entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
  "displayName": "PHP-FPM",
  "discoveredName": "PHP-FPM",
  "firstSeenTimestamp": 1503909407206,
  "lastSeenTimestamp": 1545150389821,
  "tags": [],
  "fromRelationships": {
    "isNetworkClientOfProcessGroup": [
      "PROCESS_GROUP-49C926A7091830E3"
    ],
    "runsOn": [
      "HOST-249385B2CEBFE51F",
      "HOST-890A0495CB619DDF",
      "HOST-3FBF48320E4079EF"
    ]
  },
  "toRelationships": {
    "isInstanceOf": [
      "PROCESS_GROUP_INSTANCE-BBFBABB27B2686F2",
      "PROCESS_GROUP_INSTANCE-7E988C3503AE8803"
    ],
    "isNetworkClientOfProcessGroup": [
      "PROCESS_GROUP-49C926A7091830E3"
    ],
    "runsOn": [
      "SERVICE-72503CBDD2AEF066"
    ]
  },
  "metadata": {
    "hostGroups": [
      "authoring"
    ],
    "commandLineArgs": [
      "/usr/sbin/php-fpm7.0 --nodaemonize --fpm-config /etc/php/7.0/fpm/php-fpm.conf"
    ],
    "executables": [
      "php-fpm7.0"
    ],
    "executablePaths": [
      "/usr/sbin/php-fpm7.0"
    ]
  },
  "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