v1

latestOpenAPI 3.0.02026-07-249372139.7 KB

Inspector

Inspector Templates

Get Inspector Config and SecureConfig Fields. Each Inspector has a set of variables used for configuring the launchpoint of an inspector. The Name key under variables is what is needed for completing the launchpoint configuration, the Secure and Required keys are used to determine if the configuration fields are SecureConfig or Config and if they are required.

get/inspector/{InspectorId}/templates

Path parameters

InspectorIdinteger required

ID of Inspector

Query parameters

fields[]string[]

Will only return the fields specified from this parameter, multiple uses of the parameter required for multiple fields

Response

IDinteger

CreatedOnstring

UpdatedOnstring nullable

Example response

[
  {
    "ID": 107,
    "Inspector": {
      "ID": 13,
      "Name": "active-directory-inspector",
      "Alias": "Active Directory",
      "Published": true,
      "Author": "Liongard, Inc.",
      "ContactEmail": "support@liongard.com",
      "Logo": "https://resources.static.liongard.com/images/active-directory-inspector.png",
      "Icon": "https://resources.static.liongard.com/images/icons/microsoft-windows-icon.png",
      "Description": "Inspects Active Directory, returning a wide variety of data including actionable summary information such as privileged users, security policies and much more.",
      "HelpLink": "https://docs.liongard.com/docs/active-directory-inspection-setup",
      "PublishedStatus": "production",
      "InspectorCategory": "appservices",
      "DefaultFrequency": {
        "Type": "days",
        "Interval": 1
      },
      "Constraints": {
        "Tiers": [
          "core"
        ],
        "Platform": [
          "windows"
        ],
        "Frequency": {
          "MaxIntervalType": "hours",
          "MaxIntervalFrequency": 8
        },
        "AgentConstraint": [
          "customer-on-prem"
        ],
        "RecomendedAgent": "customer-on-prem"
      },
      "CreatedOn": "2021/09/10 19:21:03",
      "UpdatedOn": "2021/09/10 19:21:03"
    },
    "Version": {
      "ID": 26,
      "Name": "1.0.1-20210824-921cf729",
      "Discovers": {
        "inspectors": [
          "windows-inspector"
        ]
      },
      "CreatedOn": "2021/09/10 19:21:03",
      "Checksum": "a877d8161295685275fd3"
    },
    "Variables": {
      "Variables": [
        {
          "Help": "Help Text",
          "Hint": "Help Text",
          "Name": "Field Name",
          "Type": "string",
          "Label": "Field Label",
          "Required": true,
          "Placeholder": "example",
          "ValidationRegexBlacklist": [
            {
              "Regex": "^\\S+$",
              "ErrorMessage": "URL should not contain any whitespace"
            }
          ]
        }
      ]
    },
    "CreatedOn": "2021/09/10 19:21:03"
  }
]