Parameterized Endpoint Search

Object Fields Reference

To retrieve one or more endpoints' resource URLs, if there is a precise known parameter of the endpoint or endpoints, the API client can search the endpoint collection by that parameter.

Multiple parameters can be included in the query string to locate endpoints matching all submitted parameter values.

Request syntax:

GET <endpointlist-url>?<param1>=<value1>&<param2>=<value2>

where each <param> is one of:

• vcenter: The name of the virtual endpoint's managing vCenter.
• uuid: The virtual endpoint's Instance UUID from the vSphere environment.
• name: A descriptive label for the endpoint. For vSphere VMs - taken from the vCenter; For other endpionts - defined when adding the endpoint to JetPatch.
• hostname: The endpoint's DNS name.
• ip: The endpoint's IP address.
• tags: Endpoint tags.

Values for the above parameters appear in the endpoint list.

The response includes a JSON list of endpoint objects. For example:

[

  {

    "url":"/vmanage-server/rest/rest-api/servers/79",

    "status":"OK",

    "connectorUrl":"/vmanage-server/rest/rest-api/servers/79/connector",

    "vagentsUrl":"/vmanage-server/rest/rest-api/servers/79/vagents",

    <more object fields>

  },

  {

    "url":"/vmanage-server/rest/rest-api/servers/81",

    "status":"OK",

    "connectorUrl":"/vmanage-server/rest/rest-api/servers/81/connector",

    "vagentsUrl": "/vmanage-server/rest/rest-api/servers/81/vagents"

    <more object fields>

  }

]