Select Parameter

The select parameter is used to return only selected resource properties in a response.

The parameter accepts the array data type. To return selected properties, use the select parameter in the following format:

GET https://<hostname>:1280/api/v3/<endpoint>?select=[{"property":"<property>"}]

where:

  • endpoint is a resource collection endpoint.
  • property is the searched property name.

Select Parameter Note:

To sort a resource collection based on a property of a resource subschema, use the "<subschema>.<property>" format to specify the resource property name where <subschema> is the subschema name.

For example, to return the /organizations/resellers collection with only reseller UID, name and status displayed, send the following request:

GET https://vspc:1280/api/v3/organizations/resellers?select=[{"property":"instanceUid"},{"property":"name"},{"property":"status"}]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.