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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NiIsImVtYWlsIjoiZW1haWwtMTE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTF9.GY1Sg3luKnaQS9_eGZsGrpiEhHQUGt4KQkgQEGBp-SY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NiIsImVtYWlsIjoiZW1haWwtMTE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NTF9.GY1Sg3luKnaQS9_eGZsGrpiEhHQUGt4KQkgQEGBp-SY" \
	-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": "8da4db62-dd68-4a79-b691-84b205a2da7d",
        "url": "/v2/events/8da4db62-dd68-4a79-b691-84b205a2da7d",
        "created_at": "2015-03-20T18:27:31Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1197",
        "actor": "guid-8860d9c2-7406-4e94-b0be-2c93e1d7a44a",
        "actor_type": "name-1198",
        "actor_name": "name-1199",
        "actee": "guid-2db728be-66b2-4bda-896a-16d12cf2faa6",
        "actee_type": "name-1200",
        "actee_name": "name-1201",
        "timestamp": "2015-03-20T18:27:31Z",
        "metadata": {

        },
        "space_guid": "37e4ad93-4cc0-4327-911f-7178b442923a",
        "organization_guid": "1af77783-01e1-490e-aebd-c7f05425c437"
      }
    },
    {
      "metadata": {
        "guid": "2ff1b759-498a-46df-9a9b-ac464169ef42",
        "url": "/v2/events/2ff1b759-498a-46df-9a9b-ac464169ef42",
        "created_at": "2015-03-20T18:27:31Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1205",
        "actor": "guid-b6f99095-2453-46c9-9787-f4c76d6df3ad",
        "actor_type": "name-1206",
        "actor_name": "name-1207",
        "actee": "guid-c51fb51a-4974-4f4c-a0ad-4e740d87b3c9",
        "actee_type": "name-1208",
        "actee_name": "name-1209",
        "timestamp": "2015-03-20T18:27:31Z",
        "metadata": {

        },
        "space_guid": "8396090f-3d27-4f67-80df-6e62d588336f",
        "organization_guid": "2c657ee2-a57e-49c5-a3f1-67ad75de123a"
      }
    },
    {
      "metadata": {
        "guid": "663e9221-ce6d-438e-8650-18d93f8f1ac9",
        "url": "/v2/events/663e9221-ce6d-438e-8650-18d93f8f1ac9",
        "created_at": "2015-03-20T18:27:31Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1213",
        "actor": "guid-ee2cd0bc-9c4c-4c18-8665-a77939d445ff",
        "actor_type": "name-1214",
        "actor_name": "name-1215",
        "actee": "guid-8a472013-b590-4d9d-bc48-be9346ae9dde",
        "actee_type": "name-1216",
        "actee_name": "name-1217",
        "timestamp": "2015-03-20T18:27:31Z",
        "metadata": {

        },
        "space_guid": "7b94fb1b-d98d-4b49-aa31-284120e39816",
        "organization_guid": "4829d950-ba49-4d08-a3eb-8a600917d17e"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 09251c14-763f-417d-a98e-0e8433ee67af
Content-Length: 2400
X-Content-Type-Options: nosniff