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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NCIsImVtYWlsIjoiZW1haWwtMTY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzF9.y1el_1dE14Zb08ZohiJ3keKaWfn6TT_rpWJlqqVdnWw
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2965c737-41ad-416d-8695-1113786874ca
Content-Length: 2400
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "49cdcf3a-75ee-4d53-9ea7-578c9df18a2c",
        "url": "/v2/events/49cdcf3a-75ee-4d53-9ea7-578c9df18a2c",
        "created_at": "2015-02-10T01:42:51Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1269",
        "actor": "guid-408107e5-a977-4564-b5b7-b266300f80f2",
        "actor_type": "name-1270",
        "actor_name": "name-1271",
        "actee": "guid-40654c68-f53a-4eb7-8a27-44b9f76491e3",
        "actee_type": "name-1272",
        "actee_name": "name-1273",
        "timestamp": "2015-02-10T01:42:51Z",
        "metadata": {

        },
        "space_guid": "ce3f6bf3-c34b-4479-b97e-075d80bbd1ce",
        "organization_guid": "2622ec93-5905-4b59-a268-46137dec94d4"
      }
    },
    {
      "metadata": {
        "guid": "e33dc86a-06e6-48b8-a1f0-e25f03b4bf6b",
        "url": "/v2/events/e33dc86a-06e6-48b8-a1f0-e25f03b4bf6b",
        "created_at": "2015-02-10T01:42:51Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1277",
        "actor": "guid-184cc632-7042-4386-beac-1132b0cc9390",
        "actor_type": "name-1278",
        "actor_name": "name-1279",
        "actee": "guid-dc6d59cd-0708-43bb-9227-da3124a4a150",
        "actee_type": "name-1280",
        "actee_name": "name-1281",
        "timestamp": "2015-02-10T01:42:51Z",
        "metadata": {

        },
        "space_guid": "0b3d6eb2-abaf-4443-adfb-427a6801a410",
        "organization_guid": "e3a58a61-83c1-469f-ad5c-9ad41664a3c0"
      }
    },
    {
      "metadata": {
        "guid": "e55a0ac3-229f-4612-933d-df26ada23fb6",
        "url": "/v2/events/e55a0ac3-229f-4612-933d-df26ada23fb6",
        "created_at": "2015-02-10T01:42:51Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1285",
        "actor": "guid-91e4b42f-ddc0-4d55-9497-c5f121feb95a",
        "actor_type": "name-1286",
        "actor_name": "name-1287",
        "actee": "guid-915be217-1efa-4dbf-9c19-b89e44022f8d",
        "actee_type": "name-1288",
        "actee_name": "name-1289",
        "timestamp": "2015-02-10T01:42:51Z",
        "metadata": {

        },
        "space_guid": "5f66d916-7abb-4814-92cd-77adf68955a3",
        "organization_guid": "b657cecd-3714-4947-b384-73d4de1b934e"
      }
    }
  ]
}