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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNyIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzgzNzI2NH0.DlmDVME7AGDeSVMHXDGpg0m7QdLy8WNXTHbOkBCIVBA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNyIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzgzNzI2NH0.DlmDVME7AGDeSVMHXDGpg0m7QdLy8WNXTHbOkBCIVBA" \
	-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": "29cdf66d-e1e5-48dc-945f-532296782a41",
        "url": "/v2/events/29cdf66d-e1e5-48dc-945f-532296782a41",
        "created_at": "2016-01-19T19:41:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-656",
        "actor": "guid-a0e15e8a-1729-40bb-be0f-e44486b96eae",
        "actor_type": "name-657",
        "actor_name": "name-658",
        "actee": "guid-b1e1950d-26e7-4dfa-b597-b2ce0e78b539",
        "actee_type": "name-659",
        "actee_name": "name-660",
        "timestamp": "2016-01-19T19:41:04Z",
        "metadata": {

        },
        "space_guid": "1423edb3-6177-4e62-a31d-700dd1b0e0cf",
        "organization_guid": "f3921682-1417-4712-beab-c382a6f01953"
      }
    },
    {
      "metadata": {
        "guid": "dd5dcbbd-ad85-4886-93ea-7f6c634d72d4",
        "url": "/v2/events/dd5dcbbd-ad85-4886-93ea-7f6c634d72d4",
        "created_at": "2016-01-19T19:41:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-664",
        "actor": "guid-d32b7e5a-933e-46ad-b76c-fd891877458b",
        "actor_type": "name-665",
        "actor_name": "name-666",
        "actee": "guid-467c7be6-78e8-4fb7-9c3a-8630bc509e66",
        "actee_type": "name-667",
        "actee_name": "name-668",
        "timestamp": "2016-01-19T19:41:04Z",
        "metadata": {

        },
        "space_guid": "2e6b4202-9ee4-49a6-a645-44a6c20222f0",
        "organization_guid": "14a31b8f-a2f4-4dc1-8684-455deac7cd44"
      }
    },
    {
      "metadata": {
        "guid": "fe2b6ad1-734c-4f64-8004-daa50f197cf2",
        "url": "/v2/events/fe2b6ad1-734c-4f64-8004-daa50f197cf2",
        "created_at": "2016-01-19T19:41:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-672",
        "actor": "guid-d59528d3-e28a-4779-8f0c-285a50b7919a",
        "actor_type": "name-673",
        "actor_name": "name-674",
        "actee": "guid-7c58daf3-6a27-4438-adc8-54394be411f6",
        "actee_type": "name-675",
        "actee_name": "name-676",
        "timestamp": "2016-01-19T19:41:04Z",
        "metadata": {

        },
        "space_guid": "8920d84a-ca17-4cc7-a2af-c7aecd203dd6",
        "organization_guid": "9e187ae8-ce6d-4e5d-a4d1-d541d5bbc771"
      }
    }
  ]
}

Headers

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