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
  • audit.route.create
  • audit.route.update
  • audit.route.delete-request
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDl9.le5qdVfn-Pzc9bCgQuwtKkgBRp7L2Ozhzg4aNobDafA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDl9.le5qdVfn-Pzc9bCgQuwtKkgBRp7L2Ozhzg4aNobDafA" \
	-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": "c512725b-c1b7-44f8-b25a-68548c357c04",
        "url": "/v2/events/c512725b-c1b7-44f8-b25a-68548c357c04",
        "created_at": "2016-04-16T01:24:09Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2357",
        "actor": "guid-cdfd5012-4d81-4b4e-aeb8-cf702e9e3ba3",
        "actor_type": "name-2358",
        "actor_name": "name-2359",
        "actee": "guid-465fa5e1-9374-4754-9fa5-55d3be3dc2ec",
        "actee_type": "name-2360",
        "actee_name": "name-2361",
        "timestamp": "2016-04-16T01:24:09Z",
        "metadata": {

        },
        "space_guid": "e398407e-3f21-4a83-b328-700f42d5a34c",
        "organization_guid": "435c39a7-9745-4c8f-8aaf-4f829f819b2a"
      }
    },
    {
      "metadata": {
        "guid": "9234484d-2321-4b15-b059-51c5c639e2b5",
        "url": "/v2/events/9234484d-2321-4b15-b059-51c5c639e2b5",
        "created_at": "2016-04-16T01:24:09Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2365",
        "actor": "guid-39e48ecc-0146-4fe0-b56f-df64c39d9393",
        "actor_type": "name-2366",
        "actor_name": "name-2367",
        "actee": "guid-36fb8106-2bc3-4513-80be-5b39eaa5b3a4",
        "actee_type": "name-2368",
        "actee_name": "name-2369",
        "timestamp": "2016-04-16T01:24:09Z",
        "metadata": {

        },
        "space_guid": "0e093ca7-48c1-4eaa-ab31-5dae457cfd98",
        "organization_guid": "825b02b5-f8ab-4290-bd42-68747b8f70a7"
      }
    },
    {
      "metadata": {
        "guid": "072bcdde-98c2-4ac9-baf8-f3b99ad8fbf7",
        "url": "/v2/events/072bcdde-98c2-4ac9-baf8-f3b99ad8fbf7",
        "created_at": "2016-04-16T01:24:09Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2373",
        "actor": "guid-d1f37ffc-7f14-4ca1-9e44-34d15926c9e9",
        "actor_type": "name-2374",
        "actor_name": "name-2375",
        "actee": "guid-4394d7aa-21c6-4929-a640-d05a4fdbadde",
        "actee_type": "name-2376",
        "actee_name": "name-2377",
        "timestamp": "2016-04-16T01:24:09Z",
        "metadata": {

        },
        "space_guid": "a36c8551-7963-44f1-8038-aa84941ad8e0",
        "organization_guid": "48d95742-d69d-4f11-a559-91c2edfdffdf"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1e16f580-9f05-4b3b-acd7-9e7e6ac5451c
Content-Length: 2400
X-Content-Type-Options: nosniff