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.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxNzQ2MjM0N30.GPV0dr1gwTil4z1Uguz0C-qr8sR973E6QWI2DO11sV4
Host: example.org
Cookie: 

Route

GET /v2/events

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c8c31a00-c2f7-4333-9a79-fc79e3f8a98e
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": "51b6f379-d172-40ba-b28b-c73259717eb5",
        "url": "/v2/events/51b6f379-d172-40ba-b28b-c73259717eb5",
        "created_at": "2014-11-24T19:32:27+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-25",
        "actor": "guid-1b821aad-364b-488a-b4b2-9f8df8b240c7",
        "actor_type": "name-26",
        "actor_name": "name-27",
        "actee": "guid-dc336726-799d-4ada-83de-f491e46ac8d2",
        "actee_type": "name-28",
        "actee_name": "name-29",
        "timestamp": "2014-11-24T19:32:27+00:00",
        "metadata": {

        },
        "space_guid": "3e00f802-66fb-4be9-9a09-c64cbdb40487",
        "organization_guid": "9fb4557d-ba40-4e75-b8e8-257f00d13d24"
      }
    },
    {
      "metadata": {
        "guid": "197d2ae1-3a10-4a7b-835a-57511e79e776",
        "url": "/v2/events/197d2ae1-3a10-4a7b-835a-57511e79e776",
        "created_at": "2014-11-24T19:32:27+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-33",
        "actor": "guid-db2b6f80-39bb-40dd-8e25-8b480b90a0da",
        "actor_type": "name-34",
        "actor_name": "name-35",
        "actee": "guid-4a0993a4-d632-4954-b5c0-2e6215881049",
        "actee_type": "name-36",
        "actee_name": "name-37",
        "timestamp": "2014-11-24T19:32:27+00:00",
        "metadata": {

        },
        "space_guid": "b05d0a01-b14d-4991-95e7-3d69ac550439",
        "organization_guid": "c7f8e399-6df6-44aa-ad19-81998ae05e24"
      }
    },
    {
      "metadata": {
        "guid": "d96896cb-f148-498c-a800-a5ac7f26a5be",
        "url": "/v2/events/d96896cb-f148-498c-a800-a5ac7f26a5be",
        "created_at": "2014-11-24T19:32:27+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "name-41",
        "actor": "guid-fd704ff7-9488-49e1-92a7-69da37b730e2",
        "actor_type": "name-42",
        "actor_name": "name-43",
        "actee": "guid-f3b9e340-e2f5-44b2-bcc5-c3f4be697e87",
        "actee_type": "name-44",
        "actee_name": "name-45",
        "timestamp": "2014-11-24T19:32:27+00:00",
        "metadata": {

        },
        "space_guid": "5321571e-6253-4131-8e6e-49621bba466a",
        "organization_guid": "84130d5e-5b41-45a1-b184-d82e147053b6"
      }
    }
  ]
}