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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtODNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyOTY2NDEzOH0.CL6QNhkoT3LqzfwOn1QSnHUQoRi2rpbw6uoyfZ58qyI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtODNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyOTY2NDEzOH0.CL6QNhkoT3LqzfwOn1QSnHUQoRi2rpbw6uoyfZ58qyI" \
	-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": "269fe9c2-f299-4618-85f2-fd6b28d051a5",
        "url": "/v2/events/269fe9c2-f299-4618-85f2-fd6b28d051a5",
        "created_at": "2015-04-15T00:55:38Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1140",
        "actor": "guid-f192bde7-5500-4acd-be5f-a9052cd20847",
        "actor_type": "name-1141",
        "actor_name": "name-1142",
        "actee": "guid-fce6d68e-d394-4165-9e98-4e963ba0bfec",
        "actee_type": "name-1143",
        "actee_name": "name-1144",
        "timestamp": "2015-04-15T00:55:38Z",
        "metadata": {

        },
        "space_guid": "5d26780f-3092-4bb6-9005-7778ac9e9b66",
        "organization_guid": "6677bbcb-5b4a-44a3-ac67-23f971daac29"
      }
    },
    {
      "metadata": {
        "guid": "0771bc1a-460e-4f6a-bf20-568e1a15c08c",
        "url": "/v2/events/0771bc1a-460e-4f6a-bf20-568e1a15c08c",
        "created_at": "2015-04-15T00:55:38Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1148",
        "actor": "guid-46d2934c-e70c-424f-b895-0198e8a757dc",
        "actor_type": "name-1149",
        "actor_name": "name-1150",
        "actee": "guid-8a41336a-089e-4f3e-a1a3-81adae1e5f2b",
        "actee_type": "name-1151",
        "actee_name": "name-1152",
        "timestamp": "2015-04-15T00:55:38Z",
        "metadata": {

        },
        "space_guid": "7d477f7f-1299-4c3a-b26f-25474fcf41c2",
        "organization_guid": "3ac7bb7c-20c5-473c-b8dc-6b033aed1307"
      }
    },
    {
      "metadata": {
        "guid": "1ae4b5d5-e1b0-45fb-bf34-c58e84185cbf",
        "url": "/v2/events/1ae4b5d5-e1b0-45fb-bf34-c58e84185cbf",
        "created_at": "2015-04-15T00:55:38Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1156",
        "actor": "guid-2ecbbb98-1041-4b22-a6eb-94d3fb660bec",
        "actor_type": "name-1157",
        "actor_name": "name-1158",
        "actee": "guid-026701f5-7516-42a3-840f-299e8528dc70",
        "actee_type": "name-1159",
        "actee_name": "name-1160",
        "timestamp": "2015-04-15T00:55:38Z",
        "metadata": {

        },
        "space_guid": "fd44a964-6701-43a1-b0c8-c3b6045ffe08",
        "organization_guid": "c3b63e3f-d743-4546-853a-b6778e65c1ad"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c807ea8d-054f-4d91-a488-013a27df2812
Content-Length: 2400
X-Content-Type-Options: nosniff