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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NyIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTJ9.VrgBswo8jg_3Vmvu0HHWfy7BUFdcxGO18Dm0GdcvU1Y
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7cce9bc8-253f-4a14-a206-0696e819e154
Content-Length: 2385
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "28a87968-d0e7-4715-bc4b-fc41a2328c27",
        "url": "/v2/events/28a87968-d0e7-4715-bc4b-fc41a2328c27",
        "created_at": "2015-02-13T22:34:52Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-398",
        "actor": "guid-1310d9b9-7a22-4562-929b-5c5ce1958545",
        "actor_type": "name-399",
        "actor_name": "name-400",
        "actee": "guid-32a51672-9c53-404d-bf9f-837b63db0681",
        "actee_type": "name-401",
        "actee_name": "name-402",
        "timestamp": "2015-02-13T22:34:52Z",
        "metadata": {

        },
        "space_guid": "2ff553c8-50c7-4cd4-91b2-92a789a3e175",
        "organization_guid": "c5a93f9c-b0ba-4d53-92f7-b39fda84b04d"
      }
    },
    {
      "metadata": {
        "guid": "c441f044-87a2-4038-ace9-78e9bc4946bb",
        "url": "/v2/events/c441f044-87a2-4038-ace9-78e9bc4946bb",
        "created_at": "2015-02-13T22:34:52Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-406",
        "actor": "guid-7e11aa84-0016-4384-9fa0-c8f48cc5a429",
        "actor_type": "name-407",
        "actor_name": "name-408",
        "actee": "guid-29da1f53-f89b-4f28-8a61-73db61d2b497",
        "actee_type": "name-409",
        "actee_name": "name-410",
        "timestamp": "2015-02-13T22:34:52Z",
        "metadata": {

        },
        "space_guid": "39351394-f709-4a62-a653-ebd7f95f9e33",
        "organization_guid": "d6e7a562-4aae-4380-bf26-4359154a6a04"
      }
    },
    {
      "metadata": {
        "guid": "ae88937d-c072-4b62-9dd0-f2d0a4f75aea",
        "url": "/v2/events/ae88937d-c072-4b62-9dd0-f2d0a4f75aea",
        "created_at": "2015-02-13T22:34:52Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-414",
        "actor": "guid-4df06fa1-7754-40f7-b6c9-b4f707bb494a",
        "actor_type": "name-415",
        "actor_name": "name-416",
        "actee": "guid-60ede4e2-c560-4d04-a31d-49fa03124a54",
        "actee_type": "name-417",
        "actee_name": "name-418",
        "timestamp": "2015-02-13T22:34:52Z",
        "metadata": {

        },
        "space_guid": "36a9b103-b056-4278-b464-fa23afb0ce87",
        "organization_guid": "a9591ecc-8209-4dc3-96f0-7ffac99826ac"
      }
    }
  ]
}