Chapter 5. Cloud Events API

5.1. List Events

5.1.1. Description

List events from the event log for an app.

5.1.2. Endpoint

  • uri - /box/srv/1.1/app/eventlog/listEvents
  • method - POST

5.1.3. Request Body

{
  "appGuid":"<24 char String>",
  "env":"<environment>"
}

5.1.4. Response Body

5.1.4.1. Success

{
  "list":[{
    "fields":
      {
        "appGuid": "WaD9Fgzx7yMZRfAvQSwO85el",
        "category": "APP_STATE",
        "dismissed": false,
        "env": "dev",
        "eventDetails": {message:Completed app deployment},
        "message": "Completed app deployment",
        "eventType": "DEPLOYED",
        "guid": "43f-WyNeI4Wlif07-cgpBZVy",
        "message": "Completed app deployment",
        "severity": "INFO",
        "sysCreated": "2013-07-04 14:47:49:034",
        "timestamp": "2013-07-04 14:47:48:977",
        "title": "DEPLOYED",
        "uid": "WaD9Fgzx7yMZRfAvQSwO85el",
        "updatedBy": "System"
      },
      "guid":"rVfKTjq-YoosmcGUJf96f0xx",
      "type":"eventlog_EventLog"
    },
    ...
  ],
  "status":"ok"
}

5.1.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}