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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MCIsImVtYWlsIjoiZW1haWwtMTk5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTd9.GToFRluaaPE93CqtysdUX5b6aCVKy8BsCZ4EaHjcPGg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1MCIsImVtYWlsIjoiZW1haWwtMTk5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTd9.GToFRluaaPE93CqtysdUX5b6aCVKy8BsCZ4EaHjcPGg" \
	-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": "7fa49ff7-48e0-4983-85cb-8bf654d0e334",
        "url": "/v2/events/7fa49ff7-48e0-4983-85cb-8bf654d0e334",
        "created_at": "2015-06-16T23:40:57Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-994",
        "actor": "guid-8996df12-ffba-479d-add1-4b8949fa8044",
        "actor_type": "name-995",
        "actor_name": "name-996",
        "actee": "guid-2d64e471-5c73-433f-bafb-ece8daf7c491",
        "actee_type": "name-997",
        "actee_name": "name-998",
        "timestamp": "2015-06-16T23:40:57Z",
        "metadata": {

        },
        "space_guid": "27fd24ec-3fc1-421e-8d30-dc3161485cea",
        "organization_guid": "e119abdf-cb4f-47ed-94e9-dc71e7cba081"
      }
    },
    {
      "metadata": {
        "guid": "1cd6a51d-78e4-4209-ad4b-42961c673f89",
        "url": "/v2/events/1cd6a51d-78e4-4209-ad4b-42961c673f89",
        "created_at": "2015-06-16T23:40:57Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1002",
        "actor": "guid-6d1a79bd-8e59-45e9-87f2-1afadda5ea1f",
        "actor_type": "name-1003",
        "actor_name": "name-1004",
        "actee": "guid-c7ff60ed-8853-495a-9cf1-e3477c56b401",
        "actee_type": "name-1005",
        "actee_name": "name-1006",
        "timestamp": "2015-06-16T23:40:57Z",
        "metadata": {

        },
        "space_guid": "16a54083-7c4a-40b4-ad61-d6370c3720fd",
        "organization_guid": "35801379-a479-494c-b818-b6772f0eb4f0"
      }
    },
    {
      "metadata": {
        "guid": "9da0f8b9-37c3-4175-b070-63937d81cfc5",
        "url": "/v2/events/9da0f8b9-37c3-4175-b070-63937d81cfc5",
        "created_at": "2015-06-16T23:40:57Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1010",
        "actor": "guid-fb9b05b9-6abb-4288-8cd9-d7a640e53dd7",
        "actor_type": "name-1011",
        "actor_name": "name-1012",
        "actee": "guid-0434b0b6-009e-4823-97d3-c881ea85808f",
        "actee_type": "name-1013",
        "actee_name": "name-1014",
        "timestamp": "2015-06-16T23:40:57Z",
        "metadata": {

        },
        "space_guid": "9dd61a2c-9f4f-46d5-925c-6ccedeb10cb2",
        "organization_guid": "8232ad8b-6d40-45f5-9764-676b2f956be3"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 434cc1f6-0b7b-4123-abcd-8f7297faaf46
Content-Length: 2395
X-Content-Type-Options: nosniff