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
  • 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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxNTc1NDEzNn0.8Wm2s-Hs5WvDdXS1bRO-fe2NKF5-dDU9CZ69Q16Qw3c
Host: example.org
Cookie:

Route

GET /v2/events

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxNTc1NDEzNn0.8Wm2s-Hs5WvDdXS1bRO-fe2NKF5-dDU9CZ69Q16Qw3c" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 75087684-87be-48be-8c48-aad2fecf1b6b
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": "2a4a090c-e614-403e-abce-4e4a23a57df7",
        "url": "/v2/events/2a4a090c-e614-403e-abce-4e4a23a57df7",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-599",
        "actor": "guid-20b1a735-9033-453f-989f-0de8775cf3e1",
        "actor_type": "name-600",
        "actor_name": "name-601",
        "actee": "guid-754775bc-ac0b-43f1-a38a-b76e16ae19b3",
        "actee_type": "name-602",
        "actee_name": "name-603",
        "timestamp": "2014-11-05T01:02:16+00:00",
        "metadata": {

        },
        "space_guid": "71bbc8e3-806d-4e67-aca3-ee956b746cd6",
        "organization_guid": "d13775d3-4cd2-458e-bd89-85a8b99c83cf"
      }
    },
    {
      "metadata": {
        "guid": "33f2a043-70d1-4645-a28d-83826b573ee1",
        "url": "/v2/events/33f2a043-70d1-4645-a28d-83826b573ee1",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-607",
        "actor": "guid-a79c7a95-cb30-499c-827e-eed53c41f845",
        "actor_type": "name-608",
        "actor_name": "name-609",
        "actee": "guid-7a214b55-b2c4-4538-a9e6-9c16dab473ec",
        "actee_type": "name-610",
        "actee_name": "name-611",
        "timestamp": "2014-11-05T01:02:16+00:00",
        "metadata": {

        },
        "space_guid": "a4c3fcc7-d672-4ed0-b604-9c65337d5ee6",
        "organization_guid": "421dd439-3005-44d2-b559-d264860a98c2"
      }
    },
    {
      "metadata": {
        "guid": "8b57108a-505e-4dde-8204-5970b1e57bb4",
        "url": "/v2/events/8b57108a-505e-4dde-8204-5970b1e57bb4",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-615",
        "actor": "guid-7731afbe-9764-4d01-a18e-ca83002e83f1",
        "actor_type": "name-616",
        "actor_name": "name-617",
        "actee": "guid-9f6a2340-3a78-4c18-b4fc-c64a25174473",
        "actee_type": "name-618",
        "actee_name": "name-619",
        "timestamp": "2014-11-05T01:02:16+00:00",
        "metadata": {

        },
        "space_guid": "ca8c025b-fa7d-4e4d-932b-69cfad0329e9",
        "organization_guid": "bfe9eb04-7a4b-4185-b972-1059052af1e2"
      }
    }
  ]
}