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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNCIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.hv8MJ58xjJWuk-r5U8FIqIIu4tbJP8MbYcyYCSQygxI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNCIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.hv8MJ58xjJWuk-r5U8FIqIIu4tbJP8MbYcyYCSQygxI" \
	-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": "76464d48-7434-4467-b0ee-ef60a76bd387",
        "url": "/v2/events/76464d48-7434-4467-b0ee-ef60a76bd387",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1080",
        "actor": "guid-8bcca0b3-3116-4011-b380-3e37a8ffb755",
        "actor_type": "name-1081",
        "actor_name": "name-1082",
        "actee": "guid-42ff2f29-d928-4d31-8ee1-5d21778a1634",
        "actee_type": "name-1083",
        "actee_name": "name-1084",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {

        },
        "space_guid": "a1a1ae1b-dbb5-4a34-9e1e-06d5ff6ada53",
        "organization_guid": "419ff3cb-423e-45a2-a50d-6dd45411edbd"
      }
    },
    {
      "metadata": {
        "guid": "7e3014da-d0cd-4e08-bd0b-f816fc19d0cc",
        "url": "/v2/events/7e3014da-d0cd-4e08-bd0b-f816fc19d0cc",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1088",
        "actor": "guid-1fbf36eb-2abd-4dd4-9877-e842e799b9a2",
        "actor_type": "name-1089",
        "actor_name": "name-1090",
        "actee": "guid-d4c98350-a141-4c69-aab0-a128d146b375",
        "actee_type": "name-1091",
        "actee_name": "name-1092",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {

        },
        "space_guid": "8c4ff9b4-1cf4-4818-9f75-a092e7aeb4bb",
        "organization_guid": "0d6d5da1-e2af-4d29-8811-d42eb480bec5"
      }
    },
    {
      "metadata": {
        "guid": "9a16f787-8d1e-4e50-b331-0ccee64d5186",
        "url": "/v2/events/9a16f787-8d1e-4e50-b331-0ccee64d5186",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1096",
        "actor": "guid-4ed813b9-3b8c-403b-8e96-416b4e3f1136",
        "actor_type": "name-1097",
        "actor_name": "name-1098",
        "actee": "guid-a3196f02-d7cd-48a5-b242-4b2273cdcc52",
        "actee_type": "name-1099",
        "actee_name": "name-1100",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {

        },
        "space_guid": "c82ad5cc-df80-415c-a538-0d8e0b051066",
        "organization_guid": "fecae850-a8d0-4bba-914b-100f7243a427"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2400
X-Content-Type-Options: nosniff