LIliongard
Environment

Get Related Entities per Environment

Returns all the Related Entities that are tied to a single Environment such as Agents, Launchpoints, and Integration mappings

get/environments/{environmentId}/relatedEntities

Request

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

Path parameters

environmentIdinteger required

Environment ID

Response

Success

Successboolean

Example response

{
  "Success": true,
  "Data": {
    "ID": 1,
    "LaunchPoints": [
      {
        "ID": 1,
        "Alias": "string",
        "SystemID": 1,
        "InspectorID": 25,
        "InspectorName": "string",
        "Enabled": true,
        "Status": "string"
      }
    ],
    "Agents": [
      {
        "ID": 1,
        "Name": "string",
        "Description": "string",
        "Hostname": "ip address",
        "Platform": "string",
        "Managed": true
      }
    ],
    "IntegrationMappings": [
      {
        "ID": 1,
        "Integration": "string"
      }
    ],
    "ChildEnvironments": [
      {
        "ID": 1,
        "Name": "string",
        "Status": 1,
        "Visible": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.