Status¶

Getting the Server Status¶

An unauthenticated resource that shows the current status of the Pulp server. A 200 response shows that the server is up and running. Users of this API may want to examine pulp_messaging_connection, pulp_database_connection and known_workers to get more detailed status information.

Warning

Clustered Pulp installations have additional monitoring concerns. See Cluster Monitoring for more information.

Note

This API is meant to provide an “at-a-glance” status to aid debugging of a Pulp deployment, and is not meant to replace monitoring of Pulp components in a production environment.

A healthy Pulp installation will contain one or more records for “resource_manager”, one or more records for “scheduler”, and one or more records for “reserved_resource_worker” in the worker list. It will also have messaging_connection and database_connection entries that contain {connected: True}. Note that if the scheduler is not running, other workers may be running but not updating their last heartbeat record.

The version of Pulp is also returned via platform_version in the versions object. This field is calculated from the “pulp-server” python package version. Do not use the deprecated api_version record.

Method: GET
Path: /pulp/api/v2/status/
Permission: none

Response Codes:

200 - pulp server is up and running

Return: jSON document showing current server status

Sample 200 Response Body: :

{
   "api_version": "2",
   "database_connection": {
       "connected": true
   },
   "known_workers": [
       {
           "last_heartbeat": "2015-01-02T20:39:58Z",
           "name": "scheduler@status-info-net0.default.virt"
       },
       {
           "last_heartbeat": "2015-01-02T20:40:34Z",
           "name": "reserved_resource_worker-0@status-info-net0.default.virt"
       },
       {
           "last_heartbeat": "2015-01-02T20:40:36Z",
           "name": "resource_manager@status-info-net0.default.virt"
       }
   ],
   "messaging_connection": {
       "connected": true
   },
   "versions": {
       "platform_version": "2.6.0"
   }
}