Servers Resource

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 1 (for on-premise deployments)

 
 {
   "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 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 Gatekeeping Service",
       "type" : "BGS",
       "status" : "STOPPED",
       "version" : "1.41.0.586"
     }]
   }]
 }

Sample response body 2 (for cloud deployments)

 
 {
   "servers" : [{
     "guid" : "acedff68-254e-4d45-b22c-506c100529cb",
     "hostname" : "server02",
     "type" : "BCN",
     "version" : "2.15.0",
     "services" : [{
       "name" : "BlackBerry UEM - BlackBerry Cloud Connector",
       "type" : "BCC",
       "status" : "RUNNING",
       "version" : "37.34.0",
       "connections" : [{
         "type" : "BCP",
         "status" : "CONNECTED"
       },{
         "type" : "BCP",
         "status" : "CONNECTED"
       },{
         "type" : "BCP",
         "status" : "CONNECTED"
       },{
         "type" : "BCP",
         "status" : "CONNECTED"
       },{
         "type": "LDAP",
         "status": "CONNECTED",
         "certificateExpiryDate": "2031-11-10T00:00:00.000Z",
         "certificateSerialNumber": "10944719598952040374951832963794454346",
         "certificateSubject": "CN=ABC Enterprise Root CA,DC=abc,DC=abc,DC=abcnet,DC=abc,DC=net",
         "name": "LDAP_withCertificate"
       },{
         "type": "LDAP",
         "status": "CONNECTED",
         "name": "LDAP_withoutCertificate"
       }]
     },{
       "name" : "BlackBerry UEM - BlackBerry Secure Gateway",
       "type" : "BSG",
       "status" : "RUNNING",
       "version" : "33.34.0"
     },{
       "name" : "BlackBerry UEM - BlackBerry Proxy Service",
       "type" : "PROXY",
       "status" : "RUNNING",
       "version" : "35.36.0.0",
       "connections" : [{
         "type" : "DYNAMICS_APP_CONNECTIVITY",
         "status" : "CONNECTED",
         "activeConnections" : 0,
         "maxConnections" : 15000
       },{
         "type" : "DYNAMICS_NOC_CONNECTIVITY",
         "status" : "CONNECTED",
         "lastConnected" : "2024-04-30T19:29:22.103Z"
       }],
       "proxyClusterGuid" : "39D3A3D8-7110-4B42-C289-F8E35E53A921",
       "proxyClusterName" : "First",
       "directConnection": {
         "proxyServerName": "proxyServerNameValue",
         "directConnect": false,
         "webProxy": false
       }
     },{
       "name" : "BlackBerry UEM - BlackBerry Secure Connect Plus",
       "type" : "BSCP",
       "status" : "RUNNING",
       "version" : "34.36.0",
       "connections" : [{
         "type" : "TURN",
         "status" : "CONNECTED"
       }]
     },{
       "name" : "BlackBerry UEM - BlackBerry Gatekeeping Service",
       "type" : "BGS",
       "status" : "RUNNING",
       "version" : "34.35.0",
       "connections" : [{
         "type": "EAS",
         "status": "CONNECTED",
         "certificateExpiryDate": "2031-11-10T00:00:00.000Z",
         "certificateSerialNumber": "1E3DD496DJ2B6DA89JK0B22EA97FB594",
         "certificateSubject": "CN=908b8jc7-8963-4be1-482c-f6f94ede56e0",
         "name": "EAS_withModernAuthentication"
       },{
         "type": "EAS",
         "status": "CONNECTED",
         "name": "EAS_withoutModernAuthentication"
       }]
     }]
   }]
 }

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}

Available Since:
12.14.0

Get the server (ex. BlackBerry Unified Endpoint Manager, BlackBerry Connectivity Node) in the UEM topology.

Sample response body

 
 {
    "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 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 Gatekeeping Service",
          "type":"BGS",
          "status":"STOPPED",
          "version":"1.41.0.586"
       }
    ]
 }

Request Parameters
Name Location Description
serverGuid path
Response Codes
Code Condition Data type
200 OK.
404 Server not found.
Response Body
Media type Data type Description
application/vnd.blackberry.server-v1+json Server (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)