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
  • audit.service_broker.create
  • audit.service_broker.update
  • audit.service_broker.delete
  • audit.service.create
  • audit.service.update
  • audit.service.delete
  • audit.service_plan.create
  • audit.service_plan.update
  • audit.service_plan.delete
  • audit.service_plan_visibility.create
  • audit.service_plan_visibility.update
  • audit.service_plan_visibility.delete
  • audit.service_dashboard_client.create
  • audit.service_dashboard_client.delete
  • audit.service_instance.create
  • audit.service_instance.update
  • audit.service_instance.delete
  • audit.user_provided_service_instance.create
  • audit.user_provided_service_instance.update
  • audit.user_provided_service_instance.delete
  • audit.service_binding.create
  • audit.service_binding.delete
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTY5IiwiZW1haWwiOiJlbWFpbC00NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyOTkwODY3fQ.b5nlyhBexCpbba_bqHEs86nW-dgLGF0Vkj1Ngl87BIY
Host: example.org
Cookie: 

Route

GET /v2/events?q=actee:ba3a65da-edab-4cb7-996d-68646e49da9a&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:ba3a65da-edab-4cb7-996d-68646e49da9a&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY5IiwiZW1haWwiOiJlbWFpbC00NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyOTkwODY3fQ.b5nlyhBexCpbba_bqHEs86nW-dgLGF0Vkj1Ngl87BIY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fdc10976-b35f-48ea-b376-212a4436c287
Content-Length: 2764
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "44181fa5-6efe-45fe-a6d3-63d2277f2582",
        "url": "/v2/events/44181fa5-6efe-45fe-a6d3-63d2277f2582",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.create",
        "actor": "uaa-id-68",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "ba3a65da-edab-4cb7-996d-68646e49da9a",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "54afbde8-60aa-4d71-b917-b1dd8f8f694a",
        "organization_guid": "5de84798-4212-466b-8384-787bee0fd7d0"
      }
    },
    {
      "metadata": {
        "guid": "b16fc387-ded9-4e6c-a8ac-176d1cba63a1",
        "url": "/v2/events/b16fc387-ded9-4e6c-a8ac-176d1cba63a1",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.update",
        "actor": "uaa-id-68",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "ba3a65da-edab-4cb7-996d-68646e49da9a",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "54afbde8-60aa-4d71-b917-b1dd8f8f694a",
        "organization_guid": "5de84798-4212-466b-8384-787bee0fd7d0"
      }
    },
    {
      "metadata": {
        "guid": "073ebb61-3ca9-45c3-8022-6df5c057bab9",
        "url": "/v2/events/073ebb61-3ca9-45c3-8022-6df5c057bab9",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.delete-request",
        "actor": "uaa-id-68",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "ba3a65da-edab-4cb7-996d-68646e49da9a",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {
          "request": {
            "recursive": false
          }
        },
        "space_guid": "54afbde8-60aa-4d71-b917-b1dd8f8f694a",
        "organization_guid": "5de84798-4212-466b-8384-787bee0fd7d0"
      }
    }
  ]
}