The Private locations API includes a set of endpoints that provide information about the health and operational status of your configured private locations. These endpoints allow you to monitor the availability, performance, and connectivity of each checkpoint.
Private location and private checkpoint health
Private location health and private checkpoint health are two related concepts that may be used interchangeably when working with the API. The /PrivateCheckpointHealth endpoint returns health-related information for a single, specific checkpoint within your private location. In contrast, the /PrivateLocationHealth endpoint provides an overview of the health status for all individual private checkpoints associated with a given private location. This allows you to monitor each checkpoint separately or get a collective view of their overall status.
Server information
The API provides detailed information about your server status, including the following:
- Healthy servers — the number of fully functional servers without any errors or warnings.
- Unhealthy servers — the number of servers experiencing errors, warnings, or those not properly set up.
- Number of servers — the total number of servers running in a private location or at a specific checkpoint.
- Checkpoint name — the name of the checkpoint associated with the private location.
- Status — the current status of your server:
Available,NotAvailable, orMaintenance. - Status details — the date and time when your server was last active.
- Warnings — displays the warning information, such as if the server requires an update, installation, or other attention.
Authorization
The API allows you to manipulate private locations permissions. Using this endpoint lets you check whether your authorization type has permission to use or edit private locations. To know more about authorizations, refer to Setting up Private locations permissions .
For more information, refer to the Uptrends Private locations API .