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>

Example: 

endpointlist-url: https://<CORE_SERVER>/vmanage-server/rest/rest-api/servers

where each <param> is one of:

Partly matching, case insensitive

• name: A descriptive label for the endpoint. 
• hostname: The endpoint's DNS name.
• ip: The endpoint's IP address.

Comma-separated exact match, case sensitive

• • tags: Endpoint tags.

Exact match, case sensitive

• vcenter: The name of the virtual endpoint's managing vCenter.
• uuid: The virtual endpoint's Instance UUID from the vSphere environment.

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>

  }

]

More information about tag searching

• tags= or no tags at all - EPs is not filtering by tag(-s)
• tags=null - only EPs without tag(-s)
• tags=aaa - only EPs assigned with tag “aaa”
• tags=QCM%20Production%20Servers%20group - only EPs assigned with tag “QCM Production Servers group”

There is a possibility to query by tag(-s) with spaces. In that case space must be replaced with %20, it is encoded space. Chrome browser replaces all spaces in URL with %20 by default. In python it must be done in code, it is called “URL encoding”.