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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDR9.H3fwZRehNQiPqRZJZ9EoMWeWjn1ZE_8d1DTmGqeRYp4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDR9.H3fwZRehNQiPqRZJZ9EoMWeWjn1ZE_8d1DTmGqeRYp4" \
	-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": "52aa8a25-7d3a-41a3-9016-d9f8ca9fbad5",
        "url": "/v2/events/52aa8a25-7d3a-41a3-9016-d9f8ca9fbad5",
        "created_at": "2015-09-11T18:39:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1871",
        "actor": "guid-9ea58766-a732-4e56-af7e-2abce14cc605",
        "actor_type": "name-1872",
        "actor_name": "name-1873",
        "actee": "guid-9f04bde9-89be-4b26-998b-1b5c25c84f85",
        "actee_type": "name-1874",
        "actee_name": "name-1875",
        "timestamp": "2015-09-11T18:39:04Z",
        "metadata": {

        },
        "space_guid": "783468f1-af43-4ef2-a2c7-f6de6526fbce",
        "organization_guid": "3f1a0908-2437-46b9-b616-a9da1d44b551"
      }
    },
    {
      "metadata": {
        "guid": "88fd9001-2b72-4fe9-ae5b-801f9fd72d82",
        "url": "/v2/events/88fd9001-2b72-4fe9-ae5b-801f9fd72d82",
        "created_at": "2015-09-11T18:39:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1879",
        "actor": "guid-dab0a893-5e96-4f79-a6d4-3ac9b36c942d",
        "actor_type": "name-1880",
        "actor_name": "name-1881",
        "actee": "guid-7123ef3f-bdb3-4650-87ef-7b6d148c6592",
        "actee_type": "name-1882",
        "actee_name": "name-1883",
        "timestamp": "2015-09-11T18:39:04Z",
        "metadata": {

        },
        "space_guid": "a5cd4127-4e0c-493d-9d40-9077c56e053f",
        "organization_guid": "206baeb6-f06c-43cb-ad03-924f641f69fd"
      }
    },
    {
      "metadata": {
        "guid": "20c0cfb6-d8a8-415b-bcf4-ffee214af0a9",
        "url": "/v2/events/20c0cfb6-d8a8-415b-bcf4-ffee214af0a9",
        "created_at": "2015-09-11T18:39:04Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1887",
        "actor": "guid-72e3c788-7f98-4592-881c-43608e46420f",
        "actor_type": "name-1888",
        "actor_name": "name-1889",
        "actee": "guid-3256e718-a320-4825-9fed-4e774151b56f",
        "actee_type": "name-1890",
        "actee_name": "name-1891",
        "timestamp": "2015-09-11T18:39:04Z",
        "metadata": {

        },
        "space_guid": "b32cd620-a18a-4a24-9690-1493177f9191",
        "organization_guid": "e490c433-0827-4499-b2f2-770e86e32ee7"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6bb1e1ae-bef9-4b44-936a-9b5f12878ced
Content-Length: 2400
X-Content-Type-Options: nosniff