Home
Version 3
Events API

Events API

List Space Update 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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk1fQ.vTPsH_4AUmUtemQ2Fev1Cf2dcCZkDKMeu6N09bWGnh0
Host: example.org
Cookie: 

Route

GET /v2/events?q=type:audit.space.update

Query Parameters

q: type:audit.space.update

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:audit.space.update" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk1fQ.vTPsH_4AUmUtemQ2Fev1Cf2dcCZkDKMeu6N09bWGnh0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c7959dbd-5272-49c1-ac4f-15586017b75a
Content-Length: 914
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "aa215549-9207-4da8-9c6a-d2baf430afc9",
        "url": "/v2/events/aa215549-9207-4da8-9c6a-d2baf430afc9",
        "created_at": "2014-11-13T23:38:15+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.space.update",
        "actor": "uaa-id-12",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "73d8fe47-1a62-41a4-9696-b79773a751c5",
        "actee_type": "space",
        "actee_name": "name-84",
        "timestamp": "2014-11-13T23:38:15+00:00",
        "metadata": {
          "request": {
            "name": "outer space"
          }
        },
        "space_guid": "73d8fe47-1a62-41a4-9696-b79773a751c5",
        "organization_guid": "7a85d18b-7629-4813-9507-6d6325f156ba"
      }
    }
  ]
}