Monitor Connector Status

A connector is a multi-purpose service, similar to a proxy, that ensures that your computers and services can communicate with the CyberArk Identity. Monitoring the status of your connectors and logging instances of downtime may be important to the overall health of your environment. In addition to accessing the health of your connectors, you can also view what services are running on them.

You can use the /Core/CheckProxyHealth API to manually check the status of one or all of your connectors through a service like Postman, or you can automate monitoring and logging processes in a number of ways, such as using Windows Task Manager with a custom script.

This topic introduces some of the ways in which you can use the API to monitor the status of your CyberArk Identity connectors.

Making the call

To manually access the status of your connectors, you must be logged on to your tenant and have administrative permissions. To check the status of all of your connectors, you simply call /Core/CheckProxyHealth. To check the status of a single connector, you must specify the connector's UUID in the following way:

/Core/CheckProxyHealth?proxyUuid=YourCloudConnectorUUID

A successful call returns the status of your connection to CyberArk Identity (ConnectorInfo), as well as the status of the connection to your domain controller (AdInfo). The status will either be "Healthy" or "Unhealthy" for each of these catagories. The call also returns what services are running on each connector (FeaturesEnabled).

Successful /Core/CheckProxyHealth response:

{
  "success": true,
  "Result": {
    "Connectors": [
      {
        "ConnectorInfo": {
          "Id": "0d8r4yad-66ab-444b-b1d88-5208fuY613a8",
          "Version": "17.5.121.0",
          "MachineName": "member1",
          "FeaturesEnabled": [
            "adwatcher",
            "mobile.gpupdate",
            "mobile.stateSync"
          ],
          "Name": "member1",
          "Status": "Healthy"
        },
        "AdInfo": {
          "Status": "Healthy",
          "ForestUuid": "1455f2437tuielieo5784fsdei40481e121fb",
          "Forest": "cpubs.net"
        }
      }
    ],
    "Version": "1.0"
  },
  "Message": null,
  "MessageID": null,
  "Exception": null,
  "ErrorID": null,
  "ErrorCode": null,
  "InnerExceptions": null
}

Automate the monitoring and logging of connector health

If you want to automate the process of periodically logging the status of your connectors, you can use the /Core/CheckProxyHealth API to format and direct this data to a number of platforms. For example, you can send the data to a database, a CSV file, or a SIEM service.

Updated 2 months ago

Monitor Connector Status


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.