View Banners
This documentation will describe the View Banners (XMADOWST) endpoint. This endpoint allows users to view banners currently present on a client’s system.
Use cases
- Configuring an external alerting product to send a notification if a service is down.
- Managing a status monitor that shows if anything is down.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
| *setMethod | string | Yes | Determines the endpoint you are calling. Must be XMADOWST to view banners. |
Example request
curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod="XMADOWST"'
Example response
{
"XMADOWST": [
{
"DOWN_MESSAGE": "MATRIX TASK GC HAS FAILED. CONTACT YOUR SUPERVISOR.",
"DOWN_COLOR": "6C",
"COLOR": "6C",
"DOWN_TIME": ".22885"
},
{
"DOWN_MESSAGE": "Doc Driver HAS FAILED. CONTACT YOUR SUPERVISOR.",
"DOWN_COLOR": "6C",
"COLOR": "6C",
"DOWN_TIME": ".00411"
}
]
}
Response fields
| Field | Description |
|---|---|
| DOWN_MESSAGE | The message text assigned to the banner. This text is viewable to Matrix users when in Monitoring. |
| DOWN_COLOR/COLOR | The color of the banner and its assigned text. The first character is the background color, the second is the foreground (text) color. |
| DOWN_TIME | The number of days the service has been down. |
See the Supplemental Information documentation for information on how to interpret the DOWN_COLOR/COLOR fields.