Get details of an endpoint.
get
/connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/endpoints/{endpointId}
This operation retrieves the details of an endpoint.
Request
Path Parameters
-
endpointId: string
Endpoint identifier
-
orgId: string
Organization identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Endpoint was successfully retrieved.
Root Schema : Discriminator: type
Type:
Show Source
object
-
description(optional):
string
More detailed information about the endpointExample:
Manufacturer: cisco; type: AP-123
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
links(optional):
array links
-
name:
string
Minimum Length:
0
Maximum Length:255
Human readable name of the endpointExample:Endpoint located at first floor
-
organizationId:
string
id of the organizationExample:
ORA_DEFAULT_ORG
-
type(optional):
string
Allowed Values:
[ "ACCESS_POINT" ]
Type of the endpointExample:ACCESS_POINT
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type