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
  • audit.route.create
  • audit.route.update
  • audit.route.delete-request
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjI4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODJ9.2YveufzXAyZXI0g2qwTdH9MO1zFvnIsCX9nB4aPmJ2k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjI4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODJ9.2YveufzXAyZXI0g2qwTdH9MO1zFvnIsCX9nB4aPmJ2k" \
	-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": "cc44b1ed-e310-4f04-bb37-0d07ef2b1efa",
        "url": "/v2/events/cc44b1ed-e310-4f04-bb37-0d07ef2b1efa",
        "created_at": "2016-03-17T21:41:22Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1165",
        "actor": "guid-792ff84e-c063-4aaa-b836-b4cdc6aa597d",
        "actor_type": "name-1166",
        "actor_name": "name-1167",
        "actee": "guid-3256cc6d-f2ed-4f4c-96ef-f3c1e2216671",
        "actee_type": "name-1168",
        "actee_name": "name-1169",
        "timestamp": "2016-03-17T21:41:22Z",
        "metadata": {

        },
        "space_guid": "f047651f-2eb8-4b71-8e88-fb899285a6ac",
        "organization_guid": "4917d953-fecf-4c53-8ff6-f84fc9daca91"
      }
    },
    {
      "metadata": {
        "guid": "b2c81266-e953-4c38-95f5-f5927fa67318",
        "url": "/v2/events/b2c81266-e953-4c38-95f5-f5927fa67318",
        "created_at": "2016-03-17T21:41:22Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1173",
        "actor": "guid-3a9fa03e-26bc-4aa8-a607-e1ab021a3dfc",
        "actor_type": "name-1174",
        "actor_name": "name-1175",
        "actee": "guid-61043eff-8b68-4374-841d-154a5e52249a",
        "actee_type": "name-1176",
        "actee_name": "name-1177",
        "timestamp": "2016-03-17T21:41:22Z",
        "metadata": {

        },
        "space_guid": "58c60331-3231-419f-bdb3-452eb49ce0a9",
        "organization_guid": "3fdc2cc7-0ce5-4744-9bca-9c5274f215ce"
      }
    },
    {
      "metadata": {
        "guid": "d3c4814d-1a86-4687-a9d7-d13f6665c4c0",
        "url": "/v2/events/d3c4814d-1a86-4687-a9d7-d13f6665c4c0",
        "created_at": "2016-03-17T21:41:22Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1181",
        "actor": "guid-08ee517b-0846-4d98-b1b1-a5aefca8657f",
        "actor_type": "name-1182",
        "actor_name": "name-1183",
        "actee": "guid-ce5100c1-08bc-4843-aea1-a359cfe685c6",
        "actee_type": "name-1184",
        "actee_name": "name-1185",
        "timestamp": "2016-03-17T21:41:22Z",
        "metadata": {

        },
        "space_guid": "ca263a84-912b-480f-ae80-481fade014d9",
        "organization_guid": "7a1118ba-1719-4202-a291-e4e8a90ee2d7"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2400
X-Content-Type-Options: nosniff