Targets utility requests

Utility requests provide metadata that you can use to make related requests, assemble inputDTOs, or see the potential values of a particular DTO.

The targets endpoint contains a utility request called specs that shows the information required for probe registry for each target available to Turbonomic, including required input fields and expected target type and category values.

Note:

For a list of probes available to your specific Turbonomic installation, review your organization's licensing agreement.

Example: GET https://10.10.10.10/api/v3/targets/specs

Response: An array of TargetApiDTO objects, where each object contains an array of input fields. This example shows one entry for the JVM probe in the Application Server category.

[        
 {
  [
    ...    
    {
      "category":"Application Server",
      "identifyingFields":[
        "nameOrAddress"
      ],
      "inputFields":[
        {
          "displayName":"Scope/Address",
          "name":"nameOrAddress",
          "isMandatory":true,
          "isSecret":false,
          "valueType":"GROUP_SCOPE",
          "description":"The group of VMs or the address of the JVM server"
        },
        {
          "displayName":"Port Number",
          "name":"targetPort",
          "defaultValue":"1099",
          "isMandatory":true,
          "isSecret":false,
          "valueType":"NUMERIC",
          "description":"The JMX port that connects with the JVM server"
        },
        {
          "displayName":"Username",
          "name":"username",
          "isMandatory":true,
          "isSecret":false,
          "valueType":"STRING",
          "description":"The JVM server JMX password, enter a space if the server has no security"
        },
        {
          "displayName":"Password",
          "name":"password",
          "isMandatory":true,
          "isSecret":true,
          "valueType":"STRING",
          "description":"The JVM server JMX port, enter a space if the server has no security"
        }
      ],
      "type":"JVM"
    },
    ...
  }
]