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.start
  • audit.app.stop
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.app.ssh-authorized
  • audit.app.ssh-unauthorized
  • 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
  • audit.service_key.create
  • audit.service_key.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
  • v3-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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtNzBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTU1NzkzNn0.3WVN2_OsYyychHZJAptbjOHWorifs6GXS1jL7-5THq0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtNzBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTU1NzkzNn0.3WVN2_OsYyychHZJAptbjOHWorifs6GXS1jL7-5THq0" \
	-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": "15af63ad-1b44-4ecd-a288-eaeb870b75b5",
        "url": "/v2/events/15af63ad-1b44-4ecd-a288-eaeb870b75b5",
        "created_at": "2015-10-15T23:52:16Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1235",
        "actor": "guid-51838b81-3e07-4f6b-9316-7dfc1d587c96",
        "actor_type": "name-1236",
        "actor_name": "name-1237",
        "actee": "guid-1fbcc5fb-af9e-4449-867a-200b73cbf9a9",
        "actee_type": "name-1238",
        "actee_name": "name-1239",
        "timestamp": "2015-10-15T23:52:16Z",
        "metadata": {

        },
        "space_guid": "77c92cd6-4c82-49c6-b794-abfc2f12cbcb",
        "organization_guid": "e8a508bf-b499-4b45-bc06-d389573ca41d"
      }
    },
    {
      "metadata": {
        "guid": "4fa28da2-1f8e-454c-a699-f2658153f9b2",
        "url": "/v2/events/4fa28da2-1f8e-454c-a699-f2658153f9b2",
        "created_at": "2015-10-15T23:52:16Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1243",
        "actor": "guid-7de64d8b-a09f-4e4e-b7c2-80cffde2d7d2",
        "actor_type": "name-1244",
        "actor_name": "name-1245",
        "actee": "guid-abaa81bb-839f-4d6a-89cb-510ea4202c06",
        "actee_type": "name-1246",
        "actee_name": "name-1247",
        "timestamp": "2015-10-15T23:52:16Z",
        "metadata": {

        },
        "space_guid": "a5444b80-54d3-4448-b8a1-e7c0297b9075",
        "organization_guid": "f12e348c-a048-43b4-a00d-4763eccba118"
      }
    },
    {
      "metadata": {
        "guid": "425cbc2a-6357-4ca9-ad4c-e58c681a525d",
        "url": "/v2/events/425cbc2a-6357-4ca9-ad4c-e58c681a525d",
        "created_at": "2015-10-15T23:52:16Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1251",
        "actor": "guid-60b1030c-d5df-4109-ad3b-eded60b03af8",
        "actor_type": "name-1252",
        "actor_name": "name-1253",
        "actee": "guid-a3bede1c-2cf9-4a5c-a9f9-c0d1ddfaa311",
        "actee_type": "name-1254",
        "actee_name": "name-1255",
        "timestamp": "2015-10-15T23:52:16Z",
        "metadata": {

        },
        "space_guid": "9a500dcd-448e-4f61-817a-302973f41aa7",
        "organization_guid": "4eb5c720-3039-4c44-a786-ecff10f722bb"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 409d2d86-2caf-472f-a0f4-916fbb7b195d
Content-Length: 2400
X-Content-Type-Options: nosniff