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.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyOTkwODY3fQ.rLrrVSCnC7eoiHwHgTLIWqFP4rf7XrINU9uedb1ikAI
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8a886325-5111-4e68-a3f2-3f46fe1ad8c8
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": "91f3946f-ee62-471e-b868-8f4061c730ed",
        "url": "/v2/events/91f3946f-ee62-471e-b868-8f4061c730ed",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-932",
        "actor": "guid-24634167-7d96-4c23-b374-aa5d0b57b874",
        "actor_type": "name-933",
        "actor_name": "name-934",
        "actee": "guid-8fb433e4-9e54-4af9-a495-5069fe2de691",
        "actee_type": "name-935",
        "actee_name": "name-936",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {

        },
        "space_guid": "613aec9b-b4b9-45fd-b5aa-4d77d8ea9e37",
        "organization_guid": "7a6ed7b9-a0a2-4850-8211-2ffc94297e73"
      }
    },
    {
      "metadata": {
        "guid": "04825572-53b6-4b07-9ba2-a097303b4780",
        "url": "/v2/events/04825572-53b6-4b07-9ba2-a097303b4780",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-940",
        "actor": "guid-3a3cc94c-23fe-43d8-8d89-42c1ee0073cb",
        "actor_type": "name-941",
        "actor_name": "name-942",
        "actee": "guid-d0d9e916-314e-4281-a9a5-464fcc4d89f1",
        "actee_type": "name-943",
        "actee_name": "name-944",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {

        },
        "space_guid": "33eb5798-8e1a-4bab-b8a7-a5fcc5b2c4e3",
        "organization_guid": "f5b5b2f2-c23b-45e6-8827-120f2e96c815"
      }
    },
    {
      "metadata": {
        "guid": "526f97b9-4408-4fad-a308-7caccb006ef3",
        "url": "/v2/events/526f97b9-4408-4fad-a308-7caccb006ef3",
        "created_at": "2015-01-27T19:14:27Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-948",
        "actor": "guid-4a0692f3-98ae-4141-956f-701244bfc5c0",
        "actor_type": "name-949",
        "actor_name": "name-950",
        "actee": "guid-aa1f9a09-925e-4efe-a8e7-163c50ea05e7",
        "actee_type": "name-951",
        "actee_name": "name-952",
        "timestamp": "2015-01-27T19:14:27Z",
        "metadata": {

        },
        "space_guid": "dd39813b-8dcb-4818-b0bb-4a4a0a3db626",
        "organization_guid": "8a289bd2-473f-4117-b59e-9f1cf6019546"
      }
    }
  ]
}