Home
Version 3
Events API

Events API

List App Exited Events

GET /v2/events

Fields

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.space.create
  • audit.space.update
  • audit.space.delete-request
  • app.crash
  • audit.app.update
actor The GUID of the actor.
actor_type The actor type.
  • user
  • app
actor_name The name of the actor.
actee The GUID of the actee.
actee_type The actee type.
  • space
  • app
actee_name The name of the actee.
timestamp The event creation time.
metadata The additional information about event. {}
space_guid The guid of the associated space.
organization_guid The guid of the associated organization.

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: timestamp, type, actee
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2IiwiZW1haWwiOiJlbWFpbC0xOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk2fQ.aI0dPVEU-xsfLAXFD5GAWI9y34DYfzJNbYIHcIjphoo
Host: example.org
Cookie:

Route

GET /v2/events?q=type:app.crash

Query Parameters

q: type:app.crash

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:app.crash" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2IiwiZW1haWwiOiJlbWFpbC0xOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk2fQ.aI0dPVEU-xsfLAXFD5GAWI9y34DYfzJNbYIHcIjphoo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9cb117cc-2c22-4bee-b325-7f01ee072c48
Content-Length: 1009
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "dd61aac1-3e97-453a-b750-ab61f45244b9",
        "url": "/v2/events/dd61aac1-3e97-453a-b750-ab61f45244b9",
        "created_at": "2014-11-13T23:38:16+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "app.crash",
        "actor": "d72a3276-428a-40d9-9a7c-7b96c0328dbf",
        "actor_type": "app",
        "actor_name": "name-281",
        "actee": "d72a3276-428a-40d9-9a7c-7b96c0328dbf",
        "actee_type": "app",
        "actee_name": "name-281",
        "timestamp": "2014-11-13T23:38:16+00:00",
        "metadata": {
          "instance": 0,
          "index": 1,
          "exit_status": "1",
          "exit_description": "out of memory",
          "reason": "crashed"
        },
        "space_guid": "161e47d8-0561-4c87-b3a0-140e5d89a712",
        "organization_guid": "6341f220-7670-4f2f-ab05-d2b7217e8a6c"
      }
    }
  ]
}