cdns_health.rst

cdns/health

Extract health information from all :term:`Cache Groups` across all CDNs

.. seealso:: :ref:`health-proto`

GET

Auth. Required:	Yes
Roles Required:	None
Response Type:	Object

Request Structure

No parameters available

Response Structure

cachegroups:	An array of objects describing the health of each Cache Group name: The name of the Cache Group offline: The number of OFFLINE caches in the Cache Group online: The number of ONLINE caches in the Cache Group
totalOffline:	Total number of OFFLINE caches across all Cache Groups which are assigned to any CDN
totalOnline:	Total number of ONLINE caches across all Cache Groups which are assigned to any CDN

{ "response": {
        "totalOffline": 0,
        "totalOnline": 1,
        "cachegroups": [
                {
                                "offline": 0,
                                "name": "CDN_in_a_Box_Edge",
                                "online": 1
                        }
        ]
}}