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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0OTUzMTUxN30.PZutMMv7KwbdHTOTimBXUBQnRQYkqB3-P8kQdoyBgTo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0OTUzMTUxN30.PZutMMv7KwbdHTOTimBXUBQnRQYkqB3-P8kQdoyBgTo" \
	-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": "b36b9c8a-6e2b-4357-880b-de95f63db5ac",
        "url": "/v2/events/b36b9c8a-6e2b-4357-880b-de95f63db5ac",
        "created_at": "2015-11-30T23:38:37Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-633",
        "actor": "guid-6e493e9c-be9e-49fb-b150-e3cc01608ca8",
        "actor_type": "name-634",
        "actor_name": "name-635",
        "actee": "guid-a61b472e-14f3-46b2-9bb8-289feabde915",
        "actee_type": "name-636",
        "actee_name": "name-637",
        "timestamp": "2015-11-30T23:38:37Z",
        "metadata": {

        },
        "space_guid": "bb24e121-5604-405f-ac28-bdb4cbbc58f1",
        "organization_guid": "3e16592a-12bd-4f0c-a4e8-3afff1f35c7e"
      }
    },
    {
      "metadata": {
        "guid": "c46bde6f-f427-4e14-85d9-bec232624037",
        "url": "/v2/events/c46bde6f-f427-4e14-85d9-bec232624037",
        "created_at": "2015-11-30T23:38:37Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-641",
        "actor": "guid-5bc19e33-74ef-4694-b442-3e1fce8fe04b",
        "actor_type": "name-642",
        "actor_name": "name-643",
        "actee": "guid-ac6af999-1b5b-4d6f-8f5c-69a6c7d54cc2",
        "actee_type": "name-644",
        "actee_name": "name-645",
        "timestamp": "2015-11-30T23:38:37Z",
        "metadata": {

        },
        "space_guid": "84f16390-5c76-4604-8db7-e4487fb1265f",
        "organization_guid": "a3c171dc-3cfd-4ece-b5ac-48b6933de3ce"
      }
    },
    {
      "metadata": {
        "guid": "9b57aa0b-453a-4210-a613-56fc8c0467a3",
        "url": "/v2/events/9b57aa0b-453a-4210-a613-56fc8c0467a3",
        "created_at": "2015-11-30T23:38:37Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-649",
        "actor": "guid-57c6a730-976c-4cb3-8e5d-da9d84f52999",
        "actor_type": "name-650",
        "actor_name": "name-651",
        "actee": "guid-c13c4bee-be6d-4afc-99d0-08c3cb67c321",
        "actee_type": "name-652",
        "actee_name": "name-653",
        "timestamp": "2015-11-30T23:38:37Z",
        "metadata": {

        },
        "space_guid": "a7669916-240a-42ac-aa03-a6ebc256ada1",
        "organization_guid": "ba5feb44-897a-4496-982b-e5733a6f27c3"
      }
    }
  ]
}

Headers

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