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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9.C-mObaw6v-Fa__zRqACbBPbGt-WYfXC7Kyxebcux8tM
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9.C-mObaw6v-Fa__zRqACbBPbGt-WYfXC7Kyxebcux8tM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2b597fca-2be5-496a-a8f8-f47a5392c7d5
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": "1c65c9f1-2393-406f-912e-1d4d11476133",
        "url": "/v2/events/1c65c9f1-2393-406f-912e-1d4d11476133",
        "created_at": "2015-02-12T01:42:11Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1347",
        "actor": "guid-1f31e0c5-6d72-4825-83c2-c67b7ea65780",
        "actor_type": "name-1348",
        "actor_name": "name-1349",
        "actee": "guid-c2fd74ad-95f5-45e5-87f9-4007a8d8fe7a",
        "actee_type": "name-1350",
        "actee_name": "name-1351",
        "timestamp": "2015-02-12T01:42:11Z",
        "metadata": {

        },
        "space_guid": "93ffa86c-c3a5-405f-b036-b664f566c6c6",
        "organization_guid": "d16b5e92-13e4-41df-b80f-3b656bb127cb"
      }
    },
    {
      "metadata": {
        "guid": "0cf0bddc-4126-4a8b-a9bc-085cb0d5e86f",
        "url": "/v2/events/0cf0bddc-4126-4a8b-a9bc-085cb0d5e86f",
        "created_at": "2015-02-12T01:42:11Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1355",
        "actor": "guid-5549c121-c6b6-4818-a976-bcbaa5c390cd",
        "actor_type": "name-1356",
        "actor_name": "name-1357",
        "actee": "guid-1f7ac6a5-aab0-4fd6-9e0b-b87da9a33675",
        "actee_type": "name-1358",
        "actee_name": "name-1359",
        "timestamp": "2015-02-12T01:42:12Z",
        "metadata": {

        },
        "space_guid": "b7ed8b8e-5484-410a-9d96-7a5a9ebe9d50",
        "organization_guid": "31b4a16a-8d29-499a-8ca8-b370cbd93c84"
      }
    },
    {
      "metadata": {
        "guid": "bd4747a3-9c2e-4a38-b7df-660519a36990",
        "url": "/v2/events/bd4747a3-9c2e-4a38-b7df-660519a36990",
        "created_at": "2015-02-12T01:42:11Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1363",
        "actor": "guid-50207880-e6a9-4e14-bd73-90799bac1c3b",
        "actor_type": "name-1364",
        "actor_name": "name-1365",
        "actee": "guid-c8cc63e4-65ba-4ea7-afd9-164dc5b928a2",
        "actee_type": "name-1366",
        "actee_name": "name-1367",
        "timestamp": "2015-02-12T01:42:12Z",
        "metadata": {

        },
        "space_guid": "e00fe524-42ff-4884-a1ce-5d64bdcf2e3e",
        "organization_guid": "cad27598-b414-4d94-9f84-dde983ab0165"
      }
    }
  ]
}