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
  • 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
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MjF9.iUWqFF_HfJqRlknWAZT_GGjlZVo_MblvrYK1vhaR8ws
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MjF9.iUWqFF_HfJqRlknWAZT_GGjlZVo_MblvrYK1vhaR8ws" \
	-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": "e0f153b1-32ed-48da-a4fe-75ebe6af7ad8",
        "url": "/v2/events/e0f153b1-32ed-48da-a4fe-75ebe6af7ad8",
        "created_at": "2015-05-15T16:53:41Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1784",
        "actor": "guid-ac06252b-a3a0-46fc-ae0a-79d0a9d402e6",
        "actor_type": "name-1785",
        "actor_name": "name-1786",
        "actee": "guid-c1bcf46f-35e6-4aa0-a8bb-ebf7fe689d0f",
        "actee_type": "name-1787",
        "actee_name": "name-1788",
        "timestamp": "2015-05-15T16:53:41Z",
        "metadata": {

        },
        "space_guid": "6250aaa2-c015-46df-8b92-31a7a909131a",
        "organization_guid": "dece1c58-64ec-4546-a9c1-ef052ad077b6"
      }
    },
    {
      "metadata": {
        "guid": "7c131e5f-7d14-4a53-b27e-a106b1865c2d",
        "url": "/v2/events/7c131e5f-7d14-4a53-b27e-a106b1865c2d",
        "created_at": "2015-05-15T16:53:41Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1792",
        "actor": "guid-c5454a9a-2653-410d-95ce-48720df63055",
        "actor_type": "name-1793",
        "actor_name": "name-1794",
        "actee": "guid-878fbca8-af4b-48db-b984-1095a5c46c0d",
        "actee_type": "name-1795",
        "actee_name": "name-1796",
        "timestamp": "2015-05-15T16:53:41Z",
        "metadata": {

        },
        "space_guid": "a988d5af-8bc0-4cac-b776-4b44276769ca",
        "organization_guid": "7f1e9f9c-e3e0-4b9f-bc5e-a26728918156"
      }
    },
    {
      "metadata": {
        "guid": "7f8a6e34-74af-4399-8437-2100837e7862",
        "url": "/v2/events/7f8a6e34-74af-4399-8437-2100837e7862",
        "created_at": "2015-05-15T16:53:41Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1800",
        "actor": "guid-c035dee4-64e1-4751-a19e-5b99d79e1fd4",
        "actor_type": "name-1801",
        "actor_name": "name-1802",
        "actee": "guid-f0777170-8715-4755-a945-0a6aa1c5fba1",
        "actee_type": "name-1803",
        "actee_name": "name-1804",
        "timestamp": "2015-05-15T16:53:41Z",
        "metadata": {

        },
        "space_guid": "3f2c4a2a-7c08-401f-9dc0-75f8c8a4616e",
        "organization_guid": "e0142b20-33b0-4a2f-99a1-818f422f12cc"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2f8d6895-0cac-41b7-a748-276b8791eb3c
Content-Length: 2400
X-Content-Type-Options: nosniff