Monitor Partner App Health

You can monitor the health of your cloud or on-prem partner app in various ways as described in the following sections.

Cloud Partner App Health

The following URLs return parameters indicating the health of your cloud partner app:

App Health Check URL: If all components of the partner app on the > Monitor window are indicated as healthy, then the app health check URL returns a 200 OK response.
App Health Check URL
API Health Status URL: The API health status URL returns a 200 OK response when the customer data is successfully received through the Cisco Spaces - Partner Firehose API.
API Health Status URL
App Status Page URL: As a partner, you need to host an app status page which provides the health status of the platform app and platform. This App Status Page URL needs to be entered in the App Status Page URL field under the Behaviors tab.

A sample status page is shown below:
Sample App Status Page

On-Prem Partner App Health

To check the health of your on-prem partner app, you can access the API at https://partners.dnaspaces.io/api/partners/v1/monitoring/status.

Use the PUT method and specify the following request headers:

Content-Type: application/json
x-api-key: api-key

Note
For information on how to create the API key, go to On-Prem App - API Integration.

The format of the request body in JSON format is given below:


{
    "data":
    {
        "overallStatus":
        {
            "status": "up/down",
            "notices":
            [
                {
                    "message": "",
                    "category": "critical/warning/info"
                }
            ]
        },
        "instanceDetails":
        {
            "ipAddress": "",
            "instanceId": ""
        },
        "cloudFirehose":
        {
            "status": "connected/disconnected",
            "lastReceived": 1576722187000
        },
        "localFirehose":
        {
            "status": "connected/disconnected",
            "lastReceived": 1576722187000
        },
        "subsystems":
        [
            {
                "name": "Engine",
                "status": "up/down"
            },
            {
                "name": "Database",
                "status": "up/down"
            }
        ]
    }
}

A list of status codes and status messages is given below:

Note	The app status is updated only for partner apps that are in Live, Approved, or Under Review states.

If the operation is successful, you will receive the following status code and status message:
- Status code 200: Success
```
{
    "status": true,
    "message": "No error, operation successful"
}
```
If the operation is unsuccessful, you will receive one of the following status codes and the corresponding error message:
- Status code 400: Bad Request
```
{
    "status": false,
    "message": "Bad Request"
}
```
- Status code 403: Unauthorized request
```
{
    "status": false,
    "message": "Authentication failure or invalid API Key"
}
```
If there is any error during server operation, the status code 500 is returned to the client .