List Home Sites

List Home Sites

This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com All the listed privileges are required -

Privileges Description
FEDERATED_LDAP_VIEW Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE.
Request
URI
GET
https://{api_host}/rest/federation/v1/home-sites
COPY
Query Parameters
integer
page
Optional

page, if passed should be > 0.

page example
1
integer
size
Optional

size, if passed should be > 0.

size example
10
string
filter
Optional

filter expression built using fields with 'supported filters' as described in output model schema of this API.

filter example
[object Object]
Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "ad_user_or_group_id": "S-1-5-32-551",
        "global_application_entitlement_id": "e285ebe1-194b-4563-80e0-0ad21134c503",
        "global_desktop_entitlement_id": "7493bfc7-834a-4d9b-ac7d-b5f60893a3a6",
        "id": "28deeb70-97d5-409e-abb4-497196f1ee18",
        "site_id": "32a5ea06-cd09-4609-b3e5-df8379e99c13"
    }
]

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/rest/federation/v1/home-sites
On This Page
Federation Operations
GET
Get Pod Federation
PUT
Update Pod Federation
POST
Eject Pod
POST
Initialize CPA
POST
Join CPA
POST
Rotate Key Pair
POST
Uninitialize CPA
POST
Unjoin CPA
GET
List Tasks
GET
Get Task
DELETE
Delete Home Sites
GET
List Home Sites
POST
Create Home Sites
POST
Resolve Home Sites
GET
Get Home Site
GET
List Pod Assignments
GET
Get Pod Assignment
GET
List Pods
GET
Get Pod
PUT
Update Pod
GET
List Pod Endpoint
GET
Get Pod Endpoint
GET
List Sites
POST
Create Site
DELETE
Delete Site
GET
Get Site
PUT
Update Site