PingFederate Server

Active and passive administrative console endpoints

The active and passive administrative console endpoints allow an admin to monitor the status of active and passive admin consoles, and promote a passive admin console to the active role.

Learn more about constructing requests for the following endpoints in the Swagger documentation bundled with PingFederate.

Endpoint: cluster/status

Returns information about the status of each node in the cluster, including admin nodes and engines.

HTTP Status: 200

{
  "nodes": [
    {
      "address": "127.0.0.1:7600",
      "mode": "CLUSTERED_CONSOLE",
      "index": 1,
      "nodeGroup": "node_group_A",
      "version": "12.1",
      "configurationTimestamp": "2024-06-17T17:11:05.442Z",
      "replicationStatus": "SUCCEEDED",
      "adminConsoleInfo": {
        "consoleRole": "ACTIVE",
        "consoleRoleLastUpdateDate": "2024-06-17T17:05:34.461Z",
        "configSyncStatus": "SUCCEEDED",
        "configSyncTimestamp": "2024-06-17T17:11:12.137Z"
    }
  },
    {
    "address": "127.0.0.1:7603",
    "mode": "CLUSTERED_CONSOLE",
    "index": 2,
    "nodeGroup": "node_group_B",
    "version": "12.1",
    "configurationTimestamp": "2024-06-17T17:11:05.442Z",
    "replicationStatus": "SUCCEEDED",
    "adminConsoleInfo": {
      "consoleRole": "PASSIVE",
      "consoleRoleLastUpdateDate": "2024-06-17T16:57:11.811Z",
      "configSyncStatus": "SUCCEEDED",
      "configSyncTimestamp": "2024-06-17T17:11:12.250Z"
    }
  },
  {
    "address": "127.0.0.1:7602",
    "mode": "CLUSTERED_ENGINE",
    "index": 100,
    "nodeGroup": "",
    "version": "12.1",
    "nodeTags": "",
    "configurationTimestamp": "2024-06-17T17:11:05.442Z",
    "replicationStatus": "SUCCEEDED"
  }
],
  "lastConfigUpdateTime": "2024-06-17T17:11:13.000Z",
  "lastReplicationTime": "2024-06-17T17:11:05.442Z",
  "currentNodeIndex": 2,
  "replicationRequired": true,
  "mixedMode": false
}

Endpoint: cluster/adminNode/status

Get this administrative console’s role and synchronization status.

HTTP Status: 200

{
  "consoleRole": "PASSIVE",
  "consoleRoleLastUpdateDate": "2024-06-17T16:57:11.811Z",
  "configSyncStatus": "SUCCEEDED",
  "configSyncTimestamp": "2024-06-17T17:07:42.243Z"
}

Endpoint: cluster/adminNode/role/active

Update this administrative console node’s role to active. Can respond with warnings related to the update process.

HTTP Status: 200

{
  "warnings": [
    "Currently no active admin console node in cluster to attempt synchronization with."
  ]
}