Get Pod

Get Pod

Note that this API depends on internal cache. There may be a delay in new fields being reflected in the response. At least one of the listed privileges is required -

Privileges Description
FEDERATED_LDAP_VIEW Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group.
FEDERATED_SESSIONS_VIEW Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group.
Request
URI
GET
https://{api_host}/rest/federation/v1/pods/{id}
COPY
Path Parameters
string
id
Required

ID of the Pod.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PodInfo of type(s) */*
{
    "active_global_application_entitlements": [
        "01c42e80-d31e-4633-93c6-44ff8a5b1afe",
        "86ba95e0-9d59-4b1f-934e-2deba13fcecb"
    ],
    "active_global_desktop_entitlements": [
        "648d8fc5-94e5-438f-8524-8edb533c7de2",
        "50075a5b-6a68-4be5-b079-cff355945856"
    ],
    "cloud_managed": true,
    "description": "Pod Description.",
    "endpoints": [
        "716269b7-e43d-4874-877a-c5af36a11322",
        "d56671b5-42a6-490e-ab40-8373f839f2d3"
    ],
    "id": "28deeb70-97d5-409e-abb4-497196f1ee18",
    "local_pod": true,
    "name": "Cluster-CS-1",
    "site_id": "9a892821-8c3d-4e61-9d65-69dfec7b70dc"
}
array of string
active_global_application_entitlements
Optional

List of Global Application Entitlements with mappings to application pools within this pod.

array of string
active_global_desktop_entitlements
Optional

List of Global Desktop Entitlements with mappings to desktop pools within this pod.

boolean
cloud_managed
Optional

Indicates whether this pod is managed from cloud.

string
description
Optional

Description of this pod.

array of string
endpoints
Optional

List of endpoints within this pod.

string
id
Optional

Unique ID representing this pod.

boolean
local_pod
Optional

Indicates whether this is the local pod the request was made from.
Only one pod in the pod federation will return true.

string
name
Optional

Name of this pod.

string
site_id
Optional

ID of the site this pod belongs to.


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

404

Not Found

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure