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.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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU3IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI1OTQ4NjYwfQ.Uryn6f7RTrjYLMavrMQFPAi-mNo1XPguVKyvRbvaxU0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU3IiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI1OTQ4NjYwfQ.Uryn6f7RTrjYLMavrMQFPAi-mNo1XPguVKyvRbvaxU0" \
	-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": "351b289b-b950-4ae7-ba7e-e09f4e510c67",
        "url": "/v2/events/351b289b-b950-4ae7-ba7e-e09f4e510c67",
        "created_at": "2015-03-03T00:51:00Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-163",
        "actor": "guid-ef96f35d-1b68-4088-b126-9bf3cdbbdde1",
        "actor_type": "name-164",
        "actor_name": "name-165",
        "actee": "guid-b283a46b-9f11-4d7a-b9e0-b5b041aa964a",
        "actee_type": "name-166",
        "actee_name": "name-167",
        "timestamp": "2015-03-03T00:51:00Z",
        "metadata": {

        },
        "space_guid": "dca762df-ebed-4fbf-9414-17d58a95a2de",
        "organization_guid": "c3cb6664-a6a4-43f1-9d87-c506687d8807"
      }
    },
    {
      "metadata": {
        "guid": "571978e8-7a32-4ad3-999b-f43d15d9126d",
        "url": "/v2/events/571978e8-7a32-4ad3-999b-f43d15d9126d",
        "created_at": "2015-03-03T00:51:00Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-171",
        "actor": "guid-1f99b30e-25a6-479e-8ec4-caeac846ea85",
        "actor_type": "name-172",
        "actor_name": "name-173",
        "actee": "guid-e14f1f4f-a619-4928-ada1-5cce47663a87",
        "actee_type": "name-174",
        "actee_name": "name-175",
        "timestamp": "2015-03-03T00:51:00Z",
        "metadata": {

        },
        "space_guid": "4f389196-25b6-4258-ba33-f09d75cc83cf",
        "organization_guid": "cb779274-4d8d-4297-a4ba-38c400f26142"
      }
    },
    {
      "metadata": {
        "guid": "4add8ae3-e47e-42b2-b011-ebc3cd3e7803",
        "url": "/v2/events/4add8ae3-e47e-42b2-b011-ebc3cd3e7803",
        "created_at": "2015-03-03T00:51:00Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-179",
        "actor": "guid-73b6f1e7-eaaf-4691-9af7-ba9206dba16a",
        "actor_type": "name-180",
        "actor_name": "name-181",
        "actee": "guid-e81a552d-8e0a-4dcf-9fc2-87ffe4b6ff34",
        "actee_type": "name-182",
        "actee_name": "name-183",
        "timestamp": "2015-03-03T00:51:00Z",
        "metadata": {

        },
        "space_guid": "32182564-cca4-4c93-a80e-a3aeb9930931",
        "organization_guid": "d8294f6e-fad9-4c77-b060-15af0258db07"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 21092668-e31a-475a-82be-8ff983481f5b
Content-Length: 2385
X-Content-Type-Options: nosniff