Home
Version 3
Events API

Events API

List all 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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzN30.ieo2YqUKuDP5fQG_ooEP-PFIl4qfwJOFgj8xbj4nqos
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzN30.ieo2YqUKuDP5fQG_ooEP-PFIl4qfwJOFgj8xbj4nqos" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8fe5f384-9052-4539-bfc7-deed6e9a3b83
Content-Length: 2415
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "4ccf2d8d-f31d-4aca-a91c-b040b374859a",
        "url": "/v2/events/4ccf2d8d-f31d-4aca-a91c-b040b374859a",
        "created_at": "2015-01-20T01:52:17+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-472",
        "actor": "guid-2350900a-0fe9-44c5-86d4-06370496a07e",
        "actor_type": "name-473",
        "actor_name": "name-474",
        "actee": "guid-c8ffa774-1cef-481a-a0ca-eb5939f0174e",
        "actee_type": "name-475",
        "actee_name": "name-476",
        "timestamp": "2015-01-20T01:52:17+00:00",
        "metadata": {

        },
        "space_guid": "cff9e5bf-04b3-45c4-b883-2c57eeddae67",
        "organization_guid": "af8ee50e-358e-4f90-ab1e-982e39815bf5"
      }
    },
    {
      "metadata": {
        "guid": "b382264c-e6bf-444d-b531-1a6a34a2ccb3",
        "url": "/v2/events/b382264c-e6bf-444d-b531-1a6a34a2ccb3",
        "created_at": "2015-01-20T01:52:17+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-480",
        "actor": "guid-ed1bb325-71b9-4b6e-abde-b8ce905a01cc",
        "actor_type": "name-481",
        "actor_name": "name-482",
        "actee": "guid-d5c61a00-cf20-4cad-aa7c-034e81c2b2ee",
        "actee_type": "name-483",
        "actee_name": "name-484",
        "timestamp": "2015-01-20T01:52:17+00:00",
        "metadata": {

        },
        "space_guid": "57bd970b-5a87-4a46-bd25-6f322f62e894",
        "organization_guid": "5a2fd27e-37ac-4295-87b2-5559ea258542"
      }
    },
    {
      "metadata": {
        "guid": "c4083a18-28ab-4964-9d8d-30b2ebaf3450",
        "url": "/v2/events/c4083a18-28ab-4964-9d8d-30b2ebaf3450",
        "created_at": "2015-01-20T01:52:17+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-488",
        "actor": "guid-33ee4253-a965-43c7-a8d2-169a19bc46a2",
        "actor_type": "name-489",
        "actor_name": "name-490",
        "actee": "guid-97d9b173-1cb9-490a-b6be-ac06d54fa91d",
        "actee_type": "name-491",
        "actee_name": "name-492",
        "timestamp": "2015-01-20T01:52:17+00:00",
        "metadata": {

        },
        "space_guid": "20b4fa22-dd38-453c-973f-0b0a3df215f4",
        "organization_guid": "0adff2e0-53b8-465a-bc52-e406e9c6f4d4"
      }
    }
  ]
}