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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzV9.vSl9e9p0pHttmZZL9MCKejfiazhyXN-QtnC9S8yyckU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzV9.vSl9e9p0pHttmZZL9MCKejfiazhyXN-QtnC9S8yyckU" \
	-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": "b989d103-b7a6-445e-a3df-20c0abec9efd",
        "url": "/v2/events/b989d103-b7a6-445e-a3df-20c0abec9efd",
        "created_at": "2015-03-18T22:52:55Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1218",
        "actor": "guid-8de5b740-671c-4f21-90f7-7c339e237f38",
        "actor_type": "name-1219",
        "actor_name": "name-1220",
        "actee": "guid-f0779c3b-7a20-417d-b936-31e096fb79d7",
        "actee_type": "name-1221",
        "actee_name": "name-1222",
        "timestamp": "2015-03-18T22:52:55Z",
        "metadata": {

        },
        "space_guid": "9810a697-ba85-4a1a-867b-105842209e85",
        "organization_guid": "3420d664-530f-4e3a-bf8a-e018e0e88614"
      }
    },
    {
      "metadata": {
        "guid": "25e8a414-d171-4a95-b798-3339621ea752",
        "url": "/v2/events/25e8a414-d171-4a95-b798-3339621ea752",
        "created_at": "2015-03-18T22:52:55Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1226",
        "actor": "guid-58997aa3-1473-4e67-974e-b34cb3f959c7",
        "actor_type": "name-1227",
        "actor_name": "name-1228",
        "actee": "guid-9c4bf7ef-ec1d-46c7-89e6-2bc5ede0efe0",
        "actee_type": "name-1229",
        "actee_name": "name-1230",
        "timestamp": "2015-03-18T22:52:55Z",
        "metadata": {

        },
        "space_guid": "1653347e-fef3-45f7-abe3-0d61f7d6317a",
        "organization_guid": "672f1a97-2691-4fb1-8a54-2f3077281a36"
      }
    },
    {
      "metadata": {
        "guid": "9e997fb5-3681-4ad1-8098-8e988f2b726f",
        "url": "/v2/events/9e997fb5-3681-4ad1-8098-8e988f2b726f",
        "created_at": "2015-03-18T22:52:55Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1234",
        "actor": "guid-1e6c62dc-a0c4-433e-8432-f94e754e15c2",
        "actor_type": "name-1235",
        "actor_name": "name-1236",
        "actee": "guid-4e9ce6c5-09ef-4faf-b3b9-f9c87d597b2a",
        "actee_type": "name-1237",
        "actee_name": "name-1238",
        "timestamp": "2015-03-18T22:52:55Z",
        "metadata": {

        },
        "space_guid": "9a91f3de-d159-4ebe-b13f-b05d6678b4e2",
        "organization_guid": "bd6378b4-a1a3-43a2-9e21-13c2fa0fad60"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2ae04391-9689-429a-96be-fe190113424f
Content-Length: 2400
X-Content-Type-Options: nosniff