Environments

Related Entities

Fetch all the related entities for a specific environment, including Launchpoints, Agents, and Child Environments.

get/environments/{EnvironmentID}/relatedEntities

Request

  • Base URL
    https://example.app.liongard.com/api/v1
  • URL
    https://example.app.liongard.com/api/v1/environments/{EnvironmentID}/relatedEntities
  • Auth
    API key in header X-ROAR-API-KEY

Path parameters

EnvironmentIDinteger required

ID of Environment

Response

IDinteger

Example response

{
  "ID": 8095,
  "Launchpoint": [
    {
      "ID": 18671,
      "Alias": "Active Directory - Contoso Nation",
      "Enabled": true,
      "Status": "Active"
    }
  ],
  "Agents": [
    {
      "ID": 1068,
      "Name": "Contoso Nation Agent",
      "Description": "Main Agent",
      "Hostname": "CN-DC01",
      "Platform": "windows"
    }
  ],
  "IntegrationMappings": [
    {
      "ID": 5502,
      "Integration": "integrationName"
    }
  ],
  "ChildEnvironments": [
    {
      "ID": 8669,
      "Name": "Contoso Nation - Remote",
      "Status": 1,
      "Visible": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.