Home
Version 3
Events API

Events API

List all Events

GET /v2/events

Fields

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • 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.

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYzfQ.ddqSJ88YhBPj3yr1twYfuOuDl0B7yrCQefyMKThFz10
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYzfQ.ddqSJ88YhBPj3yr1twYfuOuDl0B7yrCQefyMKThFz10" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 81bd4dfa-692f-48bc-8af2-3d759d55adaa
Content-Length: 2415
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "d3008ab3-6258-4daf-b90d-c07afcf93348",
        "url": "/v2/events/d3008ab3-6258-4daf-b90d-c07afcf93348",
        "created_at": "2014-12-24T01:39:23+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-140",
        "actor": "guid-51034976-9565-4416-a00a-3fc3e4e9f086",
        "actor_type": "name-141",
        "actor_name": "name-142",
        "actee": "guid-b09ad904-ca3f-4432-b897-99bb22d237a9",
        "actee_type": "name-143",
        "actee_name": "name-144",
        "timestamp": "2014-12-24T01:39:23+00:00",
        "metadata": {

        },
        "space_guid": "5bc3ac89-96f6-4861-a21c-0f6ecc0bb904",
        "organization_guid": "2e074bc4-d497-4176-8fc6-aa9c64d4eaf1"
      }
    },
    {
      "metadata": {
        "guid": "4974252d-d50a-435a-b2c5-fd7ae55383aa",
        "url": "/v2/events/4974252d-d50a-435a-b2c5-fd7ae55383aa",
        "created_at": "2014-12-24T01:39:23+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-148",
        "actor": "guid-9627abbc-ae02-43f9-8041-e098b3028beb",
        "actor_type": "name-149",
        "actor_name": "name-150",
        "actee": "guid-f6e706d9-e46b-496c-aeab-713ff34e8758",
        "actee_type": "name-151",
        "actee_name": "name-152",
        "timestamp": "2014-12-24T01:39:23+00:00",
        "metadata": {

        },
        "space_guid": "b91df666-0c5b-4d2b-a953-63d6eb5fe6d3",
        "organization_guid": "a97f2646-1f15-4015-806f-1f9414f82394"
      }
    },
    {
      "metadata": {
        "guid": "b5edb468-5dd3-4c1a-acc2-9701b8a66f01",
        "url": "/v2/events/b5edb468-5dd3-4c1a-acc2-9701b8a66f01",
        "created_at": "2014-12-24T01:39:23+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-156",
        "actor": "guid-d08a26dd-2bd1-47d7-8c85-f965b1ea0f92",
        "actor_type": "name-157",
        "actor_name": "name-158",
        "actee": "guid-aa31d723-eb35-4639-98ff-d49d8510e8fc",
        "actee_type": "name-159",
        "actee_name": "name-160",
        "timestamp": "2014-12-24T01:39:23+00:00",
        "metadata": {

        },
        "space_guid": "ecb15f76-d5dc-479c-9cf7-c7a168adfde3",
        "organization_guid": "e057664c-626f-4d07-b1a4-5aa9c4c6159f"
      }
    }
  ]
}