Overview

This guide explains how to use parameterized endpoint search to retrieve specific endpoints' resource URLs by querying the endpoint collection using known parameters. 

Multiple parameters can be combined to locate endpoints matching all specified criteria.

Object Fields Reference

Request Syntax

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

Example Endpoint URL

Available Parameters

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.

Response Format

The response includes a JSON list of endpoint objects:

Tag Searching Details

• 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."

URL Encoding for Tags with Spaces

When querying by tags containing spaces, the space must be replaced with %20 (encoded space). 

Chrome browser replaces all spaces in URLs with %20 by default. 

In Python, this must be done in code using URL encoding.