Provides server related functionality.
GET /{tenantGuid}/api/v1/servers
- Available Since:
- 12.8.0
Get the servers (ex. BlackBerry Unified Endpoint Manager, BlackBerry Connectivity Node) in the UEM topology.
Sample response body
{
"servers" : [{
"guid" : "c9086f84-5f11-48e8-a8e4-b01e17a901d4",
"hostname" : "server01",
"type" : "UEM",
"version" : "12.8.0",
"services" : [{
"name" : "BlackBerry UEM - UEM Core",
"type" : "CORE",
"status" : "RUNNING",
"version" : "5.38.37",
"connections" : [{
"type" : "DB",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
}]
},{
"name" : "BlackBerry UEM - Management console",
"type" : "UI",
"status" : "RUNNING",
"version" : "2.45.36",
"connections" : [{
"type" : "DB",
"status" : "CONNECTED"
}]
},{
"name": "BlackBerry UEM - BlackBerry Affinity Manager",
"type": "AFFINITY",
"status": "RUNNING",
"version": "1.27.36",
"connections" : [{
"type" : "DB",
"status" : "CONNECTED"
},{
"type" : "RCP",
"status" : "CONNECTED"
}]
},{
"name" : "BlackBerry UEM - BlackBerry Secure Gateway",
"type" : "BSG",
"status" : "RUNNING",
"version" : "1.41.0.586",
"connections" : [{
"type" : "DB",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
}]
},{
"name" : "BlackBerry UEM - BlackBerry Proxy Service",
"type" : "PROXY",
"status" : "RUNNING",
"version" : "1.2.33",
"connections" : [{
"type" : "DYNAMICS_APP_CONNECTIVITY",
"status" : "CONNECTED",
"activeConnections" : 0,
"maxConnections" : 15000
},{
"type" : "DYNAMICS_NOC_CONNECTIVITY",
"status" : "CONNECTED",
"lastConnected" : "2018-04-30T19:29:22.103Z"
}],
"proxyClusterGuid" : "47D3A3D8-7110-4B42-B289-F8E35E53A921",
"proxyClusterName" : "First",
"directConnection": {
"proxyServerName": "proxyServerNameValue",
"directConnect": true,
"proxyHostName": "proxyHostNameValue",
"webProxy": true,
"webProxyHostName": "webProxyHostNameValue",
"webProxyPort": 9888
}
},{
"name" : "BlackBerry UEM - BlackBerry Secure Connect Plus",
"type" : "BSCP",
"status" : "RUNNING",
"version" : "1.30.30",
"connections" : [{
"type" : "BCP",
"status" : "CONNECTED"
},{
"type" : "BCP",
"status" : "CONNECTED"
}]
},{
"name" : "BlackBerry UEM - BlackBerry Control Service",
"type" : "CONTROL",
"status" : "RUNNING",
"version" : "57.2.48",
"connections" : [{
"type" : "DYNAMICS_NOC_CONNECTIVITY",
"status" : "CONNECTED"
},{
"type" : "DB",
"status" : "CONNECTED"
}]
},{
"name" : "BlackBerry UEM - BlackBerry Gatekeeping Service",
"type" : "BGS",
"status" : "STOPPED",
"version" : "1.41.0.586"
}]
}]
}
Response Codes
Code |
Condition |
Data type |
200 |
OK. |
|
Response Body
Media type |
Data type |
Description |
application/vnd.blackberry.servers-v1+json |
Servers
(JSON) |
|
GET /{tenantGuid}/api/v1/servers/{serverGuid}/services/{type}
- Available Since:
- 12.12.0
Get the service by server guid and service type.
Sample response body
{
"name": "BlackBerry UEM - BlackBerry Proxy Service",
"type": "PROXY",
"status": "RUNNING",
"version": "5.29.0",
"proxyClusterGuid" : "47D3A3D8-7110-4B42-B289-F8E35E53A921",
"proxyClusterName": "First",
"directConnection": {
"proxyServerName": "proxyServerNameValue",
"directConnect": true,
"proxyHostName": "proxyHostNameValue",
"webProxy": true,
"webProxyHostName": "webProxyHostNameValue",
"webProxyPort": 9888
}
}
Request Parameters
Name |
Location |
Description |
serverGuid |
path |
server guid |
type |
path |
service type |
Response Codes
Code |
Condition |
Data type |
200 |
OK. |
|
400 |
Invalid request. For example, invalid field semantics or missing required field. |
|
404 |
Server not found. |
|
404 |
Service not found. |
|
Response Body
Media type |
Data type |
Description |
application/vnd.blackberry.service-v1+json |
Server service
(JSON) |
|
PUT /{tenantGuid}/api/v1/servers/{serverGuid}/services/{type}
- Available Since:
- 12.12.0
Updates an existing service. Only direct connection settings can be updated using the route. All other fields are ignored.
Validation rules for direct connection settings:
- The proxy host name can be set only when direct connect is enabled
- Web proxy related settings can be set only when direct connect is enabled
- Web proxy related settings can be set only when web proxy and direct connect is enabled
- The web proxy port value should be from 0 to 65535 inclusive; any other value is not valid
Sample request
{
"name": "BlackBerry UEM - BlackBerry Proxy Service",
"type": "PROXY",
"status": "RUNNING",
"version": "5.29.0",
"proxyClusterGuid" : "47D3A3D8-7110-4B42-B289-F8E35E53A921",
"proxyClusterName": "First",
"directConnection": {
"proxyServerName": "proxyServerNameValue",
"directConnect": true,
"proxyHostName": "proxyHostNameValue",
"webProxy": true,
"webProxyHostName": "webProxyHostNameValue",
"webProxyPort": 9888
}
}
Request Parameters
Name |
Location |
Description |
serverGuid |
path |
server guid |
type |
path |
service type |
Request Body
Media type |
Data type |
application/vnd.blackberry.service-v1+json |
Server service
(JSON) |
Response Codes
Code |
Condition |
Data type |
200 |
OK. |
|
400 |
Invalid request. For example, invalid field semantics or missing required field. |
|
404 |
Server not found. |
|
404 |
Service not found. |
|
405 |
Service not supported. |
|
Response Body
Media type |
Data type |
Description |
application/json |
Server service
(JSON) |
|