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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NyIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYxOTl9.dF-1qutHhEbrV5zTwbrkKRtNtWfo_IC2Auyya9tGVMY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NyIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYxOTl9.dF-1qutHhEbrV5zTwbrkKRtNtWfo_IC2Auyya9tGVMY" \
	-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": "70cbfe64-c23b-4d51-a356-9347fdfdd98c",
        "url": "/v2/events/70cbfe64-c23b-4d51-a356-9347fdfdd98c",
        "created_at": "2015-08-06T00:36:39Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-618",
        "actor": "guid-b6e172cd-0407-45d3-8562-0e99a1cf152a",
        "actor_type": "name-619",
        "actor_name": "name-620",
        "actee": "guid-def34e0e-6ad4-4721-ae4d-6654aa19cdaf",
        "actee_type": "name-621",
        "actee_name": "name-622",
        "timestamp": "2015-08-06T00:36:39Z",
        "metadata": {

        },
        "space_guid": "a5e8190e-c571-4bfe-a759-f4061b86d212",
        "organization_guid": "4e73c899-e144-4833-9e24-26f344528e35"
      }
    },
    {
      "metadata": {
        "guid": "39ff0ce8-34ee-4fad-9e0a-37ae5b8c8ec4",
        "url": "/v2/events/39ff0ce8-34ee-4fad-9e0a-37ae5b8c8ec4",
        "created_at": "2015-08-06T00:36:39Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-626",
        "actor": "guid-a14b3f85-b33f-47cc-82a1-5f43cc74f36b",
        "actor_type": "name-627",
        "actor_name": "name-628",
        "actee": "guid-ba8eb2dc-ab07-499b-8516-75f24875b8aa",
        "actee_type": "name-629",
        "actee_name": "name-630",
        "timestamp": "2015-08-06T00:36:39Z",
        "metadata": {

        },
        "space_guid": "28b4e266-dd7d-4976-83ee-068e15d55390",
        "organization_guid": "a51b5366-d3b6-4d5e-bcef-7fb71c97f423"
      }
    },
    {
      "metadata": {
        "guid": "8b1044ee-020f-481a-a68b-d62801c1b229",
        "url": "/v2/events/8b1044ee-020f-481a-a68b-d62801c1b229",
        "created_at": "2015-08-06T00:36:39Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-634",
        "actor": "guid-727622f1-338b-4d45-a487-97f3733432c0",
        "actor_type": "name-635",
        "actor_name": "name-636",
        "actee": "guid-3a2c8940-838e-4600-b63d-d0ef643ea3eb",
        "actee_type": "name-637",
        "actee_name": "name-638",
        "timestamp": "2015-08-06T00:36:39Z",
        "metadata": {

        },
        "space_guid": "03442a0f-8a4c-4389-8675-ea17cc5401ad",
        "organization_guid": "ca75fc2d-fdb9-4992-8dd8-71e5ce299d9c"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 30679de4-21c3-440e-9201-e84d88596a08
Content-Length: 2385
X-Content-Type-Options: nosniff