Get Pod Endpoint
All the listed privileges are required -
Privileges | Description |
---|---|
FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |
Request
URI
GET
https://{api_host}/rest/federation/v1/pods/{id}/endpoints/{endpointId}
COPY
Path Parameters
string
id
Required
Pod ID
string
endpointId
Required
Pod endpoint ID
Responses
200
OK
Returns PodEndpointInfo of type(s) */*
{
"enabled": true,
"id": "48dreb70-97g6-405e-abb5-497136g2ee35",
"name": "Horizon Connection Server",
"server_address": "https://horizon-CS.xyz.local:8472"
}
boolean
enabled
Optional
Indicates whether an endpoint is enabled. A disabled endpoint is excluded from participating in inter-pod communication.
string
id
Optional
Unique ID representing this pod endpoint.
string
name
Optional
Name of the pod endpoint.
string
server_address
Optional
The URL for the pod endpoint. This address and port is used for inter-pod communication.
400
Bad Request
Operation doesn't return any data structure
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
Federation Operations
POST
Create Home Sites
POST
Create Site
DELETE
Delete Home Sites
DELETE
Delete Site
POST
Eject Pod
GET
Get Home Site
GET
Get Pod
GET
Get Pod Assignment
GET
Get Pod Endpoint
GET
Get Pod Federation
GET
Get Site
GET
Get Task
POST
Initialize CPA
POST
Join CPA
GET
List Home Sites
GET
List Pod Assignments
GET
List Pod Endpoint
GET
List Pods
GET
List Sites
GET
List Tasks
POST
Resolve Home Sites
POST
Rotate Key Pair
POST
Uninitialize CPA
POST
Unjoin CPA
PUT
Update Pod
PUT
Update Pod Federation
PUT
Update Site