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, space_guid, organization_guid		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
order-by	Attribute to order results by	timestamp id
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgzfQ.mlJWB09dxc0WyknW6JvygsC5UtSph8tJvsq0OZ3-nqM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgzfQ.mlJWB09dxc0WyknW6JvygsC5UtSph8tJvsq0OZ3-nqM" \
	-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.copy-bits audit.app.create audit.app.delete-request audit.app.droplet.mapped audit.app.map-route audit.app.package.create audit.app.package.delete audit.app.package.download audit.app.package.upload audit.app.restage audit.app.ssh-authorized audit.app.ssh-unauthorized audit.app.start audit.app.stop audit.app.unmap-route audit.app.update audit.app.upload-bits audit.organization.create audit.organization.delete-request audit.organization.update audit.route.create audit.route.delete-request audit.route.update audit.service.create audit.service.delete audit.service.update audit.service_binding.create audit.service_binding.delete audit.service_broker.create audit.service_broker.delete audit.service_broker.update audit.service_dashboard_client.create audit.service_dashboard_client.delete audit.service_instance.bind_route audit.service_instance.create audit.service_instance.delete audit.service_instance.unbind_route audit.service_instance.update audit.service_key.create audit.service_key.delete audit.service_plan.create audit.service_plan.delete audit.service_plan.update audit.service_plan_visibility.create audit.service_plan_visibility.delete audit.service_plan_visibility.update audit.space.create audit.space.delete-request audit.space.update audit.user_provided_service_instance.create audit.user_provided_service_instance.delete audit.user_provided_service_instance.update audit.user.space_auditor_add audit.user.space_auditor_remove audit.user.space_manager_add audit.user.space_manager_remove audit.user.space_developer_add audit.user.space_developer_remove audit.user.organization_auditor_add audit.user.organization_auditor_remove audit.user.organization_billing_manager_add audit.user.organization_billing_manager_remove audit.user.organization_manager_add audit.user.organization_manager_remove audit.user.organization_user_add audit.user.organization_user_remove blob.remove_orphan	app.crash audit.app.update
type	The type of the event.	audit.app.build.create audit.app.droplet.create audit.app.droplet.delete audit.app.droplet.download 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.task.cancel audit.app.task.create audit.service_instance.share audit.service_instance.unshare	audit.app.process.crash
actor	The GUID of the actor.
actor_type	The actor type.		service_broker system user
actor_name	The name of the actor.		user1@example.com
actor_username	The username of the actor.		user1
actee	The GUID of the actee.
actee_type	The actee type.		app route service service_binding service_broker service_dashboard_client service_instance service_key service_plan service_plan_visibility space user user_provided_service_instance
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": "b8ede8e1-afc8-40a1-baae-236a0a77b27b",
        "url": "/v2/events/b8ede8e1-afc8-40a1-baae-236a0a77b27b",
        "created_at": "2016-06-08T16:41:23Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "type": "name-167",
        "actor": "guid-008640fc-d316-4602-9251-c8d09bbdc750",
        "actor_type": "name-168",
        "actor_name": "name-169",
        "actee": "guid-e7790fa4-be2b-4a0f-aa82-c124342b0bb4",
        "actee_type": "name-170",
        "actee_name": "name-171",
        "timestamp": "2016-06-08T16:41:23Z",
        "metadata": {

        },
        "space_guid": "3a1368e7-e3b7-46af-a98d-57b9c71445e7",
        "organization_guid": "86aa12ee-8c4f-4b26-b391-2be6c1730dbc"
      }
    },
    {
      "metadata": {
        "guid": "2ccf53a8-d0eb-4807-9bb9-7dd844e65267",
        "url": "/v2/events/2ccf53a8-d0eb-4807-9bb9-7dd844e65267",
        "created_at": "2016-06-08T16:41:23Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "type": "name-175",
        "actor": "guid-52cb38f4-d52d-4201-87e3-8e5650efc8c1",
        "actor_type": "name-176",
        "actor_name": "name-177",
        "actee": "guid-5c4214a1-f295-42ae-bd92-38e7cb8be538",
        "actee_type": "name-178",
        "actee_name": "name-179",
        "timestamp": "2016-06-08T16:41:23Z",
        "metadata": {

        },
        "space_guid": "10f0fd9d-dd68-428e-8e93-c00bb8eff0a6",
        "organization_guid": "aa3fdaaa-42c8-4141-bc22-9792c37aa62f"
      }
    },
    {
      "metadata": {
        "guid": "4f9b1fef-2ce4-4877-85e1-0da9114a92cb",
        "url": "/v2/events/4f9b1fef-2ce4-4877-85e1-0da9114a92cb",
        "created_at": "2016-06-08T16:41:23Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "type": "name-183",
        "actor": "guid-d3be7ed1-1c08-43f6-a20d-5cd9287492e1",
        "actor_type": "name-184",
        "actor_name": "name-185",
        "actee": "guid-9844795f-943d-47ed-a997-2c04ee611f5a",
        "actee_type": "name-186",
        "actee_name": "name-187",
        "timestamp": "2016-06-08T16:41:23Z",
        "metadata": {

        },
        "space_guid": "f9ef235c-25df-4aa1-bcb4-15eec6f92146",
        "organization_guid": "24a920db-f551-46af-bf73-e1db972f652a"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: eadf02e9-3d03-4790-b827-89728c055e19
Content-Length: 2385
X-Content-Type-Options: nosniff