Home
Version 3
Events API

Events API

List events associated with an App since January 1, 2014

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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5IiwiZW1haWwiOiJlbWFpbC0xNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk1fQ._PLoeYeSPJVArJq7ier_zz1x64Bsqe2dHAXGf49HKjk
Host: example.org
Cookie:

Route

GET /v2/events?q=actee:551795a1-19a2-4853-b600-a652109377cd&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00

Query Parameters

q: timestamp>2014-01-01 00:00:00-04:00

cURL

curl "https://api.[your-domain.com]/v2/events?q=actee:551795a1-19a2-4853-b600-a652109377cd&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5IiwiZW1haWwiOiJlbWFpbC0xNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk1fQ._PLoeYeSPJVArJq7ier_zz1x64Bsqe2dHAXGf49HKjk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6d69813c-e0d1-4636-87b4-614ed3ad1580
Content-Length: 2794
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "f58bed2e-e9b6-4664-a252-397c9aa7f398",
        "url": "/v2/events/f58bed2e-e9b6-4664-a252-397c9aa7f398",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.create",
        "actor": "uaa-id-18",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "551795a1-19a2-4853-b600-a652109377cd",
        "actee_type": "app",
        "actee_name": "name-167",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "959959c2-df33-48f1-b037-11ad21f2ca9c",
        "organization_guid": "d338b3f1-f416-422e-981d-9d5a80af052d"
      }
    },
    {
      "metadata": {
        "guid": "5eb8bab3-d1eb-47fd-a1eb-6a291b188514",
        "url": "/v2/events/5eb8bab3-d1eb-47fd-a1eb-6a291b188514",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.update",
        "actor": "uaa-id-18",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "551795a1-19a2-4853-b600-a652109377cd",
        "actee_type": "app",
        "actee_name": "name-167",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "959959c2-df33-48f1-b037-11ad21f2ca9c",
        "organization_guid": "d338b3f1-f416-422e-981d-9d5a80af052d"
      }
    },
    {
      "metadata": {
        "guid": "ef824ae8-909d-46bc-b02b-24d49586449f",
        "url": "/v2/events/ef824ae8-909d-46bc-b02b-24d49586449f",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.delete-request",
        "actor": "uaa-id-18",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "551795a1-19a2-4853-b600-a652109377cd",
        "actee_type": "app",
        "actee_name": "name-167",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {
          "request": {
            "recursive": false
          }
        },
        "space_guid": "959959c2-df33-48f1-b037-11ad21f2ca9c",
        "organization_guid": "d338b3f1-f416-422e-981d-9d5a80af052d"
      }
    }
  ]
}