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.
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.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk1fQ.rEoX8X_Pnzo_qB6uEj5vzyZc_v4_9l2_pAdDAdXdaoY
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 508d5243-578e-490b-96c9-8b92413da424
Content-Length: 2400
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "03511c04-d718-40f9-8930-33a8ed1ef928",
        "url": "/v2/events/03511c04-d718-40f9-8930-33a8ed1ef928",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-36",
        "actor": "guid-7eec80cd-65b9-4611-adf9-5c2d56fd76e0",
        "actor_type": "name-37",
        "actor_name": "name-38",
        "actee": "guid-f0115e5f-89d1-4b2e-95b6-08b888bd5025",
        "actee_type": "name-39",
        "actee_name": "name-40",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {

        },
        "space_guid": "4d497f3b-7a94-4cda-8fe3-b7ee7e5c50f3",
        "organization_guid": "acb2b1e5-1a6f-47fc-a836-eb221f82b007"
      }
    },
    {
      "metadata": {
        "guid": "0b871955-1f7b-4bc1-9d84-c4a10ac48821",
        "url": "/v2/events/0b871955-1f7b-4bc1-9d84-c4a10ac48821",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-44",
        "actor": "guid-1ea64f53-f1f3-4797-9002-1cc2fa310c60",
        "actor_type": "name-45",
        "actor_name": "name-46",
        "actee": "guid-cfd74f51-d67f-44aa-b2ae-d7f917fb924c",
        "actee_type": "name-47",
        "actee_name": "name-48",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {

        },
        "space_guid": "886c7bd7-3b24-4abe-95de-560823105c75",
        "organization_guid": "41c7b776-eb5d-4094-843e-faaa487291dd"
      }
    },
    {
      "metadata": {
        "guid": "3c7c1187-edb5-446a-b0c7-44f62a593eec",
        "url": "/v2/events/3c7c1187-edb5-446a-b0c7-44f62a593eec",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-52",
        "actor": "guid-ffca8436-a120-4be9-ab3e-fd50478aed74",
        "actor_type": "name-53",
        "actor_name": "name-54",
        "actee": "guid-57c5807a-20f5-44ca-a584-7b35e895d626",
        "actee_type": "name-55",
        "actee_name": "name-56",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {

        },
        "space_guid": "014524d2-adf6-467a-9be9-45456d2dc484",
        "organization_guid": "fefef0d1-2cca-4c5b-8b41-4a514814921a"
      }
    }
  ]
}