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
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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NyIsImVtYWlsIjoiZW1haWwtMjY5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTJ9.HXxVlF2dVqdKnHdZVNo3ZW28Gly2Hp-0wJs52P9EiSA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NyIsImVtYWlsIjoiZW1haWwtMjY5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTJ9.HXxVlF2dVqdKnHdZVNo3ZW28Gly2Hp-0wJs52P9EiSA" \
	-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": "d0cb3bd7-9e15-4f33-b3e8-726260297bdb",
        "url": "/v2/events/d0cb3bd7-9e15-4f33-b3e8-726260297bdb",
        "created_at": "2016-04-22T19:33:32Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1288",
        "actor": "guid-6ebaf9d1-721e-47ef-b83c-cb34660b9d56",
        "actor_type": "name-1289",
        "actor_name": "name-1290",
        "actee": "guid-6c4a057e-4842-49d0-9aac-720e84be6f07",
        "actee_type": "name-1291",
        "actee_name": "name-1292",
        "timestamp": "2016-04-22T19:33:32Z",
        "metadata": {

        },
        "space_guid": "16a7cebe-7d42-43a8-b64e-3ff66be1bc35",
        "organization_guid": "a8eb500f-d2d4-4436-969e-4c4ed59a0082"
      }
    },
    {
      "metadata": {
        "guid": "0fdadbc9-1f76-48e7-9873-c16fde6ed799",
        "url": "/v2/events/0fdadbc9-1f76-48e7-9873-c16fde6ed799",
        "created_at": "2016-04-22T19:33:32Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1296",
        "actor": "guid-76a340c8-55a6-4fc8-bd96-c6c0388ab4b4",
        "actor_type": "name-1297",
        "actor_name": "name-1298",
        "actee": "guid-14e82ce6-f79a-41d1-93a1-8ff4565366b6",
        "actee_type": "name-1299",
        "actee_name": "name-1300",
        "timestamp": "2016-04-22T19:33:32Z",
        "metadata": {

        },
        "space_guid": "ac135867-20f9-4736-af76-7307eeb24c87",
        "organization_guid": "cf087b80-5f54-4eac-9f0f-d15e071dfc5b"
      }
    },
    {
      "metadata": {
        "guid": "22ff6412-edc9-426b-9dae-04f104385b93",
        "url": "/v2/events/22ff6412-edc9-426b-9dae-04f104385b93",
        "created_at": "2016-04-22T19:33:32Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1304",
        "actor": "guid-126e26e9-a612-49ee-87e7-255822e217ee",
        "actor_type": "name-1305",
        "actor_name": "name-1306",
        "actee": "guid-64b70544-1b0c-4115-8016-3739ca061f29",
        "actee_type": "name-1307",
        "actee_name": "name-1308",
        "timestamp": "2016-04-22T19:33:32Z",
        "metadata": {

        },
        "space_guid": "6f4c79fd-4951-4198-9c71-c2c1e75752d4",
        "organization_guid": "171701db-ab2c-43fe-b79e-ecd000ae858d"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 651f5080-f67e-4d99-8604-fe598a65016d
Content-Length: 2400
X-Content-Type-Options: nosniff