Home
Version 3
Events API

Events API

List all Events

GET /v2/events

Request

Route

GET /v2/events

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

Body

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.start
  • audit.app.stop
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.app.ssh-authorized
  • audit.app.ssh-unauthorized
  • 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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIiLCJlbWFpbCI6ImVtYWlsLTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMTY0NjYyNn0.wRs_QWyOQtpLRZ1w5Hq4zpU3xrjGxOaChiauG5v32z4
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "0f03a715-2bd7-4f24-896a-7c50c62836c9",
        "url": "/v2/events/0f03a715-2bd7-4f24-896a-7c50c62836c9",
        "created_at": "2015-05-07T23:37:06Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-25",
        "actor": "guid-7788e280-0f10-4f92-bf38-1fd5ea178399",
        "actor_type": "name-26",
        "actor_name": "name-27",
        "actee": "guid-edf32316-e45c-4015-a76d-a75b6c80de06",
        "actee_type": "name-28",
        "actee_name": "name-29",
        "timestamp": "2015-05-07T23:37:06Z",
        "metadata": {

        },
        "space_guid": "a38373f5-6cad-44a2-b1e5-9cf6a7df3122",
        "organization_guid": "0ca508ae-88ac-4ed3-8f42-0fb2bb261ca6"
      }
    },
    {
      "metadata": {
        "guid": "839270bb-c856-48e7-a73d-e9c7313390ca",
        "url": "/v2/events/839270bb-c856-48e7-a73d-e9c7313390ca",
        "created_at": "2015-05-07T23:37:06Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-33",
        "actor": "guid-ad4e6808-c3fc-4935-a49a-cc760e0220c0",
        "actor_type": "name-34",
        "actor_name": "name-35",
        "actee": "guid-9a84118b-4d97-4810-8349-31a874aa7327",
        "actee_type": "name-36",
        "actee_name": "name-37",
        "timestamp": "2015-05-07T23:37:06Z",
        "metadata": {

        },
        "space_guid": "a55f90a8-215f-4832-921a-e49e1c444d01",
        "organization_guid": "8b23dc0a-0de8-4c2f-b5ae-1b30dde87b4e"
      }
    },
    {
      "metadata": {
        "guid": "44b8369c-6222-4de8-9f29-70e9b82962c5",
        "url": "/v2/events/44b8369c-6222-4de8-9f29-70e9b82962c5",
        "created_at": "2015-05-07T23:37:06Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-41",
        "actor": "guid-92d6d4f5-68d4-4b36-bdc1-eae5e40ece01",
        "actor_type": "name-42",
        "actor_name": "name-43",
        "actee": "guid-b7eff026-471a-4536-a0ac-6166643b9be9",
        "actee_type": "name-44",
        "actee_name": "name-45",
        "timestamp": "2015-05-07T23:37:06Z",
        "metadata": {

        },
        "space_guid": "7caa64bb-cb6e-4fe2-931c-ec7a8ec3b623",
        "organization_guid": "5482b801-7a70-45e0-bd35-8f38a832b9ea"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 857ac5e0-09c4-4cd5-85c6-d496c5b34305
Content-Length: 2370
X-Content-Type-Options: nosniff