list-notifications.adoc

List All Notifications

Tip	This document deals with calling the CloudHub API. For instructions on how to perform these same tasks more easily via the Runtime Manager UI, see CloudHub and its child pages.

The GET operation specified with the /api/notifications resource returns a list of all notifications for your account. The resulting JSON contains a list of notification objects.

The following query parameters are supported:

Name	Default	Description
limit	25	The number of notifications to return.
offset	0	The row to start listing notifications messages at.
domain		The application to find notifications for.
status		"read", "unread" or "all"
search		Searches the message of the notification for the specified text.
tenantId		The id of the tenant to find notifications for.

Example Request:

GET https://anypoint.mulesoft.com/cloudhub/api/notifications

Example Response:

200 OK
Content-Type: application/json
Date: Sun, 18 Jan 2015 00:12:55 GMT

{
  "data" :
  [
    {
      "domain": "myapp",
      "username": "joecloud",
      "priority": "INFO",
      "message": "Something happened",
      "createdAt": "2015-01-10T23:42:53.010Z",
      "read": false,
      "href": "https://prod.anypoint.mulesoft.com/cloudhub/api/notifications/518d85fde4b00795a6ec3394"},
      "transactionId": "2a097804-f0d5-11e2-b4d2-9dd46521a02d",
      "properties": {
         "recordId" : "1234"
      }
  ],
  "total": 1
}

Tip	Check out the API Portal of the CloudHub API to see an interactive reference of all the supported resources, methods, required properties and expected responses. In the link above, search among other Mule APIs for the "CloudHub" API and click on its latest version.

See Also

• Runtime Manager

• CloudHub

• Managing Deployed Applications

• Managing Applications on CloudHub

• Monitoring Applications