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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMCIsImVtYWlsIjoiZW1haWwtMjAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTN9.b-NHN5PYDvatzBSWPE0-Y4uut1cEqREdwGhXUIdsnw0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMCIsImVtYWlsIjoiZW1haWwtMjAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTN9.b-NHN5PYDvatzBSWPE0-Y4uut1cEqREdwGhXUIdsnw0" \
	-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": "fb2c932f-5a05-4730-8372-eda7a19cef0a",
        "url": "/v2/events/fb2c932f-5a05-4730-8372-eda7a19cef0a",
        "created_at": "2015-04-07T19:11:53Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1517",
        "actor": "guid-9537562f-6dc0-4b5d-953a-b2d899b66ffb",
        "actor_type": "name-1518",
        "actor_name": "name-1519",
        "actee": "guid-64082f90-08a9-4861-a1b7-638eedd869e2",
        "actee_type": "name-1520",
        "actee_name": "name-1521",
        "timestamp": "2015-04-07T19:11:53Z",
        "metadata": {

        },
        "space_guid": "54fc38d0-1765-47f3-b750-bf28f970085b",
        "organization_guid": "b5d91700-27e7-4c3a-9736-7593db157023"
      }
    },
    {
      "metadata": {
        "guid": "a298ca67-2f1e-47b5-b1fd-bdb536d9d1a3",
        "url": "/v2/events/a298ca67-2f1e-47b5-b1fd-bdb536d9d1a3",
        "created_at": "2015-04-07T19:11:53Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1525",
        "actor": "guid-096802b3-e62d-4edb-af17-c48cb4c2b9aa",
        "actor_type": "name-1526",
        "actor_name": "name-1527",
        "actee": "guid-7032d9f6-e890-4f0c-b571-4f5b9e93eae6",
        "actee_type": "name-1528",
        "actee_name": "name-1529",
        "timestamp": "2015-04-07T19:11:53Z",
        "metadata": {

        },
        "space_guid": "b2da64a4-aa8f-4798-93cd-0120d3e1912e",
        "organization_guid": "4865c623-c663-4b00-a298-32adf6658ffd"
      }
    },
    {
      "metadata": {
        "guid": "3408342c-0581-406d-aa89-c40ed27e1f19",
        "url": "/v2/events/3408342c-0581-406d-aa89-c40ed27e1f19",
        "created_at": "2015-04-07T19:11:53Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1533",
        "actor": "guid-4f5833b7-2ece-4f01-9a59-d31d1c1d925e",
        "actor_type": "name-1534",
        "actor_name": "name-1535",
        "actee": "guid-6e1c23c0-0082-47fc-b67d-a903c4483bd8",
        "actee_type": "name-1536",
        "actee_name": "name-1537",
        "timestamp": "2015-04-07T19:11:53Z",
        "metadata": {

        },
        "space_guid": "082fd5e8-64c2-4a8c-94be-98bf01c2bde4",
        "organization_guid": "cfcdb392-2e02-4970-8b5a-282077c5916e"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 20cf7e6d-583a-4ecf-9899-88fd254f23ca
Content-Length: 2400
X-Content-Type-Options: nosniff