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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtOTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcxMH0.QwDnBNso6OaIVHKNmZhfYuDqnaXF13WRQ95S4wizR18
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtOTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcxMH0.QwDnBNso6OaIVHKNmZhfYuDqnaXF13WRQ95S4wizR18" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

Name	Description	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.service_instance.bind_route audit.service_instance.unbind_route 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
type	The type of the event.	audit.app.droplet.create audit.app.droplet.delete audit.app.process.crash audit.app.process.create audit.app.process.delete audit.app.process.scale audit.app.process.terminate_instance audit.app.process.update	audit.app.process.crash
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 (experimental) v3-service-binding (experimental)
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.

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "69a93da5-2a55-4cdd-85fd-c0a19eda74eb",
        "url": "/v2/events/69a93da5-2a55-4cdd-85fd-c0a19eda74eb",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-276",
        "actor": "guid-dd165771-c60c-4208-9229-b72453607ed8",
        "actor_type": "name-277",
        "actor_name": "name-278",
        "actee": "guid-d47dc206-99c7-41ae-82e9-1338f13cb257",
        "actee_type": "name-279",
        "actee_name": "name-280",
        "timestamp": "2016-05-12T00:45:10Z",
        "metadata": {

        },
        "space_guid": "5f36f89e-d5c8-42ac-8c45-8136d7f71f5c",
        "organization_guid": "6631d5ce-3d4c-4772-88ea-aab94b8e3ab1"
      }
    },
    {
      "metadata": {
        "guid": "6c5a605c-82b7-4126-ac33-1ebdf893ffaf",
        "url": "/v2/events/6c5a605c-82b7-4126-ac33-1ebdf893ffaf",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-284",
        "actor": "guid-7171f7ce-6f62-4893-9030-04d500851d1a",
        "actor_type": "name-285",
        "actor_name": "name-286",
        "actee": "guid-f359492d-5dea-4fe7-961e-e5f04ea90053",
        "actee_type": "name-287",
        "actee_name": "name-288",
        "timestamp": "2016-05-12T00:45:10Z",
        "metadata": {

        },
        "space_guid": "72e21403-b71c-4581-b543-e206e14f6060",
        "organization_guid": "4f8f3ecc-9506-4005-b78e-3a06e40da8aa"
      }
    },
    {
      "metadata": {
        "guid": "8b464a63-8522-4ecb-9308-67ae4f73c33b",
        "url": "/v2/events/8b464a63-8522-4ecb-9308-67ae4f73c33b",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-292",
        "actor": "guid-04518f32-a342-434a-b119-31ebfc6c17ea",
        "actor_type": "name-293",
        "actor_name": "name-294",
        "actee": "guid-23392f6d-815a-415a-8662-bd59a1a2a475",
        "actee_type": "name-295",
        "actee_name": "name-296",
        "timestamp": "2016-05-12T00:45:10Z",
        "metadata": {

        },
        "space_guid": "0bd1f56d-2e91-4d4a-8b6b-1281c10c62bc",
        "organization_guid": "493dab75-7b97-42a6-86f7-09cd43430d22"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7cc266d9-1d74-46e6-b74f-aea791243ad7
Content-Length: 2385
X-Content-Type-Options: nosniff